> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt
> Use this file to discover all available pages before exploring further.

# AWS S3 Event

<Badge className="hny-badge-enterprise-addon" stroke>Ent+</Badge>

<Note>
  This feature is available as an add-on for the [Honeycomb Enterprise plan](https://www.honeycomb.io/pricing/).
  Please contact your Honeycomb account team for details.
</Note>

The AWS S3 Event Receiver consumes S3 event notifications for object creation events (`s3:ObjectCreated:*`) and emits the S3 object as the string body of a log record.

## Supported Platforms

| Platform | Supported |
| -------- | --------- |
| Linux    | ✓         |
| Windows  | ✓         |
| macOS    | ✓         |

Available in the Bindplane Distro for OpenTelemetry Collector `v1.74.0+`.

## Prerequisites

* An AWS account with access to S3 and SQS.
* An SQS queue configured to receive S3 event notifications.

1. Ensure the collector has permission to read and delete messages from the SQS queue.
2. Ensure the collector has permission to read objects from the S3 bucket.

## How It Works

1. The receiver polls an SQS queue for S3 event notifications.
2. When an object creation event (`s3:ObjectCreated:*`) is received, the receiver downloads the S3 object.
3. The receiver reads the object into the body of a new log record.
4. Non-object creation events are ignored but removed from the queue.
5. If an S3 object is not found (404 error), the corresponding SQS message is preserved for retry later.

## Configuration Fields

<table><thead><tr><th>Field</th><th>Type</th><th>Default</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td>sqs\_queue\_url</td><td>string</td><td /><td><code>true</code></td><td>The URL of the SQS queue to poll for S3 event notifications.</td></tr><tr><td>standard\_poll\_interval</td><td>duration</td><td>15</td><td><code>false</code></td><td>The interval (in seconds) at which the SQS queue is polled for messages.</td></tr><tr><td>max\_poll\_interval</td><td>duration</td><td>2</td><td><code>false</code></td><td>The maximum interval (in seconds) at which the SQS queue is polled for messages.</td></tr><tr><td>polling\_backoff\_factor</td><td>float</td><td>2</td><td><code>false</code></td><td>The factor by which the polling interval is multiplied after an unsuccessful poll.</td></tr><tr><td>workers</td><td>int</td><td>5</td><td><code>false</code></td><td>The number of workers to process events.</td></tr><tr><td>visibility\_timeout</td><td>duration</td><td>300</td><td><code>false</code></td><td>How long (in seconds) messages received from the queue will be invisible to other consumers.</td></tr><tr><td>visibility\_extension\_interval</td><td>duration</td><td>1m</td><td><code>false</code></td><td>How often to extend message visibility during processing. Should be less than visibility\_timeout. Minimum is 10s.</td></tr><tr><td>max\_visibility\_window</td><td>duration</td><td>1h</td><td><code>false</code></td><td>Maximum total time a message can remain invisible before becoming visible to other consumers. Must be less than SQS's 12-hour limit.</td></tr><tr><td>max\_log\_size</td><td>int</td><td>1048576</td><td><code>false</code></td><td>The maximum size of a log record in bytes. Logs exceeding this size will be split</td></tr><tr><td>max\_logs\_emitted</td><td>int</td><td>1000</td><td><code>false</code></td><td>The maximum number of log records to emit in a single batch. A higher number will result in fewer batches, but more memory.</td></tr><tr><td>bucket\_name\_filter</td><td>string</td><td /><td><code>false</code></td><td>When set, the source will only emit logs for bucket names that match the specified regex.</td></tr><tr><td>object\_key\_filter</td><td>string</td><td /><td><code>false</code></td><td>When set, the source will only emit logs for object names that match the specified regex.</td></tr><tr><td>notification\_type</td><td>enum</td><td><code>s3</code></td><td><code>false</code></td><td>Options are <code>s3</code> and <code>sns</code>. S3 notifications are the default for S3 to SQS. SNS is for S3 notifications sent via SNS to SQS.</td></tr><tr><td>enable\_offset\_storage</td><td>bool</td><td><code>false</code></td><td><code>false</code></td><td>When enabled, the current position into an object will be saved to Redis, and reading will resume from where it left off after a collector restart.</td></tr><tr><td>redis\_hostname</td><td>string</td><td /><td><code>false</code></td><td>The hostname or IP address of the Redis server used for offset storage.</td></tr><tr><td>redis\_port</td><td>int</td><td>6379</td><td><code>false</code></td><td>The port number of the Redis server used for offset storage.</td></tr><tr><td>redis\_password</td><td>string</td><td /><td><code>false</code></td><td>The password for the Redis server used for offset storage.</td></tr><tr><td>redis\_database</td><td>string</td><td /><td><code>false</code></td><td>The Redis database number to use for offset storage.</td></tr><tr><td>redis\_expiration</td><td>int</td><td>0</td><td><code>false</code></td><td>The expiration time (in seconds) for offset storage in Redis.</td></tr><tr><td>redis\_tls\_enabled</td><td>bool</td><td><code>false</code></td><td><code>false</code></td><td>Whether to enable TLS for the Redis connection.</td></tr><tr><td>redis\_tls\_ca\_file</td><td>string</td><td /><td><code>false</code></td><td>The path to the CA file for Redis TLS connection.</td></tr><tr><td>redis\_tls\_cert\_file</td><td>string</td><td /><td><code>false</code></td><td>The path to the client certificate file for Redis TLS connection.</td></tr><tr><td>redis\_tls\_key\_file</td><td>string</td><td /><td><code>false</code></td><td>The path to the client key file for Redis TLS connection.</td></tr></tbody></table>

## Component Telemetry

This component emits telemetry that can provide insight into how it is performing. The collector is configured to emit these metrics to `localhost:8888/metrics` by default.

<table><thead><tr><th>Metric Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>otelcol\_s3event\_batch\_size</td><td>histogram</td><td>The number of logs in a batch.</td></tr><tr><td>otelcol\_s3event\_objects\_handled\_total</td><td>counter</td><td>The number of S3 objects processed by the receiver.</td></tr><tr><td>otelcol\_s3event\_failures\_total</td><td>counter</td><td>The number of failures encountered while processing S3 objects.</td></tr></tbody></table>
