Global options reference

Page source Edit this page

Global configuration parameters

data_dir

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.
Examples 
"/var/lib/vector"
"/var/local/lib/vector/"
"/home/user/vector/"
default: /var/lib/vector/

healthchecks

optional object
Configures health checks for all sinks.

healthchecks.enabled

optional bool
Disables all health checks if false, otherwise sink specific option overrides it.
default: true

healthchecks.require_healthy

optional bool
Exit on startup if any sinks' health check fails. Overridden by --require-healthy command line flag.
default: false

log_schema

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

log_schema.host_key

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

log_schema.message_key

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

log_schema.source_type_key

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

log_schema.timestamp_key

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

proxy

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

proxy.enabled

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

proxy.http

optional string literal
The URL to proxy HTTP requests through.
Examples 
"http://foo.bar:3128"

proxy.https

optional string literal
The URL to proxy HTTPS requests through.
Examples 
"http://foo.bar:3128"

proxy.no_proxy

optional [string]

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

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

timezone

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.
Examples 
"local"
"America/NewYork"
"EST5EDT"
default: local
Sidebar