Labels

The labels processor lets you manipulate the labels of metrics.

Similar to filters, this processor presents a enriching/modifying mechanism to perform operations for labels manipulation. The most significant difference is that processors perform better than filters, and when chaining them there are no encoding or decoding performance penalties.

Only YAML configuration files support processors.

Configuration parameters

Key
Description

update

Updates an existing key with a value into metrics. The key/value pair is required. If the specified key doesn't exist, the operation silently fails and has no effect.

insert

Inserts a new key with a value into metrics. The key/value pair is required.

upsert

Upserts a specific key with a value, the upsert operation will try to update the value of the key. If the specified key doesn't exist, a new key will be created. The key/value pair is required.

delete

Deletes a key from the labels of metrics. The key/value pair is required. If the specified key doesn't exist, the operation silently fails and has no effect.

hash

Replaces the key value with a hash generated by the SHA-256 algorithm from the specified label name. The generated binary value is set as a hex string.

Update example

The following example changes the value of the name key to fluentbit:

pipeline:
    inputs:
        - name: fluentbit_metrics

          processors:
              metrics:
                  - name: labels
                    update: name fluentbit
    outputs:
        - name : stdout
          match: '*'

Insert example

The following example appends the key agent with the value fluentbit as the label of metrics:

pipeline:
    inputs:
        - name: fluentbit_metrics

          processors:
              metrics:
                  - name: labels
                    insert: agent fluentbit

    outputs:
        - name : stdout
          match: '*'

Upsert example

The following example upserts the value of name and inserts fluentbit:

pipeline:
    inputs:
        - name: fluentbit_metrics

          processors:
              metrics:
                  - name: labels
                    upsert: name fluentbit
    outputs:
        - name : stdout
          match: '*'

Delete example

The following example deletes the name key from metrics:

pipeline:
    inputs:
        - name: fluentbit_metrics

          processors:
              metrics:
                  - name: labels
                    delete: name
    outputs:
        - name : stdout
          match: '*'

Hash example

The following example applies the SHA-1 algorithm for the value of the key hostname:

pipeline:
    inputs:
        - name: fluentbit_metrics

          processors:
              metrics:
                  - name: labels
                    hash: hostname
    outputs:
        - name : stdout
          match: '*'

Last updated

Was this helpful?