Deprecate AWS XrayIdGenerator (#1573)

Deprecates the XrayIdGenerator in the opentelemetry core sdk. Now available in opentelemetry-aws Relates #1489
open-telemetry · Feb 24, 2024 · 27cf653 · 27cf653
1 parent 188a26c
commit 27cf653
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 2 deletions.
diff --git a/opentelemetry-sdk/CHANGELOG.md b/opentelemetry-sdk/CHANGELOG.md
@@ -1,7 +1,13 @@
 # Changelog
 
+
 ## vNext
 
+
+### Deprecated
+
+- XrayIdGenerator in the opentelemetry-sdk has been deprecated and moved to version 0.10.0 of the opentelemetry-aws crate.
+
 ### Added
 
 - [#1410](https://github.com/open-telemetry/opentelemetry-rust/pull/1410) Add experimental synchronous gauge
@@ -12,7 +18,6 @@
 Performance Improvement : Creating Spans and LogRecords are now faster, by avoiding expensive cloning of `Resource` for every Span/LogRecord.
 
 ### Changed
-
 - **Breaking**
 [#1313](https://github.com/open-telemetry/opentelemetry-rust/pull/1313)
 [#1350](https://github.com/open-telemetry/opentelemetry-rust/pull/1350)

diff --git a/opentelemetry-sdk/src/lib.rs b/opentelemetry-sdk/src/lib.rs
@@ -137,6 +137,8 @@ pub mod runtime;
 #[cfg(any(feature = "testing", test))]
 #[cfg_attr(docsrs, doc(cfg(any(feature = "testing", test))))]
 pub mod testing;
+
+#[allow(deprecated)]
 #[cfg(feature = "trace")]
 #[cfg_attr(docsrs, doc(cfg(feature = "trace")))]
 pub mod trace;

diff --git a/opentelemetry-sdk/src/trace/id_generator/aws.rs b/opentelemetry-sdk/src/trace/id_generator/aws.rs
@@ -34,6 +34,10 @@ use std::time::{Duration, UNIX_EPOCH};
 /// [xray-exporter]: https://godoc.org/github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awsxrayexporter
 /// [xray-trace-id]: https://docs.aws.amazon.com/xray/latest/devguide/xray-api-sendingdata.html#xray-api-traceids
 #[derive(Debug, Default)]
+#[deprecated(
+    since = "0.21.3",
+    note = "XrayId Generator has been migrated to the opentelemetry-aws crate"
+)]
 pub struct XrayIdGenerator {
     sdk_default_generator: RandomIdGenerator,
 }

diff --git a/opentelemetry-sdk/src/trace/mod.rs b/opentelemetry-sdk/src/trace/mod.rs
@@ -19,7 +19,13 @@ mod tracer;
 
 pub use config::{config, Config};
 pub use events::SpanEvents;
-pub use id_generator::{aws::XrayIdGenerator, IdGenerator, RandomIdGenerator};
+
+#[deprecated(
+    since = "0.21.3",
+    note = "XrayId Generator has been migrated to the opentelemetry-aws crate"
+)]
+pub use id_generator::aws::XrayIdGenerator;
+pub use id_generator::{IdGenerator, RandomIdGenerator};
 pub use links::SpanLinks;
 pub use provider::{Builder, TracerProvider};
 pub use sampler::{Sampler, ShouldSample};