Metric to log

Convert metric events to log events

status: stable egress: stream state: stateless
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"
      ],
      "host_tag": "hostname"
    }
  }
}
[transforms.my_transform_id]
type = "metric_to_log"
inputs = [ "my-source-or-transform-id" ]
host_tag = "hostname"
---
transforms:
  my_transform_id:
    type: metric_to_log
    inputs:
      - my-source-or-transform-id
    host_tag: hostname
{
  "transforms": {
    "my_transform_id": {
      "type": "metric_to_log",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "host_tag": "hostname",
      "timezone": "local"
    }
  }
}
[transforms.my_transform_id]
type = "metric_to_log"
inputs = [ "my-source-or-transform-id" ]
host_tag = "hostname"
timezone = "local"
---
transforms:
  my_transform_id:
    type: metric_to_log
    inputs:
      - my-source-or-transform-id
    host_tag: hostname
    timezone: local

host_tag

common optional string literal
Tag key that identifies the source host.
Examples
"host"
"hostname"
default: 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-*"
]

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/NewYork"
"EST5EDT"
default: local

Telemetry

Metrics

link

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 required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
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 required
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 required
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 required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
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 required
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 required
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 required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

component_sent_events_total

counter
The total number of events emitted by this component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

events_in_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins. This metric is deprecated and will be removed in a future version. Use component_received_events_total instead.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
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 required
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 required
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.

events_out_total

counter
The total number of events emitted by this component. This metric is deprecated and will be removed in a future version. Use component_sent_events_total instead.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

processed_bytes_total

counter
The number of bytes processed by the component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
container_name optional
The name of the container from which the bytes originate.
file optional
The file from which the bytes originate.
host required
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 bytes originate.
peer_path optional
The pathname from which the bytes originate.
pid required
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the bytes originate.
uri optional
The sanitized URI from which the bytes originate.

processed_events_total

counter
The total number of events processed by this component. This metric is deprecated in place of using component_received_events_total and component_sent_events_total metrics.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

processing_errors_total

counter
The total number of processing errors encountered by this component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
error_type required
The type of the error
host required
The hostname of the system Vector is running on.
pid required
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 required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
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.