Skip to content

feat(httpx): Migrate to span first#6084

Open
ericapisani wants to merge 7 commits intomasterfrom
ep/span-first-httpx-c35
Open

feat(httpx): Migrate to span first#6084
ericapisani wants to merge 7 commits intomasterfrom
ep/span-first-httpx-c35

Conversation

@ericapisani
Copy link
Copy Markdown
Member

@ericapisani ericapisani commented Apr 16, 2026

Migrates the httpx integration to the span-first (streaming span) architecture.

When _experiments={"trace_lifecycle": "stream"} is enabled, the integration
now uses StreamedSpan via sentry_sdk.traces.start_span instead of the legacy
Span-based (transactions) path. The legacy path remains unchanged for backwards compatibility.

Supporting changes:

  • add_http_request_source_for_streamed_span() added to tracing_utils — a
    StreamedSpan-compatible variant that must be called inside the span context
    manager so source data is attached before the span is flushed
  • add_source() updated to dispatch between set_data/set_attribute depending
    on span type
  • start_timestamp_monotonic_ns property added to StreamedSpan and
    NoOpStreamedSpan to support the request source duration threshold check

Part of the broader span-first integration migration.

Fixes PY-2330
Fixes #6028

Adds span streaming support to the httpx integration by adding a new
code path that uses `start_span` from `sentry_sdk.traces` when
`_experiments={"trace_lifecycle": "stream"}` is enabled. The existing
legacy path is preserved unchanged.

Test coverage is updated to:
- Rename span-data-asserting tests with a `_legacy` suffix
- Fix broken mock targets in duration threshold tests (`start_span` →
  `legacy_start_span` after the rename introduced two names)
- Add `_span_streaming` variants for all tests that assert on span data,
  using `capture_items("span")` and `span["attributes"]` instead of
  `event["spans"][*]["data"]`

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 16, 2026

Semver Impact of This PR

🟡 Minor (new features)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


New Features ✨

  • (ci) Cancel in-progress PR workflows on new commit push by joshuarli in #5994
  • (httpx) Migrate to span first by ericapisani in #6084
  • Add db.driver.name spans to database integrations by ericapisani in #6082

Bug Fixes 🐛

  • (google_genai) Redact binary data in inline_data and fix multi-part message extraction by ericapisani in #5977
  • (grpc) Add isolation_scope to async server interceptor by robinvd in #5940
  • (profiler) Stop nulling buffer on teardown by ericapisani in #6075

Internal Changes 🔧

  • (celery) Remove unused NoOpMgr from utils by sentrivana in #6078
  • (ci) Update outdated pinned action version comments by JoshuaMoelans in #6088
  • (pydantic-ai) Remove dead Model.request patch by alexander-alderman-webb in #5956
  • (tests) Replace deprecated enable_tracingwith traces_sample_rate by sentrivana in #6077
  • Set explicit base-branch for codecov action by ericapisani in #5992

🤖 This preview updates automatically when you update the PR.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 16, 2026

Codecov Results 📊

13 passed | Total: 13 | Pass Rate: 100% | Execution Time: 8.92s

All tests are passing successfully.

❌ Patch coverage is 2.86%. Project has 15091 uncovered lines.

Files with missing lines (3)
File Patch % Lines
tracing_utils.py 37.23% ⚠️ 472 Missing and 28 partials
traces.py 36.18% ⚠️ 194 Missing
httpx.py 9.32% ⚠️ 107 Missing

Generated by Codecov Action

@github-actions
Copy link
Copy Markdown
Contributor

Codecov Results 📊


Generated by Codecov Action

@ericapisani
Copy link
Copy Markdown
Member Author

bugbot run

Comment thread sentry_sdk/traces.py Outdated
Comment thread sentry_sdk/integrations/httpx.py Outdated
@ericapisani ericapisani marked this pull request as ready for review April 16, 2026 20:35
@ericapisani ericapisani requested a review from a team as a code owner April 16, 2026 20:35
Copy link
Copy Markdown
Contributor

@sentrivana sentrivana left a comment

Choose a reason for hiding this comment

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

TY! Left some comments, the gist:

  • Any attributes we set on the span in streaming mode need to be in Sentry Conventions. I've tried to point out some that need changing but please go through the rest too and double check 🙏🏻
  • I'd remove all of the start_timestamp_monotonic_ms changes. I don't really see the benefit over just using the start_timestamp and removing it makes the new and old add_http_request_source similar enough that we can unify them.

Comment thread sentry_sdk/traces.py Outdated
Comment thread sentry_sdk/traces.py
Comment thread sentry_sdk/integrations/httpx.py Outdated
Comment thread sentry_sdk/integrations/httpx.py Outdated
Comment thread sentry_sdk/integrations/httpx.py Outdated
Comment thread sentry_sdk/tracing_utils.py Outdated
Comment thread sentry_sdk/tracing_utils.py Outdated
Comment thread sentry_sdk/integrations/httpx.py Outdated
Comment thread sentry_sdk/tracing_utils.py Outdated
Comment thread sentry_sdk/integrations/httpx.py Outdated
Comment thread sentry_sdk/integrations/httpx.py Outdated
Comment thread sentry_sdk/integrations/httpx.py Outdated
Comment thread tests/integrations/httpx/test_httpx.py Outdated
@ericapisani ericapisani requested a review from sentrivana April 17, 2026 18:27
Comment thread sentry_sdk/tracing_utils.py
@linear-code
Copy link
Copy Markdown

linear-code bot commented Apr 17, 2026

Remove start_timestamp_monotonic_ns from StreamedSpan and NoOpStreamedSpan,
and simplify the end timestamp fallback in add_http_request_source to use
datetime.now(timezone.utc) directly. The monotonic-based calculation added
complexity without meaningful benefit over the UTC fallback.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 19eeac5. Configure here.

# Needs to happen within the context manager as we want to attach the
# final data before the span finishes and is sent for ingesting.
with capture_internal_exceptions():
add_http_request_source(streamed_span)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

URL attributes lost on request exception in streaming path

Medium Severity

In the streaming span path, URL-related attributes (url.full, url.query, url.fragment) are accumulated in a local attributes dict but only flushed to the span via streamed_span.set_attributes(attributes) after real_send completes. If real_send raises an exception, the __exit__ handler fires and the span ends without those attributes ever being set, losing known-before-request URL metadata. The legacy path doesn't have this problem because it calls span.set_data() for URL info before the request is made. The same issue exists in both the sync and async client paths.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 19eeac5. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migrate httpx to span first

2 participants