AWS S3 source

Requirements

The AWS S3 source requires a SQS queue configured to receive S3 bucket notifications for the desired S3 buckets.

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "aws_s3",
      "acknowledgements": null,
      "region": "us-east-1",
      "sqs": null
    }
  }
}

[sources.my_source_id]
type = "aws_s3"
region = "us-east-1"

---
sources:
  my_source_id:
    type: aws_s3
    acknowledgements: null
    region: us-east-1
    sqs: null

{
  "sources": {
    "my_source_id": {
      "type": "aws_s3",
      "auth": null,
      "endpoint": "http://127.0.0.0:5000/path/to/service",
      "acknowledgements": null,
      "strategy": "sqs",
      "compression": "text",
      "multiline": null,
      "proxy": null,
      "tls": null,
      "region": "us-east-1",
      "sqs": null
    }
  }
}

[sources.my_source_id]
type = "aws_s3"
endpoint = "http://127.0.0.0:5000/path/to/service"
strategy = "sqs"
compression = "text"
region = "us-east-1"

---
sources:
  my_source_id:
    type: aws_s3
    auth: null
    endpoint: http://127.0.0.0:5000/path/to/service
    acknowledgements: null
    strategy: sqs
    compression: text
    multiline: null
    proxy: null
    tls: null
    region: us-east-1
    sqs: null

acknowledgements

common optional object

Controls how acknowledgements are handled by this source. These settings override the global acknowledgement settings. This setting is deprecated in favor of enabling acknowledgements in the destination sink.

acknowledgements.enabled

common optional bool

Controls if the source will wait for destination sinks to deliver the events before acknowledging receipt.

default: false

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"

compression

optional string literal enum

The compression format of the S3 objects..

Enum options string literal

Option	Description
`auto`	Vector will try to determine the compression format of the object from its: `Content-Encoding` metadata, `Content-Type` metadata, and key suffix (e.g. `.gz`). It will fallback to ‘none’ if it cannot determine the compression.
`gzip`	GZIP format.
`none`	Uncompressed.
`zstd`	ZSTD format.

default: text

endpoint

optional string literal

Custom endpoint for use with AWS-compatible services.

Examples

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

multiline

optional object

Multiline parsing configuration. If not specified, multiline parsing is disabled.

multiline.condition_pattern

required string regex

Condition regex pattern to look for. Exact behavior is configured via mode.

Examples

"^[\\s]+"

"\\\\$"

"^(INFO|ERROR) "

";$"

multiline.mode

required string literal enum

Mode of operation, specifies how the condition_pattern is interpreted.

Enum options

Option	Description
`continue_past`	All consecutive lines matching this pattern, plus one additional line, are included in the group. This is useful in cases where a log message ends with a continuation marker, such as a backslash, indicating that the following line is part of the same message.
`continue_through`	All consecutive lines matching this pattern are included in the group. The first line (the line that matched the start pattern) does not need to match the `ContinueThrough` pattern. This is useful in cases such as a Java stack trace, where some indicator in the line (such as leading whitespace) indicates that it is an extension of the preceding line.
`halt_before`	All consecutive lines not matching this pattern are included in the group. This is useful where a log line contains a marker indicating that it begins a new message.
`halt_with`	All consecutive lines, up to and including the first line matching this pattern, are included in the group. This is useful where a log line ends with a termination marker, such as a semicolon.

Examples

"continue_through"

"continue_past"

"halt_before"

"halt_with"

multiline.start_pattern

required string regex

Start regex pattern to look for as a beginning of the message.

Examples

"^[^\\s]"

"\\\\$"

"^(INFO|ERROR) "

"[^;]$"

multiline.timeout_ms

required uint

The maximum time to wait for the continuation. Once this timeout is reached, the buffered message is guaranteed to be flushed, even if incomplete.

Examples

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"

sqs

common optional object

SQS strategy options. Required if strategy=sqs.

sqs.delete_message

common optional bool

Whether to delete the message once Vector processes it. It can be useful to set this to false to debug or during initial Vector setup.

default: true

sqs.poll_secs

common optional uint

How long to wait when polling SQS for new messages.

default: 15 (seconds)

sqs.queue_url

required string literal

The URL of the SQS queue to receive bucket notifications from.

Examples

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

sqs.visibility_timeout_secs

optional uint

The visibility timeout to use for messages in secords. This controls how long a message is left unavailable when a Vector receives it. If a vector does not delete the message before the timeout expires, it will be made reavailable for another consumer; this can happen if, for example, the vector process crashes.

default: 300 (seconds)

strategy

optional string literal enum

The strategy to use to consume objects from AWS S3.

Enum options string literal

Option	Description
`sqs`	Consume S3 objects by polling for bucket notifications sent to an AWS SQS queue.

default: sqs

tls

optional object

Configures the TLS options for outgoing connections.

tls.alpn_protocols

optional [string]

Sets the list of supported ALPN protolols, 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

HTTPS_PROXY

common optional string literal

The global URL to proxy HTTPS requests through.

If another HTTPS proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples

http://foo.bar:3128

HTTP_PROXY

common optional string literal

The global URL to proxy HTTP requests through.

If another HTTP proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples

http://foo.bar:3128

NO_PROXY

common optional string literal

List of hosts to avoid proxying globally.

Allowed patterns here include:

Pattern	Example match
Domain names	`example.com` matches requests to `example.com`
Wildcard domains	`.example.come` 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

