Loki sink

Configuration

Example configurations

{
  "sinks": {
    "my_sink_id": {
      "type": "loki",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "endpoint": "http://localhost:3100",
      "labels": {
        "forwarder": "vector",
        "event": "{{ event_field }}",
        "key": "value",
        "\"{{ event_field }}\"": "{{ another_event_field }}",
        "pod_labels_*": "{{ kubernetes.pod_labels }}"
      },
      "acknowledgements": null,
      "compression": "none",
      "encoding": {
        "codec": "json"
      },
      "healthcheck": null
    }
  }
}

[sinks.my_sink_id]
type = "loki"
inputs = [ "my-source-or-transform-id" ]
endpoint = "http://localhost:3100"
compression = "none"

  [sinks.my_sink_id.labels]
  forwarder = "vector"
  event = "{{ event_field }}"
  key = "value"
  "\"{{ event_field }}\"" = "{{ another_event_field }}"
  "pod_labels_*" = "{{ kubernetes.pod_labels }}"

  [sinks.my_sink_id.encoding]
  codec = "json"

---
sinks:
  my_sink_id:
    type: loki
    inputs:
      - my-source-or-transform-id
    endpoint: http://localhost:3100
    labels:
      forwarder: vector
      event: "{{ event_field }}"
      key: value
      "\"{{ event_field }}\"": "{{ another_event_field }}"
      pod_labels_*: "{{ kubernetes.pod_labels }}"
    acknowledgements: null
    compression: none
    encoding:
      codec: json
    healthcheck: null

{
  "sinks": {
    "my_sink_id": {
      "type": "loki",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "endpoint": "http://localhost:3100",
      "auth": null,
      "labels": {
        "forwarder": "vector",
        "event": "{{ event_field }}",
        "key": "value",
        "\"{{ event_field }}\"": "{{ another_event_field }}",
        "pod_labels_*": "{{ kubernetes.pod_labels }}"
      },
      "out_of_order_action": "drop",
      "remove_label_fields": null,
      "remove_timestamp": true,
      "buffer": null,
      "acknowledgements": null,
      "batch": null,
      "compression": "none",
      "encoding": {
        "codec": "json"
      },
      "healthcheck": null,
      "request": null,
      "tls": null,
      "proxy": null,
      "tenant_id": "some_tenant_id"
    }
  }
}

[sinks.my_sink_id]
type = "loki"
inputs = [ "my-source-or-transform-id" ]
endpoint = "http://localhost:3100"
out_of_order_action = "drop"
remove_timestamp = true
compression = "none"
tenant_id = "some_tenant_id"

  [sinks.my_sink_id.labels]
  forwarder = "vector"
  event = "{{ event_field }}"
  key = "value"
  "\"{{ event_field }}\"" = "{{ another_event_field }}"
  "pod_labels_*" = "{{ kubernetes.pod_labels }}"

  [sinks.my_sink_id.encoding]
  codec = "json"

---
sinks:
  my_sink_id:
    type: loki
    inputs:
      - my-source-or-transform-id
    endpoint: http://localhost:3100
    auth: null
    labels:
      forwarder: vector
      event: "{{ event_field }}"
      key: value
      "\"{{ event_field }}\"": "{{ another_event_field }}"
      pod_labels_*: "{{ kubernetes.pod_labels }}"
    out_of_order_action: drop
    remove_label_fields: null
    remove_timestamp: true
    buffer: null
    acknowledgements: null
    batch: null
    compression: none
    encoding:
      codec: json
    healthcheck: null
    request: null
    tls: null
    proxy: null
    tenant_id: some_tenant_id

acknowledgements

common optional object

Controls how acknowledgements are handled by this sink. When enabled, all connected sources that support end-to-end acknowledgements will wait for the destination of this sink to acknowledge receipt of events before providing acknowledgement to the sending source. These settings override the global acknowledgement settings.

acknowledgements.enabled

optional bool

Controls if all connected sources will wait for this sink to deliver the events before acknowledging receipt.

default: false

auth

optional object

Configures the authentication strategy.

auth.password

optional string literal

The basic authentication password.

Examples

"${LOKI_PASSWORD}"

"password"

auth.strategy

optional string literal enum

The authentication strategy to use.

Enum options

Option	Description
`basic`	The basic authentication strategy.
`bearer`	The bearer token authentication strategy.

Examples

"basic"

"bearer"

auth.token

optional string literal

The token to use for bearer authentication

Examples

"${API_TOKEN}"

"xyz123"

auth.user

optional string literal

The basic authentication user name.

Examples

"${LOKI_USERNAME}"

"username"

batch

optional object

Configures the sink batching behavior.

batch.max_bytes

optional uint

The maximum size of a batch, in bytes, before it is flushed.

batch.max_events

optional uint

The maximum size of a batch, in events, before it is flushed.

