stdin source

Ingests data through standard input (STDIN) and outputs `log` events.

The stdin source ingests data through standard input (STDIN) and outputs log events.

Config File

vector.toml (example)
vector.toml (schema)
vector.toml (specification)
[sources.my_source_id]
# REQUIRED - General
type = "stdin" # must be: "stdin"
# OPTIONAL - General
max_length = 102400 # default, bytes
# OPTIONAL - Context
host_key = "host" # default

Options

Key

Type

Description

REQUIRED - General

type

string

The component type required must be: "stdin"

OPTIONAL - General

max_length

int

The maxiumum bytes size of a message before it is discarded. default: 102400 unit: bytes

OPTIONAL - Context

host_key

string

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

Examples

Given the following input line:

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

A log event will be emitted with the following structure:

log
{
"timestamp": <timestamp> # current time,
"message": "2019-02-13T19:48:34+00:00 [info] Started GET "/" for 127.0.0.1",
"host": "10.2.22.122" # current hostname
}

How It Works

Context

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

Delivery Guarantee

This component offers an at least once delivery guarantee if your pipeline is configured to achieve this.

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.

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.

Resources