beacon-agent
Synopsis
beacon-agent
runs Beacon Agent or sets up Beacon agent through its subcommand setup
.
Usage
Global options
Option | Description |
---|---|
--help | Provides information about optional flags. |
Sub-commands
(no sub-command)
Description
Runs the Beacon agent.
In default mode, with no subcommand, this runs the Beacon 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
Options
Option | Description |
---|---|
-file=<string> | Sets the filename (and path) of the configuration file. (default "beacon_agent.yaml" ) |
Examples
Start Beacon Agent:
setup
Description
Creates the Beacon agent configuration file and, by default, authenticates the Beacon 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.
Usage
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
Creating a configuration file with a different name
version
Description
Print the version of the agent and exit.
Usage
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 Beacon 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 Beacon 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
Could this page be better? Report a problem or suggest an addition!