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 Reference Configuration blocks argument

argument block

argument is an optional configuration block used to specify parameterized input to a custom component. argument blocks must be given a label which determines the name of the argument.

The argument block may only be specified inside the definition of a declare block.

Example

river Copy

argument "ARGUMENT_NAME" {}

Arguments

NOTE: For clarity, “argument” in this section refers to arguments which can be given to the argument block. “Module argument” refers to the argument being defined for a module, determined by the label of the argument block.

The following arguments are supported:

By default, all module arguments are required. The optional argument can be used to mark the module argument as optional. When optional is true, the initial value for the module argument is specified by default.

Exported fields

The following fields are exported and can be referenced by other components:

If you use a custom component, you are responsible for determining the values for arguments. Other expressions within a custom component may use argument.ARGUMENT_NAME.value to retrieve the value you provide.

Example

This example creates a custom component that self-collects process metrics and forwards them to an argument specified by the user of the custom component:

river Copy

declare "self_collect" {
  argument "metrics_output" {
    optional = false
    comment  = "Where to send collected metrics."
  }

  prometheus.scrape "selfmonitor" {
    targets = [{
      __address__ = "127.0.0.1:12345",
    }]

    forward_to = [argument.metrics_output.value]
  }
}