HTTP Sink

The Vector http sink batches log events to a generic HTTP endpoint.

Configuration

  • Common
  • Advanced
vector.toml
[sinks.my_sink_id]
# REQUIRED - General
type = "http" # must be: "http"
inputs = ["my-source-id"] # example
uri = "https://10.22.212.22:9000/endpoint" # example
# REQUIRED - requests
encoding = "json" # example, enum
# OPTIONAL - General
healthcheck = true # default
# OPTIONAL - requests
compression = "none" # default, enum
# OPTIONAL - Batch
[sinks.my_sink_id.batch]
max_size = 1049000 # default, bytes
timeout_secs = 1 # default, seconds
# OPTIONAL - Request
[sinks.my_sink_id.request]
in_flight_limit = 10 # default, requests
rate_limit_duration_secs = 1 # default, seconds
rate_limit_num = 1000 # default
retry_attempts = -1 # default
retry_initial_backoff_secs = 1 # default, seconds
retry_max_duration_secs = 10 # default, seconds
timeout_secs = 30 # default, seconds

Options

11 items
tableoptional

auth

Options for the authentication strategy.

stringenumcommonrequired

strategy

The authentication strategy to use.

No default
Enum, must be one of: "basic"
View examples
stringcommonrequired

password

The basic authentication password.

No default
Only relevant when: strategy = "basic"
View examples
stringcommonrequired

user

The basic authentication user name.

No default
Only relevant when: strategy = "basic"
View examples
tablecommonoptional

batch

Configures the sink batching behavior.

int (bytes)commonrequired

max_size

The maximum size of a batch, in bytes, before it is flushed. See Buffers & Batches for more info.

Default: 1049000 (bytes)
View examples
int (seconds)commonrequired

timeout_secs

The maximum age of a batch before it is flushed. See Buffers & Batches for more info.

Default: 1 (seconds)
View examples
tableoptional

buffer

Configures the sink specific buffer behavior.

int (events)commonrequired

max_events

The maximum number of events allowed in the buffer.

Default: 500 (events)
Only relevant when: type = "memory"
View examples
int (bytes)commonrequired

max_size

The maximum size of the buffer on the disk. See Buffers & Batches for more info.

No default
Only relevant when: type = "disk"
View examples
stringenumcommonrequired

type

The buffer's type and storage mechanism.

Default: "memory"
Enum, must be one of: "memory" "disk"
View examples
stringenumoptional

when_full

The behavior when the buffer becomes full.

Default: "block"
Enum, must be one of: "block" "drop_newest"
View examples
stringenumcommonoptional

compression

The compression strategy used to compress the encoded event data before outputting.

Default: "none"
Enum, must be one of: "none" "gzip"
View examples
stringenumcommonrequired

encoding

The encoding format used to serialize the events before outputting.

No default
Enum, must be one of: "json" "ndjson" "text"
View examples
tableoptional

headers

Options for custom headers. See Authentication for more info.

stringcommonrequired

[header-key]

A custom header to be added to each outgoing HTTP request.

No default
View examples
boolcommonoptional

healthcheck

Enables/disables the sink healthcheck upon start. See Health Checks for more info.

Default: true
View examples
stringoptional

healthcheck_uri

A URI that Vector can request in order to determine the service health. See Health Checks for more info.

No default
View examples
tablecommonoptional

request

Configures the sink request behavior.

int (requests)commonoptional

in_flight_limit

The maximum number of in-flight requests allowed at any given time. See Rate Limits for more info.

Default: 10 (requests)
View examples
int (seconds)commonoptional

rate_limit_duration_secs

The time window, in seconds, used for the rate_limit_num option. See Rate Limits for more info.

Default: 1 (seconds)
View examples
intcommonoptional

rate_limit_num

The maximum number of requests allowed within the rate_limit_duration_secs time window. See Rate Limits for more info.

Default: 1000
View examples
intcommonoptional

retry_attempts

The maximum number of retries to make for failed requests. See Retry Policy for more info.

Default: -1
View examples
int (seconds)commonoptional

retry_initial_backoff_secs

The amount of time to wait before attempting the first retry for a failed request. Once, the first retry has failed the fibonacci sequence will be used to select future backoffs.

