AWS SNS sink

Configuration

Example configurations

{
  "sinks": {
    "my_sink_id": {
      "type": "aws_sns",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "queue_url": "https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue"
    }
  }
}

[sinks.my_sink_id]
type = "aws_sns"
inputs = [ "my-source-or-transform-id" ]
queue_url = "https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue"

sinks:
  my_sink_id:
    type: aws_sns
    inputs:
      - my-source-or-transform-id
    queue_url: https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue

{
  "sinks": {
    "my_sink_id": {
      "type": "aws_sns",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "endpoint": "http://127.0.0.0:5000/path/to/service",
      "message_deduplication_id": "{{ transaction_id }}",
      "message_group_id": "vector",
      "queue_url": "https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue",
      "region": "us-east-1"
    }
  }
}

[sinks.my_sink_id]
type = "aws_sns"
inputs = [ "my-source-or-transform-id" ]
endpoint = "http://127.0.0.0:5000/path/to/service"
message_deduplication_id = "{{ transaction_id }}"
message_group_id = "vector"
queue_url = "https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue"
region = "us-east-1"

sinks:
  my_sink_id:
    type: aws_sns
    inputs:
      - my-source-or-transform-id
    endpoint: http://127.0.0.0:5000/path/to/service
    message_deduplication_id: "{{ transaction_id }}"
    message_group_id: vector
    queue_url: https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue
    region: us-east-1

acknowledgements

optional object

Controls how acknowledgements are handled for this sink.

See End-to-end Acknowledgements for more information on how event acknowledgement is handled.

acknowledgements.enabled

optional bool

Whether or not end-to-end acknowledgements are enabled.

When enabled for a sink, any source connected to that sink, where the source supports end-to-end acknowledgements as well, waits for events to be acknowledged by all connected sinks before acknowledging them at the source.

Enabling or disabling acknowledgements at the sink level takes precedence over any global acknowledgements configuration.

auth

optional object

Configuration of the authentication strategy for interacting with AWS services.

auth.access_key_id

required string literal

The AWS access key ID.

Examples

"AKIAIOSFODNN7EXAMPLE"

auth.assume_role

required string literal

The ARN of an IAM role to assume.

Examples

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

auth.credentials_file

required string literal

Path to the credentials file.

Examples

"/my/aws/credentials"

auth.external_id

optional string literal

The optional unique external ID in conjunction with role to assume.

Examples

"randomEXAMPLEidString"

auth.imds

optional object

Configuration for authenticating with AWS through IMDS.

auth.imds.connect_timeout_seconds

optional uint

Connect timeout for IMDS.

default: 1 (seconds)

auth.imds.max_attempts

optional uint

Number of IMDS retries for fetching tokens and metadata.

default: 4

auth.imds.read_timeout_seconds

optional uint

Read timeout for IMDS.

default: 1 (seconds)

auth.load_timeout_secs

optional uint

Timeout for successfully loading any credentials, in seconds.

Relevant when the default credentials chain or assume_role is used.

Examples

auth.profile

optional string literal

The credentials profile to use.

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 defaults to the configured region for the service itself.

Examples

"us-west-2"

auth.secret_access_key

required string literal

The AWS secret access key.

Examples

"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"

buffer

optional object

Configures the buffering behavior for this sink.

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

buffer.max_events

optional uint

The maximum number of events allowed in the buffer.

Relevant when: type = "memory"

default: 500

buffer.max_size

required uint

The maximum size of the buffer on disk.

Must be at least ~256 megabytes (268435488 bytes).

Relevant when: type = "disk"

buffer.type

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

Event handling behavior when a buffer is full.

Enum options

Option Description

Option	Description
`block`	Wait for free space in the buffer. This applies backpressure up the topology, signalling that sources should slow down the acceptance/consumption of events. This means that while no data is lost, data will pile up at the edge.
`drop_newest`	Drops the event instead of waiting for free space in buffer. The event will be intentionally dropped. This mode is typically used when performance is the highest priority, and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance/consumption of events.

block

Wait for free space in the buffer.

This applies backpressure up the topology, signalling that sources should slow down the acceptance/consumption of events. This means that while no data is lost, data will pile up at the edge.

drop_newest

Drops the event instead of waiting for free space in buffer.

The event will be intentionally dropped. This mode is typically used when performance is the highest priority, and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance/consumption of events.

default: block

encoding

required object

Configures how events are encoded into raw bytes.

encoding.avro

required object

Apache Avro-specific encoder options.

Relevant when: codec = "avro"

