feat(core): Add updateSpanName helper function - #14291

Merged
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper
Dec 16, 2024
Merged

feat(core): Add updateSpanName helper function#14291
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper

Conversation

@Lms24

@Lms24Lms24 commented Nov 14, 2024

Copy link
Copy Markdown
Member

TL;DR: This PR Adds Sentry.updateSpanName() to reliably update span names in OpenTelemetry environments; prevents overwrites from both OpenTelemetry HTTP instrumentation and Sentry's span inference logic; preserves custom names by marking them with 'custom' source and storing in temp field which takes precedence over the actual name and gets deleted at the end

"Why not use span.updateName()?", the avid SDK user might ask. Here's why:

In our Node SDK, most/all spans are created by OpenTelemetry instrumentation. OpenTelemetry has no concept of a transaction source and only stores the name of the span in the Span instance. Some instrumentation, most importantly, @opentelemetry/instrumentation-http starts a span (in this case root span) and later on updates the name. In the http case, this update happens at the end of the request lifecycle. Consequently, any span name updates prior to this call, regardless of them coming from our SDK or from users, are overwritten.

In addition to this limitation within Otel instrumentation, we also have our own span name, op and source inference logic which we apply when exporting the span to add Sentry-specific data (like a better span name, an op, a transaction source and additional data) to otel-generated spans. So even if Otel didn't call updateName() in its instrumentation, user-made updateName calls to e.g. http.server spans were also overwritten by our logic.

So we need some way of 1. bypassing our span inference logic and 2. ensuring a user-update span name has precedence over otel's span name updates.

1 we can achieve with setting the source attribute to custom and ensuring we don't change the span name if we encounter a custom source.
2 we can only achieve if we write the user-updated span name to temporary field on the span and apply it during our span name processing logic.

This is exactly what updateSpanName does:

  • update the span name via span.updateName()
  • add SEMANTIC_ATTRIBUTES_SENTRY_SOURCE: 'custom to the span
  • add a temporary attribute with the provided name to the span

Further changes in this PR:

  • Ensure we use the span name from temporary attribute if provided in parseSpanDescription
  • Ensure we respect source custom in parseSpanDescription
  • Delete the temporary attribute when creating the transaction envelope (no need to send this)
  • Add a bunch of unit and integration tests for the newly added function.
  • Also add two unit tests showing that span.updateName has no effect on http.server spans, even if you set source custom

This PR supersedes #14280 where I thought we could monkey-patch span.updateName directly to make updating the span name AND the source more consistent without a new top-level function. Turns out, we cannot do this because then, Otel instrumentation would also call the monkey-patched version of updateName, meaning we can no longer distinguish between user-made and otel-made span name updates.

@github-actions

github-actionsBot commented Nov 14, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.29 KB--
@sentry/browser - with treeshaking flags21.96 KB--
@sentry/browser (incl. Tracing)35.81 KB+0.06%+20 B 🔺
@sentry/browser (incl. Tracing, Replay)73.05 KB+0.06%+42 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.44 KB+0.05%+31 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)77.36 KB+0.05%+37 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)89.84 KB+0.04%+30 B 🔺
@sentry/browser (incl. Feedback)40.04 KB--
@sentry/browser (incl. sendFeedback)27.89 KB--
@sentry/browser (incl. FeedbackAsync)32.68 KB--
@sentry/react25.96 KB--
@sentry/react (incl. Tracing)38.64 KB+0.1%+36 B 🔺
@sentry/vue27.52 KB+0.11%+30 B 🔺
@sentry/vue (incl. Tracing)37.67 KB+0.11%+39 B 🔺
@sentry/svelte23.45 KB--
CDN Bundle24.47 KB+0.19%+46 B 🔺
CDN Bundle (incl. Tracing)37.51 KB+0.16%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)72.69 KB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)78.09 KB+0.1%+79 B 🔺
CDN Bundle - uncompressed71.85 KB+0.15%+109 B 🔺
CDN Bundle (incl. Tracing) - uncompressed111.23 KB+0.17%+185 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed225.28 KB+0.09%+185 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed238.5 KB+0.08%+185 B 🔺
@sentry/nextjs (client)38.9 KB+0.05%+16 B 🔺
@sentry/sveltekit (client)36.32 KB+0.1%+36 B 🔺
@sentry/node162.68 KB+0.11%+170 B 🔺
@sentry/node - without tracing98.86 KB+0.16%+152 B 🔺
@sentry/aws-serverless126.52 KB+0.11%+134 B 🔺

View base workflow run

@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from 70674de to c7b6718CompareNovember 14, 2024 14:58
@codecov

codecovBot commented Nov 14, 2024

Copy link
Copy Markdown

❌ We are unable to process any of the uploaded JUnit XML files. Please ensure your files are in the right format.

