LOG

UDP Source

The Vector udp source ingests data through the UDP protocol and outputs log events.

Configuration

  • Common
  • Advanced
vector.toml
[sources.my_source_id]
  type = "udp" # example, must be: "udp"
  address = "0.0.0.0:9000" # example

Options

3 items
commonstringrequired

address

The address to bind the socket to.

No default
View examples
stringoptional

host_key

The key name added to each event representing the current host. See Context for more info.

Default: "host"
View examples
intbytesoptional

max_length

The maximum bytes size of incoming messages before they are discarded.

Default: 102400
View examples

Output

The udp source ingests data through the UDP protocol and outputs log events. For example:

Given the following input:

2019-02-13T19:48:34+00:00 [info] Started GET "/" for 127.0.0.1

A log event will be output with the following structure:

{
  "timestamp": <current_timestamp>,
  "message": "2019-02-13T19:48:34+00:00 [info] Started GET "/" for 127.0.0.1",
  "host": "<upstream_hostname>"
}

More detail on the output schema is below.

3 items
stringrequired

host

The upstream hostname.

No default
View examples
stringrequired

message

The raw message, unaltered.

No default
View examples
timestamprequired

timestamp

The exact time the event was ingested.

No default
View examples

How It Works

Context

By default, the udp source will add context keys to your events via the host_key options.

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.

Line Delimiters

Each line is read until a new line delimiter (the 0xA byte) is found.

Support
Contents
Resources