encoding.avro.schema

required string literal

The Avro schema.

Examples

"{ \"type\": \"record\", \"name\": \"log\", \"fields\": [{ \"name\": \"message\", \"type\": \"string\" }] }"

encoding.codec

required string literal enum

The codec to use for encoding events.

Enum options

Option	Description
`avro`	Encodes an event as an Apache Avro message.
`csv`	Encodes an event as a CSV message. This codec must be configured with fields to encode.
`gelf`	Encodes an event as a GELF message. This codec is experimental for the following reason: The GELF specification is more strict than the actual Graylog receiver. Vector’s encoder currently adheres more strictly to the GELF spec, with the exception that some characters such as `@` are allowed in field names. Other GELF codecs such as Loki’s, use a Go SDK that is maintained by Graylog, and is much more relaxed than the GELF spec. Going forward, Vector will use that Go SDK as the reference implementation, which means the codec may continue to relax the enforcement of specification.
`json`	Encodes an event as JSON.
`logfmt`	Encodes an event as a logfmt message.
`native`	Encodes an event in the native Protocol Buffers format. This codec is experimental.
`native_json`	Encodes an event in the native JSON format. This codec is experimental.
`protobuf`	Encodes an event as a Protobuf message.
`raw_message`	No encoding. This encoding uses the `message` field of a log event. Be careful if you are modifying your log events (for example, by using a `remap` transform) and removing the message field while doing additional parsing on it, as this could lead to the encoding emitting empty strings for the given event.
`text`	Plain text encoding. This encoding uses the `message` field of a log event. For metrics, it uses an encoding that resembles the Prometheus export format. Be careful if you are modifying your log events (for example, by using a `remap` transform) and removing the message field while doing additional parsing on it, as this could lead to the encoding emitting empty strings for the given event.

Examples

"avro"

"csv"

"gelf"

"json"

"logfmt"

"native"

"native_json"

"protobuf"

"raw_message"

"text"

encoding.csv

required object

The CSV Serializer Options.

Relevant when: codec = "csv"

encoding.csv.capacity

optional uint

Set the capacity (in bytes) of the internal buffer used in the CSV writer. This defaults to a reasonable setting.

default: 8192

encoding.csv.delimiter

optional ascii_char

The field delimiter to use when writing CSV.

default: ,

encoding.csv.double_quote

optional bool

Enable double quote escapes.

This is enabled by default, but it may be disabled. When disabled, quotes in field data are escaped instead of doubled.

default: true

encoding.csv.escape

optional ascii_char

The escape character to use when writing CSV.

In some variants of CSV, quotes are escaped using a special escape character like \ (instead of escaping quotes by doubling them).

To use this, double_quotes needs to be disabled as well otherwise it is ignored.

default: "

encoding.csv.fields

required [string]

Configures the fields that will be encoded, as well as the order in which they appear in the output.

If a field is not present in the event, the output will be an empty string.

Values of type Array, Object, and Regex are not supported and the output will be an empty string.

encoding.csv.quote

optional ascii_char

The quote character to use when writing CSV.

default: "

encoding.csv.quote_style

optional string literal enum

The quoting style to use when writing CSV data.

Enum options

Option	Description
`always`	Always puts quotes around every field.
`necessary`	Puts quotes around fields only when necessary. They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field).
`never`	Never writes quotes, even if it produces invalid CSV data.
`non_numeric`	Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, then quotes are used even if they aren’t strictly necessary.

default: necessary

encoding.except_fields

optional [string]

List of fields that are excluded from the encoded event.

encoding.json

optional object

Options for the JsonSerializer.

Relevant when: codec = "json"

encoding.json.pretty

optional bool

Whether to use pretty JSON formatting.

default: false

encoding.metric_tag_values

optional string literal enum

Controls how metric tag values are encoded.

When set to single, only the last non-bare value of tags are displayed with the metric. When set to full, all metric tags are exposed as separate assignments.

Relevant when: codec = "json" or codec = "text"

Enum options

Option	Description
`full`	All tags are exposed as arrays of either string or null values.
`single`	Tag values are exposed as single strings, the same as they were before this config option. Tags with multiple values show the last assigned value, and null values are ignored.

default: single

encoding.only_fields

optional [string]

List of fields that are included in the encoded event.

encoding.protobuf

required object

Options for the Protobuf serializer.

Relevant when: codec = "protobuf"

encoding.protobuf.desc_file

required string literal

The path to the protobuf descriptor set file.

This file is the output of protoc -o <path> ...

Examples