@Lms24
Lms24 marked this pull request as ready for review November 14, 2024 16:23
},
],
[
'works with prefetch request',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This is just an additional test I added because we didn't test the condition to add .prefetch to the op.

Comment threadpackages/core/src/envelope.ts Outdated
Comment threadpackages/core/src/utils/spanUtils.ts Outdated
const httpMethod = attributes[ATTR_HTTP_REQUEST_METHOD] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
return descriptionForHttpMethod({ attributes, name: getOriginalName(spanName, attributes), kind }, httpMethod);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: Instead of repeating getOriginalName, can we just do this at the very top of this method and then use this processed name everywhere below?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I wanted to do this initially but then we'd potentially lose the inferred op, no?

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threaddev-packages/rollup-utils/plugins/bundlePlugins.mjs Outdated
Comment threadpackages/core/src/types-hoist/span.ts Outdated
@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from adee375 to 24e8320CompareDecember 13, 2024 09:41
@Lms24
Lms24 requested a review from mydeaDecember 13, 2024 11:31
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/core/src/envelope.ts Outdated
@Lms24
Lms24 merged commit f8ac98d into developDec 16, 2024
@Lms24
Lms24 deleted the lms/feat-span-updatename-wrapper branch December 16, 2024 15:30
Lms24 added a commit that referenced this pull request Dec 16, 2024
Add `Sentry.updateSpanName()` to reliably update span
names in OpenTelemetry environments; prevents overwrites from both
OpenTelemetry HTTP instrumentation and Sentry's span inference logic;
preserves custom names by marking them with 'custom' source and storing
in temp field which takes precedence over the actual name and gets
deleted at the end
Lms24 added a commit that referenced this pull request Dec 17, 2024
Sign up for freeto 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

@Lms24@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(core): Add updateSpanName helper function - #14291

Merged
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper
Dec 16, 2024
Merged

feat(core): Add updateSpanName helper function#14291
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper

Conversation

@Lms24

@Lms24Lms24 commented Nov 14, 2024

Copy link
Copy Markdown
Member

TL;DR: This PR Adds Sentry.updateSpanName() to reliably update span names in OpenTelemetry environments; prevents overwrites from both OpenTelemetry HTTP instrumentation and Sentry's span inference logic; preserves custom names by marking them with 'custom' source and storing in temp field which takes precedence over the actual name and gets deleted at the end

"Why not use span.updateName()?", the avid SDK user might ask. Here's why:

In our Node SDK, most/all spans are created by OpenTelemetry instrumentation. OpenTelemetry has no concept of a transaction source and only stores the name of the span in the Span instance. Some instrumentation, most importantly, @opentelemetry/instrumentation-http starts a span (in this case root span) and later on updates the name. In the http case, this update happens at the end of the request lifecycle. Consequently, any span name updates prior to this call, regardless of them coming from our SDK or from users, are overwritten.

In addition to this limitation within Otel instrumentation, we also have our own span name, op and source inference logic which we apply when exporting the span to add Sentry-specific data (like a better span name, an op, a transaction source and additional data) to otel-generated spans. So even if Otel didn't call updateName() in its instrumentation, user-made updateName calls to e.g. http.server spans were also overwritten by our logic.

So we need some way of 1. bypassing our span inference logic and 2. ensuring a user-update span name has precedence over otel's span name updates.

1 we can achieve with setting the source attribute to custom and ensuring we don't change the span name if we encounter a custom source.
2 we can only achieve if we write the user-updated span name to temporary field on the span and apply it during our span name processing logic.

This is exactly what updateSpanName does:

  • update the span name via span.updateName()
  • add SEMANTIC_ATTRIBUTES_SENTRY_SOURCE: 'custom to the span
  • add a temporary attribute with the provided name to the span

Further changes in this PR:

  • Ensure we use the span name from temporary attribute if provided in parseSpanDescription
  • Ensure we respect source custom in parseSpanDescription
  • Delete the temporary attribute when creating the transaction envelope (no need to send this)
  • Add a bunch of unit and integration tests for the newly added function.
  • Also add two unit tests showing that span.updateName has no effect on http.server spans, even if you set source custom

This PR supersedes #14280 where I thought we could monkey-patch span.updateName directly to make updating the span name AND the source more consistent without a new top-level function. Turns out, we cannot do this because then, Otel instrumentation would also call the monkey-patched version of updateName, meaning we can no longer distinguish between user-made and otel-made span name updates.

@github-actions

github-actionsBot commented Nov 14, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.29 KB--
@sentry/browser - with treeshaking flags21.96 KB--
@sentry/browser (incl. Tracing)35.81 KB+0.06%+20 B 🔺
@sentry/browser (incl. Tracing, Replay)73.05 KB+0.06%+42 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.44 KB+0.05%+31 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)77.36 KB+0.05%+37 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)89.84 KB+0.04%+30 B 🔺
@sentry/browser (incl. Feedback)40.04 KB--
@sentry/browser (incl. sendFeedback)27.89 KB--
@sentry/browser (incl. FeedbackAsync)32.68 KB--
@sentry/react25.96 KB--
@sentry/react (incl. Tracing)38.64 KB+0.1%+36 B 🔺
@sentry/vue27.52 KB+0.11%+30 B 🔺
@sentry/vue (incl. Tracing)37.67 KB+0.11%+39 B 🔺
@sentry/svelte23.45 KB--
CDN Bundle24.47 KB+0.19%+46 B 🔺
CDN Bundle (incl. Tracing)37.51 KB+0.16%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)72.69 KB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)78.09 KB+0.1%+79 B 🔺
CDN Bundle - uncompressed71.85 KB+0.15%+109 B 🔺
CDN Bundle (incl. Tracing) - uncompressed111.23 KB+0.17%+185 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed225.28 KB+0.09%+185 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed238.5 KB+0.08%+185 B 🔺
@sentry/nextjs (client)38.9 KB+0.05%+16 B 🔺
@sentry/sveltekit (client)36.32 KB+0.1%+36 B 🔺
@sentry/node162.68 KB+0.11%+170 B 🔺
@sentry/node - without tracing98.86 KB+0.16%+152 B 🔺
@sentry/aws-serverless126.52 KB+0.11%+134 B 🔺

View base workflow run

@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from 70674de to c7b6718CompareNovember 14, 2024 14:58
@codecov

codecovBot commented Nov 14, 2024

Copy link
Copy Markdown

❌ We are unable to process any of the uploaded JUnit XML files. Please ensure your files are in the right format.

@Lms24
Lms24 marked this pull request as ready for review November 14, 2024 16:23
},
],
[
'works with prefetch request',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This is just an additional test I added because we didn't test the condition to add .prefetch to the op.

Comment threadpackages/core/src/envelope.ts Outdated
Comment threadpackages/core/src/utils/spanUtils.ts Outdated
const httpMethod = attributes[ATTR_HTTP_REQUEST_METHOD] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
return descriptionForHttpMethod({ attributes, name: getOriginalName(spanName, attributes), kind }, httpMethod);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: Instead of repeating getOriginalName, can we just do this at the very top of this method and then use this processed name everywhere below?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I wanted to do this initially but then we'd potentially lose the inferred op, no?

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threaddev-packages/rollup-utils/plugins/bundlePlugins.mjs Outdated
Comment threadpackages/core/src/types-hoist/span.ts Outdated
@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from adee375 to 24e8320CompareDecember 13, 2024 09:41
@Lms24
Lms24 requested a review from mydeaDecember 13, 2024 11:31
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/core/src/envelope.ts Outdated
@Lms24
Lms24 merged commit f8ac98d into developDec 16, 2024
@Lms24
Lms24 deleted the lms/feat-span-updatename-wrapper branch December 16, 2024 15:30
Lms24 added a commit that referenced this pull request Dec 16, 2024
Add `Sentry.updateSpanName()` to reliably update span
names in OpenTelemetry environments; prevents overwrites from both
OpenTelemetry HTTP instrumentation and Sentry's span inference logic;
preserves custom names by marking them with 'custom' source and storing
in temp field which takes precedence over the actual name and gets
deleted at the end
Lms24 added a commit that referenced this pull request Dec 17, 2024
Sign up for freeto 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

@Lms24@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core): Add updateSpanName helper function - #14291

