Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/1489 deprecate aws id generator #1573

Merged
merged 7 commits into from
Feb 24, 2024
Merged

Chore/1489 deprecate aws id generator #1573

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
45375c1
mark XrayIdGenerator as deprecated
sreeo Feb 22, 2024
5a90808
update changelog
sreeo Feb 22, 2024
6309c7d
allow usage of deprecated xrayidgenerator
sreeo Feb 23, 2024
da21bbb
Merge branch 'main' into chore/1489-deprecate-aws-id-generator
sreeo Feb 23, 2024
64c7d9d
update deprecated since versions
sreeo Feb 23, 2024
c28f017
Merge branch 'main' into chore/1489-deprecate-aws-id-generator
sreeo Feb 24, 2024
2a91ea9
update changelog
sreeo Feb 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion opentelemetry-sdk/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Changelog

## Deprecation Notice

XrayIdGenerator has been migrated to the opentelemetry-aws crate starting from 0.10.0. [#33](https://github.com/open-telemetry/opentelemetry-rust-contrib/pull/33)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the message is not very clear. Could you rephrase so that it is clear that we are referrung to 0.10.0 of the aws create.

Also, this can be under a "##Removed" section.

Copy link
Member

@lalitb lalitb Feb 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this has been deprecated in this crate, not removed yet.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can however be moved inside of the version. I think this may have been inspired by my jaeger deprecation, but in this case we're only deprecating a component. Where as for jaeger we're deprecating the crate.

Could be:

# Changelog

## vNext

### Deprecated
...

Copy link
Contributor Author

@sreeo sreeo Feb 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about this?

### Deprecated

- XrayIdGenerator in the opentelemetry-sdk has been deprecated and moved to version 0.10.0 of the opentelemetry-aws crate.



## vNext


### Added

- [#1410](https://github.com/open-telemetry/opentelemetry-rust/pull/1410) Add experimental synchronous gauge
Expand All @@ -12,7 +18,7 @@
Performance Improvement : Creating Spans and LogRecords are now faster, by avoiding expensive cloning of `Resource` for every Span/LogRecord.

### Changed

- XrayIdGenerator in the opentelemetry-sdk has been deprecated. XrayIdGenerator has been added to the opentelemetry-aws crate starting from version 0.10.0.
- **Breaking**
[#1313](https://github.com/open-telemetry/opentelemetry-rust/pull/1313)
[#1350](https://github.com/open-telemetry/opentelemetry-rust/pull/1350)
Expand Down
2 changes: 2 additions & 0 deletions opentelemetry-sdk/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 4 additions & 0 deletions opentelemetry-sdk/src/trace/id_generator/aws.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}
Expand Down
8 changes: 7 additions & 1 deletion opentelemetry-sdk/src/trace/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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};
Expand Down
Loading