fix(core): Set `sentry.source` attribute to `custom` when calling `span.updateName` on `SentrySpan` #14251

Lms24 · 2024-11-13T09:54:59Z

This PR fixes a "regression" introduced in v8 where we no longer updated the source of the span when calling span.updateName. We had this behaviour in our v7 Transaction class (IIRC via transaction.setName(name, source) but most likely forgot to port it to the Span class as the event.transaction_info.source field is only relevant for transactions (i.e. root spans in today's SDK lingo).

The PR also adds and improves some unit and browser integration tests so that we check against the default source as well as that updating the name updates the source.

Important: While this is a fix in the core package it has no effect on spans created in the Node SDK, since these are created from OpenTelemetry. I'll open a second PR for Node, as the changes there are more involved. This fix only addresses the behaviour of our SentrySpan class, which is used in browser SDKs (and none-Otel SDKs if any others use tracing)

The issue addressed in this PR shouldn't be a major issue because it does not concern manually created root spans. Probably the only relevant scenario where this behaviour had user impact is something like:

SDK starts pageload/navigation span with source url (likely via browserTracingIntegration from @sentry/browser)
User updates the span name but doesn't set source explicitly
SDK sends transaction envelope with transaction_info.source: "url"
Relay applies clustering because the "url" source is low quality
Custom name is lost or modified by clustering.

Which again is unlikely an issue in framework SDKs because most of our routing instrumentations update the span name and set the source to "route". The described example would for example happen in @sentry/browser with the default browserTracingIntegration enabled and users running their own enhancement for e.g. a yet unsupported router.

github-actions · 2024-11-13T10:06:34Z

size-limit report 📦

Path	Size	% Change	Change
@sentry/browser	22.77 KB	-	-
@sentry/browser - with treeshaking flags	21.53 KB	-	-
@sentry/browser (incl. Tracing)	35.27 KB	+0.03%	+9 B 🔺
@sentry/browser (incl. Tracing, Replay)	71.99 KB	+0.02%	+9 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	62.37 KB	+0.03%	+17 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)	76.32 KB	+0.02%	+8 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)	89.15 KB	+0.01%	+9 B 🔺
@sentry/browser (incl. Feedback)	39.93 KB	-	-
@sentry/browser (incl. sendFeedback)	27.42 KB	-	-
@sentry/browser (incl. FeedbackAsync)	32.23 KB	-	-
@sentry/react	25.52 KB	-	-
@sentry/react (incl. Tracing)	38.23 KB	+0.03%	+8 B 🔺
@sentry/vue	26.92 KB	+0.06%	+15 B 🔺
@sentry/vue (incl. Tracing)	37.11 KB	+0.03%	+10 B 🔺
@sentry/svelte	22.91 KB	-	-
CDN Bundle	24.13 KB	-	-
CDN Bundle (incl. Tracing)	37.05 KB	+0.04%	+13 B 🔺
CDN Bundle (incl. Tracing, Replay)	71.71 KB	+0.02%	+11 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)	77.06 KB	+0.02%	+11 B 🔺
CDN Bundle - uncompressed	70.73 KB	-	-
CDN Bundle (incl. Tracing) - uncompressed	109.93 KB	+0.03%	+31 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed	222.45 KB	+0.02%	+31 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	235.67 KB	+0.02%	+31 B 🔺
@sentry/nextjs (client)	38.35 KB	+0.06%	+20 B 🔺
@sentry/sveltekit (client)	35.85 KB	+0.03%	+9 B 🔺
@sentry/node	134.29 KB	+0.01%	+7 B 🔺
@sentry/node - without tracing	96.46 KB	-	-
@sentry/aws-serverless	106.72 KB	-	-

View base workflow run

codecov · 2024-11-13T10:12:52Z

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
652	1	651	25

View the top 1 failed tests by shortest run time

performance.client.test.ts updates the transaction when using the back button

Stack Traces | 2.27s run time

performance.client.test.ts:49:1 updates the transaction when using the back button

To view more test analytics, go to the Test Analytics Dashboard
Got feedback? Let us know on Github

