Edge Delta OpenMetrics Output

Overview

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

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 Visual Pipelines 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 paramater 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>"

features

The features parameter defines which data types to stream to the destination. It is specified as a string of comma-separated list of item types. The default is metric. It is optional.

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

use_legacy_formatting

The use_legacy_formatting parameter tries to match agent v2 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>"