Merged
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper
Dec 16, 2024
Merged

feat(core): Add updateSpanName helper function#14291
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper

Conversation

@Lms24

@Lms24Lms24 commented Nov 14, 2024

Copy link
Copy Markdown
Member

TL;DR: This PR Adds Sentry.updateSpanName() to reliably update span names in OpenTelemetry environments; prevents overwrites from both OpenTelemetry HTTP instrumentation and Sentry's span inference logic; preserves custom names by marking them with 'custom' source and storing in temp field which takes precedence over the actual name and gets deleted at the end

"Why not use span.updateName()?", the avid SDK user might ask. Here's why:

In our Node SDK, most/all spans are created by OpenTelemetry instrumentation. OpenTelemetry has no concept of a transaction source and only stores the name of the span in the Span instance. Some instrumentation, most importantly, @opentelemetry/instrumentation-http starts a span (in this case root span) and later on updates the name. In the http case, this update happens at the end of the request lifecycle. Consequently, any span name updates prior to this call, regardless of them coming from our SDK or from users, are overwritten.

In addition to this limitation within Otel instrumentation, we also have our own span name, op and source inference logic which we apply when exporting the span to add Sentry-specific data (like a better span name, an op, a transaction source and additional data) to otel-generated spans. So even if Otel didn't call updateName() in its instrumentation, user-made updateName calls to e.g. http.server spans were also overwritten by our logic.

So we need some way of 1. bypassing our span inference logic and 2. ensuring a user-update span name has precedence over otel's span name updates.

1 we can achieve with setting the source attribute to custom and ensuring we don't change the span name if we encounter a custom source.
2 we can only achieve if we write the user-updated span name to temporary field on the span and apply it during our span name processing logic.

This is exactly what updateSpanName does:

  • update the span name via span.updateName()
  • add SEMANTIC_ATTRIBUTES_SENTRY_SOURCE: 'custom to the span
  • add a temporary attribute with the provided name to the span

Further changes in this PR:

  • Ensure we use the span name from temporary attribute if provided in parseSpanDescription
  • Ensure we respect source custom in parseSpanDescription
  • Delete the temporary attribute when creating the transaction envelope (no need to send this)
  • Add a bunch of unit and integration tests for the newly added function.
  • Also add two unit tests showing that span.updateName has no effect on http.server spans, even if you set source custom

This PR supersedes #14280 where I thought we could monkey-patch span.updateName directly to make updating the span name AND the source more consistent without a new top-level function. Turns out, we cannot do this because then, Otel instrumentation would also call the monkey-patched version of updateName, meaning we can no longer distinguish between user-made and otel-made span name updates.

@github-actions

github-actionsBot commented Nov 14, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.29 KB--
@sentry/browser - with treeshaking flags21.96 KB--
@sentry/browser (incl. Tracing)35.81 KB+0.06%+20 B 🔺
@sentry/browser (incl. Tracing, Replay)73.05 KB+0.06%+42 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.44 KB+0.05%+31 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)77.36 KB+0.05%+37 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)89.84 KB+0.04%+30 B 🔺
@sentry/browser (incl. Feedback)40.04 KB--
@sentry/browser (incl. sendFeedback)27.89 KB--
@sentry/browser (incl. FeedbackAsync)32.68 KB--
@sentry/react25.96 KB--
@sentry/react (incl. Tracing)38.64 KB+0.1%+36 B 🔺
@sentry/vue27.52 KB+0.11%+30 B 🔺
@sentry/vue (incl. Tracing)37.67 KB+0.11%+39 B 🔺
@sentry/svelte23.45 KB--
CDN Bundle24.47 KB+0.19%+46 B 🔺
CDN Bundle (incl. Tracing)37.51 KB+0.16%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)72.69 KB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)78.09 KB+0.1%+79 B 🔺
CDN Bundle - uncompressed71.85 KB+0.15%+109 B 🔺
CDN Bundle (incl. Tracing) - uncompressed111.23 KB+0.17%+185 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed225.28 KB+0.09%+185 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed238.5 KB+0.08%+185 B 🔺
@sentry/nextjs (client)38.9 KB+0.05%+16 B 🔺
@sentry/sveltekit (client)36.32 KB+0.1%+36 B 🔺
@sentry/node162.68 KB+0.11%+170 B 🔺
@sentry/node - without tracing98.86 KB+0.16%+152 B 🔺
@sentry/aws-serverless126.52 KB+0.11%+134 B 🔺

View base workflow run

@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from 70674de to c7b6718CompareNovember 14, 2024 14:58
@codecov

codecovBot commented Nov 14, 2024

Copy link
Copy Markdown

❌ We are unable to process any of the uploaded JUnit XML files. Please ensure your files are in the right format.

@Lms24
Lms24 marked this pull request as ready for review November 14, 2024 16:23
},
],
[
'works with prefetch request',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This is just an additional test I added because we didn't test the condition to add .prefetch to the op.

Comment threadpackages/core/src/envelope.ts Outdated
Comment threadpackages/core/src/utils/spanUtils.ts Outdated
const httpMethod = attributes[ATTR_HTTP_REQUEST_METHOD] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
return descriptionForHttpMethod({ attributes, name: getOriginalName(spanName, attributes), kind }, httpMethod);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: Instead of repeating getOriginalName, can we just do this at the very top of this method and then use this processed name everywhere below?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I wanted to do this initially but then we'd potentially lose the inferred op, no?

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threaddev-packages/rollup-utils/plugins/bundlePlugins.mjs Outdated
Comment threadpackages/core/src/types-hoist/span.ts Outdated
@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from adee375 to 24e8320CompareDecember 13, 2024 09:41
@Lms24
Lms24 requested a review from mydeaDecember 13, 2024 11:31
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/core/src/envelope.ts Outdated
@Lms24
Lms24 merged commit f8ac98d into developDec 16, 2024
@Lms24
Lms24 deleted the lms/feat-span-updatename-wrapper branch December 16, 2024 15:30
Lms24 added a commit that referenced this pull request Dec 16, 2024
Add `Sentry.updateSpanName()` to reliably update span
names in OpenTelemetry environments; prevents overwrites from both
OpenTelemetry HTTP instrumentation and Sentry's span inference logic;
preserves custom names by marking them with 'custom' source and storing
in temp field which takes precedence over the actual name and gets
deleted at the end
Lms24 added a commit that referenced this pull request Dec 17, 2024
Sign up for freeto 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

@Lms24@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core): Add updateSpanName helper function - #14291