…an.updateName`

Lms24 · 2024-11-13T15:11:52Z

dev-packages/browser-integration-tests/suites/public-api/startSpan/basic/test.ts

-  expect(transaction.transaction).toBe('parent_span');
-  expect(transaction.spans).toBeDefined();
-});
+sentryTest(


adjusted this test to check that we by default start a span with source "custom"

Lms24 · 2024-11-13T15:12:32Z

...packages/browser-integration-tests/suites/tracing/browserTracingIntegration/pageload/test.ts

 import { sentryTest } from '../../../../utils/fixtures';
 import { getFirstSentryEnvelopeRequest, shouldSkipTracingTest } from '../../../../utils/helpers';

-sentryTest('should create a pageload transaction', async ({ getLocalTestPath, page }) => {
+sentryTest('creates a pageload transaction with url as source', async ({ getLocalTestPath, page }) => {


no behaviour change here, just to explicitly check that our default browserTracingIntegration starts spans with source "url"

packages/solid/src/solidrouter.ts

andreiborza · 2024-11-13T15:48:14Z

packages/core/src/tracing/sentrySpan.ts

@@ -193,6 +193,7 @@ export class SentrySpan implements Span {
   */
  public updateName(name: string): this {
    this._name = name;
+    this.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'custom');


l: Wondering if we would want to mention this in the jsdoc?

Good point, let me add a note

On second thought, I'll add this but only in #14280 (which is the PR to fix this and a couple of depending things in Node). Since we always pass the Span interface, I need to upadet the JSDoc of the interface which we should only do once the behaviour is adjusted everywhere.

…an.updateName` on `SentrySpan` (#14251) Fix a "regression" introduced in v8 where we no longer updated the source of the span when calling `span.updateName`. We had this behaviour in our v7 `Transaction` class (IIRC via `transaction.setName(name, source)` but most likely forgot to port it to the `Span` class as the `event.transaction_info.source` field is only relevant for transactions (i.e. root spans in today's SDK lingo).

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.37.1` -> `8.40.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.37.1/8.40.0) | | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.37.1` -> `8.40.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.37.1/8.40.0) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/node)</summary> ### [`v8.40.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8400) [Compare Source](getsentry/sentry-javascript@8.39.0...8.40.0) ##### Important Changes - **feat(angular): Support Angular 19 ([#14398](getsentry/sentry-javascript#14398 The `@sentry/angular` SDK can now be used with Angular 19. If you're upgrading to the new Angular version, you might want to migrate from the now deprecated `APP_INITIALIZER` token to `provideAppInitializer`. In this case, change the Sentry `TraceService` initialization in `app.config.ts`: ```ts // Angular 18 export const appConfig: ApplicationConfig = { providers: [ // other providers { provide: TraceService, deps: [Router], }, { provide: APP_INITIALIZER, useFactory: () => () => {}, deps: [TraceService], multi: true, }, ], }; // Angular 19 export const appConfig: ApplicationConfig = { providers: [ // other providers { provide: TraceService, deps: [Router], }, provideAppInitializer(() => { inject(TraceService); }), ], }; ``` - **feat(core): Deprecate `debugIntegration` and `sessionTimingIntegration` ([#14363](getsentry/sentry-javascript#14363 The `debugIntegration` was deprecated and will be removed in the next major version of the SDK. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...). The `sessionTimingIntegration` was deprecated and will be removed in the next major version of the SDK. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`). - **feat(nestjs): Deprecate `@WithSentry` in favor of `@SentryExceptionCaptured` ([#14323](getsentry/sentry-javascript#14323 The `@WithSentry` decorator was deprecated. Use `@SentryExceptionCaptured` instead. This is a simple renaming and functionality stays identical. - **feat(nestjs): Deprecate `SentryTracingInterceptor`, `SentryService`, `SentryGlobalGenericFilter`, `SentryGlobalGraphQLFilter` ([#14371](getsentry/sentry-javascript#14371 The `SentryTracingInterceptor` was deprecated. If you are using `@sentry/nestjs` you can safely remove any references to the `SentryTracingInterceptor`. If you are using another package migrate to `@sentry/nestjs` and remove the `SentryTracingInterceptor` afterwards. The `SentryService` was deprecated and its functionality was added to `Sentry.init`. If you are using `@sentry/nestjs` you can safely remove any references to the `SentryService`. If you are using another package migrate to `@sentry/nestjs` and remove the `SentryService` afterwards. The `SentryGlobalGenericFilter` was deprecated. Use the `SentryGlobalFilter` instead which is a drop-in replacement. The `SentryGlobalGraphQLFilter` was deprecated. Use the `SentryGlobalFilter` instead which is a drop-in replacement. - **feat(node): Deprecate `nestIntegration` and `setupNestErrorHandler` in favor of using `@sentry/nestjs` ([#14374](getsentry/sentry-javascript#14374 The `nestIntegration` and `setupNestErrorHandler` functions from `@sentry/node` were deprecated and will be removed in the next major version of the SDK. If you're using `@sentry/node` in a NestJS application, we recommend switching to our new dedicated `@sentry/nestjs` package. ##### Other Changes - feat(browser): Send additional LCP timing info ([#14372](getsentry/sentry-javascript#14372)) - feat(replay): Clear event buffer when full and in buffer mode ([#14078](getsentry/sentry-javascript#14078)) - feat(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is merged ([#14315](getsentry/sentry-javascript#14315)) - feat(core): Hoist everything from `@sentry/utils` into `@sentry/core` ([#14382](getsentry/sentry-javascript#14382)) - fix(core): Do not throw when trying to fill readonly properties ([#14402](getsentry/sentry-javascript#14402)) - fix(feedback): Fix `__self` and `__source` attributes on feedback nodes ([#14356](getsentry/sentry-javascript#14356)) - fix(feedback): Fix non-wrapping form title ([#14355](getsentry/sentry-javascript#14355)) - fix(nextjs): Update check for not found navigation error ([#14378](getsentry/sentry-javascript#14378)) ### [`v8.39.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8390) [Compare Source](getsentry/sentry-javascript@8.38.0...8.39.0) ##### Important Changes - **feat(nestjs): Instrument event handlers ([#14307](getsentry/sentry-javascript#14307 The `@sentry/nestjs` SDK will now capture performance data for [NestJS Events (`@nestjs/event-emitter`)](https://docs.nestjs.com/techniques/events) ##### Other Changes - feat(nestjs): Add alias `@SentryExceptionCaptured` for `@WithSentry` ([#14322](getsentry/sentry-javascript#14322)) - feat(nestjs): Duplicate `SentryService` behaviour into `@sentry/nestjs` SDK `init()` ([#14321](getsentry/sentry-javascript#14321)) - feat(nestjs): Handle GraphQL contexts in `SentryGlobalFilter` ([#14320](getsentry/sentry-javascript#14320)) - feat(node): Add alias `childProcessIntegration` for `processThreadBreadcrumbIntegration` and deprecate it ([#14334](getsentry/sentry-javascript#14334)) - feat(node): Ensure request bodies are reliably captured for http requests ([#13746](getsentry/sentry-javascript#13746)) - feat(replay): Upgrade rrweb packages to 2.29.0 ([#14160](getsentry/sentry-javascript#14160)) - fix(cdn): Ensure `_sentryModuleMetadata` is not mangled ([#14344](getsentry/sentry-javascript#14344)) - fix(core): Set `sentry.source` attribute to `custom` when calling `span.updateName` on `SentrySpan` ([#14251](getsentry/sentry-javascript#14251)) - fix(mongo): rewrite Buffer as ? during serialization ([#14071](getsentry/sentry-javascript#14071)) - fix(replay): Remove replay id from DSC on expired sessions ([#14342](getsentry/sentry-javascript#14342)) - ref(profiling) Fix electron crash ([#14216](getsentry/sentry-javascript#14216)) - ref(types): Deprecate `Request` type in favor of `RequestEventData` ([#14317](getsentry/sentry-javascript#14317)) - ref(utils): Stop setting `transaction` in `requestDataIntegration` ([#14306](getsentry/sentry-javascript#14306)) - ref(vue): Reduce bundle size for starting application render span ([#14275](getsentry/sentry-javascript#14275)) ### [`v8.38.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8380) [Compare Source](getsentry/sentry-javascript@8.37.1...8.38.0) - docs: Improve docstrings for node otel integrations ([#14217](getsentry/sentry-javascript#14217)) - feat(browser): Add moduleMetadataIntegration lazy loading support ([#13817](getsentry/sentry-javascript#13817)) - feat(core): Add trpc path to context in trpcMiddleware ([#14218](getsentry/sentry-javascript#14218)) - feat(deps): Bump [@opentelemetry/instrumentation-amqplib](https://github.com/opentelemetry/instrumentation-amqplib) from 0.42.0 to 0.43.0 ([#14230](getsentry/sentry-javascript#14230)) - feat(deps): Bump [@sentry/cli](https://github.com/sentry/cli) from 2.37.0 to 2.38.2 ([#14232](getsentry/sentry-javascript#14232)) - feat(node): Add `knex` integration ([#13526](getsentry/sentry-javascript#13526)) - feat(node): Add `tedious` integration ([#13486](getsentry/sentry-javascript#13486)) - feat(utils): Single implementation to fetch debug ids ([#14199](getsentry/sentry-javascript#14199)) - fix(browser): Avoid recording long animation frame spans starting before their parent span ([#14186](getsentry/sentry-javascript#14186)) - fix(node): Include `debug_meta` with ANR events ([#14203](getsentry/sentry-javascript#14203)) - fix(nuxt): Fix dynamic import rollup plugin to work with latest nitro ([#14243](getsentry/sentry-javascript#14243)) - fix(react): Support wildcard routes on React Router 6 ([#14205](getsentry/sentry-javascript#14205)) - fix(spotlight): Export spotlightBrowserIntegration from the main browser package ([#14208](getsentry/sentry-javascript#14208)) - ref(browser): Ensure start time of interaction root and child span is aligned ([#14188](getsentry/sentry-javascript#14188)) - ref(nextjs): Make build-time value injection turbopack compatible ([#14081](getsentry/sentry-javascript#14081)) Work in this release was contributed by [@grahamhency](https://github.com/grahamhency), [@Zen-cronic](https://github.com/Zen-cronic), [@gilisho](https://github.com/gilisho) and [@phuctm97](https://github.com/phuctm97). Thank you for your contributions! </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/317 Reviewed-by: Alexandre Soro <code@soro.dev> Co-authored-by: renovate <renovate@git.tristess.app> Co-committed-by: renovate <renovate@git.tristess.app>

