Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(core): Remove sampled flag from dynamic sampling context in Tracing without Performance mode #13753

Merged

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Sep 23, 2024

This PR fixes a bug in Core that surfaced in Node apps configured for Tracing without Performance.

Previously, we'd incorrectly addsampled: false flag when creating the DSC from an active span if the application was configured for TwP. This is possible because in TwP, Otel still emits non-recording spans for the incoming requests. Our implementation in Core didn't account for this edge case yet.

This PR also adds a regression test and fixes some previously incorrectly passing tests.

@Lms24 Lms24 changed the title fix(core): Remove sampled flag from baggage meta tag in Tracing without Performance mode fix(core): Remove sampled flag from baggage meta tag in Tracing without Performance mode Sep 23, 2024
@Lms24 Lms24 changed the title fix(core): Remove sampled flag from baggage meta tag in Tracing without Performance mode fix(core): Remove sampled flag from dynamic sampling context in Tracing without Performance mode Sep 23, 2024
@Lms24 Lms24 self-assigned this Sep 23, 2024
@Lms24 Lms24 requested a review from mydea September 23, 2024 16:00
@@ -27,5 +27,6 @@ describe('getTraceMetaTags', () => {
expect(sentryBaggageContent).toContain('sentry-environment=production');
expect(sentryBaggageContent).toContain('sentry-public_key=public');
expect(sentryBaggageContent).toContain(`sentry-trace_id=${traceId}`);
expect(sentryBaggageContent).not.toContain('sentry-sampled=');
Copy link
Member Author

Choose a reason for hiding this comment

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

This assertion failed before the change in this PR

Copy link
Contributor

github-actions bot commented Sep 23, 2024

size-limit report 📦

⚠️ Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.

Path Size % Change Change
@sentry/browser 22.63 KB +0.23% +53 B 🔺
@sentry/browser - with treeshaking flags 21.42 KB +0.31% +67 B 🔺
@sentry/browser (incl. Tracing) 34.86 KB +0.01% +1 B 🔺
@sentry/browser (incl. Tracing, Replay) 71.36 KB +0.01% +7 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 61.79 KB -0.02% -7 B 🔽
@sentry/browser (incl. Tracing, Replay with Canvas) 75.71 KB +0.02% +12 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback) 88.48 KB +0.01% +6 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 90.36 KB +0.02% +10 B 🔺
@sentry/browser (incl. metrics) 26.91 KB +0.04% +11 B 🔺
@sentry/browser (incl. Feedback) 39.77 KB +0.14% +55 B 🔺
@sentry/browser (incl. sendFeedback) 27.29 KB +0.19% +52 B 🔺
@sentry/browser (incl. FeedbackAsync) 32.08 KB +0.17% +53 B 🔺
@sentry/react 25.38 KB +0.21% +53 B 🔺
@sentry/react (incl. Tracing) 37.84 KB +0.02% +7 B 🔺
@sentry/vue 26.8 KB +0.04% +9 B 🔺
@sentry/vue (incl. Tracing) 36.75 KB -0.01% -1 B 🔽
@sentry/svelte 22.76 KB +0.25% +57 B 🔺
CDN Bundle 23.94 KB +0.25% +59 B 🔺
CDN Bundle (incl. Tracing) 36.63 KB +0.01% +3 B 🔺
CDN Bundle (incl. Tracing, Replay) 71.13 KB +0.01% +1 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) 76.44 KB +0.01% +2 B 🔺
CDN Bundle - uncompressed 70.14 KB +0.28% +195 B 🔺
CDN Bundle (incl. Tracing) - uncompressed 108.6 KB +0.01% +8 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed 220.48 KB +0.01% +8 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 233.69 KB +0.01% +8 B 🔺
@sentry/nextjs (client) 37.8 KB +0.01% +2 B 🔺
@sentry/sveltekit (client) 35.43 KB -0.05% -17 B 🔽
@sentry/node 124.92 KB +0.01% +2 B 🔺
@sentry/node - without tracing 93.57 KB -0.02% -13 B 🔽
@sentry/aws-serverless 103.28 KB +0.01% +2 B 🔺

View base workflow run

metaTags: Sentry.getTraceMetaTags(),
},
};
if (!event.contexts.traceData) {
Copy link
Member

Choose a reason for hiding this comment

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

why is this change necessary?

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, two of the tests have become so similar that I'll just remove the beforeSend hook and one of the tests.


expect(traceData.metaTags).toContain(`<meta name="sentry-trace" content="${trace_id}-${span_id}"/>`);
expect(traceData.metaTags).toContain(`sentr y-trace_id=${trace_id}`);
Copy link
Member

Choose a reason for hiding this comment

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

how did that pass before? 😅 oops

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah, it "passed" because the test function was async but it should have been sync and passed done to the runner. So I guess the assertion failed eventually but at that point the test already passed and we never saw any failing logs 😬

@Lms24 Lms24 enabled auto-merge (squash) September 24, 2024 14:39
@Lms24 Lms24 merged commit 354dcee into develop Sep 24, 2024
131 of 132 checks passed
@Lms24 Lms24 deleted the lms/fix-core-getDynamicSamplingContextFromSpan-unsampled-span branch September 24, 2024 14:43
alexandresoro pushed a commit to alexandresoro/ouca that referenced this pull request Sep 25, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.31.0` -> `8.32.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.31.0/8.32.0) |
| [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.31.0` -> `8.32.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.31.0/8.32.0) |

