feat(core): Deprecate Span.status
#10208
Merged
Conversation
This file contains hidden or 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
Lms24
commented
Jan 16, 2024
| * | ||
| * @deprecated Use `.setStatus` to set or update and `spanToJSON()` to read the status. | ||
| */ | ||
| status?: string; |
There was a problem hiding this comment.
Had to re-declare status on the Span interface because it's inherited from SpanContext. I don't think we want to deprecate it there in v7 but tbh not sure.
Side note:
This is similar to #10189 where I realized I also didn't deprecate op on the Span interface because of this inheritance yet. I'll tackle this in a follow-up PR though.
There was a problem hiding this comment.
yes, I think that's fine! I'd deprecate stuff on the Span interface directly and leave the span context alone, it will go away "automatically" when all methods that use it are gone in v8!
And yeah, if we missed some there let's just add it, may very well be! 😅
size-limit report 📦
|
1dd0b12 to
75f1cd8
Compare
mydea
approved these changes
Jan 17, 2024
75f1cd8 to
c068724
Compare
Lms24
added a commit
that referenced
this pull request
Jan 18, 2024
As discovered during #10208, the `op` property of the `Span` interface was still missing a deprecation because `Span` inherited it from `SpanContext` which I missed.
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.
This PR deprecates the
statusfield on the span interface as well as on the class. The replacements for this field arespan.setStatusto set or update a span status (this API exists on the Otel Span interface but the types don't align yet)spanToJsonto read the statusref #10184