Reduce scope forking when using OpenTelemetry #4565

adinauer · 2025-07-21T07:28:39Z

📜 Description

We are now re-wrapping Context after with has been called on the wrapped context. We do not perform any additional scope forking in this case.

We now also wrap the root context immediately.

💡 Motivation and Context

Previously our scope forking logic kicked in more often than desired because our wrapped Context would be converted to a new ArrayBasedContext on every invocation of with that didn't set a span.

This broke our withScope (and siblings) where we were passing a forked scope into the callback but when making the forked Scopes the current ones, our OpenTelemetry wrapper would also fork again. This caused the parameter passed into the callback of withScope to be different from Sentry.getCurrentScopes().getScope().

This change also reduces scope forking, when Context is being written to like this:

try (final @NotNull Scope s1 = Context.current().with(ContextKey.named("testkey"), "test1").makeCurrent()) {
...
}

Previously this would have caused the scopes to be forked later.

💚 How did you test it?

📝 Checklist

I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
I updated the wizard if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

github-actions · 2025-07-21T07:29:34Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against 3dc95fe

github-actions · 2025-07-21T07:44:14Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	423.61 ms	474.78 ms	51.16 ms
Size	1.58 MiB	2.09 MiB	519.48 KiB

Baseline results on branch: feat/e2e-tests-console-otel

Startup times

Revision	Plain	With Sentry	Diff
`fcbda68`	394.98 ms	421.94 ms	26.96 ms

App size

Revision	Plain	With Sentry	Diff
`fcbda68`	1.58 MiB	2.09 MiB	519.48 KiB

Previous results on branch: feat/otel-less-scope-forking

Startup times

Revision	Plain	With Sentry	Diff
`b7e5a4f`	438.98 ms	493.47 ms	54.49 ms

App size

Revision	Plain	With Sentry	Diff
`b7e5a4f`	1.58 MiB	2.09 MiB	519.05 KiB

…forking

lcian

Good catch, LGTM

…forking

...ntry-opentelemetry-bootstrap/src/main/java/io/sentry/opentelemetry/SentryContextWrapper.java

