AWS Kinesis Firehose Sink

The Vector aws_kinesis_firehose sink batches log events to Amazon Web Service's Kinesis Data Firehose via the PutRecordBatch API endpoint.

Configuration

  • Common
  • Advanced
vector.toml
[sinks.my_sink_id]
# REQUIRED - General
type = "aws_kinesis_firehose" # must be: "aws_kinesis_firehose"
inputs = ["my-source-id"] # example
region = "us-east-1" # example, relevant when host = ""
stream_name = "my-stream" # example
# REQUIRED - requests
encoding = "json" # example, enum
# OPTIONAL - General
healthcheck = true # default

Options

9 items
stringoptional

assume_role

The ARN of an IAM role to assume at startup. See AWS Authentication for more info.

No default
View examples
tableoptional

batch

Configures the sink batching behavior.

int (events)commonrequired

max_events

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

Default: 500 (events)
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. See Buffers & Batches for more info.

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

max_size

The maximum size of the buffer on the disk.

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
stringenumcommonrequired

encoding

The encoding format used to serialize the events before outputting.

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

endpoint

Custom endpoint for use with AWS-compatible services. Providing a value for this option will make region moot.

No default
Only relevant when: region = null
View examples
boolcommonoptional

healthcheck

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

Default: true
View examples
stringcommonrequired

region

The AWS region of the target service. If endpoint is provided it will override this value since the endpoint includes the region.

No default
Only relevant when: host = null
View examples
tableoptional

request

Configures the sink request behavior.

int (requests)optional

in_flight_limit

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

Default: 5 (requests)
View examples
int (seconds)optional

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
intoptional

rate_limit_num

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

Default: 5
View examples
intoptional

retry_attempts

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

Default: -1
View examples
int (seconds)optional

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)optional

retry_max_duration_secs

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

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

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
stringcommonrequired

stream_name

The stream name of the target Kinesis Firehose delivery stream.

No default
View examples

Env Vars

2 items
stringoptional

AWS_ACCESS_KEY_ID

Used for AWS authentication when communicating with AWS services. See relevant AWS components for more info. See AWS Authentication for more info.

No default
View examples
stringoptional

AWS_SECRET_ACCESS_KEY

Used for AWS authentication when communicating with AWS services. See relevant AWS components for more info. See AWS Authentication for more info.

No default
View examples

Output

The aws_kinesis_firehose sink batches log events to Amazon Web Service's Kinesis Data Firehose via the PutRecordBatch API endpoint. Batches are flushed via the batch_size or batch_timeout options. You can learn more in the buffers & batches section. For example:

POST / HTTP/1.1
Host: firehose.<region>.<domain>
Content-Length: <byte_size>
Content-Type: application/x-amz-json-1.1
Connection: Keep-Alive
X-Amz-Target: Firehose_20150804.PutRecordBatch
{
"DeliveryStreamName": "<stream_name>",
"Records": [
{
"Data": "<base64_encoded_log>",
},
{
"Data": "<base64_encoded_log>",
},
{
"Data": "<base64_encoded_log>",
},
]
}

How It Works

AWS Authentication

Vector checks for AWS credentials in the following order:

  1. Environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
  2. The credential_process command in the AWS config file. (usually located at ~/.aws/config)
  3. The AWS credentials file. (usually located at ~/.aws/credentials)
  4. The IAM instance profile. (will only work if running on an EC2 instance with an instance profile/role)

If credentials are not found the healtcheck will fail and an error will be logged.

Obtaining an access key

In general, we recommend using instance profiles/roles whenever possible. In cases where this is not possible you can generate an AWS access key for any user within your AWS account. AWS provides a detailed guide on how to do this.

Assuming Roles

Vector can assume an AWS IAM role via the assume_role option. This is an optional setting that is helpful for a variety of use cases, such as cross account access.

Buffers & Batches

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

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.