statsd sink

The statsd sink streams metric events to StatsD metrics service.

Configuration

• Common
• Advanced

vector.toml

[sinks.my_sink_id]
  # REQUIRED
  type = "statsd" # example, must be: "statsd"
  inputs = ["my-source-id"] # example
  namespace = "service" # example
  
  # OPTIONAL
  address = "127.0.0.1:8125" # default

Options

3 items

common onlyrequired only

commonstringoptional

address

The UDP socket address to send stats to.

Default: "127.0.0.1:8125"

View examples

booloptional

healthcheck

Enables/disables the sink healthcheck upon start.

Default: true

View examples

commonstringrequired

namespace

A prefix that will be added to all metric names.

No default

View examples

Output

The statsd sink streams metric events to StatsD metrics service. For example:

gorets:1|c
glork:320|ms
gaugor:333|g
uniques:765|s

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.

Streaming

The statsd sink streams data on a real-time event-by-event basis. It does not batch data.