Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source

Getting Started

Install Grafana Agent

To use Grafana Agent Flow, first install Grafana Agent. Grafana Agent Flow is an operating mode which will be available in an upcoming Grafana Agent release.

Running Grafana Agent Flow

Grafana Agent Flow can be enabled by setting the AGENT_MODE environment variable to flow.

NOTE: In previous releases, the EXPERIMENTAL_ENABLE_FLOW environment variable was set to 1 to enable Grafana Agent Flow. This environment variable is deprecated and support for it will be removed in the v0.32 release. It is recommended to change to AGENT_MODE=flow as soon as possible.

Then, use the agent run command to start Grafana Agent Flow, replacing FILE_PATH with the path of a config file to use:

AGENT_MODE=flow agent run FILE_PATH

Grafana Agent Flow uses a different command-line interface and command line flags than the normal Grafana Agent. You can see the supported commands and the flags they support in the reference documentation for the command-line interface.

You can use this file as an example to get started:

river
prometheus.scrape "default" {
  targets = [
    {"__address__" = "demo.robustperception.io:9090"},
  ]
  forward_to = [prometheus.remote_write.default.receiver]
}

prometheus.remote_write "default" {
  // No endpoints configured; metrics will be accumulated locally in a WAL
  // and discarded.
}