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 Components reference discovery.relabel

discovery.relabel

In Flow, targets are defined as sets of key-value pairs called labels.

discovery.relabel rewrites the label set of the input targets by applying one or more relabeling rules. If no rules are defined, then the input targets are exported as-is.

The most common use of discovery.relabel is to filter targets or standardize the target label set that is passed to a downstream component. The rule blocks are applied to the label set of each target in order of their appearance in the configuration file. The configured rules can be retrieved by calling the function in the rules export field.

Target labels which start with a double underscore __ are considered internal, and may be removed by other Flow components prior to telemetry collection. To retain any of these labels, use a labelmap action to remove the prefix, or remap them to a different name. Service discovery mechanisms usually group their labels under __meta_*. For example, the discovery.kubernetes component populates a set of __meta_kubernetes_* labels to provide information about the discovered Kubernetes resources. If a relabeling rule needs to store a label value temporarily, for example as the input to a subsequent step, use the __tmp label name prefix, as it is guaranteed to never be used.

Multiple discovery.relabel components can be specified by giving them different labels.

Usage

river Copy

discovery.relabel "LABEL" {
  targets = TARGET_LIST

  rule {
    ...
  }

  ...
}

Arguments

The following arguments are supported:

Blocks

The following blocks are supported inside the definition of discovery.relabel:

rule block

The rule block contains the definition of any relabeling rules that can be applied to an input metric. If more than one rule block is defined, the transformations are applied in top-down order.

The following arguments can be used to configure a rule. All arguments are optional. Omitted fields take their default values.

You can use the following actions:

• drop - Drops metrics where regex matches the string extracted using the source_labels and separator.
• dropequal - Drop targets for which the concatenated source_labels do match target_label.
• hashmod - Hashes the concatenated labels, calculates its modulo modulus and writes the result to the target_label.
• keep - Keeps metrics where regex matches the string extracted using the source_labels and separator.
• keepequal - Drop targets for which the concatenated source_labels do not match target_label.
• labeldrop - Matches regex against all label names. Any labels that match are removed from the metric’s label set.
• labelkeep - Matches regex against all label names. Any labels that don’t match are removed from the metric’s label set.
• labelmap - Matches regex against all label names. Any labels that match are renamed according to the contents of the replacement field.
• lowercase - Sets target_label to the lowercase form of the concatenated source_labels.
• replace - Matches regex to the concatenated labels. If there’s a match, it replaces the content of the target_label using the contents of the replacement field.
• uppercase - Sets target_label to the uppercase form of the concatenated source_labels.

Exported fields

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

Component health

discovery.relabel is only reported as unhealthy when given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

discovery.relabel does not expose any component-specific debug information.

Debug metrics

discovery.relabel does not expose any component-specific debug metrics.

Example

river Copy

discovery.relabel "keep_backend_only" {
  targets = [
    { "__meta_foo" = "foo", "__address__" = "localhost", "instance" = "one",   "app" = "backend"  },
    { "__meta_bar" = "bar", "__address__" = "localhost", "instance" = "two",   "app" = "database" },
    { "__meta_baz" = "baz", "__address__" = "localhost", "instance" = "three", "app" = "frontend" },
  ]

  rule {
    source_labels = ["__address__", "instance"]
    separator     = "/"
    target_label  = "destination"
    action        = "replace"
  }

  rule {
    source_labels = ["app"]
    action        = "keep"
    regex         = "backend"
  }
}