Skip to content

Commit e3f183b

Browse files
committed
added README.md and moved otlp_aws_span_exporter into its own folder
1 parent 9082f2d commit e3f183b

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# ADOT X-Ray OTLP Trace Export Configuration
2+
3+
This guide explains how to automatically configure ADOT environment variables for exporting traces to [AWS X-Ray OTLP endpoint](https://docs.aws.amazon.com/xray/latest/devguide/xray-opentelemetry.html)
4+
5+
## Prerequisites
6+
7+
1. Transaction Search must be enabled in order to send spans to the Xray OTLP endpoint. See [this doc](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search-getting-started.html) on how to enable Transaction Search.
8+
9+
2. Ensure the AWS role in your application environment has [AWSXRayWriteOnlyAccess](https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSXrayWriteOnlyAccess.html) managed policy attached.
10+
11+
## Environment Variables
12+
13+
Set the following environment variables to **PROPERLY** configure trace export with SigV4 authentication:
14+
15+
```shell
16+
# Set X-Ray endpoint (replace AWS_REGION with your region)
17+
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://xray.<AWS_REGION>.amazonaws.com/v1/traces
18+
19+
# Configure OTLP export protocol
20+
OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
21+
22+
OTEL_TRACES_EXPORTER=otlp
23+
OTEL_METRICS_EXPORTER=none
24+
OTEL_LOGS_EXPORTER=none
25+
OTEL_RESOURCE_ATTRIBUTES="service.name=<YOUR_SERVICE_NAME>"
26+
27+
# Disable application signals (they will be generated in CloudWatch backend)
28+
OTEL_AWS_APPLICATION_SIGNALS_ENABLED=false

0 commit comments

Comments
 (0)