fix(shim): Map OpenTracing span.kind tag to OTel SpanKind#5080
Open
Nik-Reddy wants to merge 1 commit intoopen-telemetry:mainfrom
Open
fix(shim): Map OpenTracing span.kind tag to OTel SpanKind#5080Nik-Reddy wants to merge 1 commit intoopen-telemetry:mainfrom
Nik-Reddy wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
MikeGoldsmith
requested changes
Apr 13, 2026
Member
MikeGoldsmith
left a comment
MikeGoldsmith
left a comment
There was a problem hiding this comment.
Looks good - thanks @Nik-Reddy. I've left a couple of suggestions and queries.
Also, please add a changelog entry.
github-project-automation
bot
moved this to Reviewed PRs that need fixes
in Python PR digest
Nik-Reddy
force-pushed
the
fix/opentracing-shim-span-kind-2549
branch
from
d8e751e to
0532d05
Compare
Nik-Reddy
force-pushed
the
fix/opentracing-shim-span-kind-2549
branch
from
0532d05 to
81b3ada
Compare
Extract span.kind from OpenTracing tags, map to the corresponding OpenTelemetry SpanKind, and remove it from attributes to avoid duplication. Unrecognized kinds default to SpanKind.INTERNAL. Fixes open-telemetry#2549
Nik-Reddy
force-pushed
the
fix/opentracing-shim-span-kind-2549
branch
from
81b3ada to
0a528ec
Compare
Author
|
Hi @MikeGoldsmith, added the internal kind as suggested, updated the test, and added a CHANGELOG entry. Added \internal\ SpanKind mapping, corresponding test, and CHANGELOG entry. |
MikeGoldsmith
requested changes
Apr 15, 2026
Member
MikeGoldsmith
left a comment
MikeGoldsmith
left a comment
There was a problem hiding this comment.
Thanks for the update @Nik-Reddy. I've left one more suggestion around mutating the tags dic.
| mapped_kind = util.opentracing_kind_to_otel_kind(tags["span.kind"]) | ||
| if mapped_kind is not None: | ||
| kind = mapped_kind | ||
| del tags["span.kind"] |
Member
There was a problem hiding this comment.
del tags["span.kind"] mutates the caller's dict in place. Could you make a copy first to avoid the side effect?
Suggested change
| del tags["span.kind"] | |
| tags = dict(tags) | |
| del tags["span.kind"] |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
The OpenTracing compatibility shim ignores the
span.kindtag when creating spans viaTracerShim.start_span(). All spans default toSpanKind.INTERNALregardless of the OpenTracingspan.kindvalue (client,server,producer,consumer). This breaks interoperability for users migrating from OpenTracing to OpenTelemetry, as span kind is critical for trace visualization and backend processing.This PR extracts
span.kindfrom the tags dict before span creation, maps it to the correspondingSpanKindenum value (includinginternal), passes it as thekind=parameter, and removesspan.kindfrom the tags so it does not appear as a duplicate attribute — it is a semantic control tag, not a regular user attribute.Fixes #2549
Type of change
How Has This Been Tested?
All existing shim tests plus new test cases pass:
test_span_kind_from_tags— 7 sub-tests covering all four OpenTracing kinds + unknown + absent + Nonetest_span_kind_tag_removed_from_attributes— verifiesspan.kindis removed from attributes while other tags are preservedtest_opentracing_kind_to_otel_kind— 7 sub-tests for theutil.pyhelper (all five valid kinds + unknown + empty)61 tests passed, 0 failures.
Does This PR Require a Contrib Repo Change?
Checklist: