klahdenk/aws-otel-collector

AWS Distro for OpenTelemetry Collector

Overview

AWS Distro for OpenTelemetry Collector(AWS OTel Collector) is a AWS supported version of the upstream OpenTelemetry Collector and is distributed by Amazon. It supports the selected components from the OpenTelemetry community. It is fully compatible with AWS computing platforms including EC2, ECS and EKS. It enables users to send telemetry data to AWS CloudWatch Metrics, Traces and Logs backends as well as the other supported backends.

See the AWS Distro for OpenTelemetry documentation for more information.

Getting Help

Use the community resources below for getting help with AWS OTel Collector.

• Use GitHub issues for reporting bugs and requesting features.
• Join our GitHub Community for AWS Distro for OpenTelemetry to ask your questions, file issues, request enhancements.
• Open a support ticket with AWS Support.
• If you think you may have found a bug, open an issue.
• For contributing guidelines refer CONTRIBUTING.md.

AWS OTel Collector Built-in Components

This table represents the supported components of AWS OTel Collector in 2020. The highlighted components below are developed by AWS in-house. The rest of the components in the table are the essential default components that AWS OTel Collector will support.

Receiver	Processor	Exporter	Extensions
prometheusreceiver	attributesprocessor	awsxrayexporter	healthcheckextension
otlpreceiver	resourceprocessor	awsemfexporter	pprofextension
awsecscontainermetricsreceiver	batchprocessor	awsprometheusremotewriteexporter	zpagesextension
awsxrayreceiver	memorylimiter	loggingexporter	ecsobserver
statsdreceiver	tailsamplingprocessor	otlpexporter
zipkinreceiver	probabilisticsamplerprocessor	fileexporter
jaegerreceiver	spanprocessor	otlphttpexporter
awscontainerinsightreceiver	filterprocessor	prometheusexporter
	metricstransformprocessor	datadogexporter
	resourcedetectionprocessor	dynatraceexporter
		sapmexporter
		signalfxexporter
		logzioexporter

AWS OTel Collector AWS Components

• OpenTelemetry Collector
• Trace X-Ray Exporter
• Metrics EMF Exporter
• ECS Container Metrics Receiver
• StatsD Receiver
• ECS Observer Extension

Getting Started

Prerequisites

To build AWS OTel Collector locally, you will need to have Golang installed. You can download and install Golang here.

AWS OTel Collector Configuration

We built in a default configuration to our docker image and other format of release. So you can run AWS OTel Collector out of box with the default settings. Also, AWS OTel Collector configuration uses the same configuration syntax/design from OpenTelemetry Collector so you can customize or porting your OpenTelemetry Collector configuration files when running AWS OTel Collector. please refer Try out AWS OTel Collector section on configuring AWS OTel Collector.

Try out AWS OTel Collector

AWS OTel Collector supports all AWS computing platforms and docker/kubernetes. Here are some examples on how to run AWS OTel Collector to send telemetry data:

• Run it with Docker
• Run it with ECS
• Run it with EKS
• Run it on AWS Linux EC2
• Run it on AWS Windows EC2
• Run it on AWS Debian EC2

Build Your Own Artifacts

Use the following instruction to build your own AWS OTel Collector artifacts:

• Build Docker Image
• Build RPM/Deb/MSI

Development

See docs/developers

Release Process

• Release new version

Benchmark

The latest performance model result is here. The performance test conducted by following the instruction here.

License

AWS OTel Collector is licensed under an Apache 2.0 license.