AWS S3

Collect logs from AWS S3

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.

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.

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

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.

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.

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

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

default: sqs