Lms24 self-assigned this Nov 13, 2024

Lms24 force-pushed the lms/fix-core-source-custom-span-updatename branch from 14aa37c to ddbf336 Compare November 13, 2024 10:25

Lms24 changed the title ~~fix(core): Set sentry.source attribute to custom when calling span.updateName~~ fix(core): Set sentry.source attribute to custom when calling span.updateName on SentrySpan Nov 13, 2024

Lms24 added 3 commits November 13, 2024 12:20

fix(core): Set sentry.source attribute to custom when calling `sp…

eb55f17

…an.updateName`

formatting

cf17780

size limit increase for vue+tracing

0f12ced

Lms24 force-pushed the lms/fix-core-source-custom-span-updatename branch from 08a8882 to 0f12ced Compare November 13, 2024 12:31

add browser-specific source updates after calling updateName

2232458

Lms24 commented Nov 13, 2024

View reviewed changes

packages/solid/src/solidrouter.ts Outdated Show resolved Hide resolved

Lms24 requested review from andreiborza, lforst and mydea November 13, 2024 15:19

Lms24 marked this pull request as ready for review November 13, 2024 15:19

Lms24 mentioned this pull request Nov 13, 2024

ref(vue): Reduce bundle size for starting application render span #14275

Merged

simplify solid router

