AWS S3 sink

Configuration

Example configurations

{
  "sinks": {
    "my_sink_id": {
      "type": "aws_s3",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "bucket": "my-bucket",
      "key_prefix": "date=%F/",
      "acknowledgements": null,
      "batch": null,
      "compression": "gzip",
      "encoding": {
        "codec": "json"
      },
      "healthcheck": null,
      "region": "us-east-1"
    }
  }
}

[sinks.my_sink_id]
type = "aws_s3"
inputs = [ "my-source-or-transform-id" ]
bucket = "my-bucket"
key_prefix = "date=%F/"
compression = "gzip"
region = "us-east-1"

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

---
sinks:
  my_sink_id:
    type: aws_s3
    inputs:
      - my-source-or-transform-id
    bucket: my-bucket
    key_prefix: date=%F/
    acknowledgements: null
    batch: null
    compression: gzip
    encoding:
      codec: json
    healthcheck: null
    region: us-east-1

{
  "sinks": {
    "my_sink_id": {
      "type": "aws_s3",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "auth": null,
      "endpoint": "http://127.0.0.0:5000/path/to/service",
      "acl": "private",
      "bucket": "my-bucket",
      "content_encoding": "gzip",
      "content_type": "text/x-log",
      "filename_append_uuid": true,
      "filename_extension": "log",
      "filename_time_format": "%s",
      "grant_full_control": "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be",
      "grant_read": "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be",
      "grant_read_acp": "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be",
      "grant_write_acp": "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be",
      "key_prefix": "date=%F/",
      "server_side_encryption": "AES256",
      "ssekms_key_id": "abcd1234",
      "storage_class": "STANDARD",
      "buffer": null,
      "acknowledgements": null,
      "batch": null,
      "compression": "gzip",
      "encoding": {
        "codec": "json"
      },
      "healthcheck": null,
      "request": null,
      "tls": null,
      "proxy": null,
      "framing": null,
      "region": "us-east-1",
      "tags": {
        "Tag1": "Value1"
      }
    }
  }
}

[sinks.my_sink_id]
type = "aws_s3"
inputs = [ "my-source-or-transform-id" ]
endpoint = "http://127.0.0.0:5000/path/to/service"
acl = "private"
bucket = "my-bucket"
content_encoding = "gzip"
content_type = "text/x-log"
filename_append_uuid = true
filename_extension = "log"
filename_time_format = "%s"
grant_full_control = "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be"
grant_read = "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be"
grant_read_acp = "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be"
grant_write_acp = "79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be"
key_prefix = "date=%F/"
server_side_encryption = "AES256"
ssekms_key_id = "abcd1234"
storage_class = "STANDARD"
compression = "gzip"
region = "us-east-1"

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

  [sinks.my_sink_id.tags]
  Tag1 = "Value1"

---
sinks:
  my_sink_id:
    type: aws_s3
    inputs:
      - my-source-or-transform-id
    auth: null
    endpoint: http://127.0.0.0:5000/path/to/service
    acl: private
    bucket: my-bucket
    content_encoding: gzip
    content_type: text/x-log
    filename_append_uuid: true
    filename_extension: log
    filename_time_format: "%s"
    grant_full_control: 79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be
    grant_read: 79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be
    grant_read_acp: 79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be
    grant_write_acp: 79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be
    key_prefix: date=%F/
    server_side_encryption: AES256
    ssekms_key_id: abcd1234
    storage_class: STANDARD
    buffer: null
    acknowledgements: null
    batch: null
    compression: gzip
    encoding:
      codec: json
    healthcheck: null
    request: null
    tls: null
    proxy: null
    framing: null
    region: us-east-1
    tags:
      Tag1: Value1

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

common optional bool

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

default: false

acl

optional string literal enum

Canned ACL to apply to the created objects. For more information, see Canned ACL.

Enum options string literal

