Global options reference
Global configuration parameters
acknowledgements
common optional objectacknowledgements.enabled
optional booltrue
, all capable sources will have acknowledgements enabled.false
data_dir
optional string literal/var/lib/vector/
enrichment_tables
optional objectConfiguration 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.
enrichment_tables.file
optional objectenrichment_tables.file.encoding
optional objectenrichment_tables.file.encoding.delimiter
optional string literal,
enrichment_tables.file.encoding.include_headers
optional boolSet 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.
true
enrichment_tables.file.encoding.type
optional string literalcsv
enrichment_tables.file.path
optional string literalenrichment_tables.file.schema
optional objectKey/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:
- One of the built-in-formats listed in the Timestamp Formats table below.
- The time format specifiers from Rust’s
chrono
library.
Types
bool
string
float
integer
date
timestamp
(see the table below for formats)
Timestamp Formats
Format | Description | Example |
---|---|---|
%F %T | YYYY-MM-DD HH:MM:SS | 2020-12-01 02:37:54 |
%v %T | DD-Mmm-YYYY HH:MM:SS | 01-Dec-2020 02:37:54 |
%FT%T | ISO 8601[RFC 3339](https://tools.ietf.org/html/rfc3339) format without time zone | 2020-12-01T02:37:54 |
%a, %d %b %Y %T | RFC 822/2822 without time zone | Tue, 01 Dec 2020 02:37:54 |
%a %d %b %T %Y | date command output without time zone | Tue 01 Dec 02:37:54 2020 |
%a %b %e %T %Y | ctime format | Tue Dec 1 02:37:54 2020 |
%s | UNIX timestamp | 1606790274 |
%FT%TZ | ISO 8601/RFC 3339 UTC | 2020-12-01T09:37:54Z |
%+ | ISO 8601/RFC 3339 UTC with time zone | 2020-12-01T02:37:54-07:00 |
%a %d %b %T %Z %Y | date command output with time zone | Tue 01 Dec 02:37:54 PST 2020 |
%a %d %b %T %z %Y | date command output with numeric time zone | Tue 01 Dec 02:37:54 -0700 2020 |
%a %d %b %T %#z %Y | date 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.
healthchecks
optional objecthealthchecks.enabled
optional booltrue
healthchecks.require_healthy
optional bool--require-healthy
command line flag.false
log_schema
optional objectlog_schema.host_key
optional string literalhost
log_schema.message_key
optional string literalmessage
log_schema.metadata_key
optional string literalremap
transform).metadata
log_schema.source_type_key
optional string literalsource_type
log_schema.timestamp_key
optional string literaltimestamp
proxy
optional objectproxy.http
optional string literalproxy.https
optional string literalproxy.no_proxy
optional [string]A list of hosts to avoid proxying. Allowed patterns here include:
Pattern | Example match |
---|---|
Domain names | example.com matches requests to example.com |
Wildcard domains | .example.com matches requests to example.com and its subdomains |
IP addresses | 127.0.0.1 matches requests to 127.0.0.1 |
CIDR blocks | 192.168.0.0./16 matches requests to any IP addresses in this range |
Splat | * matches all hosts |
timezone
optional string literallocal
to indicate system local time.local