Skip to content

Commit 9499fae

Browse files
authored
Update README with end-of-support timeline and add migration links (#105)
1 parent 6fd987e commit 9499fae

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,12 +1,29 @@
11
![Build Status](https://github.com/aws/aws-xray-sdk-ruby/actions/workflows/continuous-build.yml/badge.svg)
22

3-
### :mega: OpenTelemetry Ruby with AWS X-Ray
3+
# AWS X-Ray SDK for Ruby (beta)
4+
5+
## :mega: Upcoming Maintenance Mode on February 25, 2026
6+
7+
[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.
8+
9+
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.
10+
11+
## :mega: End-of-Support on February 25, 2027
12+
13+
[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.
14+
15+
[xray-otel-migration-docs]: https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-migration.html
16+
[xray-sdk-daemon-timeline]: https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon-eos.html
17+
18+
-------------------------------------
19+
20+
### OpenTelemetry Ruby with AWS X-Ray
421

522
AWS X-Ray supports using OpenTelemetry Ruby 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. Note that using OpenTelemetry Ruby and ADOT is in public preview, and like this SDK in beta, is not recommended for production applications.
623

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

9-
# AWS X-Ray SDK for Ruby (beta)
26+
-------------------------------------
1027

1128
![Screenshot of the AWS X-Ray console](https://raw.githubusercontent.com/aws/aws-xray-sdk-ruby/master/images/example_servicemap.png)
1229

0 commit comments

Comments
 (0)