Merged
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper
Dec 16, 2024
Merged

feat(core): Add updateSpanName helper function#14291
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper

Conversation

@Lms24

@Lms24Lms24 commented Nov 14, 2024

Copy link
Copy Markdown
Member

TL;DR: This PR Adds Sentry.updateSpanName() to reliably update span names in OpenTelemetry environments; prevents overwrites from both OpenTelemetry HTTP instrumentation and Sentry's span inference logic; preserves custom names by marking them with 'custom' source and storing in temp field which takes precedence over the actual name and gets deleted at the end

"Why not use span.updateName()?", the avid SDK user might ask. Here's why:

In our Node SDK, most/all spans are created by OpenTelemetry instrumentation. OpenTelemetry has no concept of a transaction source and only stores the name of the span in the Span instance. Some instrumentation, most importantly, @opentelemetry/instrumentation-http starts a span (in this case root span) and later on updates the name. In the http case, this update happens at the end of the request lifecycle. Consequently, any span name updates prior to this call, regardless of them coming from our SDK or from users, are overwritten.

In addition to this limitation within Otel instrumentation, we also have our own span name, op and source inference logic which we apply when exporting the span to add Sentry-specific data (like a better span name, an op, a transaction source and additional data) to otel-generated spans. So even if Otel didn't call updateName() in its instrumentation, user-made updateName calls to e.g. http.server spans were also overwritten by our logic.

So we need some way of 1. bypassing our span inference logic and 2. ensuring a user-update span name has precedence over otel's span name updates.

1 we can achieve with setting the source attribute to custom and ensuring we don't change the span name if we encounter a custom source.
2 we can only achieve if we write the user-updated span name to temporary field on the span and apply it during our span name processing logic.

This is exactly what updateSpanName does:

  • update the span name via span.updateName()
  • add SEMANTIC_ATTRIBUTES_SENTRY_SOURCE: 'custom to the span
  • add a temporary attribute with the provided name to the span

Further changes in this PR:

  • Ensure we use the span name from temporary attribute if provided in parseSpanDescription
  • Ensure we respect source custom in parseSpanDescription
  • Delete the temporary attribute when creating the transaction envelope (no need to send this)
  • Add a bunch of unit and integration tests for the newly added function.
  • Also add two unit tests showing that span.updateName has no effect on http.server spans, even if you set source custom

This PR supersedes #14280 where I thought we could monkey-patch span.updateName directly to make updating the span name AND the source more consistent without a new top-level function. Turns out, we cannot do this because then, Otel instrumentation would also call the monkey-patched version of updateName, meaning we can no longer distinguish between user-made and otel-made span name updates.

@github-actions

github-actionsBot commented Nov 14, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.29 KB--
@sentry/browser - with treeshaking flags21.96 KB--
@sentry/browser (incl. Tracing)35.81 KB+0.06%+20 B 🔺
@sentry/browser (incl. Tracing, Replay)73.05 KB+0.06%+42 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.44 KB+0.05%+31 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)77.36 KB+0.05%+37 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)89.84 KB+0.04%+30 B 🔺
@sentry/browser (incl. Feedback)40.04 KB--
@sentry/browser (incl. sendFeedback)27.89 KB--
@sentry/browser (incl. FeedbackAsync)32.68 KB--
@sentry/react25.96 KB--
@sentry/react (incl. Tracing)38.64 KB+0.1%+36 B 🔺
@sentry/vue27.52 KB+0.11%+30 B 🔺
@sentry/vue (incl. Tracing)37.67 KB+0.11%+39 B 🔺
@sentry/svelte23.45 KB--
CDN Bundle24.47 KB+0.19%+46 B 🔺
CDN Bundle (incl. Tracing)37.51 KB+0.16%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)72.69 KB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)78.09 KB+0.1%+79 B 🔺
CDN Bundle - uncompressed71.85 KB+0.15%+109 B 🔺
CDN Bundle (incl. Tracing) - uncompressed111.23 KB+0.17%+185 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed225.28 KB+0.09%+185 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed238.5 KB+0.08%+185 B 🔺
@sentry/nextjs (client)38.9 KB+0.05%+16 B 🔺
@sentry/sveltekit (client)36.32 KB+0.1%+36 B 🔺
@sentry/node162.68 KB+0.11%+170 B 🔺
@sentry/node - without tracing98.86 KB+0.16%+152 B 🔺
@sentry/aws-serverless126.52 KB+0.11%+134 B 🔺

View base workflow run

@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from 70674de to c7b6718CompareNovember 14, 2024 14:58
@codecov

codecovBot commented Nov 14, 2024

Copy link
Copy Markdown

❌ We are unable to process any of the uploaded JUnit XML files. Please ensure your files are in the right format.