If another no_proxy value is set in the configuration file or at a component level, this one is overridden.

The lowercase variant has priority over the uppercase one.

Examples

localhost,.example.com,192.168.0.0./16

http_proxy

common optional string literal

The global URL to proxy HTTP requests through.

If another HTTP proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples

http://foo.bar:3128

https_proxy

common optional string literal

The global URL to proxy HTTPS requests through.

If another HTTPS proxy is set in the configuration file or at a component level, this one will be overridden.

The lowercase variant has priority over the uppercase one.

Examples

http://foo.bar:3128

no_proxy

common optional string literal

List of hosts to avoid proxying globally.

Allowed patterns here include:

Pattern	Example match
Domain names	`example.com` matches requests to `example.com`
Wildcard domains	`.example.come` 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

If another no_proxy value is set in the configuration file or at a component level, this one is overridden.

The lowercase variant has priority over the uppercase one.

Examples

localhost,.example.com,192.168.0.0./16

Outputs

<component_id>

Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks.

Output Data

Logs

Object

A line from an S3 object.

Fields

bucket required string literal

The bucket of the object the line came from.

Examples

my-bucket

message required string literal

A line from the S3 object.

Examples

53.126.150.246 - - [01/Oct/2020:11:25:58 -0400] "GET /disintermediate HTTP/2.0" 401 20308

object required string literal

The object the line came from.

Examples

AWSLogs/111111111111/vpcflowlogs/us-east-1/2020/10/26/111111111111_vpcflowlogs_us-east-1_fl-0c5605d9f1baf680d_20201026T1950Z_b1ea4a7a.log.gz

region required string literal

The AWS region bucket is in.

Examples

us-east-1

source_type required string literal

The name of the source type.

Examples

aws_s3

timestamp required timestamp

The Last-Modified time of the object. Defaults the current timestamp if this information is missing.

Examples

2020-10-10T17:07:36.452332Z

Telemetry

Metrics

link

component_discarded_events_total

counter

The number of events dropped 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.

pid optional

The process ID of the Vector instance.

component_errors_total

counter

The total number of 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.

stage required

The stage within the component at which the error occurred.

component_received_bytes_total

counter

The number of raw bytes accepted by this component from source 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_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_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_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_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.

source_lag_time_seconds

histogram

The difference between the timestamp recorded in each event and the time when it was ingested, expressed as fractional 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.

sqs_message_delete_failed_total

counter

The total number of failures to delete SQS messages.

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.

sqs_message_delete_succeeded_total

counter

The total number of successful deletions of SQS messages.

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.

sqs_message_processing_failed_total

counter

The total number of failures to process SQS messages.

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.

sqs_message_processing_succeeded_total

counter

The total number of SQS messages successfully processed.

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.

sqs_message_receive_failed_total

counter

The total number of failures to receive SQS messages.

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.

sqs_message_receive_succeeded_total

counter

The total number of times successfully receiving SQS messages.

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.

sqs_message_received_messages_total

counter

The total number of received SQS messages.

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.

sqs_s3_event_record_ignored_total

counter

The total number of times an S3 record in an SQS message was ignored (for an event that was not ObjectCreated).

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.

ignore_type required

The reason for ignoring the S3 record

pid optional

The process ID of the Vector instance.

Permissions

Platform: Amazon Web Services

Relevant policies

Policy	Required for	Required when
`s3:GetObject`	`operation`

Platform: Amazon Web Services

Relevant policies

Policy	Required for	Required when
`sqs:ReceiveMessage`	`operation`	`strategy` is set to `sqs`
`sqs:DeleteMessage`	`operation`	`strategy` is set to `sqs` and `delete_message` is set to `true`

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.

Context

By default, the aws_s3 source augments events with helpful context keys.

Handling events from the `aws_s3` source

This source behaves very similarly to the file source in that it will output one event per line (unless the multiline configuration option is used).

You will commonly want to use transforms to parse the data. For example, to parse VPC flow logs sent to S3 you can chain the remap transform:

[transforms.flow_logs]
type = "remap" # required
inputs = ["s3"]
drop_on_error = false
source = '''
. = parse_aws_vpc_flow_log!(string!(.message))
'''

To parse AWS load balancer logs, the remap transform can be used:

[transforms.elasticloadbalancing_fields_parsed]
type = "remap" # required
inputs = ["s3"]
drop_on_error = false
source = '''
. = parse_aws_alb_log!(string!(.message))
.request_url_parts = parse_url!(.request_url)
'''

State

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

Transport Layer Security (TLS)

Vector uses OpenSSL for TLS protocols. You can adjust TLS behavior via the tls.* options.

AWS S3

Requirements

Configuration

Example configurations

Environment variables

Outputs

Output Data

Object

Fields

Telemetry

component_discarded_events_total

component_errors_total

component_received_bytes_total

component_received_event_bytes_total

component_received_events_total

component_sent_event_bytes_total

component_sent_events_total

events_in_total

events_out_total

processed_bytes_total

source_lag_time_seconds

sqs_message_delete_failed_total

sqs_message_delete_succeeded_total

sqs_message_processing_failed_total

sqs_message_processing_succeeded_total

sqs_message_receive_failed_total

sqs_message_receive_succeeded_total

sqs_message_received_messages_total

sqs_s3_event_record_ignored_total

Permissions

How it works

AWS authentication

Obtaining an access key

Assuming roles

Context

Handling events from the aws_s3 source

State

Transport Layer Security (TLS)

Handling events from the `aws_s3` source