Grafana Agent Flow Reference on Grafana Labs

The Grafana Agent command-line interface

Wed, 12 Mar 2025 11:45:31 +0100

The Grafana Agent command-line interface

When in Flow mode, the grafana-agent binary exposes a command-line interface with subcommands to perform various operations.

The most common subcommand is run which accepts a configuration file and starts Grafana Agent Flow.

Available commands:

convert: Convert a Grafana Agent configuration file.
fmt: Format a Grafana Agent Flow configuration file.
run: Start Grafana Agent Flow, given a configuration file.
tools: Read the WAL and provide statistical information.
completion: Generate shell completion for the grafana-agent-flow CLI.
help: Print help for supported commands.

Configuration blocks

Wed, 11 Sep 2024 17:43:35 +0000

Configuration blocks

Configuration blocks are optional top-level blocks that can be used to configure various parts of the Grafana Agent Flow process. Each configuration block can only be defined once.

Configuration blocks are not components, so they have no exports.

Components reference

Wed, 12 Mar 2025 11:45:31 +0100

Components reference

This section contains reference documentation for all recognized components.

Compatible components

Wed, 11 Sep 2024 17:43:35 +0000

Compatible components

This section provides an overview of some of the possible connections between compatible components in Grafana Agent Flow.

For each common data type, we provide a list of compatible components that can export or consume it.

Note
The type of export may not be the only requirement for chaining components together. The value of an attribute may matter as well as its type. Refer to each component’s documentation for more details on what values are acceptable.

For example:

A Prometheus component may always expect an "__address__" label inside a list of targets.

A string argument may only accept certain values like “traceID” or “spanID”.

Targets

Targets are a list(map(string)) - a list of maps with string values. They can contain different key-value pairs, and you can use them with a wide range of components. Some components require Targets to contain specific key-value pairs to work correctly. It’s recommended to always check component references for details when working with Targets.

Targets Exporters

The following components, grouped by namespace, export Targets.

Targets Consumers

The following components, grouped by namespace, consume Targets.

Prometheus `MetricsReceiver`

The Prometheus metrics are sent between components using MetricsReceivers. MetricsReceivers are capsules that are exported by components that can receive Prometheus metrics. Components that can consume Prometheus metrics can be passed the MetricsReceiver as an argument. Use the following components to build your Prometheus metrics pipeline:

Prometheus `MetricsReceiver` Exporters

The following components, grouped by namespace, export Prometheus MetricsReceiver.

Prometheus `MetricsReceiver` Consumers

The following components, grouped by namespace, consume Prometheus MetricsReceiver.

Loki `LogsReceiver`

LogsReceiver is a capsule that is exported by components that can receive Loki logs. Components that consume LogsReceiver as an argument typically send logs to it. Use the following components to build your Loki logs pipeline:

Loki `LogsReceiver` Exporters

The following components, grouped by namespace, export Loki LogsReceiver.

Loki `LogsReceiver` Consumers

The following components, grouped by namespace, consume Loki LogsReceiver.

OpenTelemetry `otelcol.Consumer`

The OpenTelemetry data is sent between components using otelcol.Consumers. otelcol.Consumers are capsules that are exported by components that can receive OpenTelemetry data. Components that can consume OpenTelemetry data can be passed the otelcol.Consumer as an argument. Some components that use otelcol.Consumer only support a subset of telemetry signals, for example, only traces. Refer to the component reference pages for more details on what is supported. Use the following components to build your OpenTelemetry pipeline:

OpenTelemetry `otelcol.Consumer` Exporters

The following components, grouped by namespace, export OpenTelemetry otelcol.Consumer.

OpenTelemetry `otelcol.Consumer` Consumers

The following components, grouped by namespace, consume OpenTelemetry otelcol.Consumer.

Pyroscope `ProfilesReceiver`

The Pyroscope profiles are sent between components using ProfilesReceivers. ProfilesReceivers are capsules that are exported by components that can receive Pyroscope profiles. Components that can consume Pyroscope profiles can be passed the ProfilesReceiver as an argument. Use the following components to build your Pyroscope profiles pipeline:

Pyroscope `ProfilesReceiver` Exporters

The following components, grouped by namespace, export Pyroscope ProfilesReceiver.

Pyroscope `ProfilesReceiver` Consumers

The following components, grouped by namespace, consume Pyroscope ProfilesReceiver.

Standard library

Wed, 11 Sep 2024 17:43:35 +0000

Standard library

The standard library is a list of functions which can be used in expressions when assigning values to attributes.

All standard library functions are pure functions: they will always return the same output if given the same input.

Grafana Agent Flow Reference on Grafana Labs

The Grafana Agent command-line interface

The Grafana Agent command-line interface

Configuration blocks

Configuration blocks

Components reference

Components reference

Compatible components

Compatible components

Targets

Targets Exporters

Targets Consumers

Prometheus MetricsReceiver

Prometheus MetricsReceiver Exporters

Prometheus MetricsReceiver Consumers

Loki LogsReceiver

Loki LogsReceiver Exporters

Loki LogsReceiver Consumers

OpenTelemetry otelcol.Consumer

OpenTelemetry otelcol.Consumer Exporters

OpenTelemetry otelcol.Consumer Consumers

Pyroscope ProfilesReceiver

Pyroscope ProfilesReceiver Exporters

Pyroscope ProfilesReceiver Consumers

Standard library

Standard library

Prometheus `MetricsReceiver`

Prometheus `MetricsReceiver` Exporters

Prometheus `MetricsReceiver` Consumers

Loki `LogsReceiver`

Loki `LogsReceiver` Exporters

Loki `LogsReceiver` Consumers

OpenTelemetry `otelcol.Consumer`

OpenTelemetry `otelcol.Consumer` Exporters

OpenTelemetry `otelcol.Consumer` Consumers

Pyroscope `ProfilesReceiver`

Pyroscope `ProfilesReceiver` Exporters

Pyroscope `ProfilesReceiver` Consumers