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

[sources.my_source_id]
type = "aws_s3"

sources:
  my_source_id:
    type: aws_s3

{
  "sources": {
    "my_source_id": {
      "type": "aws_s3",
      "compression": "auto",
      "endpoint": "http://127.0.0.0:5000/path/to/service",
      "region": "us-east-1"
    }
  }
}

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

sources:
  my_source_id:
    type: aws_s3
    compression: auto
    endpoint: http://127.0.0.0:5000/path/to/service
    region: us-east-1

acknowledgements

optional object

Deprecated

This field is deprecated.

Controls how acknowledgements are handled by this source.

This setting is deprecated in favor of enabling acknowledgements at the global or sink level.

Enabling or disabling acknowledgements at the source level has no effect on acknowledgement behavior.

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 for this source.

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

Option	Description
`auto`	Automatically attempt to determine the compression scheme. The compression scheme of the object is determined from its `Content-Encoding` and `Content-Type` metadata, as well as the key suffix (for example, `.gz`). It is set to `none` if the compression scheme cannot be determined.
`gzip`	GZIP.
`none`	Uncompressed.
`zstd`	ZSTD.

decoding

optional object

Configures how events are decoded from raw bytes.

Option	Description
`bytes`	Uses the raw bytes as-is.
`gelf`	Decodes the raw bytes as a GELF message.
`json`	Decodes the raw bytes as JSON.
`native`	Decodes the raw bytes as native Protocol Buffers format. This codec is experimental.
`native_json`	Decodes the raw bytes as native JSON format. This codec is experimental.
`protobuf`	Decodes the raw bytes as protobuf.
`syslog`	Decodes the raw bytes as a Syslog message. Decodes either as the RFC 3164-style format (“old” style) or the RFC 5424-style format (“new” style, includes structured data).

decoding.gelf

optional object

GELF-specific decoding options.

Relevant when: codec = "gelf"

decoding.gelf.lossy

optional bool

Determines whether or not to replace invalid UTF-8 sequences instead of failing.

When true, invalid UTF-8 sequences are replaced with the U+FFFD REPLACEMENT CHARACTER.

default: true

decoding.json

optional object

JSON-specific decoding options.

Relevant when: codec = "json"

decoding.json.lossy

optional bool

Determines whether or not to replace invalid UTF-8 sequences instead of failing.

When true, invalid UTF-8 sequences are replaced with the U+FFFD REPLACEMENT CHARACTER.

default: true

decoding.native_json

optional object

Vector’s native JSON-specific decoding options.

Relevant when: codec = "native_json"

decoding.native_json.lossy

optional bool

Determines whether or not to replace invalid UTF-8 sequences instead of failing.

When true, invalid UTF-8 sequences are replaced with the U+FFFD REPLACEMENT CHARACTER.

default: true

decoding.protobuf

optional object

Protobuf-specific decoding options.

Relevant when: codec = "protobuf"

decoding.protobuf.desc_file

optional string literal

Path to desc file

decoding.protobuf.message_type

optional string literal

message type. e.g package.message

decoding.syslog

optional object

Syslog-specific decoding options.

Relevant when: codec = "syslog"

decoding.syslog.lossy

optional bool

Determines whether or not to replace invalid UTF-8 sequences instead of failing.

When true, invalid UTF-8 sequences are replaced with the U+FFFD REPLACEMENT CHARACTER.

default: true

endpoint

optional string literal

Custom endpoint for use with AWS-compatible services.

Examples

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

Framing handles how events are separated when encoded in a raw byte form, where each event is a frame that must be prefixed, or delimited, in a way that marks where an event begins and ends within the byte stream.

framing.character_delimited

required object

Options for the character delimited decoder.

Relevant when: method = "character_delimited"

framing.character_delimited.delimiter

required uint

The character that delimits byte sequences.

framing.character_delimited.max_length

optional uint

The maximum length of the byte buffer.

This length does not include the trailing delimiter.

By default, there is no maximum length enforced. If events are malformed, this can lead to additional resource usage as events continue to be buffered in memory, and can potentially lead to memory exhaustion in extreme cases.

If there is a risk of processing malformed data, such as logs with user-controlled input, consider setting the maximum length to a reasonably large value as a safety net. This ensures that processing is not actually unbounded.

framing.method

optional string literal enum

The framing method.

Enum options

Option	Description
`bytes`	Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments).
`character_delimited`	Byte frames which are delimited by a chosen character.
`length_delimited`	Byte frames which are prefixed by an unsigned big-endian 32-bit integer indicating the length.
`newline_delimited`	Byte frames which are delimited by a newline character.
`octet_counting`	Byte frames according to the octet counting format.

