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

This node requires Edge Delta agent version v0.1.59 or higher.

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

disabled

The disabled parameter disables the node in the pipeline. When set to true, the agent ignores the node at startup. You can toggle nodes on or off in the pipeline builder. It is specified as a boolean, defaults to false, and is optional.

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

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>"

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>"

memory_buffer

This parameter requires Edge Delta agent version v2.12.0 or higher.

The memory_buffer parameter configures the in-memory buffer queue for the destination. The size sub-parameter sets the maximum number of events to hold in the memory buffer queue before blocking. It is specified as an integer, has a default of 1000, and it is optional.

nodes:
  - name: <destination-name>
    type: <destination-type>
    memory_buffer:
      size: 2000