Skip to content

Commit 9e61b83

Browse files
authored
Update README with end-of-support timeline and add migration links (#504)
1 parent 24cbdf8 commit 9e61b83

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,30 @@
11
![Test](https://github.com/aws/aws-xray-sdk-go/workflows/Test/badge.svg)
22
[![Go Report Card](https://goreportcard.com/badge/github.com/aws/aws-xray-sdk-go)](https://goreportcard.com/report/github.com/aws/aws-xray-sdk-go)
33

4-
### :mega: OpenTelemetry Go with AWS X-Ray
4+
# AWS X-Ray SDK for Go
5+
6+
## :mega: Upcoming Maintenance Mode on February 25, 2026
7+
8+
[The AWS X-Ray SDKs will enter maintenance mode on **`February 25, 2026`**][xray-sdk-daemon-timeline]. During maintenance mode, the X-Ray SDKs and Daemon will only receive critical bug fixes and security updates, and will not be updated to support new features.
9+
10+
We recommend that you migrate to [AWS Distro for OpenTelemetry (ADOT) or OpenTelemetry Instrumentation][xray-otel-migration-docs] to generate traces (through manual or zero-code instrumentation) from your application and send them to AWS X-Ray. OpenTelemetry is the industry-wide standard for tracing instrumentation and observability. It has a large open-source community for support and provides more instrumentations and updates. By adopting an OpenTelemetry solution, developers can leverage the latest services and innovations from AWS CloudWatch.
11+
12+
## :mega: End-of-Support on February 25, 2027
13+
14+
[The AWS X-Ray SDKs will reach end-of-support on **`February 25, 2027`**][xray-sdk-daemon-timeline]. After end-of-support, the X-Ray SDKs will no longer receive updates or releases. Previously published releases will continue to be available via public package managers and the source code will remain on GitHub.
15+
16+
[xray-otel-migration-docs]: https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-migration.html
17+
[xray-sdk-daemon-timeline]: https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon-eos.html
18+
19+
-------------------------------------
20+
21+
### OpenTelemetry Go with AWS X-Ray
522

623
AWS X-Ray supports using OpenTelemetry Go and the AWS Distro for OpenTelemetry (ADOT) Collector to instrument your application and send trace data to X-Ray. The OpenTelemetry SDKs are an industry-wide standard for tracing instrumentation. They provide more instrumentations and have a larger community for support, but may not have complete feature parity with the X-Ray SDKs. See [choosing between the ADOT and X-Ray SDKs](https://docs.aws.amazon.com/xray/latest/devguide/xray-instrumenting-your-app.html#xray-instrumenting-choosing) for more help with choosing between the two.
724

825
If you want additional features when tracing your Go applications, please [open an issue on the OpenTelemetry Go Instrumentation repository](https://github.com/open-telemetry/opentelemetry-go-contrib/issues/new?title=X-Ray%20Compatible%20Feature%20Request).
926

10-
# AWS X-Ray SDK for Go
27+
-------------------------------------
1128

1229
![Screenshot of the AWS X-Ray console](/images/example.png?raw=true)
1330

0 commit comments

Comments
 (0)