Configuration is done through the BindPlane UI or can be done through configuration yaml files. The configuration yaml files are found under the config folder in the install location of the UA. Any comments added to configuration files will be removed when configuration files are updated through BindPlane UI

Default Install Locations

Linux

/opt/bpagent

Windows

c:\bpagent

MacOS

/users/$USER/bpagent

OS

The os.yaml file controls the collection of OS metrics. If the os.yaml file is not present then UA will not collect OS metrics.

cpu:
  collection_interval: 5s # Minimum 5s Maximum 1h Default 5s
  enabled: true # Default: true

disk:  
  collection_interval: 1m0s # Minimum 1m Maximum 24h Default 1m
  enabled: false # Default false

file_system:  
  collection_interval: 1m0s # Minimum 1m Maximum 24h Default 1m
  enabled: false # Default false

load:
  collection_interval: 1m0s # Minimum 5s Maximum 1h Default 1m
  enabled: true # Default: true

memory:
  collection_interval: 10s # Minimum 5s Maximum 1h Default 30s
  enabled: true # Default: true

network:
  collection_interval: 10s # Minimum 5s Maximum 1h Default 10s
  enabled: true # Default: true

process:
  collection_interval: 1m0s # Minimum 5s Maximum 24h Default 1m
  enabled: false # Default false

Metrics Agent

Metrics configuration is located within the metrics/sources and will be UUID .yaml file. Each source will have an associated file. This file configuration will differ for each type of source.

#Each source yaml file will contain the following properties.
#Name: Identifing name. This can be anything.
#Value Type: string
name: Source Name Example

#Type: This is the type of source. This must match the source type.
type: host

#Version: This is the version of the source
#Value Type: string
version: 3.0.0

Log Agent

The logging.yaml file controls the level of detail and retention policy of the logs found in the install location under a log folder.

#Description: level sets the level of logging for universal agent.
#Value Type: string
#Default: INFO
#Value Options: DEBUG, INFO, WARN, ERROR, PANIC, FATAL
level: INFO

#Description: Maximum number of log files when before overwriting when rotating logs.
#Value Type: Int
#Default: 5
#Minimum: 1
max_backups: 1

#Description: Maximum size of log files when before overwriting when rotating logs.
#Value Type: Int
#Default: 1
#Minimum: 1
max_megabytes: 1

#Description: Maximum number of days to retain log files when before overwriting when rotating logs.
#Value Type: Int
#Default: 7
#Minimum: 1
max_days: 7

Remote

The remote.yaml file sets communication configuration with BindPlane. This file is configured automatically when installing via command provided through UI. If the remote.yaml file is not present it will not communicate with BindPlane.

#Agent_id: UUIDv4. This is required, but will be auto generated if missing when connecting to BindPlane
#Value Type: string
agent_id: b1ead1e1-7111-4177-861c-dfc71ff96d8a

#Secret_Key: UUIDv4. This is required. The secret key can be retrieved from the bindplane ui agent install command.
secret_key: b1ead1e1-7111-4177-861c-dfc71ff96d8a