* e2e tests for console app * fix test failures by waiting for 10s after first try to find envelopes * add system-test-runner.py script to replace bash scripts for running e2e / system tests * use py script for ci, cleanup, makefile * Format code * remove bash scripts * install requests module * api * fix gh script * Implement E2E tests for OTel based console sample * fixes after merge * Format code * e2e tests for console app * Implement E2E tests for OTel based console sample * fixes after merge * Format code * api * Reduce scope forking when using OpenTelemetry (#4565) * Reduce scope forking in OpenTelemetry * Format code * api * changelog --------- Co-authored-by: Sentry Github Bot <[email protected]> * SDKs send queue is no longer shutdown immediately on re-init (#4564) * Let queue drain on a restart * Format code * Format code * Update sentry-samples/sentry-samples-console-opentelemetry-noagent/src/test/kotlin/sentry/systemtest/ConsoleApplicationSystemTest.kt * Let queue drain on a restart * Format code * Format code * Update sentry-samples/sentry-samples-console-opentelemetry-noagent/src/test/kotlin/sentry/systemtest/ConsoleApplicationSystemTest.kt * adapt tests * changelog --------- Co-authored-by: Sentry Github Bot <[email protected]> --------- Co-authored-by: Sentry Github Bot <[email protected]>

* Do not report cached events as lost * E2E tests for OpenTelemetry based console sample (#4563) * e2e tests for console app * fix test failures by waiting for 10s after first try to find envelopes * add system-test-runner.py script to replace bash scripts for running e2e / system tests * use py script for ci, cleanup, makefile * Format code * remove bash scripts * install requests module * api * fix gh script * Implement E2E tests for OTel based console sample * fixes after merge * Format code * e2e tests for console app * Implement E2E tests for OTel based console sample * fixes after merge * Format code * api * Reduce scope forking when using OpenTelemetry (#4565) * Reduce scope forking in OpenTelemetry * Format code * api * changelog --------- Co-authored-by: Sentry Github Bot <[email protected]> * SDKs send queue is no longer shutdown immediately on re-init (#4564) * Let queue drain on a restart * Format code * Format code * Update sentry-samples/sentry-samples-console-opentelemetry-noagent/src/test/kotlin/sentry/systemtest/ConsoleApplicationSystemTest.kt * Let queue drain on a restart * Format code * Format code * Update sentry-samples/sentry-samples-console-opentelemetry-noagent/src/test/kotlin/sentry/systemtest/ConsoleApplicationSystemTest.kt * adapt tests * changelog --------- Co-authored-by: Sentry Github Bot <[email protected]> --------- Co-authored-by: Sentry Github Bot <[email protected]> * release: 8.18.0 * ref(replay): Use main thread to schedule capture (#4542) * perf(connectivity): Cache network capabilities and status to reduce IPC calls (#4560) * fix(breadcrumbs): Deduplicate battery breadcrumbs (#4561) * fix(ci): remove obsolete NDK debug symbols (#4581) As they don't exist anymore and this is done within sentry-native directly: https://github.com/getsentry/sentry-native/pull/1327/files * fix(android): Remove unused method (#4585) * fix(android): Remove unused method * Update Changelog * Add rules file for documenting SDK offline behaviour (#4572) #skip-changelog ## 📜 Description  Add rules file for documenting SDK offline behaviour ## 💡 Motivation and Context   Should help speed up AI reasoning about the SDK offline/retry behaviour. ## 💚 How did you test it? ## 📝 Checklist  - [ ] I added tests to verify the changes. - [ ] No new PII added or SDK only sends newly added PII if `sendDefaultPII` is enabled. - [ ] I updated the docs if needed. - [ ] I updated the wizard if needed. - [ ] Review from the native team if needed. - [ ] No breaking change or entry added to the changelog. - [ ] No breaking change for hybrid SDKs or communicated to hybrid SDKs. ## 🔮 Next steps * perf(connectivity): Have only one NetworkCallback active at a time (#4562) * fix(scripts): update-gradle script set-version (#4591) * fix: sentry-android-ndk proguard rule keeps all native class (#4427) * fix: sentry-androi-ndk proguard rule keeps all native class * docs: update CHANGELOG * fix: update CHANGELOG * Update CHANGELOG.md * Update CHANGELOG.md --------- Co-authored-by: Markus Hintersteiner <[email protected]> Co-authored-by: Markus Hintersteiner <[email protected]> * refactor(lifecycle): Use single lifecycle observer (#4567) * perf(connectivity): Cache network capabilities and status to reduce IPC calls * changelog * Changelog * revert * fix(breadcrumbs): Deduplicate battery breadcrumbs * ref * Changelog * Fix test * perf(connectivity): Have only one NetworkCallback active at a time * Changelog * perf(integrations): Use single lifecycle observer * Add tests * Changelog * Fix tests * Improve callback handling and test visibility (#4593) * Null-check lifecycleObserver --------- Co-authored-by: Markus Hintersteiner <[email protected]> * fix(sqlite): Fix abstract method error (#4597) * fix(sqlite): Fix abstract method error * Update CHANGELOG.md * Suppress metadata version checks * perf(integrations): Do not register for SystemEvents and NetworkCallbacks when launched with background importance (#4579) * fix(android): Ensure frame metrics listeners are registered/unregistered on the main thread (#4582) * fix(android): Ensure frame metrics listeners are registered/unregistered on the main thread * Fix race conditions * Update Changelog * Update CHANGELOG.md * Address PR feedback * perf(executor): Prewarm SentryExecutorService (#4606) * review feedback * changelog * pass through whether cache stored in AndroidEnvelopeCache + test * Format code --------- Co-authored-by: Sentry Github Bot <[email protected]> Co-authored-by: getsentry-bot <[email protected]> Co-authored-by: Roman Zavarnitsyn <[email protected]> Co-authored-by: Markus Hintersteiner <[email protected]> Co-authored-by: Ghasem Shirdel <[email protected]> Co-authored-by: Markus Hintersteiner <[email protected]>

Reduce scope forking in OpenTelemetry

e0b8e94

adinauer requested review from romtsn, stefanosiano, markushi and lcian as code owners July 21, 2025 07:28

Format code

2df540c

Merge branch 'feat/e2e-tests-console-otel' into feat/otel-less-scope-…

c496629

…forking

lcian approved these changes Jul 21, 2025

View reviewed changes

adinauer added 2 commits July 29, 2025 15:56

Merge branch 'feat/e2e-tests-console-otel' into feat/otel-less-scope-…

1559f45

…forking

api

cdcb4fc

cursor bot reviewed Jul 29, 2025

View reviewed changes

...ntry-opentelemetry-bootstrap/src/main/java/io/sentry/opentelemetry/SentryContextWrapper.java Show resolved Hide resolved

changelog

3dc95fe

adinauer merged commit a889829 into feat/e2e-tests-console-otel Jul 29, 2025
33 of 35 checks passed

adinauer deleted the feat/otel-less-scope-forking branch July 29, 2025 14:15

omarhachach mentioned this pull request Aug 8, 2025

sentry-agent 8.18.0 causes hanging threads #4622

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Reduce scope forking when using OpenTelemetry #4565

Reduce scope forking when using OpenTelemetry #4565

Uh oh!

adinauer commented Jul 21, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 21, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 21, 2025 •

edited

Loading

Baseline results on branch: feat/e2e-tests-console-otel

Startup times

App size

Previous results on branch: feat/otel-less-scope-forking

Startup times

App size

Uh oh!

lcian left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reduce scope forking when using OpenTelemetry #4565

Reduce scope forking when using OpenTelemetry #4565

Uh oh!

Conversation

adinauer commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

Uh oh!

github-actions bot commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Baseline results on branch: feat/e2e-tests-console-otel

Startup times

App size

Previous results on branch: feat/otel-less-scope-forking

Startup times

App size

Uh oh!

lcian left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adinauer commented Jul 21, 2025 •

edited

Loading

github-actions bot commented Jul 21, 2025 •

edited

Loading

github-actions bot commented Jul 21, 2025 •

edited

Loading