Reference documentation for beacon-agent

Suggest edits

beacon-agent command

Synopsis

beacon-agent runs Beacon Agent or sets up Beacon agent through its subcommand setup.

Usage

beacon-agent [command] [options]

Commands

  1. (no subcommand) - runs Beacon agent.

    • Usage
    beacon-agent
    • 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:
    beacon-agent
  2. setup - creates the configuration file and authenticates with the server.

    • Usage
    beacon-agent setup 
    • 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.

        beacon-agent setup -verify=false
      • Create the configuration file with a different name than the default (beacon_agent.yaml).

        beacon-agent setup -file my_beacon_config.yaml

Could this page be better? Report a problem or suggest an addition!