External Monitors Agent

The External Monitors agent integrates with external monitoring tools such as dbt tests. It collects test results from these tools and reports them to Bigeye as monitor data.

Installation

# Run the installer and select EXTERNAL_MONITORS
./bigeye-agent install

After installation, add connectors for the monitoring tools you want to integrate:

./bigeye-agent add-connector -c dbt

Commands

Run Monitors

# Run all connections for a connector type
./bigeye-agent external-monitors run -c dbt

# Run a specific named connection
./bigeye-agent external-monitors run -c dbt -n my-dbt-project

# Only create monitors without submitting results
./bigeye-agent external-monitors run -c dbt --create-monitors-only

# Only submit results to existing monitors
./bigeye-agent external-monitors run -c dbt --submit-results-only

Option	Description
`--connector`, `-c`	Connector type to run (e.g., `dbt`). Required.
`--name`, `-n`	Connection name(s) to run. Can be specified multiple times. If omitted, all connections are run.
`--create-monitors-only`	Only create monitors in Bigeye, don't submit results
`--submit-results-only`	Only submit results to existing monitors

Update Configuration

# Re-enter External Monitors configuration
./bigeye-agent external-monitors configure

# Overwrite existing configuration
./bigeye-agent external-monitors configure --overwrite

Option	Description
`--overwrite`, `-o`	Prompt for new configuration details even if configuration already exists (default: `false`)

Sync Configuration

./bigeye-agent external-monitors sync

Regenerates External Monitors configuration files from bigeye_agent.yml. Use this after manually editing the YAML file.

Upgrade

./bigeye-agent external-monitors upgrade

Updates the External Monitors agent to the latest Docker image version.