Option	Description
`authenticated-read`	Owner gets `FULL_CONTROL`. The AuthenticatedUsers group gets `READ` access.
`aws-exec-read`	Owner gets `FULL_CONTROL`. Amazon EC2 gets `READ` access to `GET` an Amazon Machine Image (AMI) bundle from Amazon S3.
`bucket-owner-full-control`	Both the object owner and the bucket owner get `FULL_CONTROL` over the object.
`bucket-owner-read`	Object owner gets `FULL_CONTROL`. Bucket owner gets `READ. access.
`log-delivery-write`	The LogDelivery group gets `WRITE` and `READ_ACP` permissions on the bucket. For more information about logs, see Amazon S3 Server Access Logging.
`private`	Owner gets `FULL_CONTROL`. No one else has access rights (default).
`public-read`	Owner gets `FULL_CONTROL`. The AllUsers group gets `READ` access.
`public-read-write`	Owner gets `FULL_CONTROL`. The AllUsers group gets `READ` and `WRITE` access. Granting this on a bucket is generally not recommended.

auth

optional object

Options for the authentication strategy.

auth.access_key_id

optional string literal

The AWS access key id. Used for AWS authentication when communicating with AWS services.

Examples

"AKIAIOSFODNN7EXAMPLE"

auth.assume_role

optional string literal

The ARN of an IAM role to assume at startup.

Examples

"arn:aws:iam::123456789098:role/my_role"

auth.load_timeout_secs

optional uint

The timeout for loading credentials. Relevant when the default credentials chain is used or assume_role.

Examples

default: 5 (seconds)

auth.profile

optional string literal

The AWS profile name. Used to select AWS credentials from a provided credentials file.

Examples

"develop"

default: default

auth.region

optional string literal

The AWS region to send STS requests to. If not set, this will default to the configured region for the service itself.

Examples

"us-west-2"

auth.secret_access_key

optional string literal

The AWS secret access key. Used for AWS authentication when communicating with AWS services.

Examples

"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"

batch

common optional object

Configures the sink batching behavior.

batch.max_bytes

common optional uint

The maximum size of a batch that will be processed by a sink. This is based on the uncompressed size of the batched events, before they are serialized / compressed.

batch.max_events

common optional uint

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

batch.timeout_secs

common optional float

The maximum age of a batch before it is flushed.

default: 300 (seconds)

bucket

required string literal

The S3 bucket name. Do not include a leading s3:// or a trailing /.

Examples

"my-bucket"

buffer

optional object

Configures the sink specific buffer behavior.

More information about the individual buffer types, and buffer behavior, can be found in the Buffering Model section.

buffer.max_events

common optional uint

The maximum number of events allowed in the buffer.

Relevant when: type = "memory"

default: 500 (events)

buffer.max_size

required uint

The maximum size of the buffer on the disk. Must be at least ~256 megabytes (268435488 bytes).

Relevant when: type = "disk"

Examples

268435488

buffer.type

common optional string literal enum

The type of buffer to use.

Enum options

Option Description

Option	Description
`disk`	Events are buffered on disk. This is less performant, but more durable. Data that has been synchronized to disk will not be lost if Vector is restarted forcefully or crashes. Data is synchronized to disk every 500ms.
`memory`	Events are buffered in memory. This is more performant, but less durable. Data will be lost if Vector is restarted forcefully or crashes.

disk

Events are buffered on disk.

This is less performant, but more durable. Data that has been synchronized to disk will not be lost if Vector is restarted forcefully or crashes.

Data is synchronized to disk every 500ms.

memory

Events are buffered in memory.

This is more performant, but less durable. Data will be lost if Vector is restarted forcefully or crashes.

default: memory

buffer.when_full

optional string literal enum

The behavior when the buffer becomes full.

Enum options

Option Description

Option	Description
`block`	Waits for capacity in the buffer. This will cause backpressure to propagate to upstream components, which can cause data to pile up on the edge.
`drop_newest`	Drops the event without waiting for capacity in the buffer. The data is lost. This should only be used when performance is the highest priority.

block

Waits for capacity in the buffer.

This will cause backpressure to propagate to upstream components, which can cause data to pile up on the edge.

drop_newest

Drops the event without waiting for capacity in the buffer.

The data is lost. This should only 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.

The default compression level of the chosen algorithm is used. 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. Compression level is `6` unless otherwise specified.
`none`	No compression.

default: gzip

content_encoding

optional string literal

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. By default calculated from compression value.

Examples

"gzip"

content_type

optional string literal

A standard MIME type describing the format of the contents.

default: text/x-log

encoding

required object

Configures the encoding specific sink behavior.

encoding.codec

required string literal enum

The encoding codec used to serialize the events before outputting.

Enum options

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

Examples

"json"

"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

optional string literal

Custom endpoint for use with AWS-compatible services.

Examples

"http://127.0.0.0:5000/path/to/service"

filename_append_uuid

optional bool

Whether or not to append a UUID v4 token to the end of the file. This ensures there are no name collisions high volume use cases.

default: true

filename_extension

optional string literal

The filename extension to use in the object name.

default: log

filename_time_format

optional string strftime

The format of the resulting object file name. strftime specifiers are supported.

default: %s

framing

optional object

Configures in which way events encoded as byte frames should be separated in a payload.

framing.character_delimited

required object

Options for character_delimited framing.

Relevant when: method = `character_delimited`

framing.character_delimited.delimiter

required ascii_char

The character used to separate frames.

Examples

"\n"

"\t"

framing.method

common optional string literal enum

The framing method.

Enum options

Option	Description
`bytes`	Byte frames are concatenated.
`character_delimited`	Byte frames are delimited by a chosen character.
`length_delimited`	Byte frames are prefixed by an unsigned big-endian 32-bit integer indicating the length.
`newline_delimited`	Byte frames are delimited by a newline character.

default: A suitable default is chosen depending on the sink type and the selected codec.

grant_full_control

optional string literal

Gives the named grantee READ, READ_ACP, and WRITE_ACP permissions on the created objects.

Examples

"79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be"

"person@email.com"

"http://acs.amazonaws.com/groups/global/AllUsers"

grant_read

optional string literal

Allows the named grantee to read the created objects and their metadata.

Examples

"79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be"

"person@email.com"

"http://acs.amazonaws.com/groups/global/AllUsers"

grant_read_acp

optional string literal

Allows the named grantee to read the created objects' ACL.

Examples

"79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be"

"person@email.com"

"http://acs.amazonaws.com/groups/global/AllUsers"

grant_write_acp

optional string literal

Allows the named grantee to write the created objects' ACL.

Examples

"79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be"

"person@email.com"

"http://acs.amazonaws.com/groups/global/AllUsers"

healthcheck

common optional object

Health check options for the sink.

healthcheck.enabled

common 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-*"
]

key_prefix

common optional string template

A prefix to apply to all object key names. This should be used to partition your objects, and it’s important to end this value with a / if you want this to be the root S3 “folder”.

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

Examples

"date=%F/"

"date=%F/hour=%H/"

"year=%Y/month=%m/day=%d/"

"application_id={{ application_id }}/date=%F/"

default: date=%F/

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

region

required string literal

The AWS region of the target service.

Examples

"us-east-1"

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

common 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

common optional uint

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

default: 1 (seconds)

request.rate_limit_num

common 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

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

server_side_encryption

optional string literal enum

The Server-side Encryption algorithm used when storing these objects.

Enum options string literal

Option	Description
`AES256`	256-bit Advanced Encryption Standard
`aws:kms`	AWS managed key encryption

ssekms_key_id

optional string literal

If server_side_encryption has the value "aws.kms", this specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that will used for the created objects. If not specified, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Examples

"abcd1234"

storage_class

optional string literal enum

The storage class for the created objects. See the S3 Storage Classes for more details.

Enum options string literal

Option	Description
`DEEP_ARCHIVE`	Use for archiving data that rarely needs to be accessed.
`GLACIER`	Use for archives where portions of the data might need to be retrieved in minutes.
`INTELLIGENT_TIERING`	Stores objects in two access tiers: one tier that is optimized for frequent access and another lower-cost tier that is optimized for infrequently accessed data.
`ONEZONE_IA`	Amazon S3 stores the object data in only one Availability Zone.
`REDUCED_REDUNDANCY`	Designed for noncritical, reproducible data that can be stored with less redundancy than the STANDARD storage class. AWS recommends that you not use this storage class. The STANDARD storage class is more cost effective.
`STANDARD`	The default storage class. If you don’t specify the storage class when you upload an object, Amazon S3 assigns the STANDARD storage class.
`STANDARD_IA`	Amazon S3 stores the object data redundantly across multiple geographically separated Availability Zones (similar to the STANDARD storage class).

tls

optional object

Configures the TLS options for outgoing connections.

tls.alpn_protocols

optional [string]

Sets the list of supported ALPN protocols, which are used during negotiation with peer. Prioritized in the order they are defined.

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

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

common 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. Specifically the issuer is checked but not CRLs (Certificate Revocation Lists).

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

Environment variables

AWS_ACCESS_KEY_ID

common optional string literal

The AWS access key id. Used for AWS authentication when communicating with AWS services.

Examples

AKIAIOSFODNN7EXAMPLE

AWS_CONFIG_FILE

common optional string literal

Specifies the location of the file that the AWS CLI uses to store configuration profiles.

Default: ~/.aws/config

AWS_DEFAULT_REGION

common optional string literal

The default AWS region.

Examples

/path/to/credentials.json

AWS_PROFILE

common optional string literal

Specifies the name of the CLI profile with the credentials and options to use. This can be the name of a profile stored in a credentials or config file.

Default: default

Examples

my-custom-profile

AWS_ROLE_SESSION_NAME

common optional string literal

Specifies a name to associate with the role session. This value appears in CloudTrail logs for commands performed by the user of this profile.

Examples

vector-session

AWS_SECRET_ACCESS_KEY

common optional string literal

The AWS secret access key. Used for AWS authentication when communicating with AWS services.

Examples

wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

AWS_SESSION_TOKEN

common optional string literal

The AWS session token. Used for AWS authentication when communicating with AWS services.

Examples

AQoEXAMPLEH4aoAH0gNCAPy...truncated...zrkuWJOgQs8IZZaIv2BXIa2R4Olgk

AWS_SHARED_CREDENTIALS_FILE

common optional string literal

Specifies the location of the file that the AWS CLI uses to store access keys.

Default: ~/.aws/credentials

Telemetry

Metrics

link

buffer_byte_size

gauge

The number of bytes current in the buffer.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

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.

processing_errors_total

counter

The total number of processing errors encountered by this component. This metric is deprecated in favor of component_errors_total.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

The Vector component type.

error_type

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.

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

The Vector component ID.

component_kind

The Vector component kind.

component_name

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

component_type

The Vector component type.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

Permissions

Platform: Amazon Web Services

Relevant policies

Policy	Required for	Required when
`s3:ListBucket`	`healthcheck`
`s3:PutObject`	`operation`

How it works

AWS authentication

Vector checks for AWS credentials in the following order:

The access_key_id and secret_access_key options.
The AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.
The AWS credentials file (usually located at ~/.aws/credentials).
The IAM instance profile (only works if running on an EC2 instance with an instance profile/role). Requires IMDSv2 to be enabled. For EKS, you may need to increase the metadata token response hop limit to 2.

If no credentials are found, Vector’s health check fails and an error is logged. If your AWS credentials expire, Vector will automatically search for up-to-date credentials in the places (and order) described above.

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. Such created AWS access keys can be used via access_key_id and secret_access_key options.

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

Cross account object writing

If you’re using Vector to write objects across AWS accounts then you should consider setting the grant_full_control option to the bucket owner’s canonical user ID. AWS provides a full tutorial for this use case. If don’t know the bucket owner’s canonical ID you can find it by following this tutorial.

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.

Object Access Control List (ACL)

AWS S3 supports access control lists (ACL) for buckets and objects. In the context of Vector, only object ACLs are relevant (Vector does not create or modify buckets). You can set the object level ACL by using one of the acl, grant_full_control, grant_read, grant_read_acp, or grant_write_acp options.

`acl.` vs `grant_` options

The grant_* options name a specific entity to grant access to. The acl options is one of a set of specific canned ACLs that can only name the owner or world.

Object naming

Vector uses two different naming schemes for S3 objects. If you set the compression parameter to true (this is the default), Vector uses this scheme:

<key_prefix><timestamp>-<uuidv4>.log.gz

If compression isn’t enabled, Vector uses this scheme (only the file extension is different):

<key_prefix><timestamp>-<uuidv4>.log

Some sample S3 object names (with and without compression, respectively):

date=2019-06-18/1560886634-fddd7a0e-fad9-4f7e-9bce-00ae5debc563.log.gz
date=2019-06-18/1560886634-fddd7a0e-fad9-4f7e-9bce-00ae5debc563.log

Vector appends a UUIDV4 token to ensure there are no naming conflicts in the unlikely event that two Vector instances are writing data at the same time.

You can control the resulting name via the key_prefix, filename_time_format, and filename_append_uuid options.

Object Tags & metadata

Vector currently only supports AWS S3 object tags and does not support object metadata. If you require metadata support see issue #1694.

We believe tags are more flexible since they are separate from the actual S3 object. You can freely modify tags without modifying the object. Conversely, object metadata requires a full rewrite of the object to make changes.

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.

Server-Side Encryption (SSE)

AWS S3 offers server-side encryption. You can apply defaults at the bucket level or set the encryption at the object level. In the context, of Vector only the object level is relevant (Vector does not create or modify buckets). Although, we recommend setting defaults at the bucket level when possible. You can explicitly set the object level encryption via the server_side_encryption option.

State

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

Storage class

AWS S3 offers storage classes. You can apply defaults, and rules, at the bucket level or set the storage class at the object level. In the context of Vector only the object level is relevant (Vector does not create or modify buckets). You can set the storage class via the storage_class option.

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.

AWS S3

Configuration

Example configurations

Environment variables

Telemetry

buffer_byte_size

buffer_discarded_events_total

buffer_events

buffer_received_event_bytes_total

buffer_received_events_total

buffer_sent_event_bytes_total

buffer_sent_events_total

component_received_event_bytes_total

component_received_events_count

component_received_events_total

component_sent_bytes_total

component_sent_event_bytes_total

component_sent_events_total

events_discarded_total

events_in_total

processing_errors_total

utilization

Permissions

How it works

AWS authentication

Obtaining an access key

Assuming roles

Buffers and batches

Cross account object writing

Health checks

Require health checks

Disable health checks

Object Access Control List (ACL)

acl.* vs grant_* options

Object naming

Object Tags & metadata

Partitioning

Rate limits & adaptive concurrency

Adaptive Request Concurrency (ARC)

Static concurrency

Rate limits

Retry policy

Server-Side Encryption (SSE)

State

Storage class

Transport Layer Security (TLS)

`acl.` vs `grant_` options