@Lms24
Lms24 marked this pull request as ready for review November 14, 2024 16:23
},
],
[
'works with prefetch request',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This is just an additional test I added because we didn't test the condition to add .prefetch to the op.

Comment threadpackages/core/src/envelope.ts Outdated
Comment threadpackages/core/src/utils/spanUtils.ts Outdated
const httpMethod = attributes[ATTR_HTTP_REQUEST_METHOD] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
return descriptionForHttpMethod({ attributes, name: getOriginalName(spanName, attributes), kind }, httpMethod);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: Instead of repeating getOriginalName, can we just do this at the very top of this method and then use this processed name everywhere below?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I wanted to do this initially but then we'd potentially lose the inferred op, no?

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threaddev-packages/rollup-utils/plugins/bundlePlugins.mjs Outdated
Comment threadpackages/core/src/types-hoist/span.ts Outdated
@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from adee375 to 24e8320CompareDecember 13, 2024 09:41
@Lms24
Lms24 requested a review from mydeaDecember 13, 2024 11:31
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/core/src/envelope.ts Outdated
@Lms24
Lms24 merged commit f8ac98d into developDec 16, 2024
@Lms24
Lms24 deleted the lms/feat-span-updatename-wrapper branch December 16, 2024 15:30
Lms24 added a commit that referenced this pull request Dec 16, 2024
Add `Sentry.updateSpanName()` to reliably update span
names in OpenTelemetry environments; prevents overwrites from both
OpenTelemetry HTTP instrumentation and Sentry's span inference logic;
preserves custom names by marking them with 'custom' source and storing
in temp field which takes precedence over the actual name and gets
deleted at the end
Lms24 added a commit that referenced this pull request Dec 17, 2024
Sign up for freeto 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

@Lms24@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(core): Add updateSpanName helper function - #14291

Merged
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper
Dec 16, 2024
Merged

feat(core): Add updateSpanName helper function#14291
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper

Conversation

@Lms24

@Lms24Lms24 commented Nov 14, 2024

Copy link
Copy Markdown
Member

TL;DR: This PR Adds Sentry.updateSpanName() to reliably update span names in OpenTelemetry environments; prevents overwrites from both OpenTelemetry HTTP instrumentation and Sentry's span inference logic; preserves custom names by marking them with 'custom' source and storing in temp field which takes precedence over the actual name and gets deleted at the end

"Why not use span.updateName()?", the avid SDK user might ask. Here's why:

In our Node SDK, most/all spans are created by OpenTelemetry instrumentation. OpenTelemetry has no concept of a transaction source and only stores the name of the span in the Span instance. Some instrumentation, most importantly, @opentelemetry/instrumentation-http starts a span (in this case root span) and later on updates the name. In the http case, this update happens at the end of the request lifecycle. Consequently, any span name updates prior to this call, regardless of them coming from our SDK or from users, are overwritten.

In addition to this limitation within Otel instrumentation, we also have our own span name, op and source inference logic which we apply when exporting the span to add Sentry-specific data (like a better span name, an op, a transaction source and additional data) to otel-generated spans. So even if Otel didn't call updateName() in its instrumentation, user-made updateName calls to e.g. http.server spans were also overwritten by our logic.

So we need some way of 1. bypassing our span inference logic and 2. ensuring a user-update span name has precedence over otel's span name updates.

1 we can achieve with setting the source attribute to custom and ensuring we don't change the span name if we encounter a custom source.
2 we can only achieve if we write the user-updated span name to temporary field on the span and apply it during our span name processing logic.

This is exactly what updateSpanName does:

  • update the span name via span.updateName()
  • add SEMANTIC_ATTRIBUTES_SENTRY_SOURCE: 'custom to the span
  • add a temporary attribute with the provided name to the span

Further changes in this PR:

  • Ensure we use the span name from temporary attribute if provided in parseSpanDescription
  • Ensure we respect source custom in parseSpanDescription
  • Delete the temporary attribute when creating the transaction envelope (no need to send this)
  • Add a bunch of unit and integration tests for the newly added function.
  • Also add two unit tests showing that span.updateName has no effect on http.server spans, even if you set source custom

This PR supersedes #14280 where I thought we could monkey-patch span.updateName directly to make updating the span name AND the source more consistent without a new top-level function. Turns out, we cannot do this because then, Otel instrumentation would also call the monkey-patched version of updateName, meaning we can no longer distinguish between user-made and otel-made span name updates.

@github-actions

github-actionsBot commented Nov 14, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.29 KB--
@sentry/browser - with treeshaking flags21.96 KB--
@sentry/browser (incl. Tracing)35.81 KB+0.06%+20 B 🔺
@sentry/browser (incl. Tracing, Replay)73.05 KB+0.06%+42 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.44 KB+0.05%+31 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)77.36 KB+0.05%+37 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)89.84 KB+0.04%+30 B 🔺
@sentry/browser (incl. Feedback)40.04 KB--
@sentry/browser (incl. sendFeedback)27.89 KB--
@sentry/browser (incl. FeedbackAsync)32.68 KB--
@sentry/react25.96 KB--
@sentry/react (incl. Tracing)38.64 KB+0.1%+36 B 🔺
@sentry/vue27.52 KB+0.11%+30 B 🔺
@sentry/vue (incl. Tracing)37.67 KB+0.11%+39 B 🔺
@sentry/svelte23.45 KB--
CDN Bundle24.47 KB+0.19%+46 B 🔺
CDN Bundle (incl. Tracing)37.51 KB+0.16%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)72.69 KB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)78.09 KB+0.1%+79 B 🔺
CDN Bundle - uncompressed71.85 KB+0.15%+109 B 🔺
CDN Bundle (incl. Tracing) - uncompressed111.23 KB+0.17%+185 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed225.28 KB+0.09%+185 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed238.5 KB+0.08%+185 B 🔺
@sentry/nextjs (client)38.9 KB+0.05%+16 B 🔺
@sentry/sveltekit (client)36.32 KB+0.1%+36 B 🔺
@sentry/node162.68 KB+0.11%+170 B 🔺
@sentry/node - without tracing98.86 KB+0.16%+152 B 🔺
@sentry/aws-serverless126.52 KB+0.11%+134 B 🔺

View base workflow run

@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from 70674de to c7b6718CompareNovember 14, 2024 14:58
@codecov

codecovBot commented Nov 14, 2024

Copy link
Copy Markdown

❌ We are unable to process any of the uploaded JUnit XML files. Please ensure your files are in the right format.

@Lms24
Lms24 marked this pull request as ready for review November 14, 2024 16:23
},
],
[
'works with prefetch request',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This is just an additional test I added because we didn't test the condition to add .prefetch to the op.

Comment threadpackages/core/src/envelope.ts Outdated
Comment threadpackages/core/src/utils/spanUtils.ts Outdated
const httpMethod = attributes[ATTR_HTTP_REQUEST_METHOD] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
return descriptionForHttpMethod({ attributes, name: getOriginalName(spanName, attributes), kind }, httpMethod);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: Instead of repeating getOriginalName, can we just do this at the very top of this method and then use this processed name everywhere below?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I wanted to do this initially but then we'd potentially lose the inferred op, no?

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threaddev-packages/rollup-utils/plugins/bundlePlugins.mjs Outdated
Comment threadpackages/core/src/types-hoist/span.ts Outdated
@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from adee375 to 24e8320CompareDecember 13, 2024 09:41
@Lms24
Lms24 requested a review from mydeaDecember 13, 2024 11:31
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/core/src/envelope.ts Outdated
@Lms24
Lms24 merged commit f8ac98d into developDec 16, 2024
@Lms24
Lms24 deleted the lms/feat-span-updatename-wrapper branch December 16, 2024 15:30
Lms24 added a commit that referenced this pull request Dec 16, 2024
Add `Sentry.updateSpanName()` to reliably update span
names in OpenTelemetry environments; prevents overwrites from both
OpenTelemetry HTTP instrumentation and Sentry's span inference logic;
preserves custom names by marking them with 'custom' source and storing
in temp field which takes precedence over the actual name and gets
deleted at the end
Lms24 added a commit that referenced this pull request Dec 17, 2024
Sign up for freeto 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

@Lms24@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core): Add updateSpanName helper function - #14291

Merged
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper
Dec 16, 2024
Merged

