feat(node): Use @opentelemetry/instrumentation-undici for fetch tracing - #13485

Merged
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici
Sep 9, 2024
Merged

feat(node): Use @opentelemetry/instrumentation-undici for fetch tracing#13485
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici

Conversation

@timfish

@timfishtimfish commented Aug 27, 2024

Copy link
Copy Markdown
Collaborator

This PR migrates the nativeNodeFetchIntegration to use @opentelemetry/instrumentation-undici instead of opentelemetry-instrumentation-fetch-node.

The instrumentation is still exported as nativeNodeFetchIntegration and is named NodeFetch to ensure backwards compatibility and the tests pass without changes.

Note: One nextjs-14 e2e test did need a change due to the new/differing attribute names.

It's worth noting that @opentelemetry/instrumentation-undiciuses different attributes from the latest semantic convention version vs what we are using and what's used by opentelemetry-instrumentation-fetch-node. It looks like the http instrumentation is migrating to these too so some of the changes in this PR will ensure that the http instrumentation continues to work after these updates.

Outstanding issues:

  • For the outgoing fetch > outgoing sampled fetch requests without active span are correctly instrumented tests, the sentry-trace header has an extra -1 on the end. I have no idea what causes this!

  • For /api/v3 portion of the fetch-unsampled/test.ts and fetch-sampled-no-active-span/test.ts, it fails because the baggage header is not undefined as expected. As far as I can tell, SentryPropagator should be excluding these from header injection but it's not. I guess this is because @opentelemetry/instrumentation-undici is not setting the SEMATTRS_HTTP_URL attribute (http.url). Should the otel instrumentation be setting this or should we also be checking for SemanticAttributes.URL_FULL attribute (url.full) which it already sets? Here are the attributes it is already setting.

@github-actions

github-actionsBot commented Aug 27, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser22.52 KB--
@sentry/browser - with treeshaking flags21.3 KB--
@sentry/browser (incl. Tracing)34.78 KB--
@sentry/browser (incl. Tracing, Replay)71.23 KB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags61.67 KB--
@sentry/browser (incl. Tracing, Replay with Canvas)75.57 KB--
@sentry/browser (incl. Tracing, Replay, Feedback)88.3 KB--
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)90.14 KB--
@sentry/browser (incl. metrics)26.83 KB--
@sentry/browser (incl. Feedback)39.6 KB--
@sentry/browser (incl. sendFeedback)27.19 KB--
@sentry/browser (incl. FeedbackAsync)31.9 KB--
@sentry/react25.28 KB--
@sentry/react (incl. Tracing)37.74 KB--
@sentry/vue26.67 KB--
@sentry/vue (incl. Tracing)36.61 KB--
@sentry/svelte22.65 KB--
CDN Bundle23.77 KB--
CDN Bundle (incl. Tracing)36.49 KB--
CDN Bundle (incl. Tracing, Replay)70.91 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.22 KB--
CDN Bundle - uncompressed69.63 KB--
CDN Bundle (incl. Tracing) - uncompressed108.21 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed219.87 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed233.07 KB--
@sentry/nextjs (client)37.51 KB--
@sentry/sveltekit (client)35.35 KB--
@sentry/node126.36 KB+1.11%+1.38 KB 🔺
@sentry/node - without tracing98.84 KB+3.5%+3.34 KB 🔺
@sentry/aws-serverless109.1 KB+1.47%+1.58 KB 🔺

View base workflow run

@timfish

timfish commented Aug 27, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Comment threadyarn.lock Outdated
@timfish
timfish marked this pull request as ready for review September 5, 2024 09:45
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
['http.request.method']: request.method,
['url.full']: request.url,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I replaced these in a couple of places since I just added temporary constants for them