default: newline_delimited

framing.newline_delimited

optional object

Options for the newline delimited decoder.

Relevant when: method = "newline_delimited"

framing.newline_delimited.max_length

optional uint

The maximum length of the byte buffer.

This length does not include the trailing delimiter.

framing.octet_counting

optional object

Options for the octet counting decoder.

Relevant when: method = "octet_counting"

framing.octet_counting.max_length

optional uint

The maximum length of the byte buffer.

multiline

optional object

Multiline aggregation configuration.

If not specified, multiline aggregation is disabled.

multiline.condition_pattern

required string literal

Regular expression pattern that is used to determine whether or not more lines should be read.

This setting must be configured in conjunction with mode.

Examples

"^[\\s]+"

"\\\\$"

"^(INFO|ERROR) "

";$"

multiline.mode

required string literal enum

Aggregation mode.

This setting must be configured in conjunction with condition_pattern.

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 a leading whitespace) indicates that it is an extension of the proceeding 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_past"

"continue_through"

"halt_before"

"halt_with"

multiline.start_pattern

required string literal

Regular expression pattern that is used to match the start of a new message.

Examples

"^[\\s]+"

"\\\\$"

"^(INFO|ERROR) "

";$"

multiline.timeout_ms

required uint

The maximum amount of time to wait for the next additional line, in milliseconds.

Once this timeout is reached, the buffered message is guaranteed to be flushed, even if incomplete.

Examples

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, as well as 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

region

optional string literal

The AWS region of the target service.

Examples

"us-east-1"

sqs

optional object

Configuration options for SQS.

sqs.client_concurrency

optional uint

Number of concurrent tasks to create for polling the queue for messages.

Defaults to the number of available CPUs on the system.

Should not typically need to be changed, but it can sometimes be beneficial to raise this value when there is a high rate of messages being pushed into the queue and the objects being fetched are small. In these cases, system resources may not be fully utilized without fetching more messages per second, as the SQS message consumption rate affects the S3 object retrieval rate.

Examples

sqs.delete_message

optional bool

Whether to delete the message once it is processed.

It can be useful to set this to false for debugging or during the initial setup.

default: true

sqs.poll_secs

optional uint

How long to wait while polling the queue for new messages, in seconds.

Generally, this should not be changed unless instructed to do so, as if messages are available, they are always consumed, regardless of the value of poll_secs.

default: 15 (seconds)

sqs.queue_url

required string literal

The URL of the SQS queue to poll for bucket notifications.

Examples

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

sqs.tls_options

optional object

TLS configuration.

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

sqs.tls_options.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"

sqs.tls_options.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"

sqs.tls_options.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"

sqs.tls_options.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"

sqs.tls_options.verify_certificate

optional bool

Enables certificate verification.

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.

Relevant for both incoming and outgoing connections.

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

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

sqs.visibility_timeout_secs

optional uint

The visibility timeout to use for messages, in seconds.

This controls how long a message is left unavailable after it is received. If a message is received, and takes longer than visibility_timeout_secs to process and delete the message from the queue, it is made available again for another consumer.

This can happen if there is an issue between consuming a message and deleting it.

default: 300 (seconds)

tls_options

optional object

TLS configuration.

tls_options.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_options.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_options.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_options.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_options.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_options.verify_certificate

optional bool

Enables certificate verification.

Relevant for both incoming and outgoing connections.

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

tls_options.verify_hostname

optional bool

Enables hostname verification.

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

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

Warning

The fields shown below will be different if log namespacing is enabled. See Log Namespacing for more details

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

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.

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_bytes_total

counter

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

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

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.

sqs_message_delete_succeeded_total

counter

The total number of successful deletions of SQS messages.

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.

sqs_message_processing_succeeded_total

counter

The total number of SQS messages successfully processed.

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.

sqs_message_receive_succeeded_total

counter

The total number of times successfully receiving SQS messages.

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.

sqs_message_received_messages_total

counter

The total number of received SQS messages.

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.

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

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.

ignore_type

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`
`sqs:DeleteMessage`	`operation`	`delete_message` is set to `true`

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.

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

AWS S3

Requirements

Configuration

Example configurations

Deprecated

Environment variables

Outputs

Output Data

Warning

Object

Fields

Telemetry

component_discarded_events_total

component_errors_total

component_received_bytes_total

component_received_event_bytes_total

component_received_events_count

component_received_events_total

component_sent_event_bytes_total

component_sent_events_total

source_lag_time_seconds

sqs_message_delete_succeeded_total

sqs_message_processing_succeeded_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