README
¶
Overview
AWS Distro for OpenTelemetry Collector (ADOT Collector) is an 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. Additionally, the ADOT Collector is now generally available for metrics.
Getting Help
Use the community resources below for getting help with the ADOT Collector.
- Open a support ticket with AWS Support.
- Use GitHub issues to report bugs and request features.
- Join our GitHub Community for AWS Distro for OpenTelemetry to ask your questions, file issues, or request enhancements.
- If you think you may have found a bug, open a bug report.
- For contributing guidelines, refer to CONTRIBUTING.md.
Notice: ADOT Collector v0.33.0 Breaking Change
Users of the statsd receiver, please refer to GitHub Issue - Warning: StatsD Receiver → EMF Exporter Metric Pipeline Breaking Change
for information on an upcoming breaking change.
Notices: ADOT Collector v0.35.0 Breaking Changes
- Users of the 'awscontainerinsightreceiver', please refer to the GitHub Issue - Warning: Container Image Default User Change → Important consideration for AWSContainerInsightReceiver for more information on an upcoming breaking change.
- Users of the
prometheusorprometheusremotewriteexporters please refer to the GitHub Issue Warning: ADOT Collector v0.35.0 breaking change for information on an upcoming breaking change.
ADOT Collector Built-in Components
This table represents the supported components of the ADOT Collector. The highlighted components below are developed by AWS in-house. The rest of the components in the table are the essential default components that the ADOT Collector will support.
Besides the components that interact with telemetry signals directly from the previous table, there is also support to the following confmap providers:
- file
- env
- YAML
- s3
- http
- https
More documentation for confmap providers can be found here.
Getting Started
Prerequisites
To build the ADOT Collector locally, you will need to have Golang installed. You can download and install Golang here.
ADOT Collector Configuration
The ADOT Collector is built with a default configuration.
The ADOT Collector configuration uses the same configuration syntax/design from OpenTelemetry Collector. For more information regarding OpenTelemetry Collector configuration please refer to the upstream documentation.
so you can customize or port your OpenTelemetry Collector configuration files when running ADOT Collector. Please refer to the Try out the ADOT Collector section on configuring ADOT Collector.
Try out the ADOT Collector
The ADOT Collector supports all AWS computing platforms and Docker/Kubernetes. Here are some examples on how to run the ADOT Collector to send telemetry data:
- Run it with Docker
- Run it with ECS
- Run it with EKS
- Run it on EC2 (Amazon Linux 2)
- Run it on EC2 (Windows)
- Run it on EC2 (Debian)
Build Your Own Artifacts
Use the following instructions to build your own ADOT Collector artifacts:
Development
See docs/developers.
Benchmark
The latest performance report is here, while the trends by testcase can be found here. Both are updated on each successful CI run. The charts use the github-action-benchmark action and uses a modified layout to group the testcases. The performance test can be conducted by following the instructions here.
Support
Please note that as per policy, we're providing support via GitHub on a best effort basis. However, if you have AWS Enterprise Support you can create a ticket and we will provide direct support within the respective SLAs.
For each merged pull request, a corresponding image with the naming convention of [ADOT_COLLECTOR_VERSION]-[GITHUB_SHA] is pushed to public.ecr.aws/aws-otel-test/adot-collector-integration-test.
This image is used for the integration tests. You can pull any of the images from there, however, we will not support any issues and pull requests for these test images.
Supported Versions
Each ADOT Collector release is supported until there are two newer minor releases. For example, ADOT collector v0.16.1 will be supported until v0.18.0 is released.
Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.
License
ADOT Collector is licensed under an Apache 2.0 license.
Moon Specific
The purpose of this fork is mainly to add components to base ADOT collector. To do so, import the component and add it to a relevant factory in pkg/defaultcomponents/defaults.go.
These are the current Moon specific components.
| Receiver | Processor | Exporter | Extensions |
|---|---|---|---|
| iotauthextension |
Deployment
Private Repo Access
The custom extension modules are in a private repo and thus GO needs special access. Run this command
go env -w GOPRIVATE=github.com/Moonlighting-Industries/moon_telemetry/extension/*
git config --global url."ssh://git@github.com".insteadOf "https://github.com"
Setup Docker Image
ECR_URL=<ECR Address>
DOCKER_NAMESPACE=$ECR_URL make docker-build
aws ecr get-login-password --region eu-central-1 --profile jonathanT | docker login --username AWS --password-stdin $ECR_URL
docker push $ECR_URL/awscollector:$(cat VERSION)
Deploy to ECS
AWS App Runner automatically updates the Collector instance when a new Docker image is pushed to the awscolletor ECR repository
Version Handling
Simply update the github and docker tags when pushing new changes.
Directories