Global options reference

Global configuration parameters


common optional object
Controls how acknowledgements are handled by all sources. These settings may be overridden in individual sources.
Controls if sources will wait for destination sinks to deliver the events, or persist them to a disk buffer, before acknowledging receipt. If set to true, all capable sources will have acknowledgements enabled.
default: false


optional string literal
The directory used for persisting Vector state, such as on-disk buffers, file checkpoints, and more. Please make sure the Vector project has write permissions to this directory.
default: /var/lib/vector/


optional object

Configuration options for an enrichment table to be used in a remap transform. Currently, only CSV files are supported.

For the lookup in the enrichment tables to be as performant as possible, the data is indexed according to the fields that are used in the search. Note that indices can only be created for fields for which an exact match is used in the condition. For range searches, an index isn’t used and the enrichment table drops back to a sequential scan of the data. A sequential scan shouldn’t impact performance significantly provided that there are only a few possible rows returned by the exact matches in the condition. We don’t recommend using a condition that uses only date range searches.


optional object
Configuration options for the file that provides the enrichment table.
Configuration options for the encoding of the enrichment table’s file.
The delimiter used to separate fields in each row of the CSV file.
default: ,

Set include_headers to true if the first row of the CSV file contains the headers for each column. This is the default behavior.

If you set it to false, there are no headers and the columns are referred to by their numerical index.

default: true
The encoding of the file. Currently, only CSV is supported.
default: csv
optional string literal
The path of the enrichment table file. Currently, only CSV files are supported.

Key/value pairs representing mapped log field names and types. This is used to coerce log fields from strings into their proper types. The available types are listed in the Types list below.

Timestamp coercions need to be prefaced with timestamp|, for example "timestamp|%F". Timestamp specifiers can use either of the following:

  1. One of the built-in-formats listed in the Timestamp Formats table below.
  2. The time format specifiers from Rust’s chrono library.


  • bool
  • string
  • float
  • integer
  • date
  • timestamp (see the table below for formats)

Timestamp Formats

%F %TYYYY-MM-DD HH:MM:SS2020-12-01 02:37:54
%v %TDD-Mmm-YYYY HH:MM:SS01-Dec-2020 02:37:54
%FT%TISO 8601[RFC 3339]( format without time zone2020-12-01T02:37:54
%a, %d %b %Y %TRFC 822/2822 without time zoneTue, 01 Dec 2020 02:37:54
%a %d %b %T %Ydate command output without time zoneTue 01 Dec 02:37:54 2020
%a %b %e %T %Yctime formatTue Dec 1 02:37:54 2020
%sUNIX timestamp1606790274
%FT%TZISO 8601/RFC 3339 UTC2020-12-01T09:37:54Z
%+ISO 8601/RFC 3339 UTC with time zone2020-12-01T02:37:54-07:00
%a %d %b %T %Z %Ydate command output with time zoneTue 01 Dec 02:37:54 PST 2020
%a %d %b %T %z %Ydate command output with numeric time zoneTue 01 Dec 02:37:54 -0700 2020
%a %d %b %T %#z %Ydate command output with numeric time zone (minutes can be missing or present)Tue 01 Dec 02:37:54 -07 2020

Note: the examples in this table are for 54 seconds after 2:37 am on December 1st, 2020 in Pacific Standard Time.

  "duration": "float",
  "status": "int",
  "success": "bool",
  "timestamp_custom": "timestamp|%a %b %e %T %Y",
  "timestamp_iso8601": "timestamp|%F",
  "timestamp_unix": "timestamp|%F %T"


optional object
Configures health checks for all sinks.
Disables all health checks if false, otherwise sink specific option overrides it.
default: true
Exit on startup if any sinks' health check fails. Overridden by --require-healthy command line flag.
default: false


optional object
Configures default log schema for all events. This is used by Vector source components to assign the fields on incoming events.


optional string literal
Sets the event key to use for the event host field.
default: host


optional string literal
Sets the event key to use for the event message field.
default: message


optional string literal
Sets the event key to use for event metadata field (e.g. error or abort annotations in the remap transform).
default: metadata


optional string literal
Sets the event key to use for the event source type field that is set by some sources.
default: source_type


optional string literal
Sets the event key to use for the event timestamp field.
default: timestamp


optional object
Configures an HTTP(S) proxy for Vector to use.


optional bool
If false the proxy will be disabled.
default: true


optional string literal
The URL to proxy HTTP requests through.


optional string literal
The URL to proxy HTTPS requests through.


optional [string]

A list of hosts to avoid proxying. Allowed patterns here include:

PatternExample match
Domain matches requests to
Wildcard matches requests to and its subdomains
IP addresses127.0.0.1 matches requests to
CIDR blocks192.168.0.0./16 matches requests to any IP addresses in this range
Splat* matches all hosts


optional string literal
The name of the time zone to apply to timestamp conversions that do not contain an explicit time zone. The time zone name may be any name in the TZ database, or local to indicate system local time.
default: local