Edge Delta OpenMetrics Destination

Overview

The OpenMetrics node sends items to an OpenMetrics destination. It sends generated metrics with tags that are user defined or custom.

• incoming_data_types: metric, heartbeat

Example Configuration

nodes:
  - name: my_openmetrics
    type: openmetrics_output
    features: metric
    endpoint: <REDACTED>

Required Parameters

name

A descriptive name for the node. This is the name that will appear in pipeline builder and you can reference this node in the YAML using the name. It must be unique across all nodes. It is a YAML list element so it begins with a - and a space followed by the string. It is a required parameter for all nodes.

nodes:
  - name: <node name>
    type: <node type>

type: openmetrics_output

The type parameter specifies the type of node being configured. It is specified as a string from a closed list of node types. It is a required parameter.

nodes:
  - name: <node name>
    type: <node type>

endpoint

The endpoint parameter is an OpenMetrics format compatible push-based collector endpoint. It is specified as a string and is required.

nodes:
  - name: <node name>
    type: openmetrics_output
    features: <feature 1>, <feature n>
    endpoint: <endpoint>

Optional Parameters

custom_tags

The custom_tags parameter is a map of key - template pairs that will be calculated per item and sent to the destination as attributes/fields/tags. It is only honored when use_legacy_formatting is set to true.

nodes:
  - name: <node name>
    type: openmetrics_output
    features: <feature 1>, <feature n>
    endpoint: <endpoint>
    use_legacy_formatting: true
    custom_tags:
        "<key>": "<template>"

buffer_max_bytesize

The buffer_max_bytesize parameter configures the maximum byte size for total unsuccessful items. If the limit is reached, the remaining items are discarded until the buffer space becomes available. It is specified as a datasize.Size, has a default of 0 indicating no size limit, and it is optional.

nodes:
  - name: <node name>
    type: openmetrics_output
    endpoint: <endpoint>
    buffer_max_bytesize: 2048

buffer_path

The buffer_path parameter configures the path to store unsuccessful items. Unsuccessful items are stored there to be retried back (exactly once delivery). It is specified as a string and it is optional.

nodes:
  - name: <node name>
    type: openmetrics_output
    endpoint: <endpoint>
    buffer_path: <path to unsuccessful items folder>

buffer_ttl

The buffer_ttl parameter configures the time-to-Live for unsuccessful items, which indicates when to discard them. It is specified as a duration, has a default of 10m, and it is optional.

nodes:
  - name: <node name>
    type: openmetrics_output
    endpoint: <endpoint>
    buffer_ttl: 20m

use_legacy_formatting

The use_legacy_formatting parameter tries to match the Edge Delta legacy output. If unspecified or set to false, the node will send generated metrics with user defined tags with source attributes. If set to true, the node will send generated metrics with user defined tags and tags generated from custom_tags. It is a Boolean and the default is false. It is optional.

nodes:
  - name: <node name>
    type: openmetrics_output
    features: <feature 1>, <feature n>
    endpoint: <endpoint>
    use_legacy_formatting: true
    custom_tags:
        "<key>": "<template>"