feat(core): Add updateSpanName helper function#14291
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper

Conversation

@Lms24

@Lms24Lms24 commented Nov 14, 2024

Copy link
Copy Markdown
Member

TL;DR: This PR Adds Sentry.updateSpanName() to reliably update span names in OpenTelemetry environments; prevents overwrites from both OpenTelemetry HTTP instrumentation and Sentry's span inference logic; preserves custom names by marking them with 'custom' source and storing in temp field which takes precedence over the actual name and gets deleted at the end

"Why not use span.updateName()?", the avid SDK user might ask. Here's why:

In our Node SDK, most/all spans are created by OpenTelemetry instrumentation. OpenTelemetry has no concept of a transaction source and only stores the name of the span in the Span instance. Some instrumentation, most importantly, @opentelemetry/instrumentation-http starts a span (in this case root span) and later on updates the name. In the http case, this update happens at the end of the request lifecycle. Consequently, any span name updates prior to this call, regardless of them coming from our SDK or from users, are overwritten.

In addition to this limitation within Otel instrumentation, we also have our own span name, op and source inference logic which we apply when exporting the span to add Sentry-specific data (like a better span name, an op, a transaction source and additional data) to otel-generated spans. So even if Otel didn't call updateName() in its instrumentation, user-made updateName calls to e.g. http.server spans were also overwritten by our logic.

So we need some way of 1. bypassing our span inference logic and 2. ensuring a user-update span name has precedence over otel's span name updates.

1 we can achieve with setting the source attribute to custom and ensuring we don't change the span name if we encounter a custom source.
2 we can only achieve if we write the user-updated span name to temporary field on the span and apply it during our span name processing logic.

This is exactly what updateSpanName does:

  • update the span name via span.updateName()
  • add SEMANTIC_ATTRIBUTES_SENTRY_SOURCE: 'custom to the span
  • add a temporary attribute with the provided name to the span

Further changes in this PR:

  • Ensure we use the span name from temporary attribute if provided in parseSpanDescription
  • Ensure we respect source custom in parseSpanDescription
  • Delete the temporary attribute when creating the transaction envelope (no need to send this)
  • Add a bunch of unit and integration tests for the newly added function.
  • Also add two unit tests showing that span.updateName has no effect on http.server spans, even if you set source custom

This PR supersedes #14280 where I thought we could monkey-patch span.updateName directly to make updating the span name AND the source more consistent without a new top-level function. Turns out, we cannot do this because then, Otel instrumentation would also call the monkey-patched version of updateName, meaning we can no longer distinguish between user-made and otel-made span name updates.

@github-actions

github-actionsBot commented Nov 14, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.29 KB--
@sentry/browser - with treeshaking flags21.96 KB--
@sentry/browser (incl. Tracing)35.81 KB+0.06%+20 B 🔺
@sentry/browser (incl. Tracing, Replay)73.05 KB+0.06%+42 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.44 KB+0.05%+31 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)77.36 KB+0.05%+37 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)89.84 KB+0.04%+30 B 🔺
@sentry/browser (incl. Feedback)40.04 KB--
@sentry/browser (incl. sendFeedback)27.89 KB--
@sentry/browser (incl. FeedbackAsync)32.68 KB--
@sentry/react25.96 KB--
@sentry/react (incl. Tracing)38.64 KB+0.1%+36 B 🔺
@sentry/vue27.52 KB+0.11%+30 B 🔺
@sentry/vue (incl. Tracing)37.67 KB+0.11%+39 B 🔺
@sentry/svelte23.45 KB--
CDN Bundle24.47 KB+0.19%+46 B 🔺
CDN Bundle (incl. Tracing)37.51 KB+0.16%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)72.69 KB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)78.09 KB+0.1%+79 B 🔺
CDN Bundle - uncompressed71.85 KB+0.15%+109 B 🔺
CDN Bundle (incl. Tracing) - uncompressed111.23 KB+0.17%+185 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed225.28 KB+0.09%+185 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed238.5 KB+0.08%+185 B 🔺
@sentry/nextjs (client)38.9 KB+0.05%+16 B 🔺
@sentry/sveltekit (client)36.32 KB+0.1%+36 B 🔺
@sentry/node162.68 KB+0.11%+170 B 🔺
@sentry/node - without tracing98.86 KB+0.16%+152 B 🔺
@sentry/aws-serverless126.52 KB+0.11%+134 B 🔺

View base workflow run

@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from 70674de to c7b6718CompareNovember 14, 2024 14:58
@codecov

codecovBot commented Nov 14, 2024

Copy link
Copy Markdown

❌ We are unable to process any of the uploaded JUnit XML files. Please ensure your files are in the right format.

@Lms24
Lms24 marked this pull request as ready for review November 14, 2024 16:23
},
],
[
'works with prefetch request',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This is just an additional test I added because we didn't test the condition to add .prefetch to the op.

Comment threadpackages/core/src/envelope.ts Outdated
Comment threadpackages/core/src/utils/spanUtils.ts Outdated
const httpMethod = attributes[ATTR_HTTP_REQUEST_METHOD] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
return descriptionForHttpMethod({ attributes, name: getOriginalName(spanName, attributes), kind }, httpMethod);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: Instead of repeating getOriginalName, can we just do this at the very top of this method and then use this processed name everywhere below?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I wanted to do this initially but then we'd potentially lose the inferred op, no?

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threaddev-packages/rollup-utils/plugins/bundlePlugins.mjs Outdated
Comment threadpackages/core/src/types-hoist/span.ts Outdated
@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from adee375 to 24e8320CompareDecember 13, 2024 09:41
@Lms24
Lms24 requested a review from mydeaDecember 13, 2024 11:31
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/core/src/envelope.ts Outdated
@Lms24
Lms24 merged commit f8ac98d into developDec 16, 2024
@Lms24
Lms24 deleted the lms/feat-span-updatename-wrapper branch December 16, 2024 15:30
Lms24 added a commit that referenced this pull request Dec 16, 2024
Add `Sentry.updateSpanName()` to reliably update span
names in OpenTelemetry environments; prevents overwrites from both
OpenTelemetry HTTP instrumentation and Sentry's span inference logic;
preserves custom names by marking them with 'custom' source and storing
in temp field which takes precedence over the actual name and gets
deleted at the end
Lms24 added a commit that referenced this pull request Dec 17, 2024
Sign up for freeto 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

@Lms24@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core): Add updateSpanName helper function - #14291

Merged
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper
Dec 16, 2024
Merged

feat(core): Add updateSpanName helper function#14291
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper

