Metric to log

Convert metric events to log events

status: stable egress: stream state: stateless
Page source Edit this page
Converts a metric event into a log event, which can be useful for sending metrics to log-support downstream components.

Configuration

Example configurations 

{
  "transforms": {
    "my_transform_id": {
      "type": "metric_to_log",
      "inputs": [
        "my-source-or-transform-id"
      ]
    }
  }
}
[transforms.my_transform_id]
type = "metric_to_log"
inputs = [ "my-source-or-transform-id" ]

transforms:
  my_transform_id:
    type: metric_to_log
    inputs:
      - my-source-or-transform-id

{
  "transforms": {
    "my_transform_id": {
      "type": "metric_to_log",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "host_tag": "host",
      "metric_tag_values": "single",
      "timezone": "local"
    }
  }
}
[transforms.my_transform_id]
type = "metric_to_log"
inputs = [ "my-source-or-transform-id" ]
host_tag = "host"
metric_tag_values = "single"
timezone = "local"

transforms:
  my_transform_id:
    type: metric_to_log
    inputs:
      - my-source-or-transform-id
    host_tag: host
    metric_tag_values: single
    timezone: local

graph

optional object

Extra graph configuration

Configure output for component when generated with graph command

graph.node_attributes

optional object

Node attributes to add to this component’s node in resulting graph

They are added to the node as provided

graph.node_attributes.*
required string literal
A single graph node attribute in graphviz DOT language.
Examples 
{
  "color": "red",
  "name": "Example Node",
  "width": "5.0"
}

host_tag

optional string literal

Name of the tag in the metric to use for the source host.

If present, the value of the tag is set on the generated log event in the host field, where the field key uses the global host_key option.

Examples 
"host"
"hostname"

inputs

required [string]

A list of upstream source or transform IDs.

Wildcards (*) are supported.

See configuration for more info.

Array string literal
Examples 
[
  "my-source-or-transform-id",
  "prefix-*"
]

metric_tag_values

optional string literal enum

Controls how metric tag values are encoded.

When set to single, only the last non-bare value of tags are displayed with the metric. When set to full, all metric tags are exposed as separate assignments as described by the native_json codec.

Enum options string literal
OptionDescription
fullAll tags are exposed as arrays of either string or null values.
singleTag values are exposed as single strings, the same as they were before this config option. Tags with multiple values show the last assigned value, and null values are ignored.
default: single

timezone

optional string literal

The name of the time zone to apply to timestamp conversions that do not contain an explicit time zone.

This overrides the global timezone option. The time zone name may be any name in the TZ database or local to indicate system local time.

Examples 
"local"
"America/New_York"
"EST5EDT"

Outputs

<component_id>

Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks.

Telemetry

Metrics

link

component_discarded_events_total

counter
The number of events dropped by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
intentional
True if the events were discarded intentionally, like a filter transform, or false if due to an error.
pid optional
The process ID of the Vector instance.

component_errors_total

counter
The total number of errors encountered by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
error_type
The type of the error
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.
stage
The stage within the component at which the error occurred.

component_received_event_bytes_total

counter
The number of event bytes accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_events_count

histogram

A histogram of the number of events passed in each internal batch in Vector’s internal topology.

Note that this is separate than sink-level batching. It is mostly useful for low level debugging performance issues in Vector due to small internal batches.

component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_events_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_sent_event_bytes_total

counter
The total number of event bytes emitted by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
output optional
The specific output of the component.
pid optional
The process ID of the Vector instance.

component_sent_events_total

counter
The total number of events emitted by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
output optional
The specific output of the component.
pid optional
The process ID of the Vector instance.

utilization

gauge
A ratio from 0 to 1 of the load on a component. A value of 0 would indicate a completely idle component that is simply waiting for input. A value of 1 would indicate a that is never idle. This value is updated every 5 seconds.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.

Examples

Metric To Log

Given this event...
{
  "metric": {
    "histogram": {
      "buckets": [
        {
          "count": 10,
          "upper_limit": 1
        },
        {
          "count": 20,
          "upper_limit": 2
        }
      ],
      "count": 30,
      "sum": 50
    },
    "kind": "absolute",
    "name": "histogram",
    "tags": {
      "code": "200",
      "host": "my.host.com"
    },
    "timestamp": "2020-08-01T21:15:47+00:00"
  }
}
...and this configuration...
transforms:
  my_transform_id:
    type: metric_to_log
    inputs:
      - my-source-or-transform-id
    host_tag: host

[transforms.my_transform_id]
type = "metric_to_log"
inputs = [ "my-source-or-transform-id" ]
host_tag = "host"

{
  "transforms": {
    "my_transform_id": {
      "type": "metric_to_log",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "host_tag": "host"
    }
  }
}
...this Vector event is produced:
{
  "histogram": {
    "buckets": [
      {
        "count": 10,
        "upper_limit": 1
      },
      {
        "count": 20,
        "upper_limit": 2
      }
    ],
    "count": 30,
    "sum": 50
  },
  "host": "my.host.com",
  "kind": "absolute",
  "name": "histogram",
  "tags": {
    "code": "200"
  },
  "timestamp": "2020-08-01T21:15:47+00:00"
}

How it works

State

This component is stateless, meaning its behavior is consistent across each input.
Sidebar