beacon-agent
Synopsis
beacon-agent runs the Agent or sets up the Agent through its subcommand setup.
Usage
beacon-agent [subcommand] [options]
Global options
| Option | Description |
|---|---|
--help | Provides information about optional flags. |
Sub-commands
(no sub-command)
Description
Runs the Agent.
In default mode, with no subcommand, this runs the Agent process, which sends data ingestions to the Beacon Server and maintains a local log of its activities.
With no configuration file specified, the agent looks for a beacon_agent.yaml file in /etc/beacon, $HOME/.beacon and in the current directory.
Usage
beacon-agent [-file=<configurationfilepath>]
Options
| Option | Description |
|---|---|
-file=<string> | Sets the filename (and path) of the configuration file. (default "beacon_agent.yaml") |
Examples
Start the Agent:
beacon-agent
setup
Description
Creates the Agent configuration file and, by default, authenticates the Agent with the EDB Postgres AI control plane.
Verification of credentials requires the environment variables BEACON_AGENT_ACCESS_KEY and BEACON_AGENT_PROJECT_ID to be set.
export BEACON_AGENT_ACCESS_KEY=<your-access-key> export BEACON_AGENT_PROJECT_ID=<your-project-id>
Usage
beacon-agent setup [-file=<configurationfilepath>]
Options
| Option | Description |
|---|---|
-file=<string> | Sets the filename (and path) of the generated configuration file. (default "beacon_agent.yaml") |
-verify=<boolean> | Verifies the project's credentials with the Beacon server. |
Examples
Creating a configuration file, without authentication
beacon-agent setup -verify=false
Creating a configuration file with a different name
beacon-agent setup -file my_beacon_config.yaml
version
Description
Print the version of the agent and exit.
Usage
beacon-agent version
Configuration file format
The configuration file is a YAML file that contains the following fields:
| Key | Description |
|---|---|
| agent.access_key | The access key for the Agent. |
| agent.access_key_grpc_header | The header key for the access key. |
| agent.batch_size | The number of records to send in a batch. |
| agent.beacon_server | The URL of the Beacon Server. |
| agent.feature_flag_interval | The interval to check for feature flags. |
| agent.project_id | The project ID for the Agent. |
| agent.providers | An array of provider names of database providers. |
| provider | An object containing provider configurations. |
The provider object contains provider configurations for each provider. The key is the provider name.
| Key | Description |
|---|---|
| provider_name.databases | An object containing named database configurations for the provider. |
| provider_name.host | The host for the provider. |
| provider_name.poll_interval | The polling interval for the provider. |
| provider_name.host.resource_id | The resource ID for the host. |
| provider_name.host.tags | An array of tags for the host. |
The databases object contains database configurations for each database. The key is the database name:
| Key | Description |
|---|---|
| databasename.dsn | The DSN for the database. |
| databasename.tags | An array of tags for the database. |
Example configuration file
agent: access_key: "$BEACON_AGENT_ACCESS_KEY" access_key_grpc_header: "x-access-key" batch_size: 100 beacon_server: "beacon.biganimal.com:443" feature_flag_interval: 10m0s project_id: "<project ID>" providers: - "onprem" provider: onprem: databases: - dsn: "$DSN" tags: - "foo" - "bar" host: resource_id: "postgresql.lan" tags: [] poll_interval: 5m0s
← Prev
Running the Agent as a service
↑ Up
EDB Postgres AI Estate: Agent
Next →
Integrating resources into your EDB Postgres AI Estate
Could this page be better? Report a problem or suggest an addition!