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.

Documentation Grafana Agent Flow mode Get started Migrate from Promtail

Migrate from Promtail to Grafana Agent Flow

The built-in Grafana Agent convert command can migrate your Promtail configuration to a Grafana Agent Flow configuration.

This topic describes how to:

• Convert a Promtail configuration to a Grafana Agent Flow configuration.
• Run a Promtail configuration natively using Grafana Agent Flow.

Components used in this topic

• local.file_match
• loki.source.file
• loki.write

Before you begin

• You must have an existing Promtail configuration.
• You must be familiar with the concept of Components in Grafana Agent Flow.

Convert a Promtail configuration

To fully migrate fromPromtail to Grafana Agent Flow, you must convert your Promtail configuration into a Grafana Agent Flow configuration. This conversion will enable you to take full advantage of the many additional features available in Grafana Agent Flow.

In this task, we will use the convert CLI command to output a flow configuration from a Promtail configuration.

1. Open a terminal window and run the following command:

   static-binaryflow-binary

   Copy

   static-binary Copy

   AGENT_MODE=flow grafana-agent convert --source-format=promtail --output=OUTPUT_CONFIG_PATH INPUT_CONFIG_PATH

   flow-binary Copy

   grafana-agent-flow convert --source-format=promtail --output=OUTPUT_CONFIG_PATH INPUT_CONFIG_PATH

   Replace the following:

   • INPUT_CONFIG_PATH: The full path to the Promtail configuration.
   • OUTPUT_CONFIG_PATH: The full path to output the flow configuration.

2. Start Grafana Agent Flow using the new flow configuration from OUTPUT_CONFIG_PATH:

Debugging

1. If the convert command cannot convert a Promtail configuration, diagnostic information is sent to stderr. You can bypass any non-critical issues and output the flow configuration using a best-effort conversion by including the --bypass-errors flag.

   Caution

   If you bypass the errors, the behavior of the converted configuration may not match the original Promtail configuration. Make sure you fully test the converted configuration before using it in a production environment.

   static-binaryflow-binary

   Copy

   static-binary Copy

   AGENT_MODE=flow grafana-agent convert --source-format=promtail --bypass-errors --output=OUTPUT_CONFIG_PATH INPUT_CONFIG_PATH

   flow-binary Copy

   grafana-agent-flow convert --source-format=promtail --bypass-errors --output=OUTPUT_CONFIG_PATH INPUT_CONFIG_PATH

2. You can also output a diagnostic report by including the --report flag.

   static-binaryflow-binary

   Copy

   static-binary Copy

   AGENT_MODE=flow grafana-agent convert --source-format=promtail --report=OUTPUT_REPORT_PATH --output=OUTPUT_CONFIG_PATH INPUT_CONFIG_PATH

   flow-binary Copy

   grafana-agent-flow convert --source-format=promtail --report=OUTPUT_REPORT_PATH --output=OUTPUT_CONFIG_PATH INPUT_CONFIG_PATH

   • Replace OUTPUT_REPORT_PATH with the output path for the report.

   Using the example Promtail configuration below, the diagnostic report provides the following information:

   plaintext Copy

   (Warning) If you have a tracing set up for Promtail, it cannot be migrated to Grafana Agent Flow automatically. Refer to the documentation on how to configure tracing in Grafana Agent Flow.
   (Warning) The metrics from Grafana Agent Flow are different from the metrics emitted by Promtail. If you rely on Promtail's metrics, you must change your configuration, for example, your alerts and dashboards.

Run a Promtail configuration

If you’re not ready to completely switch to a flow configuration, you can run Grafana Agent using your existing Promtail configuration. The --config.format=promtail flag tells Grafana Agent to convert your Promtail configuration to Grafana Agent Flow and load it directly without saving the new configuration. This allows you to try Grafana Agent Flow without modifying your existing Promtail configuration infrastructure.

In this task, we will use the run CLI command to run Grafana Agent Flow using a Promtail configuration.

Start Grafana Agent Flow and include the command line flag --config.format=promtail. Your configuration file must be a valid Promtail configuration file rather than a Flow mode configuration file.

Debugging

1. You can follow the convert CLI command debugging instructions to generate a diagnostic report.

2. Refer to the Grafana Agent Flow Debugging for more information about running Grafana Agent Flow.

3. If your Promtail configuration can’t be converted and loaded directly into Grafana Agent, diagnostic information is sent to stderr. You can bypass any non-critical issues and start Grafana Agent by including the --config.bypass-conversion-errors flag in addition to --config.format=promtail.

   Caution

   If you bypass the errors, the behavior of the converted configuration may not match the original Promtail configuration. Do not use this flag in a production environment.

Example

This example demonstrates converting a Promtail configuration file to a Grafana Agent Flow configuration file.

The following Promtail configuration file provides the input for the conversion:

yaml Copy

clients:
  - url: http://localhost/loki/api/v1/push
scrape_configs:
  - job_name: example
    static_configs:
      - targets:
          - localhost
        labels:
          __path__: /var/log/*.log

The convert command takes the YAML file as input and outputs a River file.

static-binaryflow-binary

Copy

static-binary Copy

AGENT_MODE=flow grafana-agent convert --source-format=promtail --output=OUTPUT_CONFIG_PATH INPUT_CONFIG_PATH

flow-binary Copy

grafana-agent-flow convert --source-format=promtail --output=OUTPUT_CONFIG_PATH INPUT_CONFIG_PATH

The new Grafana Agent Flow configuration file looks like this:

river Copy

local.file_match "example" {
	path_targets = [{
		__address__ = "localhost",
		__path__    = "/var/log/*.log",
	}]
}

loki.source.file "example" {
	targets    = local.file_match.example.targets
	forward_to = [loki.write.default.receiver]
}

loki.write "default" {
	endpoint {
		url = "http://localhost/loki/api/v1/push"
	}
	external_labels = {}
}

Limitations

Configuration conversion is done on a best-effort basis. Grafana Agent will issue warnings or errors where the conversion can’t be performed.

Once the configuration is converted, we recommend that you review the Grafana Agent Flow configuration file created, and verify that it’s correct before starting to use it in a production environment.

Furthermore, we recommend that you review the following checklist:

• Check if you are using any extra command line arguments with Promtail which aren’t present in your configuration file. For example, -max-line-size.
• Check if you are setting any environment variables, whether expanded in the config file itself or consumed directly by Promtail, such as JAEGER_AGENT_HOST.
• In Grafana Agent Flow, the positions file is saved at a different location. Refer to the loki.source.file documentation for more details. Check if you have any existing setup, for example, a Kubernetes Persistent Volume, that you must update to use the new positions file path.
• Metamonitoring metrics exposed by the Flow Mode usually match Promtail metamonitoring metrics but will use a different name. Make sure that you use the new metric names, for example, in your alerts and dashboards queries.
• Note that the logs produced by Grafana Agent Flow will differ from those produced by Promtail.
• Note that Grafana Agent Flow exposes the Grafana Agent Flow UI, which differs from Promtail’s Web UI.