Skip to content

Latest commit

 

History

History
88 lines (67 loc) · 6.2 KB

File metadata and controls

88 lines (67 loc) · 6.2 KB

AWS S3 Exporter for OpenTelemetry Collector

Status
Stability alpha: traces, metrics, logs
Distributions contrib, observiq, splunk, sumo
Issues Open issues Closed issues
Code Owners @atoulme, @pdelewski

Schema supported

This exporter targets to support proto/json format.

Exporter Configuration

The following exporter configuration parameters are supported.

Name Description Default
region AWS region. "us-east-1"
s3_bucket S3 bucket
s3_prefix prefix for the S3 key (root directory inside bucket).
s3_partition time granularity of S3 key: hour or minute "minute"
role_arn the Role ARN to be assumed
file_prefix file prefix defined by user
marshaler marshaler used to produce output data otlp_json
encoding Encoding extension to use to marshal data. Overrides the marshaler configuration option if set.
encoding_file_extension file format extension suffix when using the encoding configuration option. May be left empty for no suffix to be appended.
endpoint overrides the endpoint used by the exporter instead of constructing it from region and s3_bucket
s3_force_path_style set this to true to force the request to use path-style addressing false
disable_ssl set this to true to disable SSL when sending requests false
compression should the file be compressed none

Marshaler

Marshaler determines the format of data sent to AWS S3. Currently, the following marshalers are implemented:

Encoding

Encoding overrides marshaler if present and sets to use an encoding extension defined in the collector configuration.

See https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/encoding.

Compression

  • none (default): No compression will be applied
  • gzip: Files will be compressed with gzip. This does not support sumo_icmarshaler.

Example Configuration

Following example configuration defines to store output in 'eu-central' region and bucket named 'databucket'.

exporters:
  awss3:
    s3uploader:
        region: 'eu-central-1'
        s3_bucket: 'databucket'
        s3_prefix: 'metric'
        s3_partition: 'minute'

Logs and traces will be stored inside 'databucket' in the following path format.

metric/year=XXXX/month=XX/day=XX/hour=XX/minute=XX

AWS Credential Configuration

This exporter follows default credential resolution for the aws-sdk-go.

Follow the guidelines for the credential configuration.