Conversation

@Lms24

@Lms24Lms24 commented Nov 14, 2024

Copy link
Copy Markdown
Member

TL;DR: This PR Adds Sentry.updateSpanName() to reliably update span names in OpenTelemetry environments; prevents overwrites from both OpenTelemetry HTTP instrumentation and Sentry's span inference logic; preserves custom names by marking them with 'custom' source and storing in temp field which takes precedence over the actual name and gets deleted at the end

"Why not use span.updateName()?", the avid SDK user might ask. Here's why:

In our Node SDK, most/all spans are created by OpenTelemetry instrumentation. OpenTelemetry has no concept of a transaction source and only stores the name of the span in the Span instance. Some instrumentation, most importantly, @opentelemetry/instrumentation-http starts a span (in this case root span) and later on updates the name. In the http case, this update happens at the end of the request lifecycle. Consequently, any span name updates prior to this call, regardless of them coming from our SDK or from users, are overwritten.

In addition to this limitation within Otel instrumentation, we also have our own span name, op and source inference logic which we apply when exporting the span to add Sentry-specific data (like a better span name, an op, a transaction source and additional data) to otel-generated spans. So even if Otel didn't call updateName() in its instrumentation, user-made updateName calls to e.g. http.server spans were also overwritten by our logic.

So we need some way of 1. bypassing our span inference logic and 2. ensuring a user-update span name has precedence over otel's span name updates.

1 we can achieve with setting the source attribute to custom and ensuring we don't change the span name if we encounter a custom source.
2 we can only achieve if we write the user-updated span name to temporary field on the span and apply it during our span name processing logic.

This is exactly what updateSpanName does:

  • update the span name via span.updateName()
  • add SEMANTIC_ATTRIBUTES_SENTRY_SOURCE: 'custom to the span
  • add a temporary attribute with the provided name to the span

Further changes in this PR:

  • Ensure we use the span name from temporary attribute if provided in parseSpanDescription
  • Ensure we respect source custom in parseSpanDescription
  • Delete the temporary attribute when creating the transaction envelope (no need to send this)
  • Add a bunch of unit and integration tests for the newly added function.
  • Also add two unit tests showing that span.updateName has no effect on http.server spans, even if you set source custom

This PR supersedes #14280 where I thought we could monkey-patch span.updateName directly to make updating the span name AND the source more consistent without a new top-level function. Turns out, we cannot do this because then, Otel instrumentation would also call the monkey-patched version of updateName, meaning we can no longer distinguish between user-made and otel-made span name updates.

@github-actions

github-actionsBot commented Nov 14, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.29 KB--
@sentry/browser - with treeshaking flags21.96 KB--
@sentry/browser (incl. Tracing)35.81 KB+0.06%+20 B 🔺
@sentry/browser (incl. Tracing, Replay)73.05 KB+0.06%+42 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.44 KB+0.05%+31 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)77.36 KB+0.05%+37 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)89.84 KB+0.04%+30 B 🔺
@sentry/browser (incl. Feedback)40.04 KB--
@sentry/browser (incl. sendFeedback)27.89 KB--
@sentry/browser (incl. FeedbackAsync)32.68 KB--
@sentry/react25.96 KB--
@sentry/react (incl. Tracing)38.64 KB+0.1%+36 B 🔺
@sentry/vue27.52 KB+0.11%+30 B 🔺
@sentry/vue (incl. Tracing)37.67 KB+0.11%+39 B 🔺
@sentry/svelte23.45 KB--
CDN Bundle24.47 KB+0.19%+46 B 🔺
CDN Bundle (incl. Tracing)37.51 KB+0.16%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)72.69 KB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)78.09 KB+0.1%+79 B 🔺
CDN Bundle - uncompressed71.85 KB+0.15%+109 B 🔺
CDN Bundle (incl. Tracing) - uncompressed111.23 KB+0.17%+185 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed225.28 KB+0.09%+185 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed238.5 KB+0.08%+185 B 🔺
@sentry/nextjs (client)38.9 KB+0.05%+16 B 🔺
@sentry/sveltekit (client)36.32 KB+0.1%+36 B 🔺
@sentry/node162.68 KB+0.11%+170 B 🔺
@sentry/node - without tracing98.86 KB+0.16%+152 B 🔺
@sentry/aws-serverless126.52 KB+0.11%+134 B 🔺

View base workflow run

@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from 70674de to c7b6718CompareNovember 14, 2024 14:58
@codecov

codecovBot commented Nov 14, 2024

Copy link
Copy Markdown

❌ We are unable to process any of the uploaded JUnit XML files. Please ensure your files are in the right format.