"/etc/vector/protobuf_descriptor_set.desc"

encoding.protobuf.message_type

required string literal

The name of the message type to use for serializing.

Examples

"package.Message"

encoding.timestamp_format

optional string literal enum

Format used for timestamp fields.

Enum options

Option	Description
`rfc3339`	Represent the timestamp as a RFC 3339 timestamp.
`unix`	Represent the timestamp as a Unix timestamp.
`unix_float`	Represent the timestamp as a Unix timestamp in floating point.
`unix_ms`	Represent the timestamp as a Unix timestamp in milliseconds.
`unix_ns`	Represent the timestamp as a Unix timestamp in nanoseconds.
`unix_us`	Represent the timestamp as a Unix timestamp in microseconds

endpoint

optional string literal

Custom endpoint for use with AWS-compatible services.

Examples

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

healthcheck

optional object

Healthcheck configuration.

healthcheck.enabled

optional bool

Whether or not to check the health of the sink when Vector starts up.

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

message_deduplication_id

optional string literal

The message deduplication ID value to allow AWS to identify duplicate messages.

This value is a template which should result in a unique string for each event. See the AWS documentation for more about how AWS does message deduplication.

Examples

"{{ transaction_id }}"

message_group_id

optional string literal

The tag that specifies that a message belongs to a specific message group.

Can be applied only to FIFO queues.

Examples

"vector"

"vector-%Y-%m-%d"

proxy

optional object

Proxy configuration.

Configure to proxy traffic through an HTTP(S) proxy when making external requests.

Similar to common proxy configuration convention, you can set different proxies to use based on the type of traffic being proxied. You can also set specific hosts that should not be proxied.

proxy.enabled

optional bool

Enables proxying support.

default: true

proxy.http

optional string literal

Proxy endpoint to use when proxying HTTP traffic.

Must be a valid URI string.

Examples

"http://foo.bar:3128"

proxy.https

optional string literal

Proxy endpoint to use when proxying HTTPS traffic.

Must be a valid URI string.

Examples

"http://foo.bar:3128"

proxy.no_proxy

optional [string]

A list of hosts to avoid proxying.

Multiple patterns are allowed:

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

queue_url

required string literal

The URL of the Amazon SQS queue to which messages are sent.

Examples

"https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue"

region

optional string literal

The AWS region of the target service.

Examples

"us-east-1"

request

optional object

Middleware settings for outbound requests.

Various settings can be configured, such as concurrency and rate limits, timeouts, retry behavior, etc.

Note that the retry backoff policy follows the Fibonacci sequence.

request.adaptive_concurrency

optional object

Configuration of adaptive concurrency parameters.

These parameters typically do not require changes from the default, and incorrect values can lead to meta-stable or unstable performance and sink behavior. Proceed with caution.

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 weighting of new measurements compared to older measurements.

Valid values are greater than 0 and less than 1.

ARC uses an exponentially weighted moving average (EWMA) of past RTT measurements as a reference to compare with the current RTT. Smaller values cause this reference to adjust more slowly, which may be useful if a service has unusually high response variability.

default: 0.4

request.adaptive_concurrency.initial_concurrency

optional uint

The initial concurrency limit to use. If not specified, the initial limit will be 1 (no concurrency).

It is recommended to set this value to your service’s average limit if you’re seeing that it takes a long time to ramp up adaptive concurrency after a restart. You can find this value by looking at the adaptive_concurrency_limit metric.

default: 1

request.adaptive_concurrency.max_concurrency_limit

optional uint

The maximum concurrency limit.

The adaptive request concurrency limit will not go above this bound. This is put in place as a safeguard.

default: 200

request.adaptive_concurrency.rtt_deviation_scale

optional float

Scale of RTT deviations which are not considered anomalous.

Valid values are greater than or equal to 0, and we expect reasonable values to range from 1.0 to 3.0.

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. Larger values cause the algorithm to ignore larger increases in the RTT.

default: 2.5

request.concurrency

optional string literal enum uint

Configuration for outbound request concurrency.

This can be set either to one of the below enum values or to a positive integer, which denotes a fixed concurrency limit.

Enum options

Option Description

adaptive Concurrency will be managed by Vector’s Adaptive Request Concurrency feature.

Option	Description
`adaptive`	Concurrency will be managed by Vector’s Adaptive Request Concurrency feature.
`none`	A fixed concurrency of 1. Only one request can be outstanding at any given time.

none

A fixed concurrency of 1.

Only one request can be outstanding at any given time.

default: adaptive

