Honeycomb Sink

The Vector honeycomb sink batches log events to Honeycomb via the batch events API.


type = "honeycomb" # required
inputs = ["my-source-or-transform-id"] # required
api_key = "${HONEYCOMB_API_KEY}" # required
dataset = "my-honeycomb-dataset" # required
healthcheck = true # optional, default
  • stringcommonrequired


    The team key that will be used to authenticate against Honeycomb.

    • No default
    • View examples
  • tableoptional


    Configures the sink batching behavior.

    • uint (bytes)commonoptional


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

      • Default: 5242880 (bytes)
    • uint (events)commonoptional


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

      • No default
      • View examples
    • uint (seconds)commonoptional


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

      • Default: 1 (seconds)
  • tableoptional


    Configures the sink specific buffer behavior.

    • uint (events)commonoptional


      The maximum number of events allowed in the buffer. See Buffers & Batches for more info.

      • Only relevant when: type = "memory"
      • Default: 500 (events)
    • uint (bytes)required*


      The maximum size of the buffer on the disk.

      • Only required when: type = "disk"
      • No default
      • View examples
    • stringenumcommonoptional


      The buffer's type and storage mechanism.

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


      The behavior when the buffer becomes full.

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


    The dataset that Vector will send logs to.

    • No default
    • View examples
  • boolcommonoptional


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

    • Default: true
    • View examples
  • tableoptional


    Configures the sink request behavior.

    • uint (requests)commonoptional


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

      • Default: 5 (requests)
    • uint (seconds)commonoptional


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

      • Default: 1 (seconds)
    • uintcommonoptional


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

      • Default: 5
    • uintoptional


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

      • Default: 18446744073709552000
    • uint (seconds)optional


      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)
    • uint (seconds)optional


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

      • Default: 10 (seconds)
    • uint (seconds)commonoptional


      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: 60 (seconds)

How It Works

Buffers & Batches

The honeycomb 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_events.

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. 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.

Obtaining a Honeycomb API key

  1. Register for a free account at honeycomb.io

  2. Once registered, create a new dataset and when presented with log shippers select the curl option and use the key provided with the curl example.

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 issue.

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.