Sample

Sample events from an event stream based on supplied criteria and at a configurable rate

status: beta egress: stream state: stateless

Configuration

Example configurations

{
  "transforms": {
    "my_transform_id": {
      "type": "sample",
      "inputs": "my-source-or-transform-id",
      "exclude": ".status_code != 200 && !includes([\"info\", \"debug\"], .severity)",
      "rate": 10
    }
  }
}
[transforms.my_transform_id]
type = "sample"
inputs = "my-source-or-transform-id"
exclude = '.status_code != 200 && !includes(["info", "debug"], .severity)'
rate = 10
---
transforms:
  my_transform_id:
    type: sample
    inputs: my-source-or-transform-id
    exclude: .status_code != 200 && !includes(["info", "debug"], .severity)
    rate: 10
{
  "transforms": {
    "my_transform_id": {
      "type": "sample",
      "inputs": "my-source-or-transform-id",
      "key_field": "message",
      "exclude": ".status_code != 200 && !includes([\"info\", \"debug\"], .severity)",
      "rate": 10
    }
  }
}
[transforms.my_transform_id]
type = "sample"
inputs = "my-source-or-transform-id"
key_field = "message"
exclude = '.status_code != 200 && !includes(["info", "debug"], .severity)'
rate = 10
---
transforms:
  my_transform_id:
    type: sample
    inputs: my-source-or-transform-id
    key_field: message
    exclude: .status_code != 200 && !includes(["info", "debug"], .severity)
    rate: 10

exclude

common optional string
The set of logical conditions to exclude events from sampling.

inputs

required [string]

A list of upstream source or transform IDs. Wildcards (*) are supported but must be the last character in the ID.

See configuration for more info.

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

key_field

optional string

The name of the log field whose value will be hashed to determine if the event should be passed.

Consistently samples the same events. Actual rate of sampling may differ from the configured one if values in the field are not uniformly distributed. If left unspecified, or if the event doesn’t have key_field, events will be count rated.

rate

required uint
The rate at which events will be forwarded, expressed as 1/N. For example, rate = 10 means 1 out of every 10 events will be forwarded and the rest will be dropped.

Telemetry

Metrics

link

events_discarded_total

counter
The total number of events discarded by this component.
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 origin like file and uri, or cumulatively from other origins.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the event originates.
file optional
The file from which the event originates.
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 event originates.
peer_path optional
The pathname from which the event originates.
pid required
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the event originates.
uri optional
The sanitized URI from which the event originates.

events_out_total

counter
The total number of events emitted by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
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_kind required
The Vector component kind.
component_name required
The Vector component name.
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 events_in_total and events_out_total metrics.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
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.

How it works

State

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