Add `SpanProcessor` for OTEL #2357

adinauer · 2022-11-14T08:43:55Z

#skip-changelog

📜 Description

Partially implement the OTEL SpanProcessor.

💡 Motivation and Context

The SpanProcessor converts OTEL spans to Sentry transactions (for root spans) or spans.

💚 How did you test it?

📝 Checklist

I reviewed the submitted code
I added tests to verify the changes
I updated the docs if needed
No breaking changes

🔮 Next steps

github-actions · 2022-11-14T11:09:17Z

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

Generated by 🚫 dangerJS against cb2fb89

github-actions · 2022-11-14T11:22:07Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	319.12 ms	355.53 ms	36.41 ms
Size	1.73 MiB	2.32 MiB	610.45 KiB

Previous results on branch: feat/otel-span-processor

Startup times

Revision	Plain	With Sentry	Diff
`cfaca0b`	334.94 ms	389.09 ms	54.15 ms

App size

Revision	Plain	With Sentry	Diff
`cfaca0b`	1.73 MiB	2.32 MiB	610.44 KiB

codecov-commenter · 2022-11-14T11:34:02Z

Codecov Report

Base: 80.49% // Head: 80.44% // Decreases project coverage by -0.04% ⚠️

Coverage data is based on head (9cef931) compared to base (6b344be).
Patch coverage: 53.33% of modified lines in pull request are covered.

Additional details and impacted files

@@               Coverage Diff               @@
##             feat/otel    #2357      +/-   ##
===============================================
- Coverage        80.49%   80.44%   -0.05%     
- Complexity        3686     3692       +6     
===============================================
  Files              291      292       +1     
  Lines            13748    13777      +29     
  Branches          1812     1817       +5     
===============================================
+ Hits             11066    11083      +17     
- Misses            1983     1993      +10     
- Partials           699      701       +2

