AWS S3

Collect logs from AWS S3

status: beta role: aggregator delivery: at-least-once egress: stream state: stateless output: log

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",
      "region": "us-east-1"
    }
  }
}
[sources.my_source_id]
type = "aws_s3"
region = "us-east-1"
---
sources:
  my_source_id:
    type: aws_s3
    region: us-east-1
    sqs: null
{
  "sources": {
    "my_source_id": {
      "type": "aws_s3",
      "endpoint": "127.0.0.0:5000/path/to/service",
      "strategy": "sqs",
      "compression": "text",
      "region": "us-east-1"
    }
  }
}
[sources.my_source_id]
type = "aws_s3"
endpoint = "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: 127.0.0.0:5000/path/to/service
    strategy: sqs
    compression: text
    multiline: null
    region: us-east-1
    sqs: null

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.

auth.assume_role

optional string literal
The ARN of an IAM role to assume at startup.

auth.secret_access_key

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

compression

optional string enum
The compression format of the S3 objects..
Enum options string literal
OptionDescription
autoVector 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.
gzipGZIP format.
noneUncompressed.
zstdZSTD format.
default: text

endpoint

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

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.

multiline.mode

required string enum literal
Mode of operation, specifies how the condition_pattern is interpreted.
Enum options
OptionDescription
continue_pastAll 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_throughAll 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_beforeAll 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_withAll 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.

multiline.start_pattern

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

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.

region

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

sqs

common optional object
SQS strategy options. Required if strategy=sqs.

sqs.delete_message

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

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 receieve bucket notifications from.

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 enum
The strategy to use to consume objects from AWS S3.
Enum options string literal
OptionDescription
sqsConsume S3 objects by polling for bucket notifications sent to an AWS SQS queue.
default: sqs

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_CREDENTIAL_EXPIRATION

common optional string literal
Expiration time in RFC 3339 format. If unset, credentials won’t expire.
Examples
1996-12-19T16:39:57-08:00

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

Output

Logs

object

A line from an S3 object.

Telemetry

Metrics

link

events_in_total

counter
The number of events accepted by this component either from tagged origin like file and uri, or cumulatively from other origins.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the event originates.
file optional
The file from which the event originates.
host required
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 event originates.
peer_path optional
The pathname from which the event originates.
pid required
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the event originates.
uri optional
The sanitized URI from which the event originates.

events_out_total

counter
The total number of events emitted by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

processed_bytes_total

counter
The number of bytes processed by the component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
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 required
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 required
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.

sqs_message_delete_failed_total

counter
The total number of failures to delete SQS messages.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

sqs_message_delete_succeeded_total

counter
The total number of successful deletions of SQS messages.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

sqs_message_processing_failed_total

counter
The total number of failures to process SQS messages.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

sqs_message_processing_succeeded_total

counter
The total number of SQS messages successfully processed.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

sqs_message_receive_failed_total

counter
The total number of failures to receive SQS messages.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

sqs_message_receive_succeeded_total

counter
The total number of times successfully receiving SQS messages.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

sqs_message_received_messages_total

counter
The total number of received SQS messages.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
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_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
ignore_type required
The reason for ignoring the S3 record
pid required
The process ID of the Vector instance.

Permissions

Platform: Amazon Web Services
Relevant policies
PolicyRequired forRequired when
s3:GetObjectwrite
Platform: Amazon Web Services
Relevant policies
PolicyRequired forRequired when
sqs:ReceiveMessagewritestrategy is set to sqs
sqs:DeleteMessagewritestrategy 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:

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

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 tokenizer transform:

[transforms.flow_logs]
type = "tokenizer" # required
inputs = ["s3"]
field_names = ["version", "account_id", "interface_id", "srcaddr", "dstaddr", "srcport", "dstport", "protocol", "packets", "bytes", "start", "end", "action", "log_status"]

types.srcport = "int"
types.dstport = "int"
types.packets = "int"
types.bytes = "int"
types.start = "timestamp|%s"
types.end = "timestamp|%s"

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

[transforms.elasticloadbalancing_fields_parsed]
type = "regex_parser"
inputs = ["s3"]
regex = '(?x)^
		(?P<type>[\w]+)[ ]
		(?P<timestamp>[\w:.-]+)[ ]
		(?P<elb>[^\s]+)[ ]
		(?P<client_host>[\d.:-]+)[ ]
		(?P<target_host>[\d.:-]+)[ ]
		(?P<request_processing_time>[\d.-]+)[ ]
		(?P<target_processing_time>[\d.-]+)[ ]
		(?P<response_processing_time>[\d.-]+)[ ]
		(?P<elb_status_code>[\d-]+)[ ]
		(?P<target_status_code>[\d-]+)[ ]
		(?P<received_bytes>[\d-]+)[ ]
		(?P<sent_bytes>[\d-]+)[ ]
		"(?P<request_method>[\w-]+)[ ]
		(?P<request_url>[^\s]+)[ ]
		(?P<request_protocol>[^"\s]+)"[ ]
		"(?P<user_agent>[^"]+)"[ ]
		(?P<ssl_cipher>[^\s]+)[ ]
		(?P<ssl_protocol>[^\s]+)[ ]
		(?P<target_group_arn>[\w.:/-]+)[ ]
		"(?P<trace_id>[^\s"]+)"[ ]
		"(?P<domain_name>[^\s"]+)"[ ]
		"(?P<chosen_cert_arn>[\w:./-]+)"[ ]
		(?P<matched_rule_priority>[\d-]+)[ ]
		(?P<request_creation_time>[\w.:-]+)[ ]
		"(?P<actions_executed>[\w,-]+)"[ ]
		"(?P<redirect_url>[^"]+)"[ ]
		"(?P<error_reason>[^"]+)"'
field = "message"
drop_failed = false

types.received_bytes = "int"
types.request_processing_time = "float"
types.sent_bytes = "int"
types.target_processing_time = "float"
types.response_processing_time = "float"

[transforms.elasticloadbalancing_url_parsed]
type = "regex_parser"
inputs = ["elasticloadbalancing_fields_parsed"]
regex = '^(?P<url_scheme>[\w]+)://(?P<url_hostname>[^\s:/?#]+)(?::(?P<request_port>[\d-]+))?-?(?:/(?P<url_path>[^\s?#]*))?(?P<request_url_query>\?[^\s#]+)?'
field = "request_url"
drop_failed = false

State

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