open-telemetry / open-telemetry/opentelemetry-python

Breaking change in 1.40 to Tracer/Span behavior in opentelemetry-api not documented

Open
#5,009 9 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.6k
Forks
1k
Avg merge
4d 15h
Merged PRs (30d)
19

Description

PR https://github.com/open-telemetry/opentelemetry-python/pull/4861 involved breaking changes to fundamental behavior of the opentelemetry-api package, namely the Span/Tracer behavior that IIUC should be stable. Mainly the span context can differ in cases where it was previously the invalid (all-zero) span context, which may also lead to differing extract/inject behavior. E.g. a service that previously did not propagate any trace/span ID from incoming to outgoing request might now do so.
But there are also more subtle differences that might break code that e.g. relied on identity checks for INVALID_SPAN (e.g. https://github.com/open-telemetry/opentelemetry-python-contrib/blob/242cfe1c58d6896144d75c404a4784d4bd16cfed/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py#L152, not that I can think of any likely scenario where this one would actually be hit).

So I don't want to say that it requires a major version bump (although I also don't want to say it wouldn't make sense), but it should IMHO at least be documented more clearly in release notes.

Maybe these changes were even all unintentional, then maybe it still makes sense to revert them, as the main feature that the PR was meant to implement is only experimental.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing PR 4861 and the opentelemetry-api Span/Tracer behavior it changed. Check the release-note documentation and the referenced instrumentation/utils.py identity check, then document the changes to span context and extract/inject behavior, including whether the behavior is intentional. Done means the relevant 1.40 breaking changes and their practical impact are clearly recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
observability
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.