Impacted Files	Coverage Δ
sentry/src/main/java/io/sentry/NoOpSpan.java	`22.22% <0.00%> (-0.86%)`	⬇️
...entry/src/main/java/io/sentry/NoOpTransaction.java	`23.68% <0.00%> (-0.65%)`	⬇️
sentry/src/main/java/io/sentry/Span.java	`93.04% <0.00%> (-3.36%)`	⬇️
...ry/src/main/java/io/sentry/TransactionContext.java	`73.21% <ø> (ø)`
...va/io/sentry/config/ClasspathPropertiesLoader.java	`94.44% <ø> (ø)`
...entry/internal/modules/ResourcesModulesLoader.java	`70.58% <33.33%> (-9.42%)`	⬇️
sentry/src/main/java/io/sentry/SentryTracer.java	`89.15% <40.00%> (-1.01%)`	⬇️
sentry/src/main/java/io/sentry/DsnUtil.java	`78.57% <78.57%> (ø)`
sentry/src/main/java/io/sentry/DateUtils.java	`100.00% <100.00%> (ø)`
...n/java/io/sentry/transport/ReusableCountLatch.java	`88.23% <0.00%> (+5.88%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

mydea · 2022-11-14T15:35:07Z

...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java

+      return;
+    }
+
+    if (isSentryRequest(otelSpan)) {


Just FYI, you may have considered this anyhow, but in the JS OTEL implementation, no attributes are set when onStart is called - attributes are (sadly) only available to check in onEnd, meaning we can't check like this. Just to keep this in mind, and make sure to test/try that these attributes are actually available here (in Ruby they are available, as far as I understood).

@mydea I just double checked. Attributes are set in onStart. If the logic didn't work we'd be creating an infinite loop here as every request to Sentry would create another one - which is not the case.

I guess this means the JS SDK starts a new span for every request to Sentry that is then never finished. In Java this could be causing problems when combined with waitForChildren or idleTimeout. Also I guess we'd be spamming the UI with lots of unfinished spans in case they aren't filtered out. But I presume you've taken care of all those things or they're not relevant in JS.

Ah no infinite loops (as that's prevented by the check in onEnd) just unnecessary Spans that might be causing the issues I just mentioned.

yeah, exactly, unfortunately that's what we have to do in the JS SDK. They are never sent to the UI in that case, but "dropped" once we hit onEnd. It's obv. not ideal, but sadly no other way to handle this (*that we've found so far, at least).

but perfect if it works here 👍 just wanted to point this out as a learning we made the hard way ;)

🙏 only thing i can think of atm is to only start the transaction in onEnd if we care about it (and set timestamps correctly) and totally ignore onStart

The problem there is that you get into weird situation with parent spans etc, as when a span is finished you don't know about the parent yet (because that's not finished and thus wasn't handled yet). Anyways, lucky for you that seems to be a JS-only problem 😂

mydea · 2022-11-14T16:24:13Z

...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java

+      return;
+    }
+
+    if (isSentryRequest(otelSpan)) {


This might be an unnecessary optimization, but I guess we can maybe skip this? As if that is a sentry request, the sentrySpan will always be null because if was never saved to the map, thus this branch should not really be reachable? (Can be left of course as added security, I guess the overhead is not really relevant, but 🤷 )

Hmm agree that it "should" not be reached. If in any case we're unable to detect a request to Sentry in onStart I'd rather be safe than sorry though as it would then cause an infinite loop which this if is able to avoid. My gut tells me to leave it in.

AbhiPrasad · 2022-11-21T10:49:40Z

sentry/src/main/java/io/sentry/NoOpSpan.java

@@ -57,6 +57,9 @@ public void finish() {}
  @Override
  public void finish(@Nullable SpanStatus status) {}

+  @Override
+  public void finish(@Nullable SpanStatus status, @Nullable Date timestamp) {}


l: Do we need a changelog entry for the new overload?

I can add one but I don't think we usually mention every API change explicitly when implementing new features. I was planning on adding a single changelog entry for the whole basic OTEL support when merging #2344

...lemetry/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SpanDescription.java

...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java

AbhiPrasad · 2022-11-21T10:58:54Z

...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java

+        traceData.getParentSpanId() == null ? null : spans.get(traceData.getParentSpanId());
+
+    if (sentryParentSpan != null) {
+      System.out.println("found a parent span: " + traceData.getParentSpanId());


we should add some additional debug logging everywhere, but we can do that in a follow up PR.

Can send a separate PR with logging. Added it to TODOs in #2327

...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java

AbhiPrasad

sentry/src/main/java/io/sentry/SentryTracer.java

buildSrc/src/main/java/Config.kt

...entry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SpanDescriptionExtractor.java

...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java

romtsn

LGTM 👍

adinauer added 4 commits November 8, 2022 11:49

Add modules for OTEL

2e41724

Add new modules in files

0ee226e

Add instrumenter option

ef5e638

Partially implement SpanProcessor

8084227

adinauer changed the base branch from main to feat/otel November 14, 2022 08:44

Merge branch 'feat/otel' into feat/otel-span-processor

9cef931

mydea reviewed Nov 14, 2022

View reviewed changes

adinauer mentioned this pull request Nov 17, 2022

Java SDK basic OTEL Support #2327

Closed

21 tasks

adinauer requested review from AbhiPrasad and sl0thentr0py November 21, 2022 06:50

adinauer marked this pull request as ready for review November 21, 2022 06:50

adinauer requested review from romtsn, stefanosiano and markushi as code owners November 21, 2022 06:50

AbhiPrasad reviewed Nov 21, 2022

View reviewed changes

AbhiPrasad approved these changes Nov 21, 2022

View reviewed changes

romtsn reviewed Nov 25, 2022

View reviewed changes

sentry/src/main/java/io/sentry/SentryTracer.java Show resolved Hide resolved

romtsn reviewed Nov 25, 2022

View reviewed changes

buildSrc/src/main/java/Config.kt Show resolved Hide resolved

romtsn reviewed Nov 28, 2022

View reviewed changes

...entry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SpanDescriptionExtractor.java Show resolved Hide resolved

romtsn reviewed Nov 28, 2022

View reviewed changes

...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java Show resolved Hide resolved

romtsn approved these changes Nov 28, 2022

View reviewed changes

Add contexts to SentryTracer and add otel context to it (#2361)

cb2fb89

adinauer merged commit 5095c0f into feat/otel Nov 28, 2022

adinauer deleted the feat/otel-span-processor branch November 28, 2022 10:28

This was referenced Jun 20, 2023

OpenTelemetry Support getsentry/sentry-dotnet#2066

Closed

OpenTelemetry support getsentry/sentry-dotnet#2434

Closed

jamescrosswell mentioned this pull request Jun 28, 2023

Feature: Open Telemetry Support getsentry/sentry-dotnet#2453

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `SpanProcessor` for OTEL #2357

Add `SpanProcessor` for OTEL #2357

adinauer commented Nov 14, 2022 •

edited

Loading

github-actions bot commented Nov 14, 2022 •

edited

Loading

github-actions bot commented Nov 14, 2022 •

edited

Loading

Previous results on branch: feat/otel-span-processor

Startup times

App size

codecov-commenter commented Nov 14, 2022

mydea Nov 14, 2022

adinauer Nov 14, 2022

adinauer Nov 14, 2022

mydea Nov 14, 2022

adinauer Nov 14, 2022

mydea Nov 14, 2022

mydea Nov 14, 2022

adinauer Nov 14, 2022

AbhiPrasad Nov 21, 2022

adinauer Nov 21, 2022

AbhiPrasad Nov 21, 2022

adinauer Nov 21, 2022

AbhiPrasad left a comment

romtsn left a comment

Add SpanProcessor for OTEL #2357

Add SpanProcessor for OTEL #2357

Conversation

adinauer commented Nov 14, 2022 • edited Loading

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Nov 14, 2022 • edited Loading

github-actions bot commented Nov 14, 2022 • edited Loading

Performance metrics 🚀

Previous results on branch: feat/otel-span-processor

Startup times

App size

codecov-commenter commented Nov 14, 2022

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AbhiPrasad left a comment

Choose a reason for hiding this comment

romtsn left a comment

Choose a reason for hiding this comment

Add `SpanProcessor` for OTEL #2357

Add `SpanProcessor` for OTEL #2357

adinauer commented Nov 14, 2022 •

edited

Loading

github-actions bot commented Nov 14, 2022 •

edited

Loading

github-actions bot commented Nov 14, 2022 •

edited

Loading