Visitar URL original
fix(spotlight): align behavior with SDK spec by BYK · Pull Request #5169 · getsentry/sentry-python · GitHub
Skip to content

fix(spotlight): align behavior with SDK spec - #5169

Merged
BYK merged 2 commits into
masterfrom
fix/spotlight-spec-alignment
Dec 1, 2025
Merged

fix(spotlight): align behavior with SDK spec#5169
BYK merged 2 commits into
masterfrom
fix/spotlight-spec-alignment

Conversation

@BYK

@BYK BYK commented Nov 27, 2025

Copy link
Copy Markdown
Member

Align the Spotlight implementation with the official spec at
https://develop.sentry.dev/sdk/expected-features/spotlight/

Changes:

  1. Fix precedence rules:

    • When spotlight=True and SENTRY_SPOTLIGHT env var is a URL, use the
      env var URL (per spec requirement)
    • Log warning when config URL overrides env var URL
    • Log warning when spotlight=False explicitly disables despite env
      var being set

  2. Route all envelopes to Spotlight:

    • Sessions, logs, and metrics now also get sent to Spotlight via the
      _capture_envelope callback
    • Move Spotlight initialization before batchers are created

  3. Add exponential backoff retry logic:

    • SpotlightClient now implements proper exponential backoff when the
      Spotlight server is unreachable
    • Skips sending during backoff period to avoid blocking
    • Logs errors only once per backoff cycle

  4. Update tests:

    • Fix test expectation for spotlight=True + env URL case
    • Add tests for warning scenarios
    • Add test for session envelope routing to Spotlight

@BYK
fix(spotlight): align behavior with SDK spec
977b306 
Align the Spotlight implementation with the official spec at
https://develop.sentry.dev/sdk/expected-features/spotlight/

Changes:

1. Fix precedence rules:
   - When spotlight=True and SENTRY_SPOTLIGHT env var is a URL, use the
     env var URL (per spec requirement)
   - Log warning when config URL overrides env var URL
   - Log warning when spotlight=False explicitly disables despite env
     var being set

2. Route all envelopes to Spotlight:
   - Sessions, logs, and metrics now also get sent to Spotlight via the
     _capture_envelope callback
   - Move Spotlight initialization before batchers are created

3. Add exponential backoff retry logic:
   - SpotlightClient now implements proper exponential backoff when the
     Spotlight server is unreachable
   - Skips sending during backoff period to avoid blocking
   - Logs errors only once per backoff cycle

4. Update tests:
   - Fix test expectation for spotlight=True + env URL case
   - Add tests for warning scenarios
   - Add test for session envelope routing to Spotlight
@BYK
BYK marked this pull request as ready for review November 27, 2025 23:23
@BYK
BYK requested a review from a team as a code owner November 27, 2025 23:23
sentrivana
sentrivana reviewed Dec 1, 2025
View reviewed changes
Comment thread sentry_sdk/client.py Resolved
Comment thread sentry_sdk/client.py Resolved
Comment thread sentry_sdk/spotlight.py Resolved
Comment thread sentry_sdk/spotlight.py Resolved
cursor[bot]
cursor Bot reviewed Dec 1, 2025
View reviewed changes
Comment thread sentry_sdk/spotlight.py Resolved
Comment thread sentry_sdk/spotlight.py Resolved
@BYK
BYK force-pushed the fix/spotlight-spec-alignment branch from 6e8b34a to 5168606 Compare December 1, 2025 15:05
cursor[bot]
cursor Bot reviewed Dec 1, 2025
View reviewed changes
Comment thread sentry_sdk/spotlight.py Resolved
@codecov

codecov Bot commented Dec 1, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 87.50000% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.93%. Comparing base (5fc28a1) to head (3703b3c).
⚠️ Report is 10 commits behind head on master.
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
sentry_sdk/spotlight.py 84.78% 5 Missing and 2 partials ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #5169      +/-   ##
==========================================
+ Coverage   83.89%   83.93%   +0.03%     
==========================================
  Files         181      181              
  Lines       18343    18369      +26     
  Branches     3261     3269       +8     
==========================================
+ Hits        15389    15418      +29     
+ Misses       1946     1944       -2     
+ Partials     1008     1007       -1
Files with missing lines Coverage Δ
sentry_sdk/client.py 83.58% <100.00%> (-0.13%) ⬇️
sentry_sdk/spotlight.py 67.36% <84.78%> (+9.70%) ⬆️

... and 3 files with indirect coverage changes

@BYK
BYK requested a review from sentrivana December 1, 2025 15:17
sentrivana
sentrivana approved these changes Dec 1, 2025
View reviewed changes

@sentrivana sentrivana left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🙏🏻

@BYK
fix(spotlight): align behavior with SDK spec
3703b3c 
Align the Spotlight implementation with the official spec at
https://develop.sentry.dev/sdk/expected-features/spotlight/

Changes:

1. Fix precedence rules:
   - When spotlight=True and SENTRY_SPOTLIGHT env var is a URL, use the
     env var URL (per spec requirement)
   - Log warning when config URL overrides env var URL
   - Log warning when spotlight=False explicitly disables despite env
     var being set

2. Route all envelopes to Spotlight:
   - Sessions, logs, and metrics now also get sent to Spotlight via the
     _capture_envelope callback
   - Move Spotlight initialization before batchers are created

3. Add exponential backoff retry logic:
   - SpotlightClient now implements proper exponential backoff when the
     Spotlight server is unreachable
   - Skips sending during backoff period to avoid blocking
   - Logs errors only once per backoff cycle

4. Update tests:
   - Fix test expectation for spotlight=True + env URL case
   - Add tests for warning scenarios
   - Add test for session envelope routing to Spotlight
@BYK
BYK force-pushed the fix/spotlight-spec-alignment branch from 5168606 to 3703b3c Compare December 1, 2025 15:28
@BYK
BYK merged commit 6c6705a into master Dec 1, 2025
155 checks passed
@BYK
BYK deleted the fix/spotlight-spec-alignment branch December 1, 2025 17:03
@coderabbitai coderabbitai Bot mentioned this pull request Apr 23, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursor cursor[bot] cursor[bot] left review comments
@sentrivana sentrivana sentrivana approved these changes

Assignees

No one assigned

Labels

Changelog: Bugfix

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@BYK @sentrivana