request.rate_limit_duration_secs

optional uint

The time window 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 (requests)

request.retry_attempts

optional uint

The maximum number of retries to make for failed requests.

default: 9.223372036854776e+18 (retries)

request.retry_initial_backoff_secs

optional uint

The amount of time to wait before attempting the first retry for a failed request.

After the first retry has failed, the fibonacci sequence is used to select future backoffs.

default: 1 (seconds)

request.retry_jitter_mode

optional string literal enum

The jitter mode to use for retry backoff behavior.

Enum options

Option Description

Option	Description
`Full`	Full jitter. The random delay is anywhere from 0 up to the maximum current delay calculated by the backoff strategy. Incorporating full jitter into your backoff strategy can greatly reduce the likelihood of creating accidental denial of service (DoS) conditions against your own systems when many clients are recovering from a failure state.
`None`	No jitter.

Full

Full jitter.

The random delay is anywhere from 0 up to the maximum current delay calculated by the backoff strategy.

Incorporating full jitter into your backoff strategy can greatly reduce the likelihood of creating accidental denial of service (DoS) conditions against your own systems when many clients are recovering from a failure state.

None No jitter.

default: Full

request.retry_max_duration_secs

optional uint

The maximum amount of time to wait between retries.

default: 30 (seconds)

request.timeout_secs

optional uint

The time a request can take before being aborted.

Datadog highly recommends 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)

tls

optional object

TLS configuration.

tls.alpn_protocols

optional [string]

Sets the list of supported ALPN protocols.

Declare the supported ALPN protocols, which are used during negotiation with peer. They are prioritized in the order that they are defined.

tls.ca_file

optional string literal

Absolute path to an additional CA certificate file.

The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string 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 server.

The certificate must be in DER, PEM (X.509), or PKCS#12 format. Additionally, the certificate can be provided as an inline string 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

optional string literal

Absolute path to a private key file used to identify this server.

The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.

Examples

"/path/to/host_certificate.key"

tls.key_pass

optional string literal

Passphrase used to unlock the encrypted key file.

This has no effect unless key_file is set.

Examples

"${KEY_PASS_ENV_VAR}"

"PassWord1"

tls.server_name

optional string literal

Server name to use when using Server Name Indication (SNI).

Only relevant for outgoing connections.

Examples

"www.example.com"

tls.verify_certificate

optional bool

Enables certificate verification. For components that create a server, this requires that the client connections have a valid client certificate. For components that initiate requests, this validates that the upstream has a valid certificate.

If enabled, certificates must not be expired and must be issued by a trusted issuer. This verification operates in a hierarchical manner, checking that the leaf certificate (the certificate presented by the client/server) is not only valid, but that the issuer of that certificate is also valid, and so on until the verification process reaches a root certificate.

Do NOT set this to false unless you understand the risks of not verifying the validity of certificates.

tls.verify_hostname

optional bool

Enables hostname verification.

If enabled, the hostname used to connect to the remote host must be present in the TLS certificate presented by the remote host, either as the Common Name or as an entry in the Subject Alternative Name extension.

Only relevant for outgoing connections.

Do NOT set this to false unless you understand the risks of not verifying the remote hostname.

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

intentional

True if the events were discarded intentionally, like a filter transform, or false if due to an error.

pid optional

The process ID of the Vector instance.

component_errors_total

counter

The total number of errors encountered by this component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

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.

stage

The stage within the component at which the error occurred.

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

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_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
`sqs:GetTopicAttributes`	`healthcheck`
`sqs:Publish`	`operation`

How it works

AWS authentication

Vector checks for AWS credentials in the following order:

The auth.access_key_id and auth.secret_access_key options.
The AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.
In Web Identity Token credentials from the environment or container (including EKS). These credentials will automatically refresh when expired.
ECS credentials (IAM roles for tasks). These credentials will automatically refresh when expired.
As entries in the credentials file in the .aws directory in your home directory (~/.aws/credentials on Linux, OS X, and Unix; %userprofile%\.aws\credentials on Microsoft Windows).
Using a named profile specified in the credentials file via the AWS_PROFILE environment variable.
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. These credentials will automatically refresh when expired.

If no credentials are found, Vector’s health check fails and an error is 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. Such created AWS access keys can be used via auth.access_key_id and auth.secret_access_key options.

Assuming roles

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

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.yaml --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 & 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
			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 via the tls.* options and/or via an OpenSSL configuration file. The file location defaults to /usr/local/ssl/openssl.cnf or can be specified with the OPENSSL_CONF environment variable.