ref(browser): Move navigation span descriptions into op #13527

0Calories · 2024-08-29T15:52:51Z

Makes some modifications to browser spans:

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

This change is being made so that these browser spans can be ingested and grouped. Currently, all browser spans are grouped into a singular browser span, despite each of the operations that these span represent doing very different things.

This will improve the experience in the Spans tab of transaction summary and span summary, since we will be able to have proper groupings for browser spans.

github-actions · 2024-08-29T15:59:21Z

size-limit report 📦

Path	Size	% Change	Change
@sentry/browser	22.52 KB	-	-
@sentry/browser - with treeshaking flags	21.3 KB	-	-
@sentry/browser (incl. Tracing)	34.81 KB	+0.04%	+11 B 🔺
@sentry/browser (incl. Tracing, Replay)	71.31 KB	+0.02%	+9 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	61.76 KB	+0.02%	+9 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)	75.65 KB	+0.02%	+10 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)	88.43 KB	+0.01%	+6 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)	90.29 KB	+0.01%	+6 B 🔺
@sentry/browser (incl. metrics)	26.83 KB	-	-
@sentry/browser (incl. Feedback)	39.66 KB	-	-
@sentry/browser (incl. sendFeedback)	27.19 KB	-	-
@sentry/browser (incl. FeedbackAsync)	31.96 KB	-	-
@sentry/react	25.28 KB	-	-
@sentry/react (incl. Tracing)	37.78 KB	+0.04%	+12 B 🔺
@sentry/vue	26.72 KB	-	-
@sentry/vue (incl. Tracing)	36.68 KB	+0.02%	+7 B 🔺
@sentry/svelte	22.66 KB	-	-
CDN Bundle	23.83 KB	-	-
CDN Bundle (incl. Tracing)	36.57 KB	+0.04%	+13 B 🔺
CDN Bundle (incl. Tracing, Replay)	71.07 KB	+0.02%	+8 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)	76.39 KB	+0.02%	+11 B 🔺
CDN Bundle - uncompressed	69.81 KB	-	-
CDN Bundle (incl. Tracing) - uncompressed	108.46 KB	+0.02%	+20 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed	220.33 KB	+0.01%	+20 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	233.55 KB	+0.01%	+20 B 🔺
@sentry/nextjs (client)	37.55 KB	+0.05%	+16 B 🔺
@sentry/sveltekit (client)	35.39 KB	+0.06%	+19 B 🔺
@sentry/node	121.77 KB	-	-
@sentry/node - without tracing	93.41 KB	-	-
@sentry/aws-serverless	103.11 KB	-	-

View base workflow run

Lms24

The op change looks fine to me! I'm concerned about the raw URLs in the span descriptions but primarily I want to make sure we're aware of the implications (see my comment)

Lms24 · 2024-08-30T08:03:07Z

packages/browser-utils/src/metrics/browserMetrics.ts

-    op: 'browser',
-    name: name || event,
+    op: `browser.${name || event}`,
+    name: entry.name,


m: assigning the URL here makes the span name become high-cardinality. Are we aware of this? Does it have impact on Relay/grouping/etc? These are unparameterized, raw URLs. I assume they not only contain path parameters but also potentially query and hash params. We generally tried to stay as far away as possible from this because historically, it always led to problems (e.g. dynamic sampling consistency, transaction name grouping)
The raw urls can also contain all kinds of tokens and ids.
I'm not 100% against changing this, I just want to make sure we're aware of the implications.

I guess an alternative would be to just describe a bit what this span is doing?

Hi Lukas, a very valid point but it's something we are aware of! There's currently no grouping in Relay for browser spans, so the cardinality will not be an issue. However, we already have the functionality available to scrub/parameterize URLs, which we use for resource and HTTP spans, for example. My next step is to update Relay to scrub these browser spans so they can be grouped safely.

Putting something different and low cardinality in the description would not be as useful, since we'd be losing a lot of details when looking at the span summary.

lforst · 2024-08-30T10:24:13Z

@JonasBa In case this lands we need to update the trace gymnastics to also work with browser.request span ops instead of just request.

JonasBa · 2024-08-30T11:44:43Z

Good thinking @lforst, let me open a PR to support this on sentry.

0Calories · 2024-09-04T16:12:45Z

@lforst @Lms24 is there anything else that needs attention before this can be approved?

Lms24