ab779bb

Lms24 force-pushed the lms/fix-core-source-custom-span-updatename branch from bbbca89 to ab779bb Compare November 13, 2024 15:36

andreiborza reviewed Nov 13, 2024

View reviewed changes

andreiborza approved these changes Nov 13, 2024

View reviewed changes

Lms24 merged commit 5b77377 into develop Nov 14, 2024
149 checks passed

Lms24 deleted the lms/fix-core-source-custom-span-updatename branch November 14, 2024 14:57

antonis mentioned this pull request Nov 20, 2024

test(fix): Add sentry.source custom in the navigation span.data getsentry/sentry-react-native#4294

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(core): Set `sentry.source` attribute to `custom` when calling `span.updateName` on `SentrySpan` #14251

fix(core): Set `sentry.source` attribute to `custom` when calling `span.updateName` on `SentrySpan` #14251

Lms24 commented Nov 13, 2024 •

edited

Loading

github-actions bot commented Nov 13, 2024 •

edited

Loading

codecov bot commented Nov 13, 2024 •

edited

Loading

Lms24 Nov 13, 2024

Lms24 Nov 13, 2024

andreiborza Nov 13, 2024

Lms24 Nov 13, 2024

Lms24 Nov 13, 2024

fix(core): Set sentry.source attribute to custom when calling span.updateName on SentrySpan #14251

fix(core): Set sentry.source attribute to custom when calling span.updateName on SentrySpan #14251

Conversation

Lms24 commented Nov 13, 2024 • edited Loading

github-actions bot commented Nov 13, 2024 • edited Loading

size-limit report 📦

codecov bot commented Nov 13, 2024 • edited Loading

❌ 1 Tests Failed:

Lms24 Nov 13, 2024

Choose a reason for hiding this comment

Lms24 Nov 13, 2024

Choose a reason for hiding this comment

andreiborza Nov 13, 2024

Choose a reason for hiding this comment

Lms24 Nov 13, 2024

Choose a reason for hiding this comment

Lms24 Nov 13, 2024

Choose a reason for hiding this comment

fix(core): Set `sentry.source` attribute to `custom` when calling `span.updateName` on `SentrySpan` #14251

fix(core): Set `sentry.source` attribute to `custom` when calling `span.updateName` on `SentrySpan` #14251

Lms24 commented Nov 13, 2024 •

edited

Loading

github-actions bot commented Nov 13, 2024 •

edited

Loading

codecov bot commented Nov 13, 2024 •

edited

Loading