Default: 1 (seconds)
View examples
int (seconds)commonoptional

retry_max_duration_secs

The maximum amount of time, in seconds, to wait between retries.

Default: 10 (seconds)
View examples
int (seconds)commonoptional

timeout_secs

The maximum time a request can take before being aborted. It is highly recommended that you do not lower value below the service's internal timeout, as this could create orphaned requests, pile on retries, and result in duplicate data downstream. See Buffers & Batches for more info.

Default: 30 (seconds)
View examples
tableoptional

tls

Configures the TLS options for connections from this sink.

stringoptional

ca_path

Absolute path to an additional CA certificate file, in DER or PEM format (X.509).

No default
View examples
stringoptional

crt_path

Absolute path to a certificate file used to identify this connection, in DER or PEM format (X.509) or PKCS#12. If this is set and is not a PKCS#12 archive, key_path must also be set.

No default
View examples
stringoptional

key_pass

Pass phrase used to unlock the encrypted key file. This has no effect unless key_pass is set.

No default
View examples
stringoptional

key_path

Absolute path to a certificate key file used to identify this connection, in DER or PEM format (PKCS#8). If this is set, crt_path must also be set.

No default
View examples
booloptional

verify_certificate

If true (the default), Vector will validate the TLS certificate of the remote host. Do NOT set this to false unless you understand the risks of not verifying the remote certificate.

Default: true
View examples
booloptional

verify_hostname

If true (the default), Vector will validate the configured remote host name against the remote host's TLS certificate. Do NOT set this to false unless you understand the risks of not verifying the remote hostname.

Default: true
View examples
stringcommonrequired

uri

The full URI to make HTTP requests to. This should include the protocol and host, but can also include the port, path, and any other valid part of a URI.

No default
View examples

Output

The http sink batches log events to a generic HTTP endpoint. Batches are flushed via the batch_size or batch_timeout options. You can learn more in the buffers & batches section. For example:

  • JSON
  • NDJSON
  • Text
POST <uri> HTTP/1.1
Host: <uri.host>
Content-Type: application/x-ndjson
Content-Length: <byte_size>
[
<json_encoded_log>,
<json_encoded_log>,
<json_encoded_log>,
]

How It Works

Authentication

HTTP authentication is controlled via the Authorization header which you can set with the headers option. For convenience, Vector also supports the basic_auth.username and basic_auth.password options which handle setting the Authorization header for the base access authentication scheme.

Buffers & Batches

The http sink buffers & batches data as shown in the diagram above. You'll notice that Vector treats these concepts differently, instead of treating them as global concepts, Vector treats them as sink specific concepts. This isolates sinks, ensuring services disruptions are contained and delivery guarantees are honored.

Batches are flushed when 1 of 2 conditions are met:

  1. The batch age meets or exceeds the configured timeout_secs.
  2. The batch size meets or exceeds the configured max_size.

Buffers are controlled via the buffer.* 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.

Health Checks

Health checks ensure that the downstream service is accessible and ready to accept data. This check is performed upon sink initialization. In order to run this check you must provide a value for the healthcheck_uri option. If the health check fails an error will be logged and Vector will proceed to start.

Require Health Checks

If you'd like to exit immediately upon a health check failure, you can pass the --require-healthy flag:

vector --config /etc/vector/vector.toml --require-healthy

Disable Health Checks

If you'd like to disable health checks for this sink you can set the healthcheck option to false.

Rate Limits

Vector offers a few levers to control the rate and volume of requests to the downstream service. Start with the rate_limit_duration_secs and rate_limit_num options to ensure Vector does not exceed the specified number of requests in the specified window. You can further control the pace at which this window is saturated with the in_flight_limit option, which will guarantee no more than the specified number of requests are in-flight at any given time.

Please note, Vector's defaults are carefully chosen and it should be rare that you need to adjust these. If you found a good reason to do so please share it with the Vector team by opening an issie.

Retry Policy

Vector will retry failed requests (status == 429, >= 500, and != 501). Other responses will not be retried. You can control the number of retry attempts and backoff rate with the retry_attempts and retry_backoff_secs options.