Delay transform

Delay events by a set duration

Delays events by a set duration.

Warnings

Delay transform operates at millisecond granularity and when multiple events are received in the same millisecond and the component doesn’t preserve original ordering if items are emitted in the same millisecond.

Configuration

Example configurations

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

[transforms.my_transform_id]
type = "delay"
inputs = [ "my-source-or-transform-id" ]

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

{
  "transforms": {
    "my_transform_id": {
      "type": "delay",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "overflow_strategy": "block",
      "queue_capacity": 500
    }
  }
}

[transforms.my_transform_id]
type = "delay"
inputs = [ "my-source-or-transform-id" ]
overflow_strategy = "block"
queue_capacity = 500

transforms:
  my_transform_id:
    type: delay
    inputs:
      - my-source-or-transform-id
    overflow_strategy: block
    queue_capacity: 500

condition

optional condition

Delay events in provided delay periods until the condition is met.

condition.source

The text of the condition. The syntax of the condition depends on the value of type.

condition.type

The type of condition to supply. See Available syntaxes below for a list of available types for this transform.

Available syntaxes

Syntax	Description	Example
`vrl`	A Vector Remap Language (VRL) Boolean expression.	`.status_code != 200 && !includes(["info", "debug"], .severity)`
`datadog_search`	A Datadog Search query string.	`*stack`
`is_log`	Whether the incoming event is a log.
`is_metric`	Whether the incoming event is a metric.
`is_trace`	Whether the incoming event is a trace.

Shorthand for VRL

If you opt for the vrl syntax for this condition, you can set the condition as a string via the condition parameter, without needing to specify both a source and a type. The table below shows some examples:

Config format	Example
YAML	`condition: .status == 200`
TOML	`condition = ".status == 200"`
JSON	`"condition": ".status == 200"`

Condition config examples

Standard VRL

condition:
  type: "vrl"
  source: ".status == 500"

condition = { type = "vrl", source = ".status == 500" }

"condition": {
  "type": "vrl",
  "source": ".status == 500"
}

Datadog Search

condition:
  type: "datadog_search"
  source: "*stack"

condition = { type = "datadog_search", source = "*stack" }

"condition": {
  "type": "datadog_search",
  "source": "*stack"
}

VRL shorthand

condition: ".status == 500"

condition = ".status == 500"

"condition": ".status == 500"

delay_ms

required uint

Time to delay each event, in milliseconds.

graph

optional object

Extra graph configuration

Configure output for component when generated with graph command

graph.edge_attributes

optional object

Edge attributes to add to the edges linked to this component’s node in resulting graph

They are added to the edge as provided

graph.edge_attributes.*

required object

A collection of graph edge attributes in graphviz DOT language, related to a single input component.

graph.edge_attributes..

required string literal

A single graph edge attribute in graphviz DOT language.

Examples

{
  "color": "red",
  "label": "Example Edge",
  "width": "5.0"
}

Examples

{
  "example_input": {
    "color": "red",
    "label": "Example Edge",
    "width": "5.0"
  }
}

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

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

measure_cpu_usage

optional bool

Enable CPU usage metrics for this transform.

When set to true, each poll of the transform task is timed using the OS thread CPU clock and the accumulated nanoseconds are reported as the component_cpu_usage_ns_total counter, tagged with component_id, component_kind, and component_type.

Defaults to false. Enable only for transforms where CPU attribution is needed, as it adds a clock_gettime call on every future poll.

default: false

overflow_strategy

optional string literal enum

Strategy to handle full queue capacity.

Enum options string literal

Option Description

Option	Description
`block`	Wait for free space in the queue. This applies backpressure up the topology, signalling that sources should slow down the acceptance/consumption of events. This may cause the system to degenerate if this component blocks for too long.
`drop_newest`	Drops the event instead of waiting for free space in the queue. The event will be intentionally dropped. This mode is typically used when performance is the highest priority, and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance/consumption of events.
`forward`	Forward the event without any delay to next component.

block

Wait for free space in the queue.

This applies backpressure up the topology, signalling that sources should slow down the acceptance/consumption of events. This may cause the system to degenerate if this component blocks for too long.

drop_newest

Drops the event instead of waiting for free space in the queue.

The event will be intentionally dropped. This mode is typically used when performance is the highest priority, and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance/consumption of events.

forward Forward the event without any delay to next component.

default: block

queue_capacity

optional uint

Limit for number of items in the delay queue.

default: 500

Input Types

The following table lists all telemetry data types supported by the component across possible configurations. Be aware that the available data types may differ based on the specified codec configuration.

Logs

Log events are supported.

Metrics

The following metrics are supported:

counter distribution gauge histogram set summary

Traces

Trace events are supported.

Outputs

<component_id>

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

Output Types

Metrics

The input metric event.

Traces

The input trace event.

Logs

Warning

The fields shown below will be different if log namespacing is enabled. See Log Namespacing for more details

The input log event.

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_latency_mean_seconds

gauge

The mean elapsed time, in fractional seconds, that an event spends in a single transform.

This includes both the time spent queued in the transform’s input buffer and the time spent executing the transform itself.

This value is smoothed over time using an exponentially weighted moving average (EWMA).

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

component_latency_seconds

histogram

The elapsed time, in fractional seconds, that an event spends in a single transform.

This includes both the time spent queued in the transform’s input buffer and the time spent executing the transform itself.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

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.

transform_buffer_max_byte_size

gauge

The maximum number of bytes the buffer that feeds into a transform can hold.

Deprecated

This metric has been deprecated in favor of transform_buffer_max_size_bytes.

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.

transform_buffer_max_event_size

gauge

The maximum number of events the buffer that feeds into a transform can hold.

State

This component is stateful, meaning its behavior changes based on previous inputs (events). State is not preserved across restarts, therefore state-dependent behavior will reset between restarts and depend on the inputs (events) received since the most recent restart.