feat(opentelemetry): Ensure DSC & attributes are correctly set #10806

mydea · 2024-02-26T11:10:35Z

This PR fixes a few things about the OTEL handling of our SDK.

Ensure that attributes are actually correctly put on the trace data - we used to remove e.g. sentry.sample_rate which we don't do in "main" SDK. Question: Should we remove the otel.attributes context data then? As this is kind of redundant at this point with the data on the trace?
Ensure we put the transaction tag correctly on the transaction, to align with "main" SDK.
Ensure we store the incoming DSC as traceState, so we can pick this up. This can include e.g. transaction name and stuff like this to persist.

github-actions · 2024-02-26T14:18:46Z

size-limit report 📦

Path	Size
@sentry/browser (incl. Tracing, Replay, Feedback) - Webpack (gzipped)	77.29 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)	68.55 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas) - Webpack (gzipped)	72.46 KB (0%)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)	62.05 KB (0%)
@sentry/browser (incl. Tracing) - Webpack (gzipped)	32.73 KB (0%)
@sentry/browser (incl. browserTracingIntegration) - Webpack (gzipped)	32.73 KB (0%)
@sentry/browser (incl. Feedback) - Webpack (gzipped)	30.91 KB (0%)
@sentry/browser (incl. sendFeedback) - Webpack (gzipped)	30.91 KB (0%)
@sentry/browser - Webpack (gzipped)	22.19 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback) - ES6 CDN Bundle (gzipped)	75.69 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)	67.46 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)	33.24 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped)	24.74 KB (0%)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)	211.04 KB (0%)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)	99.76 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)	73.96 KB (0%)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)	36.29 KB (0%)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)	68.83 KB (0%)
@sentry/react - Webpack (gzipped)	22.22 KB (0%)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)	85.24 KB (0%)
@sentry/nextjs Client - Webpack (gzipped)	49.62 KB (0%)
@sentry-internal/feedback - Webpack (gzipped)	17.14 KB (0%)

Lms24

LGTM!

Should we remove the otel.attributes context data then?

What field is this exactly on the event? I don't think we should remove stuff from event.contexts.trace.data (which IIUC span attributes end up in) because IIRC either ingest or the product later need these fields.

mydea · 2024-02-27T08:55:44Z

LGTM!

Should we remove the otel.attributes context data then?

What field is this exactly on the event? I don't think we should remove stuff from event.contexts.trace.data (which IIUC span attributes end up in) because IIRC either ingest or the product later need these fields.

What I mean is that we send the "root span" attributes in contexts.trace.data, but we also send all otel span attributes in contexts.otel.attributes - which now is basically the same list of attributes, twice 🤔

lforst

I have a feeling that we are missing the inverse logic in inject. More concretely we need to take the dynamic sampling context of the current span when inject is called, e.g. by calling getDynamicSamplingContextFromSpan([current span]) on the current span. I think I might have missed this previously.

lforst · 2024-02-27T09:02:16Z

