sampler transform

Accepts `log` events and allows you to sample events with a configurable rate.

The sampler transform is in beta. Please see the current enhancements and bugs for known issues. We kindly ask that you add any missing issues as it will help shape the roadmap of this component.

The sampler transform accepts log events and allows you to sample events with a configurable rate.

Config File

vector.toml (example)
vector.toml (schema)
vector.toml (specification)
[transforms.my_transform_id]
type = "sampler" # must be: "sampler"
inputs = ["my-source-id"]
rate = 10
pass_list = ["[error]", "field2"] # no default

Options

Key

Type

Description

REQUIRED

type

string

The component type required must be: "sampler"

inputs

[string]

A list of upstream source or transform IDs. See Config Composition for more info. required example: ["my-source-id"]

rate

int

The maximum number of events allowed per second. required example: 10

OPTIONAL

pass_list

[string]

A list of regular expression patterns to exclude events from sampling. If an event's "message" key matches any of these patterns it will not be sampled. no default example: ["[error]", "field2"]

How It Works

Environment Variables

Environment variables are supported through all of Vector's configuration. Simply add ${MY_ENV_VAR} in your Vector configuration file and the variable will be replaced before being evaluated.

You can learn more in the Environment Variables section.

Troubleshooting

The best place to start with troubleshooting is to check the Vector logs. This is typically located at /var/log/vector.log, then proceed to follow the Troubleshooting Guide.

If the Troubleshooting Guide does not resolve your issue, please:

  1. If encountered a bug, please file a bug report.

  2. If encountered a missing feature, please file a feature request.

  3. If you need help, join our chat/forum community. You can post a question and search previous questions.

Alternatives

Finally, consider the following alternatives:

Resources