@Lms24
Lms24 marked this pull request as ready for review November 14, 2024 16:23
},
],
[
'works with prefetch request',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This is just an additional test I added because we didn't test the condition to add .prefetch to the op.

Comment threadpackages/core/src/envelope.ts Outdated
Comment threadpackages/core/src/utils/spanUtils.ts Outdated
const httpMethod = attributes[ATTR_HTTP_REQUEST_METHOD] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
return descriptionForHttpMethod({ attributes, name: getOriginalName(spanName, attributes), kind }, httpMethod);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: Instead of repeating getOriginalName, can we just do this at the very top of this method and then use this processed name everywhere below?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I wanted to do this initially but then we'd potentially lose the inferred op, no?

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threaddev-packages/rollup-utils/plugins/bundlePlugins.mjs Outdated
Comment threadpackages/core/src/types-hoist/span.ts Outdated
@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from adee375 to 24e8320CompareDecember 13, 2024 09:41
@Lms24
Lms24 requested a review from mydeaDecember 13, 2024 11:31
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/core/src/envelope.ts Outdated
@Lms24
Lms24 merged commit f8ac98d into developDec 16, 2024
@Lms24
Lms24 deleted the lms/feat-span-updatename-wrapper branch December 16, 2024 15:30
Lms24 added a commit that referenced this pull request Dec 16, 2024
Add `Sentry.updateSpanName()` to reliably update span
names in OpenTelemetry environments; prevents overwrites from both
OpenTelemetry HTTP instrumentation and Sentry's span inference logic;
preserves custom names by marking them with 'custom' source and storing
in temp field which takes precedence over the actual name and gets
deleted at the end
Lms24 added a commit that referenced this pull request Dec 17, 2024
Sign up for freeto 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

@Lms24@mydea
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(core): Add updateSpanName helper function - #14291

Merged
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper
Dec 16, 2024
Merged

feat(core): Add updateSpanName helper function#14291
Lms24 merged 18 commits into
developfrom
lms/feat-span-updatename-wrapper

Conversation

@Lms24

@Lms24Lms24 commented Nov 14, 2024

Copy link
Copy Markdown
Member

TL;DR: This PR Adds Sentry.updateSpanName() to reliably update span names in OpenTelemetry environments; prevents overwrites from both OpenTelemetry HTTP instrumentation and Sentry's span inference logic; preserves custom names by marking them with 'custom' source and storing in temp field which takes precedence over the actual name and gets deleted at the end

"Why not use span.updateName()?", the avid SDK user might ask. Here's why:

In our Node SDK, most/all spans are created by OpenTelemetry instrumentation. OpenTelemetry has no concept of a transaction source and only stores the name of the span in the Span instance. Some instrumentation, most importantly, @opentelemetry/instrumentation-http starts a span (in this case root span) and later on updates the name. In the http case, this update happens at the end of the request lifecycle. Consequently, any span name updates prior to this call, regardless of them coming from our SDK or from users, are overwritten.

In addition to this limitation within Otel instrumentation, we also have our own span name, op and source inference logic which we apply when exporting the span to add Sentry-specific data (like a better span name, an op, a transaction source and additional data) to otel-generated spans. So even if Otel didn't call updateName() in its instrumentation, user-made updateName calls to e.g. http.server spans were also overwritten by our logic.

So we need some way of 1. bypassing our span inference logic and 2. ensuring a user-update span name has precedence over otel's span name updates.

1 we can achieve with setting the source attribute to custom and ensuring we don't change the span name if we encounter a custom source.
2 we can only achieve if we write the user-updated span name to temporary field on the span and apply it during our span name processing logic.

This is exactly what updateSpanName does:

  • update the span name via span.updateName()
  • add SEMANTIC_ATTRIBUTES_SENTRY_SOURCE: 'custom to the span
  • add a temporary attribute with the provided name to the span

Further changes in this PR:

  • Ensure we use the span name from temporary attribute if provided in parseSpanDescription
  • Ensure we respect source custom in parseSpanDescription
  • Delete the temporary attribute when creating the transaction envelope (no need to send this)
  • Add a bunch of unit and integration tests for the newly added function.
  • Also add two unit tests showing that span.updateName has no effect on http.server spans, even if you set source custom

This PR supersedes #14280 where I thought we could monkey-patch span.updateName directly to make updating the span name AND the source more consistent without a new top-level function. Turns out, we cannot do this because then, Otel instrumentation would also call the monkey-patched version of updateName, meaning we can no longer distinguish between user-made and otel-made span name updates.

@github-actions

github-actionsBot commented Nov 14, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.29 KB--
@sentry/browser - with treeshaking flags21.96 KB--
@sentry/browser (incl. Tracing)35.81 KB+0.06%+20 B 🔺
@sentry/browser (incl. Tracing, Replay)73.05 KB+0.06%+42 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.44 KB+0.05%+31 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)77.36 KB+0.05%+37 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)89.84 KB+0.04%+30 B 🔺
@sentry/browser (incl. Feedback)40.04 KB--
@sentry/browser (incl. sendFeedback)27.89 KB--
@sentry/browser (incl. FeedbackAsync)32.68 KB--
@sentry/react25.96 KB--
@sentry/react (incl. Tracing)38.64 KB+0.1%+36 B 🔺
@sentry/vue27.52 KB+0.11%+30 B 🔺
@sentry/vue (incl. Tracing)37.67 KB+0.11%+39 B 🔺
@sentry/svelte23.45 KB--
CDN Bundle24.47 KB+0.19%+46 B 🔺
CDN Bundle (incl. Tracing)37.51 KB+0.16%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)72.69 KB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)78.09 KB+0.1%+79 B 🔺
CDN Bundle - uncompressed71.85 KB+0.15%+109 B 🔺
CDN Bundle (incl. Tracing) - uncompressed111.23 KB+0.17%+185 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed225.28 KB+0.09%+185 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed238.5 KB+0.08%+185 B 🔺
@sentry/nextjs (client)38.9 KB+0.05%+16 B 🔺
@sentry/sveltekit (client)36.32 KB+0.1%+36 B 🔺
@sentry/node162.68 KB+0.11%+170 B 🔺
@sentry/node - without tracing98.86 KB+0.16%+152 B 🔺
@sentry/aws-serverless126.52 KB+0.11%+134 B 🔺

View base workflow run

@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from 70674de to c7b6718CompareNovember 14, 2024 14:58
@codecov

codecovBot commented Nov 14, 2024

Copy link
Copy Markdown

❌ We are unable to process any of the uploaded JUnit XML files. Please ensure your files are in the right format.

@Lms24
Lms24 marked this pull request as ready for review November 14, 2024 16:23
},
],
[
'works with prefetch request',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This is just an additional test I added because we didn't test the condition to add .prefetch to the op.

Comment threadpackages/core/src/envelope.ts Outdated
Comment threadpackages/core/src/utils/spanUtils.ts Outdated
const httpMethod = attributes[ATTR_HTTP_REQUEST_METHOD] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
return descriptionForHttpMethod({ attributes, name: getOriginalName(spanName, attributes), kind }, httpMethod);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

m: Instead of repeating getOriginalName, can we just do this at the very top of this method and then use this processed name everywhere below?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I wanted to do this initially but then we'd potentially lose the inferred op, no?

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threaddev-packages/rollup-utils/plugins/bundlePlugins.mjs Outdated
Comment threadpackages/core/src/types-hoist/span.ts Outdated
@Lms24
Lms24force-pushed the lms/feat-span-updatename-wrapper branch from adee375 to 24e8320CompareDecember 13, 2024 09:41
@Lms24
Lms24 requested a review from mydeaDecember 13, 2024 11:31
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/core/src/envelope.ts Outdated
@Lms24
Lms24 merged commit f8ac98d into developDec 16, 2024
@Lms24
Lms24 deleted the lms/feat-span-updatename-wrapper branch December 16, 2024 15:30
Lms24 added a commit that referenced this pull request Dec 16, 2024
Add `Sentry.updateSpanName()` to reliably update span
names in OpenTelemetry environments; prevents overwrites from both
OpenTelemetry HTTP instrumentation and Sentry's span inference logic;
preserves custom names by marking them with 'custom' source and storing
in temp field which takes precedence over the actual name and gets
deleted at the end
Lms24 added a commit that referenced this pull request Dec 17, 2024
Sign up for freeto 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

@Lms24@mydea