Sorry for the wait @0Calories! I think technically this is ready to go (so I'll ✅ it) but before we merge this: @JonasBa can you give us a timeline on the necessary trace view change? Ideally we make this a seamless transition.

0Calories · 2024-09-05T14:26:42Z

Sounds good! Not in a rush so I will wait for the trace view change before merging this

JonasBa · 2024-09-09T14:59:36Z

@lforst @0Calories sorry, I was out last week. I'll make the changes today to handle this change

Add reparenting support for the incoming renaming change in getsentry/sentry-javascript#13527

lforst · 2024-09-19T08:40:24Z

I guess we can merge this now?

lforst · 2024-09-19T08:40:58Z

Before I forget: Can you prepare a changelog entry in the ## unreleased section that explains this change to users?

0Calories · 2024-09-19T15:18:05Z

Thanks for the reminder! Let me do that now

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 (@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 ([#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 ([#13714](getsentry/sentry-javascript#13714 - **feat(nestjs): Add `SentryGlobalGenericFilter` and allow specifying application ref in global filter ([#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 ([#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 ([#13761](getsentry/sentry-javascript#13761)) - fix(core): Remove `sampled` flag from dynamic sampling context in Tracing without Performance mode ([#13753](getsentry/sentry-javascript#13753)) - fix(node): Ensure node-fetch does not emit spans without tracing ([#13765](getsentry/sentry-javascript#13765)) - fix(nuxt): Use Nuxt error hooks instead of errorHandler to prevent 500 ([#13748](getsentry/sentry-javascript#13748)) - fix(test): Unflake LCP test ([#13741](getsentry/sentry-javascript#13741)) Work in this release was contributed by [@Zen-cronic](https://github.com/Zen-cronic) and [@Sjoertjuh](https://github.com/Sjoertjuh). Thank you for your contributions! ##### Bundle size 📦 | Path | Size | | ---------------------------------------------------------------- | ----------------- | | [@sentry/browser](https://github.com/sentry/browser) | 22.63 KB | | [@sentry/browser](https://github.com/sentry/browser) - with treeshaking flags | 21.42 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing) | 34.86 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay) | 71.36 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay) - with treeshaking flags | 61.79 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay with Canvas) | 75.71 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay, Feedback) | 88.48 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay, Feedback, metrics) | 90.36 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. metrics) | 26.91 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Feedback) | 39.77 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. sendFeedback) | 27.29 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. FeedbackAsync) | 32.08 KB | | [@sentry/react](https://github.com/sentry/react) | 25.38 KB | | [@sentry/react](https://github.com/sentry/react) (incl. Tracing) | 37.84 KB | | [@sentry/vue](https://github.com/sentry/vue) | 26.8 KB | | [@sentry/vue](https://github.com/sentry/vue) (incl. Tracing) | 36.75 KB | | [@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 | | [@sentry/nextjs](https://github.com/sentry/nextjs) (client) | 37.8 KB | | [@sentry/sveltekit](https://github.com/sentry/sveltekit) (client) | 35.43 KB | | [@sentry/node](https://github.com/sentry/node) | 124.92 KB | | [@sentry/node](https://github.com/sentry/node) - without tracing | 93.57 KB | | [@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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  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]>

ref(browser): Move navigation span descriptions into op

477128e

adjust a test

610585c

0Calories self-assigned this Aug 29, 2024

0Calories added 4 commits August 29, 2024 13:57

adjust another test

8ff8ac9

update request and response spans and update tests

7a10db7

update request and response spans

0d418c2

remove test results file

f5955cb

0Calories requested review from lforst, a team and andreiborza and removed request for a team August 29, 2024 18:52

0Calories marked this pull request as ready for review August 29, 2024 18:53

0Calories added 2 commits August 29, 2024 15:05

update an e2e test i missed

db010bd

update sentry.op in tests

cb21d0c

mydea requested a review from Lms24 August 30, 2024 07:24

Lms24 reviewed Aug 30, 2024

View reviewed changes

Lms24 approved these changes Sep 5, 2024

View reviewed changes

JonasBa mentioned this pull request Sep 9, 2024

ref(tracing): support browser.request span for reparenting getsentry/sentry#77176

Merged

JonasBa added a commit to getsentry/sentry that referenced this pull request Sep 10, 2024

ref(tracing): support browser.request span for reparenting (#77176)

0dddd89

Add reparenting support for the incoming renaming change in getsentry/sentry-javascript#13527

c298lee pushed a commit to getsentry/sentry that referenced this pull request Sep 10, 2024

ref(tracing): support browser.request span for reparenting (#77176)

f75669d

Add reparenting support for the incoming renaming change in getsentry/sentry-javascript#13527

add unreleased changelog entry

cf18b7b

0Calories merged commit 021c8c1 into develop Sep 23, 2024
131 checks passed

0Calories deleted the ash/ref/browser-navigation-span-ops branch September 23, 2024 17:19

github-actions bot mentioned this pull request Sep 23, 2024

ref: Add external contributor to CHANGELOG.md #13755

Closed

FengShangWuQi mentioned this pull request Oct 23, 2024

[Snyk] Upgrade @sentry/gatsby from 7.20.0 to 8.32.0 FengShangWuQi/fengshangwuqi.github.io#1926

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ref(browser): Move navigation span descriptions into op #13527

ref(browser): Move navigation span descriptions into op #13527

0Calories commented Aug 29, 2024 •

edited

Loading

github-actions bot commented Aug 29, 2024 •

edited

Loading

Lms24 left a comment

Lms24 Aug 30, 2024 •

edited

Loading

0Calories Aug 30, 2024

lforst commented Aug 30, 2024

JonasBa commented Aug 30, 2024 •

edited

Loading

0Calories commented Sep 4, 2024

Lms24 left a comment •

edited

Loading

0Calories commented Sep 5, 2024

JonasBa commented Sep 9, 2024

lforst commented Sep 19, 2024

lforst commented Sep 19, 2024

0Calories commented Sep 19, 2024

ref(browser): Move navigation span descriptions into op #13527

ref(browser): Move navigation span descriptions into op #13527

Conversation

0Calories commented Aug 29, 2024 • edited Loading

github-actions bot commented Aug 29, 2024 • edited Loading

size-limit report 📦

Lms24 left a comment

Choose a reason for hiding this comment

Lms24 Aug 30, 2024 • edited Loading

Choose a reason for hiding this comment

0Calories Aug 30, 2024

Choose a reason for hiding this comment

lforst commented Aug 30, 2024

JonasBa commented Aug 30, 2024 • edited Loading

0Calories commented Sep 4, 2024

Lms24 left a comment • edited Loading

Choose a reason for hiding this comment

0Calories commented Sep 5, 2024

JonasBa commented Sep 9, 2024

lforst commented Sep 19, 2024

lforst commented Sep 19, 2024

0Calories commented Sep 19, 2024

0Calories commented Aug 29, 2024 •

edited

Loading

github-actions bot commented Aug 29, 2024 •

edited

Loading

Lms24 Aug 30, 2024 •

edited

Loading

JonasBa commented Aug 30, 2024 •

edited

Loading

Lms24 left a comment •

edited

Loading