This is documentation for the next version of Grafana Alloy Documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana Alloybreadcrumb arrow Referencebreadcrumb arrow Command-line interfacebreadcrumb arrow otel-supervisor
Experimental Open source

otel-supervisor

EXPERIMENTAL: This is an experimental feature. Experimental features are subject to frequent breaking changes, and may be removed with no equivalent replacement. To enable and use an experimental feature, you must set the stability.level flag to experimental.

The otel-supervisor command runs Alloy with the OTel Engine under an embedded OpAMP supervisor. The supervisor connects to Grafana Fleet Management and receives the OTel Engine configuration through OpAMP.

Usage

The otel-supervisor command supports simple and manual modes.

Simple mode helps you get started quickly with Grafana Fleet Management. Use manual mode to connect to an OpAMP server other than Grafana Fleet Management.

Run in simple mode

Simple mode uses environment variables to configure the supervisor. To run it, use the following command:

shell 
alloy otel-supervisor

To configure simple mode, set the following environment variables:

  • GCLOUD_FM_URL: The Grafana Fleet Management base URL. The command adds /v1/opamp when the URL doesn’t include it.
  • GCLOUD_INSTANCE_ID: Your Grafana Cloud instance ID.
  • GCLOUD_RW_API_KEY: Your Grafana Cloud API token.
  • STORAGE_DIR: A directory where the supervisor stores its data.

Set the variables before you start the supervisor. The following shell example uses placeholder values:

shell 
export GCLOUD_FM_URL="<FLEET_MANAGEMENT_URL>"
export GCLOUD_INSTANCE_ID="<GRAFANA_CLOUD_INSTANCE_ID>"
export GCLOUD_RW_API_KEY="<GRAFANA_CLOUD_API_TOKEN>"
export STORAGE_DIR="<SUPERVISOR_STORAGE_DIRECTORY>"

alloy otel-supervisor

For information about setting up Fleet Management, refer to the Grafana Fleet Management documentation.

Run in manual mode

Manual mode uses a supervisor configuration file. To run it, use the following command:

shell 
alloy otel-supervisor --config=<SUPERVISOR_CONFIG_FILE>

Replace <SUPERVISOR_CONFIG_FILE> with the path to an OpenTelemetry Collector OpAMP supervisor configuration file.

Alloy always sets agent.executable to the running Alloy binary. It ignores any agent.executable value in the supervisor configuration file. You can set agent.args to change the arguments passed to the Alloy binary.

Configure an OpAMP connection

The following configuration connects the supervisor to Grafana Fleet Management:

YAML 
server:
  endpoint: "${env:GCLOUD_FM_URL}/v1/opamp"
  headers:
    Authorization: "Basic ${env:GCLOUD_BASIC_AUTH_BASE64}"
capabilities:
  accepts_remote_config: true
  reports_remote_config: true
storage:
  directory: ${env:STORAGE_DIR}

Set GCLOUD_BASIC_AUTH_BASE64 to the base64-encoded Grafana Cloud instance ID and API token, separated by a colon.

Override Alloy arguments

To pass different arguments to the Alloy binary, add an agent block to the supervisor configuration file:

YAML 
agent:
  args: [otel, --feature-gates, +service.profilesSupport]