packages/opentelemetry/src/setupEventContextTrace.ts

      return event;
    }

    const spanContext = span.spanContext();

    // If event has already set `trace` context, use that one.
    event.contexts = {
-      trace: {
+      trace: dropUndefinedKeys({


Why do we have to add dropUndefinedKeys here?

I figured it's nicer to not send an undefined parent_span_id (this was one debugging step when I was fixing tests etc), but we can also leave it!

lforst · 2024-02-27T09:03:25Z

packages/opentelemetry/src/setupEventContextTrace.ts

+    const rootSpan = getRootSpan(span);
+    const transactionName = spanHasName(rootSpan) ? rootSpan.name : undefined;
+    if (transactionName) {
+      event.tags = { transaction: transactionName, ...event.tags };


Is transaction really a tag? I thought the transaction for an error was stored in the top level transaction field.

we store both of these right now - we can revisit later if this is (still?) needed, but I figured to maintain parity for now this makes sense!

lforst · 2024-02-27T09:04:03Z

packages/opentelemetry/src/spanExporter.ts

@@ -159,13 +171,13 @@ function createTransactionForOtelSpan(span: ReadableSpan): Transaction {
    status: mapStatus(span),
    startTimestamp: convertOtelTimeToSeconds(span.startTime),
    metadata: {
-      sampleRate: span.attributes[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE] as number | undefined,
+      ...dropUndefinedKeys({


Same q: Why dropUndefinedKeys here?

here I think it is important, because dynamicSamplingContext may be undefined in which case we don't want to set it, because later in the pipeline if you have e.g. this:

metadata: { dynamicSamplingContext: xx, ...event.metadata }

this would overwrite xx even if it is undefined, I think?

right... makes sense! Thank you!

lforst · 2024-02-27T09:07:27Z

packages/opentelemetry/src/spanExporter.ts

@@ -180,7 +192,14 @@ function createTransactionForOtelSpan(span: ReadableSpan): Transaction {
  });

  if (capturedSpanScopes) {
-    setCapturedScopesOnTransaction(transaction, capturedSpanScopes.scope, capturedSpanScopes.isolationScope);
+    // Ensure the `transaction` tag is correctly set on the transaction event


Same q: Is the transaction value really a tag? It shows up in the interface as tag but I think it is top level on the event, eg: https://us.sentry.io/api/0/projects/sentry/sentry/events/9f6a861ccacf43868a4d7d6d63b9d922/json/

packages/opentelemetry/src/utils/dynamicSamplingContext.ts

mydea · 2024-02-27T12:07:44Z

OK, I also updated the propagator to look at the span trace state first, and only then fall back to propagation context! I also added tests to cover this, and also to ensure trace state is correctly inherited & applied for spans.

mydea requested review from lforst, Lms24 and AbhiPrasad February 26, 2024 11:10

mydea self-assigned this Feb 26, 2024

mydea mentioned this pull request Feb 26, 2024

feat(opentelemetry): Support forceTransaction in OTEL #10807

Merged

mydea force-pushed the fn/otel-dsc-attributes branch from 85a7887 to b35d861 Compare February 26, 2024 14:12

Lms24 approved these changes Feb 26, 2024

View reviewed changes

mydea added 4 commits February 26, 2024 15:06

feat(opentelemetry): Ensure DSC & attributes are correctly set

882a24e

fix tests for node

28bffa1

fix e2e test?

4933d92

fix tests??

0796c63

mydea force-pushed the fn/otel-dsc-attributes branch from b35d861 to 0796c63 Compare February 26, 2024 16:20

fix e2e test

6de768d

fix e2e test for real?

c9dde6a

lforst reviewed Feb 27, 2024

View reviewed changes

rewrite method

a906b9a

mydea force-pushed the fn/otel-dsc-attributes branch from bbb7c84 to cabb3d4 Compare February 27, 2024 12:08

mydea requested a review from lforst February 27, 2024 12:08

ensure trace state is picked up form spans & add tests

39d43cc

mydea force-pushed the fn/otel-dsc-attributes branch from cabb3d4 to 39d43cc Compare February 27, 2024 12:12

mydea added 3 commits February 27, 2024 12:31

unflake test...

8790626

Merge branch 'develop' into fn/otel-dsc-attributes

6bbf1e2

fix e2e test

3073700

lforst approved these changes Feb 27, 2024

View reviewed changes

mydea merged commit 240fd8a into develop Feb 27, 2024
105 checks passed

mydea deleted the fn/otel-dsc-attributes branch February 27, 2024 16:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(opentelemetry): Ensure DSC & attributes are correctly set #10806

feat(opentelemetry): Ensure DSC & attributes are correctly set #10806

mydea commented Feb 26, 2024

github-actions bot commented Feb 26, 2024 •

edited

Loading

Lms24 left a comment •

edited

Loading

mydea commented Feb 27, 2024

lforst left a comment

lforst Feb 27, 2024

mydea Feb 27, 2024

lforst Feb 27, 2024

mydea Feb 27, 2024

lforst Feb 27, 2024

mydea Feb 27, 2024

lforst Feb 27, 2024

lforst Feb 27, 2024

mydea commented Feb 27, 2024

feat(opentelemetry): Ensure DSC & attributes are correctly set #10806

feat(opentelemetry): Ensure DSC & attributes are correctly set #10806

Conversation

mydea commented Feb 26, 2024

github-actions bot commented Feb 26, 2024 • edited Loading

size-limit report 📦

Lms24 left a comment • edited Loading

Choose a reason for hiding this comment

mydea commented Feb 27, 2024

lforst left a 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

mydea commented Feb 27, 2024

github-actions bot commented Feb 26, 2024 •

edited

Loading

Lms24 left a comment •

edited

Loading