POTEL 26 - Customize OpenTelemetry Scope.close behaviour

[adinauer]

#skip-changelog

📜 Description

Replace the default ThreadLocalContextStorage with SentryOtelThreadLocalStorage which hands back a different Scope implementation that on .close() does not check whether the current active Context is the one it expects.

💡 Motivation and Context

By default ScopeImpl.close() in OpenTelemetry checks whether the current active Context is the one from back when Context was forked. This means if during lifecycle of this Scope anything does not clean up properly, we're stuck with an outdated Context that holds a Span reference. This Span has already ended but will be used as parent for other requests coming in and breaks tracing for follow up requests.

With the customized behaviour in this PR, we're now ignoring whether an inner Scope was not closed properly and clean up anyways.

The problem with improper cleanup is not an easy one to fix. Sentry static API makes use of getCurrentScopes() which, forks scopes and sets it on the IScopesStorage if there's no valid Scopes for the current Thread available. This creates a lifecycle token that is ignored, since we don't know where to actually restore the previous Context.

We tested this using server.tomcat.threads.max=1 in application.properties so there is only one thread handling requests. Before this change, the second request would fail to properly create transactions/spans and does not send anything to Sentry.

More details:
OTel changed this behaviour to support things like Camel, where Scope.close() might be called multiple times. See open-telemetry/opentelemetry-java#5055

Risks:
This could mean when close calls go out of order, we end up with a different state than before. However this scenario probably means random result anyways.

💚 How did you test it?

📝 Checklist

• I reviewed the submitted code.
• 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.
• 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]

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

Generated by 🚫 dangerJS against 202d89f

[lbloder]

Left a question about license, otherwise LGTM 👍