batch.timeout_secs

optional float

The maximum age of a batch before it is flushed.

default: 1 (seconds)

buffer

optional object

Configures the sink specific buffer behavior.

buffer.max_events

optional uint

The maximum number of events allowed in the buffer.

Relevant when: type = "memory"

default: 500 (events)

buffer.max_size

optional uint

The maximum size of the buffer on the disk.

Relevant when: type = "disk"

Examples

104900000

buffer.type

optional string literal enum

The buffer’s type and storage mechanism.

Enum options

Option	Description
`disk`	Stores the sink’s buffer on disk. This is less performant, but durable. Data will not be lost between restarts. Will also hold data in memory to enhance performance. WARNING: This may stall the sink if disk performance isn’t on par with the throughput. For comparison, AWS gp2 volumes are usually too slow for common cases.
`memory`	Stores the sink’s buffer in memory. This is more performant, but less durable. Data will be lost if Vector is restarted forcefully.

default: memory

buffer.when_full

optional string literal enum

The behavior when the buffer becomes full.

Enum options

Option	Description
`block`	Applies back pressure when the buffer is full. This prevents data loss, but will cause data to pile up on the edge.
`drop_newest`	Drops new data as it’s received. This data is lost. This should be used when performance is the highest priority.

default: block

compression

common optional string literal enum

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

Some cloud storage API clients and browsers will handle decompression transparently, so files may not always appear to be compressed depending how they are accessed.

Enum options string literal

Option	Description
`gzip`	Gzip standard DEFLATE compression.
`none`	No compression.

default: none

encoding

required object

Configures the encoding specific sink behavior.

Note: When data in encoding is malformed, currently only a very generic error “data did not match any variant of untagged enum EncodingConfig” is reported. Follow this issue to track progress on improving these error messages.

encoding.codec

optional string literal enum

The encoding codec used to serialize the events before outputting.

Enum options

Option	Description
`json`	JSON encoded event.
`logfmt`	logfmt encoded event.
`text`	The message field from the event.

Examples

"json"

"logfmt"

"text"

encoding.except_fields

optional [string]

Prevent the sink from encoding the specified fields.

encoding.only_fields

optional [string]

Makes the sink encode only the specified fields.

encoding.timestamp_format

optional string literal enum

How to format event timestamps.

Enum options

Option	Description
`rfc3339`	Formats as a RFC3339 string
`unix`	Formats as a unix timestamp

default: rfc3339

endpoint

required string literal

The base URL of the Loki instance. Vector will append /loki/api/v1/push to this.

Examples

"http://localhost:3100"

healthcheck

common optional object

Health check options for the sink.

healthcheck.enabled

optional bool

Enables/disables the healthcheck upon Vector boot.

default: true

inputs

required [string]

A list of upstream source or transform IDs. Wildcards (*) are supported.

See configuration for more info.

Array string literal

Examples

[
  "my-source-or-transform-id",
  "prefix-*"
]

labels

required object

A set of labels that are attached to each batch of events. Both keys and values are templatable, which enables you to attach dynamic labels to events. Labels can be suffixed with a “*” to allow the expansion of objects into multiple labels, see “How it works” for more information.

Note: If the set of labels has high cardinality, this can cause drastic performance issues with Loki. To prevent this from happening, reduce the number of unique label keys and values.

labels.*

optional string template

Any Loki label, templatable

Examples

"vector"

"{{ event_field }}"

"{{ kubernetes.pod_labels }}"

out_of_order_action

optional string literal enum

Some sources may generate events with timestamps that aren’t in strictly chronological order. The Loki service can’t accept a stream of such events prior version 2.4.0. Vector sorts events before sending them to Loki, however some late events might arrive after a batch has been sent. This option specifies what Vector should do with those events. If you are using Loki 2.4.0 and newer, you should set this option to “accept”

Enum options string literal

Option	Description
`accept`	Don’t do anything, send events into Loki normally (needs Loki 2.4.0 and newer)
`drop`	Drop the event.
`rewrite_timestamp`	Rewrite timestamp of the event to the latest timestamp that was pushed.

default: drop

proxy

optional object

Configures an HTTP(S) proxy for Vector to use. By default, the globally configured proxy is used.

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:

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

remove_label_fields

optional bool

If this is set to true then when labels are collected from events those fields will also get removed from the event.

default: false

remove_timestamp

optional bool

If this is set to true then the timestamp will be removed from the event payload. Note the event timestamp will still be sent as metadata to Loki for indexing.

default: true

request

optional object

Configures the sink request behavior.

request.adaptive_concurrency

optional object

Configure the adaptive concurrency algorithms. These values have been tuned by optimizing simulated results. In general you should not need to adjust these.

request.adaptive_concurrency.decrease_ratio

optional float