---

### Release Notes

<details>
<summary>getsentry/sentry-javascript (@&#8203;sentry/node)</summary>

### [`v8.32.0`](https://github.com/getsentry/sentry-javascript/releases/tag/8.32.0)

[Compare Source](getsentry/sentry-javascript@8.31.0...8.32.0)

##### Important Changes

-   **ref(browser): Move navigation span descriptions into op ([#&#8203;13527](getsentry/sentry-javascript#13527

Moves the description of navigation related browser spans into the op, e.g. browser - cache -> browser.cache and sets
the description to the performanceEntry objects' names (in this context it is the URL of the page).

-   **feat(node): Add amqplibIntegration ([#&#8203;13714](getsentry/sentry-javascript#13714

-   **feat(nestjs): Add `SentryGlobalGenericFilter` and allow specifying application ref in global filter ([#&#8203;13673](getsentry/sentry-javascript#13673

Adds a `SentryGlobalGenericFilter` that filters both graphql and http exceptions depending on the context.

-   **feat: Set log level for Fetch/XHR breadcrumbs based on status code ([#&#8203;13711](getsentry/sentry-javascript#13711

Sets log levels in breadcrumbs for 5xx to error and 4xx to warning.

##### Other Changes

-   chore(nextjs): Bump rollup to 3.29.5 ([#&#8203;13761](getsentry/sentry-javascript#13761))
-   fix(core): Remove `sampled` flag from dynamic sampling context in Tracing without Performance mode ([#&#8203;13753](getsentry/sentry-javascript#13753))
-   fix(node): Ensure node-fetch does not emit spans without tracing ([#&#8203;13765](getsentry/sentry-javascript#13765))
-   fix(nuxt): Use Nuxt error hooks instead of errorHandler to prevent 500 ([#&#8203;13748](getsentry/sentry-javascript#13748))
-   fix(test): Unflake LCP test ([#&#8203;13741](getsentry/sentry-javascript#13741))

Work in this release was contributed by [@&#8203;Zen-cronic](https://github.com/Zen-cronic) and [@&#8203;Sjoertjuh](https://github.com/Sjoertjuh). Thank you for your contributions!

##### Bundle size 📦

| Path                                                             | Size              |
| ---------------------------------------------------------------- | ----------------- |
| [@&#8203;sentry/browser](https://github.com/sentry/browser)                                                  | 22.63 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) - with treeshaking flags                         | 21.42 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. Tracing)                                  | 34.86 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay)                          | 71.36 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay) - with treeshaking flags | 61.79 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay with Canvas)              | 75.71 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay, Feedback)                | 88.48 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay, Feedback, metrics)       | 90.36 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. metrics)                                  | 26.91 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. Feedback)                                 | 39.77 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. sendFeedback)                             | 27.29 KB  |
| [@&#8203;sentry/browser](https://github.com/sentry/browser) (incl. FeedbackAsync)                            | 32.08 KB  |
| [@&#8203;sentry/react](https://github.com/sentry/react)                                                    | 25.38 KB  |
| [@&#8203;sentry/react](https://github.com/sentry/react) (incl. Tracing)                                    | 37.84 KB  |
| [@&#8203;sentry/vue](https://github.com/sentry/vue)                                                      | 26.8 KB   |
| [@&#8203;sentry/vue](https://github.com/sentry/vue) (incl. Tracing)                                      | 36.75 KB  |
| [@&#8203;sentry/svelte](https://github.com/sentry/svelte)                                                   | 22.76 KB  |
| CDN Bundle                                                       | 23.94 KB  |
| CDN Bundle (incl. Tracing)                                       | 36.63 KB  |
| CDN Bundle (incl. Tracing, Replay)                               | 71.13 KB  |
| CDN Bundle (incl. Tracing, Replay, Feedback)                     | 76.44 KB  |
| CDN Bundle - uncompressed                                        | 70.14 KB  |
| CDN Bundle (incl. Tracing) - uncompressed                        | 108.6 KB  |
| CDN Bundle (incl. Tracing, Replay) - uncompressed                | 220.48 KB |
| CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed      | 233.69 KB |
| [@&#8203;sentry/nextjs](https://github.com/sentry/nextjs) (client)                                          | 37.8 KB   |
| [@&#8203;sentry/sveltekit](https://github.com/sentry/sveltekit) (client)                                       | 35.43 KB  |
| [@&#8203;sentry/node](https://github.com/sentry/node)                                                     | 124.92 KB |
| [@&#8203;sentry/node](https://github.com/sentry/node) - without tracing                                   | 93.57 KB  |
| [@&#8203;sentry/aws-serverless](https://github.com/sentry/aws-serverless)                                           | 103.28 KB |

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC45NC4zIiwidXBkYXRlZEluVmVyIjoiMzguOTQuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->

Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/161
Reviewed-by: Alexandre Soro <[email protected]>
Co-authored-by: renovate <[email protected]>
Co-committed-by: renovate <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants