Reference documentation for beacon-agent
Suggest editsbeacon-agent
command
Synopsis
beacon-agent
runs Beacon Agent or sets up Beacon agent through its subcommand setup
.
Usage
Commands
(no subcommand) - runs Beacon agent.
- Usage
Description
This default mode manages the Beacon Agent process, which sends data ingestions to the Beacon Server and maintains a local log of its activities.
Examples
- Start Beacon Agent:
setup - creates the configuration file and authenticates with the server.
- Usage
Description
This command creates the Beacon configuration file and, by default, authenticates the Beacon project with the Beacon server.
Options
-file string=<string>
: Sets the filename of the generated configuration file. (default "beacon_agent.yaml").-verify=<boolean>
: Verifies the project's credentials with the Beacon server.--help
: Provides information about optional flags.
Examples
Create the configuration file, but don't authenticate the Beacon project with the Beacon Server.
Create the configuration file with a different name than the default (beacon_agent.yaml).
- On this page
- beacon-agent command
Could this page be better? Report a problem or suggest an addition!