feat: export SDK crate version as constant #2504
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The committers listed above are authorized under a signed CLA. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2504 +/- ##
=====================================
Coverage 77.9% 77.9%
=====================================
Files 123 123
Lines 22887 22887
=====================================
Hits 17838 17838
Misses 5049 5049 ☔ View full report in Codecov by Sentry. |
cijothomas
reviewed
Jan 13, 2025
|
|
||
| /// The crate's version string, useful for populating [`Resource`] keys like | ||
| /// [`telemetry.sdk.version`](https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.TELEMETRY_SDK_VERSION.html) | ||
| pub const VERSION: &str = env!("CARGO_PKG_VERSION"); |
There was a problem hiding this comment.
we try to keep public API as lean as possible, so unless there is a strong reason to expose this, we should not.
Users rarely need this as this is automatically populated.
cijothomas
requested changes
Jan 13, 2025
There was a problem hiding this comment.
Thanks for your interest in contributing to the project!
I've requested changes. Please see https://github.com/open-telemetry/opentelemetry-rust/pull/2504/files#r1913817079
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
PR adds a simple constant for the SDK crate's version (pulled directly from the crate's manifest [ref]).
This is specifically useful in conjunction with things like populating the value of
telemetry.sdk.versionwhen building aResource(for example).Merge requirement checklist
N/AUnit tests added/updated (if applicable)N/AAppropriateCHANGELOG.mdfiles updated for non-trivial, user-facing changesN/AChanges in public API reviewed (if applicable)