name: 'NodeFetch',
setupOnce() {
const instrumentation = new UndiciInstrumentation({
requireParentforSpans: false,

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.

is this a typo in our config or upstream, seems like it should be requireParentForSpans 😅

@timfishtimfishSep 5, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Comment threadpackages/node/src/integrations/node-fetch.ts Outdated
Comment threadpackages/node/src/integrations/node-fetch.ts
Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@timfish

Copy link
Copy Markdown
CollaboratorAuthor

One nextjs-14 e2e test did need a change due to the differing attributes

mydea added a commit that referenced this pull request Sep 5, 2024
…13587)
This bumps all our internal OTEL instrumentation to their latest
version.
Mainly, this fixes two things:
* Mongoose now supports v7 & v8
open-telemetry/opentelemetry-js-contrib#2353
* A variety of bug fixes, including a problem with http.get in ESM mode
open-telemetry/opentelemetry-js#4857 - See:
https://github.com/open-telemetry/opentelemetry-js/releases/tag/experimental%2Fv0.53.0
Related:
* open-telemetry/opentelemetry-js#4975 Issue
about relaxing deps in "core" instrumentation packages
* PR to bump deps in `@prisma/instrumentation`:
prisma/orm#25160
* PR to bump deps in `opentelemetry-instrument-remix`:
justindsmith/opentelemetry-instrumentations-js#52
* PR to bump deps in `opentelemetry-instrumentation-fetch-node`:
gas-buddy/opentelemetry-instrumentation-fetch-node#17
(which will also be superseded by
#13485 eventually)
* Closes#11499
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.

Use @opentelemetry/instrumentation-undici Unhandled Promise Rejection in debugger on Node startup

3 participants

@timfish@mydea@AbhiPrasad
, '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(node): Use @opentelemetry/instrumentation-undici for fetch tracing - #13485

Merged
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici
Sep 9, 2024
Merged

feat(node): Use @opentelemetry/instrumentation-undici for fetch tracing#13485
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici

Conversation

@timfish

@timfishtimfish commented Aug 27, 2024

Copy link
Copy Markdown
Collaborator

This PR migrates the nativeNodeFetchIntegration to use @opentelemetry/instrumentation-undici instead of opentelemetry-instrumentation-fetch-node.

The instrumentation is still exported as nativeNodeFetchIntegration and is named NodeFetch to ensure backwards compatibility and the tests pass without changes.

Note: One nextjs-14 e2e test did need a change due to the new/differing attribute names.

It's worth noting that @opentelemetry/instrumentation-undiciuses different attributes from the latest semantic convention version vs what we are using and what's used by opentelemetry-instrumentation-fetch-node. It looks like the http instrumentation is migrating to these too so some of the changes in this PR will ensure that the http instrumentation continues to work after these updates.

Outstanding issues:

  • For the outgoing fetch > outgoing sampled fetch requests without active span are correctly instrumented tests, the sentry-trace header has an extra -1 on the end. I have no idea what causes this!

  • For /api/v3 portion of the fetch-unsampled/test.ts and fetch-sampled-no-active-span/test.ts, it fails because the baggage header is not undefined as expected. As far as I can tell, SentryPropagator should be excluding these from header injection but it's not. I guess this is because @opentelemetry/instrumentation-undici is not setting the SEMATTRS_HTTP_URL attribute (http.url). Should the otel instrumentation be setting this or should we also be checking for SemanticAttributes.URL_FULL attribute (url.full) which it already sets? Here are the attributes it is already setting.

@github-actions

github-actionsBot commented Aug 27, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser22.52 KB--
@sentry/browser - with treeshaking flags21.3 KB--
@sentry/browser (incl. Tracing)34.78 KB--
@sentry/browser (incl. Tracing, Replay)71.23 KB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags61.67 KB--
@sentry/browser (incl. Tracing, Replay with Canvas)75.57 KB--
@sentry/browser (incl. Tracing, Replay, Feedback)88.3 KB--
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)90.14 KB--
@sentry/browser (incl. metrics)26.83 KB--
@sentry/browser (incl. Feedback)39.6 KB--
@sentry/browser (incl. sendFeedback)27.19 KB--
@sentry/browser (incl. FeedbackAsync)31.9 KB--
@sentry/react25.28 KB--
@sentry/react (incl. Tracing)37.74 KB--
@sentry/vue26.67 KB--
@sentry/vue (incl. Tracing)36.61 KB--
@sentry/svelte22.65 KB--
CDN Bundle23.77 KB--
CDN Bundle (incl. Tracing)36.49 KB--
CDN Bundle (incl. Tracing, Replay)70.91 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.22 KB--
CDN Bundle - uncompressed69.63 KB--
CDN Bundle (incl. Tracing) - uncompressed108.21 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed219.87 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed233.07 KB--
@sentry/nextjs (client)37.51 KB--
@sentry/sveltekit (client)35.35 KB--
@sentry/node126.36 KB+1.11%+1.38 KB 🔺
@sentry/node - without tracing98.84 KB+3.5%+3.34 KB 🔺
@sentry/aws-serverless109.1 KB+1.47%+1.58 KB 🔺

View base workflow run

@timfish

timfish commented Aug 27, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Comment threadyarn.lock Outdated
@timfish
timfish marked this pull request as ready for review September 5, 2024 09:45
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
['http.request.method']: request.method,
['url.full']: request.url,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I replaced these in a couple of places since I just added temporary constants for them

name: 'NodeFetch',
setupOnce() {
const instrumentation = new UndiciInstrumentation({
requireParentforSpans: false,

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.

is this a typo in our config or upstream, seems like it should be requireParentForSpans 😅

@timfishtimfishSep 5, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Comment threadpackages/node/src/integrations/node-fetch.ts Outdated
Comment threadpackages/node/src/integrations/node-fetch.ts
Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@timfish

Copy link
Copy Markdown
CollaboratorAuthor

One nextjs-14 e2e test did need a change due to the differing attributes

mydea added a commit that referenced this pull request Sep 5, 2024
…13587)
This bumps all our internal OTEL instrumentation to their latest
version.
Mainly, this fixes two things:
* Mongoose now supports v7 & v8
open-telemetry/opentelemetry-js-contrib#2353
* A variety of bug fixes, including a problem with http.get in ESM mode
open-telemetry/opentelemetry-js#4857 - See:
https://github.com/open-telemetry/opentelemetry-js/releases/tag/experimental%2Fv0.53.0
Related:
* open-telemetry/opentelemetry-js#4975 Issue
about relaxing deps in "core" instrumentation packages
* PR to bump deps in `@prisma/instrumentation`:
prisma/orm#25160
* PR to bump deps in `opentelemetry-instrument-remix`:
justindsmith/opentelemetry-instrumentations-js#52
* PR to bump deps in `opentelemetry-instrumentation-fetch-node`:
gas-buddy/opentelemetry-instrumentation-fetch-node#17
(which will also be superseded by
#13485 eventually)
* Closes#11499
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.

Use @opentelemetry/instrumentation-undici Unhandled Promise Rejection in debugger on Node startup

3 participants

@timfish@mydea@AbhiPrasad
, '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(node): Use @opentelemetry/instrumentation-undici for fetch tracing - #13485

Merged
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici
Sep 9, 2024
Merged

feat(node): Use @opentelemetry/instrumentation-undici for fetch tracing#13485
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici

Conversation

@timfish

@timfishtimfish commented Aug 27, 2024

Copy link
Copy Markdown
Collaborator

This PR migrates the nativeNodeFetchIntegration to use @opentelemetry/instrumentation-undici instead of opentelemetry-instrumentation-fetch-node.

The instrumentation is still exported as nativeNodeFetchIntegration and is named NodeFetch to ensure backwards compatibility and the tests pass without changes.

Note: One nextjs-14 e2e test did need a change due to the new/differing attribute names.

It's worth noting that @opentelemetry/instrumentation-undiciuses different attributes from the latest semantic convention version vs what we are using and what's used by opentelemetry-instrumentation-fetch-node. It looks like the http instrumentation is migrating to these too so some of the changes in this PR will ensure that the http instrumentation continues to work after these updates.

Outstanding issues:

  • For the outgoing fetch > outgoing sampled fetch requests without active span are correctly instrumented tests, the sentry-trace header has an extra -1 on the end. I have no idea what causes this!

  • For /api/v3 portion of the fetch-unsampled/test.ts and fetch-sampled-no-active-span/test.ts, it fails because the baggage header is not undefined as expected. As far as I can tell, SentryPropagator should be excluding these from header injection but it's not. I guess this is because @opentelemetry/instrumentation-undici is not setting the SEMATTRS_HTTP_URL attribute (http.url). Should the otel instrumentation be setting this or should we also be checking for SemanticAttributes.URL_FULL attribute (url.full) which it already sets? Here are the attributes it is already setting.

@github-actions

github-actionsBot commented Aug 27, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser22.52 KB--
@sentry/browser - with treeshaking flags21.3 KB--
@sentry/browser (incl. Tracing)34.78 KB--
@sentry/browser (incl. Tracing, Replay)71.23 KB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags61.67 KB--
@sentry/browser (incl. Tracing, Replay with Canvas)75.57 KB--
@sentry/browser (incl. Tracing, Replay, Feedback)88.3 KB--
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)90.14 KB--
@sentry/browser (incl. metrics)26.83 KB--
@sentry/browser (incl. Feedback)39.6 KB--
@sentry/browser (incl. sendFeedback)27.19 KB--
@sentry/browser (incl. FeedbackAsync)31.9 KB--
@sentry/react25.28 KB--
@sentry/react (incl. Tracing)37.74 KB--
@sentry/vue26.67 KB--
@sentry/vue (incl. Tracing)36.61 KB--
@sentry/svelte22.65 KB--
CDN Bundle23.77 KB--
CDN Bundle (incl. Tracing)36.49 KB--
CDN Bundle (incl. Tracing, Replay)70.91 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.22 KB--
CDN Bundle - uncompressed69.63 KB--
CDN Bundle (incl. Tracing) - uncompressed108.21 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed219.87 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed233.07 KB--
@sentry/nextjs (client)37.51 KB--
@sentry/sveltekit (client)35.35 KB--
@sentry/node126.36 KB+1.11%+1.38 KB 🔺
@sentry/node - without tracing98.84 KB+3.5%+3.34 KB 🔺
@sentry/aws-serverless109.1 KB+1.47%+1.58 KB 🔺

View base workflow run

@timfish

timfish commented Aug 27, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Comment threadyarn.lock Outdated
@timfish
timfish marked this pull request as ready for review September 5, 2024 09:45
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
['http.request.method']: request.method,
['url.full']: request.url,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I replaced these in a couple of places since I just added temporary constants for them

name: 'NodeFetch',
setupOnce() {
const instrumentation = new UndiciInstrumentation({
requireParentforSpans: false,

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.

is this a typo in our config or upstream, seems like it should be requireParentForSpans 😅

@timfishtimfishSep 5, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Comment threadpackages/node/src/integrations/node-fetch.ts Outdated
Comment threadpackages/node/src/integrations/node-fetch.ts
Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@timfish

Copy link
Copy Markdown
CollaboratorAuthor

One nextjs-14 e2e test did need a change due to the differing attributes

mydea added a commit that referenced this pull request Sep 5, 2024
…13587)
This bumps all our internal OTEL instrumentation to their latest
version.
Mainly, this fixes two things:
* Mongoose now supports v7 & v8
open-telemetry/opentelemetry-js-contrib#2353
* A variety of bug fixes, including a problem with http.get in ESM mode
open-telemetry/opentelemetry-js#4857 - See:
https://github.com/open-telemetry/opentelemetry-js/releases/tag/experimental%2Fv0.53.0
Related:
* open-telemetry/opentelemetry-js#4975 Issue
about relaxing deps in "core" instrumentation packages
* PR to bump deps in `@prisma/instrumentation`:
prisma/orm#25160
* PR to bump deps in `opentelemetry-instrument-remix`:
justindsmith/opentelemetry-instrumentations-js#52
* PR to bump deps in `opentelemetry-instrumentation-fetch-node`:
gas-buddy/opentelemetry-instrumentation-fetch-node#17
(which will also be superseded by
#13485 eventually)
* Closes#11499
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.

Use @opentelemetry/instrumentation-undici Unhandled Promise Rejection in debugger on Node startup

3 participants

@timfish@mydea@AbhiPrasad
, '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(node): Use @opentelemetry/instrumentation-undici for fetch tracing - #13485

Merged
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici
Sep 9, 2024
Merged

feat(node): Use @opentelemetry/instrumentation-undici for fetch tracing#13485
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici

Conversation

@timfish

@timfishtimfish commented Aug 27, 2024

Copy link
Copy Markdown
Collaborator

This PR migrates the nativeNodeFetchIntegration to use @opentelemetry/instrumentation-undici instead of opentelemetry-instrumentation-fetch-node.

The instrumentation is still exported as nativeNodeFetchIntegration and is named NodeFetch to ensure backwards compatibility and the tests pass without changes.

Note: One nextjs-14 e2e test did need a change due to the new/differing attribute names.

It's worth noting that @opentelemetry/instrumentation-undiciuses different attributes from the latest semantic convention version vs what we are using and what's used by opentelemetry-instrumentation-fetch-node. It looks like the http instrumentation is migrating to these too so some of the changes in this PR will ensure that the http instrumentation continues to work after these updates.

Outstanding issues:

  • For the outgoing fetch > outgoing sampled fetch requests without active span are correctly instrumented tests, the sentry-trace header has an extra -1 on the end. I have no idea what causes this!

  • For /api/v3 portion of the fetch-unsampled/test.ts and fetch-sampled-no-active-span/test.ts, it fails because the baggage header is not undefined as expected. As far as I can tell, SentryPropagator should be excluding these from header injection but it's not. I guess this is because @opentelemetry/instrumentation-undici is not setting the SEMATTRS_HTTP_URL attribute (http.url). Should the otel instrumentation be setting this or should we also be checking for SemanticAttributes.URL_FULL attribute (url.full) which it already sets? Here are the attributes it is already setting.

@github-actions

github-actionsBot commented Aug 27, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser22.52 KB--
@sentry/browser - with treeshaking flags21.3 KB--
@sentry/browser (incl. Tracing)34.78 KB--
@sentry/browser (incl. Tracing, Replay)71.23 KB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags61.67 KB--
@sentry/browser (incl. Tracing, Replay with Canvas)75.57 KB--
@sentry/browser (incl. Tracing, Replay, Feedback)88.3 KB--
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)90.14 KB--
@sentry/browser (incl. metrics)26.83 KB--
@sentry/browser (incl. Feedback)39.6 KB--
@sentry/browser (incl. sendFeedback)27.19 KB--
@sentry/browser (incl. FeedbackAsync)31.9 KB--
@sentry/react25.28 KB--
@sentry/react (incl. Tracing)37.74 KB--
@sentry/vue26.67 KB--
@sentry/vue (incl. Tracing)36.61 KB--
@sentry/svelte22.65 KB--
CDN Bundle23.77 KB--
CDN Bundle (incl. Tracing)36.49 KB--
CDN Bundle (incl. Tracing, Replay)70.91 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.22 KB--
CDN Bundle - uncompressed69.63 KB--
CDN Bundle (incl. Tracing) - uncompressed108.21 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed219.87 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed233.07 KB--
@sentry/nextjs (client)37.51 KB--
@sentry/sveltekit (client)35.35 KB--
@sentry/node126.36 KB+1.11%+1.38 KB 🔺
@sentry/node - without tracing98.84 KB+3.5%+3.34 KB 🔺
@sentry/aws-serverless109.1 KB+1.47%+1.58 KB 🔺

View base workflow run

@timfish

timfish commented Aug 27, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Comment threadyarn.lock Outdated
@timfish
timfish marked this pull request as ready for review September 5, 2024 09:45
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
['http.request.method']: request.method,
['url.full']: request.url,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I replaced these in a couple of places since I just added temporary constants for them

name: 'NodeFetch',
setupOnce() {
const instrumentation = new UndiciInstrumentation({
requireParentforSpans: false,

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.

is this a typo in our config or upstream, seems like it should be requireParentForSpans 😅

@timfishtimfishSep 5, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Comment threadpackages/node/src/integrations/node-fetch.ts Outdated
Comment threadpackages/node/src/integrations/node-fetch.ts
Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@timfish

Copy link
Copy Markdown
CollaboratorAuthor

One nextjs-14 e2e test did need a change due to the differing attributes

mydea added a commit that referenced this pull request Sep 5, 2024
…13587)
This bumps all our internal OTEL instrumentation to their latest
version.
Mainly, this fixes two things:
* Mongoose now supports v7 & v8
open-telemetry/opentelemetry-js-contrib#2353
* A variety of bug fixes, including a problem with http.get in ESM mode
open-telemetry/opentelemetry-js#4857 - See:
https://github.com/open-telemetry/opentelemetry-js/releases/tag/experimental%2Fv0.53.0
Related:
* open-telemetry/opentelemetry-js#4975 Issue
about relaxing deps in "core" instrumentation packages
* PR to bump deps in `@prisma/instrumentation`:
prisma/orm#25160
* PR to bump deps in `opentelemetry-instrument-remix`:
justindsmith/opentelemetry-instrumentations-js#52
* PR to bump deps in `opentelemetry-instrumentation-fetch-node`:
gas-buddy/opentelemetry-instrumentation-fetch-node#17
(which will also be superseded by
#13485 eventually)
* Closes#11499
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.

Use @opentelemetry/instrumentation-undici Unhandled Promise Rejection in debugger on Node startup

3 participants

@timfish@mydea@AbhiPrasad
, '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(node): Use @opentelemetry/instrumentation-undici for fetch tracing - #13485

Merged
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici
Sep 9, 2024
Merged

feat(node): Use @opentelemetry/instrumentation-undici for fetch tracing#13485
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici

Conversation

@timfish

@timfishtimfish commented Aug 27, 2024

Copy link
Copy Markdown
Collaborator

This PR migrates the nativeNodeFetchIntegration to use @opentelemetry/instrumentation-undici instead of opentelemetry-instrumentation-fetch-node.

The instrumentation is still exported as nativeNodeFetchIntegration and is named NodeFetch to ensure backwards compatibility and the tests pass without changes.

Note: One nextjs-14 e2e test did need a change due to the new/differing attribute names.

It's worth noting that @opentelemetry/instrumentation-undiciuses different attributes from the latest semantic convention version vs what we are using and what's used by opentelemetry-instrumentation-fetch-node. It looks like the http instrumentation is migrating to these too so some of the changes in this PR will ensure that the http instrumentation continues to work after these updates.

Outstanding issues:

  • For the outgoing fetch > outgoing sampled fetch requests without active span are correctly instrumented tests, the sentry-trace header has an extra -1 on the end. I have no idea what causes this!

  • For /api/v3 portion of the fetch-unsampled/test.ts and fetch-sampled-no-active-span/test.ts, it fails because the baggage header is not undefined as expected. As far as I can tell, SentryPropagator should be excluding these from header injection but it's not. I guess this is because @opentelemetry/instrumentation-undici is not setting the SEMATTRS_HTTP_URL attribute (http.url). Should the otel instrumentation be setting this or should we also be checking for SemanticAttributes.URL_FULL attribute (url.full) which it already sets? Here are the attributes it is already setting.

@github-actions

github-actionsBot commented Aug 27, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser22.52 KB--
@sentry/browser - with treeshaking flags21.3 KB--
@sentry/browser (incl. Tracing)34.78 KB--
@sentry/browser (incl. Tracing, Replay)71.23 KB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags61.67 KB--
@sentry/browser (incl. Tracing, Replay with Canvas)75.57 KB--
@sentry/browser (incl. Tracing, Replay, Feedback)88.3 KB--
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)90.14 KB--
@sentry/browser (incl. metrics)26.83 KB--
@sentry/browser (incl. Feedback)39.6 KB--
@sentry/browser (incl. sendFeedback)27.19 KB--
@sentry/browser (incl. FeedbackAsync)31.9 KB--
@sentry/react25.28 KB--
@sentry/react (incl. Tracing)37.74 KB--
@sentry/vue26.67 KB--
@sentry/vue (incl. Tracing)36.61 KB--
@sentry/svelte22.65 KB--
CDN Bundle23.77 KB--
CDN Bundle (incl. Tracing)36.49 KB--
CDN Bundle (incl. Tracing, Replay)70.91 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.22 KB--
CDN Bundle - uncompressed69.63 KB--
CDN Bundle (incl. Tracing) - uncompressed108.21 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed219.87 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed233.07 KB--
@sentry/nextjs (client)37.51 KB--
@sentry/sveltekit (client)35.35 KB--
@sentry/node126.36 KB+1.11%+1.38 KB 🔺
@sentry/node - without tracing98.84 KB+3.5%+3.34 KB 🔺
@sentry/aws-serverless109.1 KB+1.47%+1.58 KB 🔺

View base workflow run

@timfish

timfish commented Aug 27, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Comment threadyarn.lock Outdated
@timfish
timfish marked this pull request as ready for review September 5, 2024 09:45
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
['http.request.method']: request.method,
['url.full']: request.url,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I replaced these in a couple of places since I just added temporary constants for them

name: 'NodeFetch',
setupOnce() {
const instrumentation = new UndiciInstrumentation({
requireParentforSpans: false,

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.

is this a typo in our config or upstream, seems like it should be requireParentForSpans 😅

@timfishtimfishSep 5, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Comment threadpackages/node/src/integrations/node-fetch.ts Outdated
Comment threadpackages/node/src/integrations/node-fetch.ts
Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@timfish

Copy link
Copy Markdown
CollaboratorAuthor

One nextjs-14 e2e test did need a change due to the differing attributes

mydea added a commit that referenced this pull request Sep 5, 2024
…13587)
This bumps all our internal OTEL instrumentation to their latest
version.
Mainly, this fixes two things:
* Mongoose now supports v7 & v8
open-telemetry/opentelemetry-js-contrib#2353
* A variety of bug fixes, including a problem with http.get in ESM mode
open-telemetry/opentelemetry-js#4857 - See:
https://github.com/open-telemetry/opentelemetry-js/releases/tag/experimental%2Fv0.53.0
Related:
* open-telemetry/opentelemetry-js#4975 Issue
about relaxing deps in "core" instrumentation packages
* PR to bump deps in `@prisma/instrumentation`:
prisma/orm#25160
* PR to bump deps in `opentelemetry-instrument-remix`:
justindsmith/opentelemetry-instrumentations-js#52
* PR to bump deps in `opentelemetry-instrumentation-fetch-node`:
gas-buddy/opentelemetry-instrumentation-fetch-node#17
(which will also be superseded by
#13485 eventually)
* Closes#11499
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.

Use @opentelemetry/instrumentation-undici Unhandled Promise Rejection in debugger on Node startup

3 participants

@timfish@mydea@AbhiPrasad
, '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(node): Use @opentelemetry/instrumentation-undici for fetch tracing - #13485

Merged
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici
Sep 9, 2024
Merged

feat(node): Use @opentelemetry/instrumentation-undici for fetch tracing#13485
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici

Conversation

@timfish

@timfishtimfish commented Aug 27, 2024

Copy link
Copy Markdown
Collaborator

This PR migrates the nativeNodeFetchIntegration to use @opentelemetry/instrumentation-undici instead of opentelemetry-instrumentation-fetch-node.

The instrumentation is still exported as nativeNodeFetchIntegration and is named NodeFetch to ensure backwards compatibility and the tests pass without changes.

Note: One nextjs-14 e2e test did need a change due to the new/differing attribute names.

It's worth noting that @opentelemetry/instrumentation-undiciuses different attributes from the latest semantic convention version vs what we are using and what's used by opentelemetry-instrumentation-fetch-node. It looks like the http instrumentation is migrating to these too so some of the changes in this PR will ensure that the http instrumentation continues to work after these updates.

Outstanding issues:

  • For the outgoing fetch > outgoing sampled fetch requests without active span are correctly instrumented tests, the sentry-trace header has an extra -1 on the end. I have no idea what causes this!

  • For /api/v3 portion of the fetch-unsampled/test.ts and fetch-sampled-no-active-span/test.ts, it fails because the baggage header is not undefined as expected. As far as I can tell, SentryPropagator should be excluding these from header injection but it's not. I guess this is because @opentelemetry/instrumentation-undici is not setting the SEMATTRS_HTTP_URL attribute (http.url). Should the otel instrumentation be setting this or should we also be checking for SemanticAttributes.URL_FULL attribute (url.full) which it already sets? Here are the attributes it is already setting.

@github-actions

github-actionsBot commented Aug 27, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser22.52 KB--
@sentry/browser - with treeshaking flags21.3 KB--
@sentry/browser (incl. Tracing)34.78 KB--
@sentry/browser (incl. Tracing, Replay)71.23 KB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags61.67 KB--
@sentry/browser (incl. Tracing, Replay with Canvas)75.57 KB--
@sentry/browser (incl. Tracing, Replay, Feedback)88.3 KB--
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)90.14 KB--
@sentry/browser (incl. metrics)26.83 KB--
@sentry/browser (incl. Feedback)39.6 KB--
@sentry/browser (incl. sendFeedback)27.19 KB--
@sentry/browser (incl. FeedbackAsync)31.9 KB--
@sentry/react25.28 KB--
@sentry/react (incl. Tracing)37.74 KB--
@sentry/vue26.67 KB--
@sentry/vue (incl. Tracing)36.61 KB--
@sentry/svelte22.65 KB--
CDN Bundle23.77 KB--
CDN Bundle (incl. Tracing)36.49 KB--
CDN Bundle (incl. Tracing, Replay)70.91 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.22 KB--
CDN Bundle - uncompressed69.63 KB--
CDN Bundle (incl. Tracing) - uncompressed108.21 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed219.87 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed233.07 KB--
@sentry/nextjs (client)37.51 KB--
@sentry/sveltekit (client)35.35 KB--
@sentry/node126.36 KB+1.11%+1.38 KB 🔺
@sentry/node - without tracing98.84 KB+3.5%+3.34 KB 🔺
@sentry/aws-serverless109.1 KB+1.47%+1.58 KB 🔺

View base workflow run

@timfish

timfish commented Aug 27, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Comment threadyarn.lock Outdated
@timfish
timfish marked this pull request as ready for review September 5, 2024 09:45
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
['http.request.method']: request.method,
['url.full']: request.url,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I replaced these in a couple of places since I just added temporary constants for them

name: 'NodeFetch',
setupOnce() {
const instrumentation = new UndiciInstrumentation({
requireParentforSpans: false,

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.

is this a typo in our config or upstream, seems like it should be requireParentForSpans 😅

@timfishtimfishSep 5, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Comment threadpackages/node/src/integrations/node-fetch.ts Outdated
Comment threadpackages/node/src/integrations/node-fetch.ts
Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@timfish

Copy link
Copy Markdown
CollaboratorAuthor

One nextjs-14 e2e test did need a change due to the differing attributes

mydea added a commit that referenced this pull request Sep 5, 2024
…13587)
This bumps all our internal OTEL instrumentation to their latest
version.
Mainly, this fixes two things:
* Mongoose now supports v7 & v8
open-telemetry/opentelemetry-js-contrib#2353
* A variety of bug fixes, including a problem with http.get in ESM mode
open-telemetry/opentelemetry-js#4857 - See:
https://github.com/open-telemetry/opentelemetry-js/releases/tag/experimental%2Fv0.53.0
Related:
* open-telemetry/opentelemetry-js#4975 Issue
about relaxing deps in "core" instrumentation packages
* PR to bump deps in `@prisma/instrumentation`:
prisma/orm#25160
* PR to bump deps in `opentelemetry-instrument-remix`:
justindsmith/opentelemetry-instrumentations-js#52
* PR to bump deps in `opentelemetry-instrumentation-fetch-node`:
gas-buddy/opentelemetry-instrumentation-fetch-node#17
(which will also be superseded by
#13485 eventually)
* Closes#11499
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.

Use @opentelemetry/instrumentation-undici Unhandled Promise Rejection in debugger on Node startup

3 participants

@timfish@mydea@AbhiPrasad
, '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(node): Use @opentelemetry/instrumentation-undici for fetch tracing - #13485

Merged
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici
Sep 9, 2024
Merged

feat(node): Use @opentelemetry/instrumentation-undici for fetch tracing#13485
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici

Conversation

@timfish

@timfishtimfish commented Aug 27, 2024

Copy link
Copy Markdown
Collaborator

This PR migrates the nativeNodeFetchIntegration to use @opentelemetry/instrumentation-undici instead of opentelemetry-instrumentation-fetch-node.

The instrumentation is still exported as nativeNodeFetchIntegration and is named NodeFetch to ensure backwards compatibility and the tests pass without changes.

Note: One nextjs-14 e2e test did need a change due to the new/differing attribute names.

It's worth noting that @opentelemetry/instrumentation-undiciuses different attributes from the latest semantic convention version vs what we are using and what's used by opentelemetry-instrumentation-fetch-node. It looks like the http instrumentation is migrating to these too so some of the changes in this PR will ensure that the http instrumentation continues to work after these updates.

Outstanding issues:

  • For the outgoing fetch > outgoing sampled fetch requests without active span are correctly instrumented tests, the sentry-trace header has an extra -1 on the end. I have no idea what causes this!

  • For /api/v3 portion of the fetch-unsampled/test.ts and fetch-sampled-no-active-span/test.ts, it fails because the baggage header is not undefined as expected. As far as I can tell, SentryPropagator should be excluding these from header injection but it's not. I guess this is because @opentelemetry/instrumentation-undici is not setting the SEMATTRS_HTTP_URL attribute (http.url). Should the otel instrumentation be setting this or should we also be checking for SemanticAttributes.URL_FULL attribute (url.full) which it already sets? Here are the attributes it is already setting.

@github-actions

github-actionsBot commented Aug 27, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser22.52 KB--
@sentry/browser - with treeshaking flags21.3 KB--
@sentry/browser (incl. Tracing)34.78 KB--
@sentry/browser (incl. Tracing, Replay)71.23 KB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags61.67 KB--
@sentry/browser (incl. Tracing, Replay with Canvas)75.57 KB--
@sentry/browser (incl. Tracing, Replay, Feedback)88.3 KB--
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)90.14 KB--
@sentry/browser (incl. metrics)26.83 KB--
@sentry/browser (incl. Feedback)39.6 KB--
@sentry/browser (incl. sendFeedback)27.19 KB--
@sentry/browser (incl. FeedbackAsync)31.9 KB--
@sentry/react25.28 KB--
@sentry/react (incl. Tracing)37.74 KB--
@sentry/vue26.67 KB--
@sentry/vue (incl. Tracing)36.61 KB--
@sentry/svelte22.65 KB--
CDN Bundle23.77 KB--
CDN Bundle (incl. Tracing)36.49 KB--
CDN Bundle (incl. Tracing, Replay)70.91 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.22 KB--
CDN Bundle - uncompressed69.63 KB--
CDN Bundle (incl. Tracing) - uncompressed108.21 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed219.87 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed233.07 KB--
@sentry/nextjs (client)37.51 KB--
@sentry/sveltekit (client)35.35 KB--
@sentry/node126.36 KB+1.11%+1.38 KB 🔺
@sentry/node - without tracing98.84 KB+3.5%+3.34 KB 🔺
@sentry/aws-serverless109.1 KB+1.47%+1.58 KB 🔺

View base workflow run

@timfish

timfish commented Aug 27, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Comment threadyarn.lock Outdated
@timfish
timfish marked this pull request as ready for review September 5, 2024 09:45
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
['http.request.method']: request.method,
['url.full']: request.url,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I replaced these in a couple of places since I just added temporary constants for them

name: 'NodeFetch',
setupOnce() {
const instrumentation = new UndiciInstrumentation({
requireParentforSpans: false,

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.

is this a typo in our config or upstream, seems like it should be requireParentForSpans 😅

@timfishtimfishSep 5, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Comment threadpackages/node/src/integrations/node-fetch.ts Outdated
Comment threadpackages/node/src/integrations/node-fetch.ts
Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@timfish

Copy link
Copy Markdown
CollaboratorAuthor

One nextjs-14 e2e test did need a change due to the differing attributes

mydea added a commit that referenced this pull request Sep 5, 2024
…13587)
This bumps all our internal OTEL instrumentation to their latest
version.
Mainly, this fixes two things:
* Mongoose now supports v7 & v8
open-telemetry/opentelemetry-js-contrib#2353
* A variety of bug fixes, including a problem with http.get in ESM mode
open-telemetry/opentelemetry-js#4857 - See:
https://github.com/open-telemetry/opentelemetry-js/releases/tag/experimental%2Fv0.53.0
Related:
* open-telemetry/opentelemetry-js#4975 Issue
about relaxing deps in "core" instrumentation packages
* PR to bump deps in `@prisma/instrumentation`:
prisma/orm#25160
* PR to bump deps in `opentelemetry-instrument-remix`:
justindsmith/opentelemetry-instrumentations-js#52
* PR to bump deps in `opentelemetry-instrumentation-fetch-node`:
gas-buddy/opentelemetry-instrumentation-fetch-node#17
(which will also be superseded by
#13485 eventually)
* Closes#11499
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.

Use @opentelemetry/instrumentation-undici Unhandled Promise Rejection in debugger on Node startup

3 participants

@timfish@mydea@AbhiPrasad
, '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(node): Use @opentelemetry/instrumentation-undici for fetch tracing - #13485

Merged
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici
Sep 9, 2024
Merged

feat(node): Use @opentelemetry/instrumentation-undici for fetch tracing#13485
AbhiPrasad merged 21 commits into
developfrom
timfish/otel-undici

Conversation

@timfish

@timfishtimfish commented Aug 27, 2024

Copy link
Copy Markdown
Collaborator

This PR migrates the nativeNodeFetchIntegration to use @opentelemetry/instrumentation-undici instead of opentelemetry-instrumentation-fetch-node.

The instrumentation is still exported as nativeNodeFetchIntegration and is named NodeFetch to ensure backwards compatibility and the tests pass without changes.

Note: One nextjs-14 e2e test did need a change due to the new/differing attribute names.

It's worth noting that @opentelemetry/instrumentation-undiciuses different attributes from the latest semantic convention version vs what we are using and what's used by opentelemetry-instrumentation-fetch-node. It looks like the http instrumentation is migrating to these too so some of the changes in this PR will ensure that the http instrumentation continues to work after these updates.

Outstanding issues:

  • For the outgoing fetch > outgoing sampled fetch requests without active span are correctly instrumented tests, the sentry-trace header has an extra -1 on the end. I have no idea what causes this!

  • For /api/v3 portion of the fetch-unsampled/test.ts and fetch-sampled-no-active-span/test.ts, it fails because the baggage header is not undefined as expected. As far as I can tell, SentryPropagator should be excluding these from header injection but it's not. I guess this is because @opentelemetry/instrumentation-undici is not setting the SEMATTRS_HTTP_URL attribute (http.url). Should the otel instrumentation be setting this or should we also be checking for SemanticAttributes.URL_FULL attribute (url.full) which it already sets? Here are the attributes it is already setting.

@github-actions

github-actionsBot commented Aug 27, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser22.52 KB--
@sentry/browser - with treeshaking flags21.3 KB--
@sentry/browser (incl. Tracing)34.78 KB--
@sentry/browser (incl. Tracing, Replay)71.23 KB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags61.67 KB--
@sentry/browser (incl. Tracing, Replay with Canvas)75.57 KB--
@sentry/browser (incl. Tracing, Replay, Feedback)88.3 KB--
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)90.14 KB--
@sentry/browser (incl. metrics)26.83 KB--
@sentry/browser (incl. Feedback)39.6 KB--
@sentry/browser (incl. sendFeedback)27.19 KB--
@sentry/browser (incl. FeedbackAsync)31.9 KB--
@sentry/react25.28 KB--
@sentry/react (incl. Tracing)37.74 KB--
@sentry/vue26.67 KB--
@sentry/vue (incl. Tracing)36.61 KB--
@sentry/svelte22.65 KB--
CDN Bundle23.77 KB--
CDN Bundle (incl. Tracing)36.49 KB--
CDN Bundle (incl. Tracing, Replay)70.91 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.22 KB--
CDN Bundle - uncompressed69.63 KB--
CDN Bundle (incl. Tracing) - uncompressed108.21 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed219.87 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed233.07 KB--
@sentry/nextjs (client)37.51 KB--
@sentry/sveltekit (client)35.35 KB--
@sentry/node126.36 KB+1.11%+1.38 KB 🔺
@sentry/node - without tracing98.84 KB+3.5%+3.34 KB 🔺
@sentry/aws-serverless109.1 KB+1.47%+1.58 KB 🔺

View base workflow run

@timfish

timfish commented Aug 27, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Comment threadyarn.lock Outdated
@timfish
timfish marked this pull request as ready for review September 5, 2024 09:45
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.server',
['http.request.method']: request.method,
['url.full']: request.url,

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

I replaced these in a couple of places since I just added temporary constants for them

name: 'NodeFetch',
setupOnce() {
const instrumentation = new UndiciInstrumentation({
requireParentforSpans: false,

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.

is this a typo in our config or upstream, seems like it should be requireParentForSpans 😅

@timfishtimfishSep 5, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Comment threadpackages/node/src/integrations/node-fetch.ts Outdated
Comment threadpackages/node/src/integrations/node-fetch.ts
Comment threadpackages/opentelemetry/src/sampler.ts Outdated
@timfish

Copy link
Copy Markdown
CollaboratorAuthor

One nextjs-14 e2e test did need a change due to the differing attributes

mydea added a commit that referenced this pull request Sep 5, 2024
…13587)
This bumps all our internal OTEL instrumentation to their latest
version.
Mainly, this fixes two things:
* Mongoose now supports v7 & v8
open-telemetry/opentelemetry-js-contrib#2353
* A variety of bug fixes, including a problem with http.get in ESM mode
open-telemetry/opentelemetry-js#4857 - See:
https://github.com/open-telemetry/opentelemetry-js/releases/tag/experimental%2Fv0.53.0
Related:
* open-telemetry/opentelemetry-js#4975 Issue
about relaxing deps in "core" instrumentation packages
* PR to bump deps in `@prisma/instrumentation`:
prisma/orm#25160
* PR to bump deps in `opentelemetry-instrument-remix`:
justindsmith/opentelemetry-instrumentations-js#52
* PR to bump deps in `opentelemetry-instrumentation-fetch-node`:
gas-buddy/opentelemetry-instrumentation-fetch-node#17
(which will also be superseded by
#13485 eventually)
* Closes#11499
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.

Use @opentelemetry/instrumentation-undici Unhandled Promise Rejection in debugger on Node startup

3 participants

@timfish@mydea@AbhiPrasad