The fraction of the current value to set the new concurrency limit when decreasing the limit. Valid values are greater than 0 and less than 1. Smaller values cause the algorithm to scale back rapidly when latency increases. Note that the new limit is rounded down after applying this ratio.

default: 0.9

request.adaptive_concurrency.ewma_alpha

optional float

The adaptive concurrency algorithm uses an exponentially weighted moving average (EWMA) of past RTT measurements as a reference to compare with the current RTT. This value controls how heavily new measurements are weighted compared to older ones. Valid values are greater than 0 and less than 1. Smaller values cause this reference to adjust more slowly, which may be useful if a service has unusually high response variability.

default: 0.7

request.adaptive_concurrency.rtt_deviation_scale

optional float

When calculating the past RTT average, we also compute a secondary “deviation” value that indicates how variable those values are. We use that deviation when comparing the past RTT average to the current measurements, so we can ignore increases in RTT that are within an expected range. This factor is used to scale up the deviation to an appropriate range. Valid values are greater than or equal to 0, and we expect reasonable values to range from 1.0 to 3.0. Larger values cause the algorithm to ignore larger increases in the RTT.

default: 2

request.concurrency

optional uint

The maximum number of in-flight requests allowed at any given time, or “adaptive” to allow Vector to automatically set the limit based on current network and service conditions.

request.rate_limit_duration_secs

optional uint

The time window, in seconds, used for the rate_limit_num option.

default: 1 (seconds)

request.rate_limit_num

optional uint

The maximum number of requests allowed within the rate_limit_duration_secs time window.

default: 9.223372036854776e+18

request.retry_attempts

optional uint

The maximum number of retries to make for failed requests. The default, for all intents and purposes, represents an infinite number of retries.

default: 1.8446744073709552e+19

request.retry_initial_backoff_secs

optional uint

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)

request.retry_max_duration_secs

optional uint

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

default: 3600 (seconds)

request.timeout_secs

optional uint

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

default: 60 (seconds)

tenant_id

optional string template

The tenant id that’s sent with every request, by default this is not required since a proxy should set this header. When running Loki locally a tenant id is not required either.

You can read more about tenant id’s here.

Note: This parameter supports Vector's template syntax, which enables you to use dynamic per-event values.

Examples

"some_tenant_id"

"{{ event_field }}"

tls

optional object

Configures the TLS options for outgoing connections.

tls.ca_file

optional string literal

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

Examples

"/path/to/certificate_authority.crt"

tls.crt_file

optional string literal

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

Examples

"/path/to/host_certificate.crt"

tls.enabled

optional bool

Enable TLS during connections to the remote.

default: false

tls.key_file

optional string literal

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

Examples

"/path/to/host_certificate.key"

tls.key_pass

optional string literal

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

Examples

"${KEY_PASS_ENV_VAR}"

"PassWord1"

tls.verify_certificate

optional bool

If true (the default), Vector will validate the TLS certificate of the remote host.

default: true

tls.verify_hostname

optional bool

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

Telemetry

Metrics

link

buffer_byte_size

gauge

The number of bytes current in the buffer.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

buffer_discarded_events_total

counter

The number of events dropped by this non-blocking buffer.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

buffer_events

gauge

The number of events currently in the buffer.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

buffer_received_event_bytes_total

counter

The number of bytes received by this buffer.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

buffer_received_events_total

counter

The number of events received by this buffer.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

buffer_sent_event_bytes_total

counter

The number of bytes sent by this buffer.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

buffer_sent_events_total

counter

The number of events sent by this buffer.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

component_received_event_bytes_total

counter

The number of event bytes accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

container_name optional

The name of the container from which the data originated.

file optional

The file from which the data originated.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the data originated.

peer_path optional

The pathname from which the data originated.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the data originated.

uri optional

The sanitized URI from which the data originated.

component_received_events_count

histogram

A histogram of Vector the number of events passed in each internal batch in Vector’s internal topology. Note that this is separate than sink-level batching. It is mostly useful for low level debugging performance issues in Vector due to small internal batches.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

container_name optional

The name of the container from which the data originated.

file optional

The file from which the data originated.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the data originated.

peer_path optional

The pathname from which the data originated.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the data originated.

uri optional

The sanitized URI from which the data originated.

component_received_events_total

counter

The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

container_name optional

The name of the container from which the data originated.

file optional

The file from which the data originated.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the data originated.

peer_path optional

The pathname from which the data originated.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the data originated.

uri optional

The sanitized URI from which the data originated.

component_sent_bytes_total

counter

The number of raw bytes sent by this component to destination sinks.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

endpoint optional

The endpoint to which the bytes were sent. For HTTP, this will be the host and path only, excluding the query string.

file optional

The absolute path of the destination file.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

protocol required

The protocol used to send the bytes.

region optional

The AWS region name to which the bytes were sent. In some configurations, this may be a literal hostname.

component_sent_event_bytes_total

counter

The total number of event bytes emitted by this component.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

output optional

The specific output of the component.

pid optional

The process ID of the Vector instance.

component_sent_events_total

counter

The total number of events emitted by this component.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

output optional

The specific output of the component.

pid optional

The process ID of the Vector instance.

events_discarded_total

counter

The total number of events discarded by this component.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

reason required

The type of the error

events_in_total

counter

The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins. This metric is deprecated and will be removed in a future version. Use component_received_events_total instead.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

container_name optional

The name of the container from which the data originated.

file optional

The file from which the data originated.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the data originated.

peer_path optional

The pathname from which the data originated.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the data originated.

uri optional

The sanitized URI from which the data originated.

events_out_total

counter

The total number of events emitted by this component. This metric is deprecated and will be removed in a future version. Use component_sent_events_total instead.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

output optional

The specific output of the component.

pid optional

The process ID of the Vector instance.

processed_bytes_total

counter

The number of bytes processed by the component.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

container_name optional

The name of the container from which the bytes originate.

file optional

The file from which the bytes originate.

host optional

The hostname of the system Vector is running on.

mode optional

The connection mode used by the component.

peer_addr optional

The IP from which the bytes originate.

peer_path optional

The pathname from which the bytes originate.

pid optional

The process ID of the Vector instance.

pod_name optional

The name of the pod from which the bytes originate.

uri optional

The sanitized URI from which the bytes originate.

processing_errors_total

counter

The total number of processing errors encountered by this component.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

error_type required

The type of the error

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

streams_total

counter

The total number of streams.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

utilization

gauge

A ratio from 0 to 1 of the load on a component. A value of 0 would indicate a completely idle component that is simply waiting for input. A value of 1 would indicate a that is never idle. This value is updated every 5 seconds.

component_id required

The Vector component ID.

component_kind required

The Vector component kind.

component_name required

Deprecated, use component_id instead. The value is the same as component_id.

component_type required

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

How it works

Buffers and batches

This component 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:

The batch age meets or exceeds the configured timeout_secs.
The batch size meets or exceeds the configured max_bytes or max_events.

Buffers are controlled via the buffer.* options.

Decentralized Deployments

Loki currently does not support out-of-order inserts. If Vector is deployed in a decentralized setup then there is the possibility that logs might get rejected due to data races between Vector instances. To avoid this we suggest either assigning each Vector instance with a unique label or deploying a centralized Vector which will ensure no logs will get sent out-of-order.

Event Ordering

The loki sink will ensure that all logs are sorted via their timestamp. This is to ensure that logs will be accepted by Loki. If no timestamp is supplied with events then the Loki sink will supply its own monotonically increasing timestamp.

Health checks

Health checks ensure that the downstream service is accessible and ready to accept data. This check is performed upon sink initialization. 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.

Label Expansion

The labels option can be passed keys suffixed with “*” to allow for setting multiple keys based on the contents of an object. For example, with an object:

{"kubernetes":{"pod_labels":{"app":"web-server","name":"unicorn"}}}

and a configuration:

[sinks.my_sink_id.labels]
pod_labels_*: "{{ kubernetes.pod_labels }}"

This would expand into two labels:

pod_labels_app: web-server
pod_labels_name: unicorn

Partitioning

Vector supports dynamic configuration values through a simple template syntax. If an option supports templating, it will be noted with a badge and you can use event fields to create dynamic values. For example:

[sinks.my-sink]
dynamic_option = "application={{ application_id }}"

In the above example, the application_id for each event will be used to partition outgoing data.

Rate limits & adaptive concurrency

Adaptive Request Concurrency (ARC)

Adaptive Request Concurrency is a feature of Vector that does away with static concurrency limits and automatically optimizes HTTP concurrency based on downstream service responses. The underlying mechanism is a feedback loop inspired by TCP congestion control algorithms. Checkout the announcement blog post,

We highly recommend enabling this feature as it improves performance and reliability of Vector and the systems it communicates with. As such, we have made it the default, and no further configuration is required.

Static concurrency

If Adaptive Request Concurrency is not for you, you can manually set static concurrency limits by specifying an integer for request.concurrency:

[sinks.my-sink]
  request.concurrency = 10

Rate limits

In addition to limiting request concurrency, you can also limit the overall request throughput via the request.rate_limit_duration_secs and request.rate_limit_num options.

[sinks.my-sink]
  request.rate_limit_duration_secs = 1
  request.rate_limit_num = 10

These will apply to both adaptive and fixed request.concurrency values.

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 request.retry_attempts and request.retry_backoff_secs options.

State

This component is stateless, meaning its behavior is consistent across each input.

Transport Layer Security (TLS)

Vector uses OpenSSL for TLS protocols due to OpenSSL’s maturity. You can enable and adjust TLS behavior using the tls.* options.