fix(node-experimental): Ensure http breadcrumbs are correctly added#8937

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 1 commit into from
Closed

fix(node-experimental): Ensure http breadcrumbs are correctly added #8937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 56 additions & 48 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import type { EventProcessor, Hub, Integration } from '@sentry/types';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

import type { NodeExperimentalClient } from '../sdk/client';
import { getParentHub } from '../utils/getParentHub';
import { getRequestSpanData } from '../utils/getRequestSpanData';

interface TracingOptions {
Expand DownExpand Up@@ -95,8 +96,11 @@ export class Http implements Integration {
new HttpInstrumentation({
requireParentforOutgoingSpans: true,
requireParentforIncomingSpans: false,
applyCustomAttributesOnSpan: (span, req, res) => {
this._onSpan(span as unknown as OtelSpan, req, res);
requestHook: (span, req) => {
this._updateSentrySpan(span as unknown as OtelSpan, req);
},
responseHook: (span, res) => {
this._addRequestBreadcrumb(span as unknown as OtelSpan, res);
},
}),
],
Expand DownExpand Up@@ -136,64 +140,68 @@ export class Http implements Integration {
return;
};

/** Handle an emitted span from the HTTP instrumentation. */
private _onSpan(
span: OtelSpan,
request: ClientRequest | IncomingMessage,
response: IncomingMessage | ServerResponse,
): void {
const data = getRequestSpanData(span, request, response);
/** Update the Sentry span data based on the OTEL span. */
private _updateSentrySpan(span: OtelSpan, request: ClientRequest | IncomingMessage): void {
const data = getRequestSpanData(span);
const { attributes } = span;

const sentrySpan = _INTERNAL_getSentrySpan(span.spanContext().spanId);
if (sentrySpan) {
sentrySpan.origin = 'auto.http.otel.http';
if (!sentrySpan) {
return;
}

const additionalData: Record<string, unknown> = {
url: data.url,
};
sentrySpan.origin = 'auto.http.otel.http';

if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}
const additionalData: Record<string, unknown> = {
url: data.url,
};

if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;
if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}

sentrySpan.setTag('http.status_code', statusCode);
}
if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;

if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}
sentrySpan.setTag('http.status_code', statusCode);
}

Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}

if (this._breadcrumbs) {
getCurrentHub().addBreadcrumb(
{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
request,
response,
},
);
Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
}

/** Add a breadcrumb for outgoing requests. */
private _addRequestBreadcrumb(span: OtelSpan, response: IncomingMessage | ServerResponse): void {
if (!this._breadcrumbs || span.kind !== SpanKind.CLIENT) {
return;
}

const data = getRequestSpanData(span);
getParentHub().addBreadcrumb(

@mydeamydeaSep 4, 2023

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.

Technically, the most correct (?) would be to add the breadcrumb both to the current and the parent hub 🤔 does that make sense? We could also make it e.g.:

consthub=getCurrentHub();constparentHub=getParentHub();hub.addBreadcrumb(breadcrumb);if(hub!==parentHub){parentHub.addBreadcrumb(breadcrumb);}

To be on the very safe side? The breadcrumb to the "actual current" hub would only really be relevant/visible if something happened inside of the OTEL internals, I believe (but it's a bit hard to say with all the callbacks/nested function scopes/etc.)

@Lms24Lms24Sep 5, 2023

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.

Without being too deep into this, it sounds reasonable to me to add it to both.

{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
// request, ???
response,
},
);
}
}

Expand Down
8 changes: 7 additions & 1 deletion packages/node-experimental/src/sdk/otelContextManager.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { Carrier, Hub } from '@sentry/core';
import { ensureHubOnCarrier, getCurrentHub, getHubFromCarrier } from '@sentry/core';

export const OTEL_CONTEXT_HUB_KEY = api.createContextKey('sentry_hub');
export const OTEL_CONTEXT_PARENT_KEY = api.createContextKey('sentry_parent_context');

function createNewHub(parent: Hub | undefined): Hub {
const carrier: Carrier = {};
Expand DownExpand Up@@ -33,6 +34,11 @@ export class SentryContextManager extends AsyncLocalStorageContextManager {
const existingHub = getCurrentHub();
const newHub = createNewHub(existingHub);

return super.with(context.setValue(OTEL_CONTEXT_HUB_KEY, newHub), fn, thisArg, ...args);
return super.with(
context.setValue(OTEL_CONTEXT_HUB_KEY, newHub).setValue(OTEL_CONTEXT_PARENT_KEY, context),
fn,
thisArg,
...args,
);
}
}
21 changes: 21 additions & 0 deletions packages/node-experimental/src/utils/getParentHub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import * as api from '@opentelemetry/api';
import { getCurrentHub } from '@sentry/core';
import type { Hub } from '@sentry/types';

import { OTEL_CONTEXT_HUB_KEY, OTEL_CONTEXT_PARENT_KEY } from '../sdk/otelContextManager';

/**
* Get the hub of the parent context.
* Can be useful if you e.g. need to add a breadcrumb from inside of an ongoing span.
*
* Without this, if you e.g. try to add a breadcrumb from an instrumentation's `onSpan` callback or similar,
* you'll always attach it to the current hub, which in that case will be hyper specific to the instrumentation.
*/
export function getParentHub(): Hub {
const ctx = api.context.active();
const parentContext = ctx?.getValue(OTEL_CONTEXT_PARENT_KEY) as api.Context | undefined;

const parentHub = parentContext && (parentContext.getValue(OTEL_CONTEXT_HUB_KEY) as Hub | undefined);

return parentHub || getCurrentHub();
}
7 changes: 1 addition & 6 deletions packages/node-experimental/src/utils/getRequestSpanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,11 @@ import type { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type { SanitizedRequestData } from '@sentry/types';
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

/**
* Get sanitizied request data from an OTEL span.
*/
export function getRequestSpanData(
span: OtelSpan,
_request: ClientRequest | IncomingMessage,
_response: IncomingMessage | ServerResponse,
): SanitizedRequestData {
export function getRequestSpanData(span: OtelSpan): SanitizedRequestData {
const data: SanitizedRequestData = {
url: span.attributes[SemanticAttributes.HTTP_URL] as string,
'http.method': (span.attributes[SemanticAttributes.HTTP_METHOD] as string) || 'GET',
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e 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

fix(node-experimental): Ensure http breadcrumbs are correctly added#8937

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 1 commit into from
Closed

fix(node-experimental): Ensure http breadcrumbs are correctly added #8937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 56 additions & 48 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import type { EventProcessor, Hub, Integration } from '@sentry/types';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

import type { NodeExperimentalClient } from '../sdk/client';
import { getParentHub } from '../utils/getParentHub';
import { getRequestSpanData } from '../utils/getRequestSpanData';

interface TracingOptions {
Expand DownExpand Up@@ -95,8 +96,11 @@ export class Http implements Integration {
new HttpInstrumentation({
requireParentforOutgoingSpans: true,
requireParentforIncomingSpans: false,
applyCustomAttributesOnSpan: (span, req, res) => {
this._onSpan(span as unknown as OtelSpan, req, res);
requestHook: (span, req) => {
this._updateSentrySpan(span as unknown as OtelSpan, req);
},
responseHook: (span, res) => {
this._addRequestBreadcrumb(span as unknown as OtelSpan, res);
},
}),
],
Expand DownExpand Up@@ -136,64 +140,68 @@ export class Http implements Integration {
return;
};

/** Handle an emitted span from the HTTP instrumentation. */
private _onSpan(
span: OtelSpan,
request: ClientRequest | IncomingMessage,
response: IncomingMessage | ServerResponse,
): void {
const data = getRequestSpanData(span, request, response);
/** Update the Sentry span data based on the OTEL span. */
private _updateSentrySpan(span: OtelSpan, request: ClientRequest | IncomingMessage): void {
const data = getRequestSpanData(span);
const { attributes } = span;

const sentrySpan = _INTERNAL_getSentrySpan(span.spanContext().spanId);
if (sentrySpan) {
sentrySpan.origin = 'auto.http.otel.http';
if (!sentrySpan) {
return;
}

const additionalData: Record<string, unknown> = {
url: data.url,
};
sentrySpan.origin = 'auto.http.otel.http';

if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}
const additionalData: Record<string, unknown> = {
url: data.url,
};

if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;
if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}

sentrySpan.setTag('http.status_code', statusCode);
}
if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;

if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}
sentrySpan.setTag('http.status_code', statusCode);
}

Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}

if (this._breadcrumbs) {
getCurrentHub().addBreadcrumb(
{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
request,
response,
},
);
Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
}

/** Add a breadcrumb for outgoing requests. */
private _addRequestBreadcrumb(span: OtelSpan, response: IncomingMessage | ServerResponse): void {
if (!this._breadcrumbs || span.kind !== SpanKind.CLIENT) {
return;
}

const data = getRequestSpanData(span);
getParentHub().addBreadcrumb(

@mydeamydeaSep 4, 2023

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.

Technically, the most correct (?) would be to add the breadcrumb both to the current and the parent hub 🤔 does that make sense? We could also make it e.g.:

consthub=getCurrentHub();constparentHub=getParentHub();hub.addBreadcrumb(breadcrumb);if(hub!==parentHub){parentHub.addBreadcrumb(breadcrumb);}

To be on the very safe side? The breadcrumb to the "actual current" hub would only really be relevant/visible if something happened inside of the OTEL internals, I believe (but it's a bit hard to say with all the callbacks/nested function scopes/etc.)

@Lms24Lms24Sep 5, 2023

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.

Without being too deep into this, it sounds reasonable to me to add it to both.

{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
// request, ???
response,
},
);
}
}

Expand Down
8 changes: 7 additions & 1 deletion packages/node-experimental/src/sdk/otelContextManager.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { Carrier, Hub } from '@sentry/core';
import { ensureHubOnCarrier, getCurrentHub, getHubFromCarrier } from '@sentry/core';

export const OTEL_CONTEXT_HUB_KEY = api.createContextKey('sentry_hub');
export const OTEL_CONTEXT_PARENT_KEY = api.createContextKey('sentry_parent_context');

function createNewHub(parent: Hub | undefined): Hub {
const carrier: Carrier = {};
Expand DownExpand Up@@ -33,6 +34,11 @@ export class SentryContextManager extends AsyncLocalStorageContextManager {
const existingHub = getCurrentHub();
const newHub = createNewHub(existingHub);

return super.with(context.setValue(OTEL_CONTEXT_HUB_KEY, newHub), fn, thisArg, ...args);
return super.with(
context.setValue(OTEL_CONTEXT_HUB_KEY, newHub).setValue(OTEL_CONTEXT_PARENT_KEY, context),
fn,
thisArg,
...args,
);
}
}
21 changes: 21 additions & 0 deletions packages/node-experimental/src/utils/getParentHub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import * as api from '@opentelemetry/api';
import { getCurrentHub } from '@sentry/core';
import type { Hub } from '@sentry/types';

import { OTEL_CONTEXT_HUB_KEY, OTEL_CONTEXT_PARENT_KEY } from '../sdk/otelContextManager';

/**
* Get the hub of the parent context.
* Can be useful if you e.g. need to add a breadcrumb from inside of an ongoing span.
*
* Without this, if you e.g. try to add a breadcrumb from an instrumentation's `onSpan` callback or similar,
* you'll always attach it to the current hub, which in that case will be hyper specific to the instrumentation.
*/
export function getParentHub(): Hub {
const ctx = api.context.active();
const parentContext = ctx?.getValue(OTEL_CONTEXT_PARENT_KEY) as api.Context | undefined;

const parentHub = parentContext && (parentContext.getValue(OTEL_CONTEXT_HUB_KEY) as Hub | undefined);

return parentHub || getCurrentHub();
}
7 changes: 1 addition & 6 deletions packages/node-experimental/src/utils/getRequestSpanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,11 @@ import type { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type { SanitizedRequestData } from '@sentry/types';
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

/**
* Get sanitizied request data from an OTEL span.
*/
export function getRequestSpanData(
span: OtelSpan,
_request: ClientRequest | IncomingMessage,
_response: IncomingMessage | ServerResponse,
): SanitizedRequestData {
export function getRequestSpanData(span: OtelSpan): SanitizedRequestData {
const data: SanitizedRequestData = {
url: span.attributes[SemanticAttributes.HTTP_URL] as string,
'http.method': (span.attributes[SemanticAttributes.HTTP_METHOD] as string) || 'GET',
Expand Down
, '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

fix(node-experimental): Ensure http breadcrumbs are correctly added#8937

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 1 commit into from
Closed

fix(node-experimental): Ensure http breadcrumbs are correctly added #8937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 56 additions & 48 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import type { EventProcessor, Hub, Integration } from '@sentry/types';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

import type { NodeExperimentalClient } from '../sdk/client';
import { getParentHub } from '../utils/getParentHub';
import { getRequestSpanData } from '../utils/getRequestSpanData';

interface TracingOptions {
Expand DownExpand Up@@ -95,8 +96,11 @@ export class Http implements Integration {
new HttpInstrumentation({
requireParentforOutgoingSpans: true,
requireParentforIncomingSpans: false,
applyCustomAttributesOnSpan: (span, req, res) => {
this._onSpan(span as unknown as OtelSpan, req, res);
requestHook: (span, req) => {
this._updateSentrySpan(span as unknown as OtelSpan, req);
},
responseHook: (span, res) => {
this._addRequestBreadcrumb(span as unknown as OtelSpan, res);
},
}),
],
Expand DownExpand Up@@ -136,64 +140,68 @@ export class Http implements Integration {
return;
};

/** Handle an emitted span from the HTTP instrumentation. */
private _onSpan(
span: OtelSpan,
request: ClientRequest | IncomingMessage,
response: IncomingMessage | ServerResponse,
): void {
const data = getRequestSpanData(span, request, response);
/** Update the Sentry span data based on the OTEL span. */
private _updateSentrySpan(span: OtelSpan, request: ClientRequest | IncomingMessage): void {
const data = getRequestSpanData(span);
const { attributes } = span;

const sentrySpan = _INTERNAL_getSentrySpan(span.spanContext().spanId);
if (sentrySpan) {
sentrySpan.origin = 'auto.http.otel.http';
if (!sentrySpan) {
return;
}

const additionalData: Record<string, unknown> = {
url: data.url,
};
sentrySpan.origin = 'auto.http.otel.http';

if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}
const additionalData: Record<string, unknown> = {
url: data.url,
};

if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;
if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}

sentrySpan.setTag('http.status_code', statusCode);
}
if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;

if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}
sentrySpan.setTag('http.status_code', statusCode);
}

Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}

if (this._breadcrumbs) {
getCurrentHub().addBreadcrumb(
{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
request,
response,
},
);
Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
}

/** Add a breadcrumb for outgoing requests. */
private _addRequestBreadcrumb(span: OtelSpan, response: IncomingMessage | ServerResponse): void {
if (!this._breadcrumbs || span.kind !== SpanKind.CLIENT) {
return;
}

const data = getRequestSpanData(span);
getParentHub().addBreadcrumb(

@mydeamydeaSep 4, 2023

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.

Technically, the most correct (?) would be to add the breadcrumb both to the current and the parent hub 🤔 does that make sense? We could also make it e.g.:

consthub=getCurrentHub();constparentHub=getParentHub();hub.addBreadcrumb(breadcrumb);if(hub!==parentHub){parentHub.addBreadcrumb(breadcrumb);}

To be on the very safe side? The breadcrumb to the "actual current" hub would only really be relevant/visible if something happened inside of the OTEL internals, I believe (but it's a bit hard to say with all the callbacks/nested function scopes/etc.)

@Lms24Lms24Sep 5, 2023

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.

Without being too deep into this, it sounds reasonable to me to add it to both.

{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
// request, ???
response,
},
);
}
}

Expand Down
8 changes: 7 additions & 1 deletion packages/node-experimental/src/sdk/otelContextManager.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { Carrier, Hub } from '@sentry/core';
import { ensureHubOnCarrier, getCurrentHub, getHubFromCarrier } from '@sentry/core';

export const OTEL_CONTEXT_HUB_KEY = api.createContextKey('sentry_hub');
export const OTEL_CONTEXT_PARENT_KEY = api.createContextKey('sentry_parent_context');

function createNewHub(parent: Hub | undefined): Hub {
const carrier: Carrier = {};
Expand DownExpand Up@@ -33,6 +34,11 @@ export class SentryContextManager extends AsyncLocalStorageContextManager {
const existingHub = getCurrentHub();
const newHub = createNewHub(existingHub);

return super.with(context.setValue(OTEL_CONTEXT_HUB_KEY, newHub), fn, thisArg, ...args);
return super.with(
context.setValue(OTEL_CONTEXT_HUB_KEY, newHub).setValue(OTEL_CONTEXT_PARENT_KEY, context),
fn,
thisArg,
...args,
);
}
}
21 changes: 21 additions & 0 deletions packages/node-experimental/src/utils/getParentHub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import * as api from '@opentelemetry/api';
import { getCurrentHub } from '@sentry/core';
import type { Hub } from '@sentry/types';

import { OTEL_CONTEXT_HUB_KEY, OTEL_CONTEXT_PARENT_KEY } from '../sdk/otelContextManager';

/**
* Get the hub of the parent context.
* Can be useful if you e.g. need to add a breadcrumb from inside of an ongoing span.
*
* Without this, if you e.g. try to add a breadcrumb from an instrumentation's `onSpan` callback or similar,
* you'll always attach it to the current hub, which in that case will be hyper specific to the instrumentation.
*/
export function getParentHub(): Hub {
const ctx = api.context.active();
const parentContext = ctx?.getValue(OTEL_CONTEXT_PARENT_KEY) as api.Context | undefined;

const parentHub = parentContext && (parentContext.getValue(OTEL_CONTEXT_HUB_KEY) as Hub | undefined);

return parentHub || getCurrentHub();
}
7 changes: 1 addition & 6 deletions packages/node-experimental/src/utils/getRequestSpanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,11 @@ import type { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type { SanitizedRequestData } from '@sentry/types';
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

/**
* Get sanitizied request data from an OTEL span.
*/
export function getRequestSpanData(
span: OtelSpan,
_request: ClientRequest | IncomingMessage,
_response: IncomingMessage | ServerResponse,
): SanitizedRequestData {
export function getRequestSpanData(span: OtelSpan): SanitizedRequestData {
const data: SanitizedRequestData = {
url: span.attributes[SemanticAttributes.HTTP_URL] as string,
'http.method': (span.attributes[SemanticAttributes.HTTP_METHOD] as string) || 'GET',
Expand Down
, '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 \u003e 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

fix(node-experimental): Ensure http breadcrumbs are correctly added#8937

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 1 commit into from
Closed

fix(node-experimental): Ensure http breadcrumbs are correctly added #8937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 56 additions & 48 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import type { EventProcessor, Hub, Integration } from '@sentry/types';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

import type { NodeExperimentalClient } from '../sdk/client';
import { getParentHub } from '../utils/getParentHub';
import { getRequestSpanData } from '../utils/getRequestSpanData';

interface TracingOptions {
Expand DownExpand Up@@ -95,8 +96,11 @@ export class Http implements Integration {
new HttpInstrumentation({
requireParentforOutgoingSpans: true,
requireParentforIncomingSpans: false,
applyCustomAttributesOnSpan: (span, req, res) => {
this._onSpan(span as unknown as OtelSpan, req, res);
requestHook: (span, req) => {
this._updateSentrySpan(span as unknown as OtelSpan, req);
},
responseHook: (span, res) => {
this._addRequestBreadcrumb(span as unknown as OtelSpan, res);
},
}),
],
Expand DownExpand Up@@ -136,64 +140,68 @@ export class Http implements Integration {
return;
};

/** Handle an emitted span from the HTTP instrumentation. */
private _onSpan(
span: OtelSpan,
request: ClientRequest | IncomingMessage,
response: IncomingMessage | ServerResponse,
): void {
const data = getRequestSpanData(span, request, response);
/** Update the Sentry span data based on the OTEL span. */
private _updateSentrySpan(span: OtelSpan, request: ClientRequest | IncomingMessage): void {
const data = getRequestSpanData(span);
const { attributes } = span;

const sentrySpan = _INTERNAL_getSentrySpan(span.spanContext().spanId);
if (sentrySpan) {
sentrySpan.origin = 'auto.http.otel.http';
if (!sentrySpan) {
return;
}

const additionalData: Record<string, unknown> = {
url: data.url,
};
sentrySpan.origin = 'auto.http.otel.http';

if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}
const additionalData: Record<string, unknown> = {
url: data.url,
};

if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;
if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}

sentrySpan.setTag('http.status_code', statusCode);
}
if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;

if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}
sentrySpan.setTag('http.status_code', statusCode);
}

Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}

if (this._breadcrumbs) {
getCurrentHub().addBreadcrumb(
{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
request,
response,
},
);
Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
}

/** Add a breadcrumb for outgoing requests. */
private _addRequestBreadcrumb(span: OtelSpan, response: IncomingMessage | ServerResponse): void {
if (!this._breadcrumbs || span.kind !== SpanKind.CLIENT) {
return;
}

const data = getRequestSpanData(span);
getParentHub().addBreadcrumb(

@mydeamydeaSep 4, 2023

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.

Technically, the most correct (?) would be to add the breadcrumb both to the current and the parent hub 🤔 does that make sense? We could also make it e.g.:

consthub=getCurrentHub();constparentHub=getParentHub();hub.addBreadcrumb(breadcrumb);if(hub!==parentHub){parentHub.addBreadcrumb(breadcrumb);}

To be on the very safe side? The breadcrumb to the "actual current" hub would only really be relevant/visible if something happened inside of the OTEL internals, I believe (but it's a bit hard to say with all the callbacks/nested function scopes/etc.)

@Lms24Lms24Sep 5, 2023

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.

Without being too deep into this, it sounds reasonable to me to add it to both.

{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
// request, ???
response,
},
);
}
}

Expand Down
8 changes: 7 additions & 1 deletion packages/node-experimental/src/sdk/otelContextManager.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { Carrier, Hub } from '@sentry/core';
import { ensureHubOnCarrier, getCurrentHub, getHubFromCarrier } from '@sentry/core';

export const OTEL_CONTEXT_HUB_KEY = api.createContextKey('sentry_hub');
export const OTEL_CONTEXT_PARENT_KEY = api.createContextKey('sentry_parent_context');

function createNewHub(parent: Hub | undefined): Hub {
const carrier: Carrier = {};
Expand DownExpand Up@@ -33,6 +34,11 @@ export class SentryContextManager extends AsyncLocalStorageContextManager {
const existingHub = getCurrentHub();
const newHub = createNewHub(existingHub);

return super.with(context.setValue(OTEL_CONTEXT_HUB_KEY, newHub), fn, thisArg, ...args);
return super.with(
context.setValue(OTEL_CONTEXT_HUB_KEY, newHub).setValue(OTEL_CONTEXT_PARENT_KEY, context),
fn,
thisArg,
...args,
);
}
}
21 changes: 21 additions & 0 deletions packages/node-experimental/src/utils/getParentHub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import * as api from '@opentelemetry/api';
import { getCurrentHub } from '@sentry/core';
import type { Hub } from '@sentry/types';

import { OTEL_CONTEXT_HUB_KEY, OTEL_CONTEXT_PARENT_KEY } from '../sdk/otelContextManager';

/**
* Get the hub of the parent context.
* Can be useful if you e.g. need to add a breadcrumb from inside of an ongoing span.
*
* Without this, if you e.g. try to add a breadcrumb from an instrumentation's `onSpan` callback or similar,
* you'll always attach it to the current hub, which in that case will be hyper specific to the instrumentation.
*/
export function getParentHub(): Hub {
const ctx = api.context.active();
const parentContext = ctx?.getValue(OTEL_CONTEXT_PARENT_KEY) as api.Context | undefined;

const parentHub = parentContext && (parentContext.getValue(OTEL_CONTEXT_HUB_KEY) as Hub | undefined);

return parentHub || getCurrentHub();
}
7 changes: 1 addition & 6 deletions packages/node-experimental/src/utils/getRequestSpanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,11 @@ import type { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type { SanitizedRequestData } from '@sentry/types';
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

/**
* Get sanitizied request data from an OTEL span.
*/
export function getRequestSpanData(
span: OtelSpan,
_request: ClientRequest | IncomingMessage,
_response: IncomingMessage | ServerResponse,
): SanitizedRequestData {
export function getRequestSpanData(span: OtelSpan): SanitizedRequestData {
const data: SanitizedRequestData = {
url: span.attributes[SemanticAttributes.HTTP_URL] as string,
'http.method': (span.attributes[SemanticAttributes.HTTP_METHOD] as string) || 'GET',
Expand Down
, '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

fix(node-experimental): Ensure http breadcrumbs are correctly added#8937

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 1 commit into from
Closed

fix(node-experimental): Ensure http breadcrumbs are correctly added #8937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 56 additions & 48 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import type { EventProcessor, Hub, Integration } from '@sentry/types';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

import type { NodeExperimentalClient } from '../sdk/client';
import { getParentHub } from '../utils/getParentHub';
import { getRequestSpanData } from '../utils/getRequestSpanData';

interface TracingOptions {
Expand DownExpand Up@@ -95,8 +96,11 @@ export class Http implements Integration {
new HttpInstrumentation({
requireParentforOutgoingSpans: true,
requireParentforIncomingSpans: false,
applyCustomAttributesOnSpan: (span, req, res) => {
this._onSpan(span as unknown as OtelSpan, req, res);
requestHook: (span, req) => {
this._updateSentrySpan(span as unknown as OtelSpan, req);
},
responseHook: (span, res) => {
this._addRequestBreadcrumb(span as unknown as OtelSpan, res);
},
}),
],
Expand DownExpand Up@@ -136,64 +140,68 @@ export class Http implements Integration {
return;
};

/** Handle an emitted span from the HTTP instrumentation. */
private _onSpan(
span: OtelSpan,
request: ClientRequest | IncomingMessage,
response: IncomingMessage | ServerResponse,
): void {
const data = getRequestSpanData(span, request, response);
/** Update the Sentry span data based on the OTEL span. */
private _updateSentrySpan(span: OtelSpan, request: ClientRequest | IncomingMessage): void {
const data = getRequestSpanData(span);
const { attributes } = span;

const sentrySpan = _INTERNAL_getSentrySpan(span.spanContext().spanId);
if (sentrySpan) {
sentrySpan.origin = 'auto.http.otel.http';
if (!sentrySpan) {
return;
}

const additionalData: Record<string, unknown> = {
url: data.url,
};
sentrySpan.origin = 'auto.http.otel.http';

if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}
const additionalData: Record<string, unknown> = {
url: data.url,
};

if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;
if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}

sentrySpan.setTag('http.status_code', statusCode);
}
if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;

if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}
sentrySpan.setTag('http.status_code', statusCode);
}

Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}

if (this._breadcrumbs) {
getCurrentHub().addBreadcrumb(
{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
request,
response,
},
);
Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
}

/** Add a breadcrumb for outgoing requests. */
private _addRequestBreadcrumb(span: OtelSpan, response: IncomingMessage | ServerResponse): void {
if (!this._breadcrumbs || span.kind !== SpanKind.CLIENT) {
return;
}

const data = getRequestSpanData(span);
getParentHub().addBreadcrumb(

@mydeamydeaSep 4, 2023

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.

Technically, the most correct (?) would be to add the breadcrumb both to the current and the parent hub 🤔 does that make sense? We could also make it e.g.:

consthub=getCurrentHub();constparentHub=getParentHub();hub.addBreadcrumb(breadcrumb);if(hub!==parentHub){parentHub.addBreadcrumb(breadcrumb);}

To be on the very safe side? The breadcrumb to the "actual current" hub would only really be relevant/visible if something happened inside of the OTEL internals, I believe (but it's a bit hard to say with all the callbacks/nested function scopes/etc.)

@Lms24Lms24Sep 5, 2023

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.

Without being too deep into this, it sounds reasonable to me to add it to both.

{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
// request, ???
response,
},
);
}
}

Expand Down
8 changes: 7 additions & 1 deletion packages/node-experimental/src/sdk/otelContextManager.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { Carrier, Hub } from '@sentry/core';
import { ensureHubOnCarrier, getCurrentHub, getHubFromCarrier } from '@sentry/core';

export const OTEL_CONTEXT_HUB_KEY = api.createContextKey('sentry_hub');
export const OTEL_CONTEXT_PARENT_KEY = api.createContextKey('sentry_parent_context');

function createNewHub(parent: Hub | undefined): Hub {
const carrier: Carrier = {};
Expand DownExpand Up@@ -33,6 +34,11 @@ export class SentryContextManager extends AsyncLocalStorageContextManager {
const existingHub = getCurrentHub();
const newHub = createNewHub(existingHub);

return super.with(context.setValue(OTEL_CONTEXT_HUB_KEY, newHub), fn, thisArg, ...args);
return super.with(
context.setValue(OTEL_CONTEXT_HUB_KEY, newHub).setValue(OTEL_CONTEXT_PARENT_KEY, context),
fn,
thisArg,
...args,
);
}
}
21 changes: 21 additions & 0 deletions packages/node-experimental/src/utils/getParentHub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import * as api from '@opentelemetry/api';
import { getCurrentHub } from '@sentry/core';
import type { Hub } from '@sentry/types';

import { OTEL_CONTEXT_HUB_KEY, OTEL_CONTEXT_PARENT_KEY } from '../sdk/otelContextManager';

/**
* Get the hub of the parent context.
* Can be useful if you e.g. need to add a breadcrumb from inside of an ongoing span.
*
* Without this, if you e.g. try to add a breadcrumb from an instrumentation's `onSpan` callback or similar,
* you'll always attach it to the current hub, which in that case will be hyper specific to the instrumentation.
*/
export function getParentHub(): Hub {
const ctx = api.context.active();
const parentContext = ctx?.getValue(OTEL_CONTEXT_PARENT_KEY) as api.Context | undefined;

const parentHub = parentContext && (parentContext.getValue(OTEL_CONTEXT_HUB_KEY) as Hub | undefined);

return parentHub || getCurrentHub();
}
7 changes: 1 addition & 6 deletions packages/node-experimental/src/utils/getRequestSpanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,11 @@ import type { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type { SanitizedRequestData } from '@sentry/types';
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

/**
* Get sanitizied request data from an OTEL span.
*/
export function getRequestSpanData(
span: OtelSpan,
_request: ClientRequest | IncomingMessage,
_response: IncomingMessage | ServerResponse,
): SanitizedRequestData {
export function getRequestSpanData(span: OtelSpan): SanitizedRequestData {
const data: SanitizedRequestData = {
url: span.attributes[SemanticAttributes.HTTP_URL] as string,
'http.method': (span.attributes[SemanticAttributes.HTTP_METHOD] as string) || 'GET',
Expand Down
, '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

fix(node-experimental): Ensure http breadcrumbs are correctly added#8937

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 1 commit into from
Closed

fix(node-experimental): Ensure http breadcrumbs are correctly added #8937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 56 additions & 48 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import type { EventProcessor, Hub, Integration } from '@sentry/types';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

import type { NodeExperimentalClient } from '../sdk/client';
import { getParentHub } from '../utils/getParentHub';
import { getRequestSpanData } from '../utils/getRequestSpanData';

interface TracingOptions {
Expand DownExpand Up@@ -95,8 +96,11 @@ export class Http implements Integration {
new HttpInstrumentation({
requireParentforOutgoingSpans: true,
requireParentforIncomingSpans: false,
applyCustomAttributesOnSpan: (span, req, res) => {
this._onSpan(span as unknown as OtelSpan, req, res);
requestHook: (span, req) => {
this._updateSentrySpan(span as unknown as OtelSpan, req);
},
responseHook: (span, res) => {
this._addRequestBreadcrumb(span as unknown as OtelSpan, res);
},
}),
],
Expand DownExpand Up@@ -136,64 +140,68 @@ export class Http implements Integration {
return;
};

/** Handle an emitted span from the HTTP instrumentation. */
private _onSpan(
span: OtelSpan,
request: ClientRequest | IncomingMessage,
response: IncomingMessage | ServerResponse,
): void {
const data = getRequestSpanData(span, request, response);
/** Update the Sentry span data based on the OTEL span. */
private _updateSentrySpan(span: OtelSpan, request: ClientRequest | IncomingMessage): void {
const data = getRequestSpanData(span);
const { attributes } = span;

const sentrySpan = _INTERNAL_getSentrySpan(span.spanContext().spanId);
if (sentrySpan) {
sentrySpan.origin = 'auto.http.otel.http';
if (!sentrySpan) {
return;
}

const additionalData: Record<string, unknown> = {
url: data.url,
};
sentrySpan.origin = 'auto.http.otel.http';

if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}
const additionalData: Record<string, unknown> = {
url: data.url,
};

if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;
if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}

sentrySpan.setTag('http.status_code', statusCode);
}
if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;

if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}
sentrySpan.setTag('http.status_code', statusCode);
}

Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}

if (this._breadcrumbs) {
getCurrentHub().addBreadcrumb(
{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
request,
response,
},
);
Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
}

/** Add a breadcrumb for outgoing requests. */
private _addRequestBreadcrumb(span: OtelSpan, response: IncomingMessage | ServerResponse): void {
if (!this._breadcrumbs || span.kind !== SpanKind.CLIENT) {
return;
}

const data = getRequestSpanData(span);
getParentHub().addBreadcrumb(

@mydeamydeaSep 4, 2023

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.

Technically, the most correct (?) would be to add the breadcrumb both to the current and the parent hub 🤔 does that make sense? We could also make it e.g.:

consthub=getCurrentHub();constparentHub=getParentHub();hub.addBreadcrumb(breadcrumb);if(hub!==parentHub){parentHub.addBreadcrumb(breadcrumb);}

To be on the very safe side? The breadcrumb to the "actual current" hub would only really be relevant/visible if something happened inside of the OTEL internals, I believe (but it's a bit hard to say with all the callbacks/nested function scopes/etc.)

@Lms24Lms24Sep 5, 2023

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.

Without being too deep into this, it sounds reasonable to me to add it to both.

{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
// request, ???
response,
},
);
}
}

Expand Down
8 changes: 7 additions & 1 deletion packages/node-experimental/src/sdk/otelContextManager.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { Carrier, Hub } from '@sentry/core';
import { ensureHubOnCarrier, getCurrentHub, getHubFromCarrier } from '@sentry/core';

export const OTEL_CONTEXT_HUB_KEY = api.createContextKey('sentry_hub');
export const OTEL_CONTEXT_PARENT_KEY = api.createContextKey('sentry_parent_context');

function createNewHub(parent: Hub | undefined): Hub {
const carrier: Carrier = {};
Expand DownExpand Up@@ -33,6 +34,11 @@ export class SentryContextManager extends AsyncLocalStorageContextManager {
const existingHub = getCurrentHub();
const newHub = createNewHub(existingHub);

return super.with(context.setValue(OTEL_CONTEXT_HUB_KEY, newHub), fn, thisArg, ...args);
return super.with(
context.setValue(OTEL_CONTEXT_HUB_KEY, newHub).setValue(OTEL_CONTEXT_PARENT_KEY, context),
fn,
thisArg,
...args,
);
}
}
21 changes: 21 additions & 0 deletions packages/node-experimental/src/utils/getParentHub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import * as api from '@opentelemetry/api';
import { getCurrentHub } from '@sentry/core';
import type { Hub } from '@sentry/types';

import { OTEL_CONTEXT_HUB_KEY, OTEL_CONTEXT_PARENT_KEY } from '../sdk/otelContextManager';

/**
* Get the hub of the parent context.
* Can be useful if you e.g. need to add a breadcrumb from inside of an ongoing span.
*
* Without this, if you e.g. try to add a breadcrumb from an instrumentation's `onSpan` callback or similar,
* you'll always attach it to the current hub, which in that case will be hyper specific to the instrumentation.
*/
export function getParentHub(): Hub {
const ctx = api.context.active();
const parentContext = ctx?.getValue(OTEL_CONTEXT_PARENT_KEY) as api.Context | undefined;

const parentHub = parentContext && (parentContext.getValue(OTEL_CONTEXT_HUB_KEY) as Hub | undefined);

return parentHub || getCurrentHub();
}
7 changes: 1 addition & 6 deletions packages/node-experimental/src/utils/getRequestSpanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,11 @@ import type { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type { SanitizedRequestData } from '@sentry/types';
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

/**
* Get sanitizied request data from an OTEL span.
*/
export function getRequestSpanData(
span: OtelSpan,
_request: ClientRequest | IncomingMessage,
_response: IncomingMessage | ServerResponse,
): SanitizedRequestData {
export function getRequestSpanData(span: OtelSpan): SanitizedRequestData {
const data: SanitizedRequestData = {
url: span.attributes[SemanticAttributes.HTTP_URL] as string,
'http.method': (span.attributes[SemanticAttributes.HTTP_METHOD] as string) || 'GET',
Expand Down
, '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

fix(node-experimental): Ensure http breadcrumbs are correctly added#8937

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 1 commit into from
Closed

fix(node-experimental): Ensure http breadcrumbs are correctly added #8937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 56 additions & 48 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import type { EventProcessor, Hub, Integration } from '@sentry/types';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

import type { NodeExperimentalClient } from '../sdk/client';
import { getParentHub } from '../utils/getParentHub';
import { getRequestSpanData } from '../utils/getRequestSpanData';

interface TracingOptions {
Expand DownExpand Up@@ -95,8 +96,11 @@ export class Http implements Integration {
new HttpInstrumentation({
requireParentforOutgoingSpans: true,
requireParentforIncomingSpans: false,
applyCustomAttributesOnSpan: (span, req, res) => {
this._onSpan(span as unknown as OtelSpan, req, res);
requestHook: (span, req) => {
this._updateSentrySpan(span as unknown as OtelSpan, req);
},
responseHook: (span, res) => {
this._addRequestBreadcrumb(span as unknown as OtelSpan, res);
},
}),
],
Expand DownExpand Up@@ -136,64 +140,68 @@ export class Http implements Integration {
return;
};

/** Handle an emitted span from the HTTP instrumentation. */
private _onSpan(
span: OtelSpan,
request: ClientRequest | IncomingMessage,
response: IncomingMessage | ServerResponse,
): void {
const data = getRequestSpanData(span, request, response);
/** Update the Sentry span data based on the OTEL span. */
private _updateSentrySpan(span: OtelSpan, request: ClientRequest | IncomingMessage): void {
const data = getRequestSpanData(span);
const { attributes } = span;

const sentrySpan = _INTERNAL_getSentrySpan(span.spanContext().spanId);
if (sentrySpan) {
sentrySpan.origin = 'auto.http.otel.http';
if (!sentrySpan) {
return;
}

const additionalData: Record<string, unknown> = {
url: data.url,
};
sentrySpan.origin = 'auto.http.otel.http';

if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}
const additionalData: Record<string, unknown> = {
url: data.url,
};

if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;
if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}

sentrySpan.setTag('http.status_code', statusCode);
}
if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;

if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}
sentrySpan.setTag('http.status_code', statusCode);
}

Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}

if (this._breadcrumbs) {
getCurrentHub().addBreadcrumb(
{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
request,
response,
},
);
Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
}

/** Add a breadcrumb for outgoing requests. */
private _addRequestBreadcrumb(span: OtelSpan, response: IncomingMessage | ServerResponse): void {
if (!this._breadcrumbs || span.kind !== SpanKind.CLIENT) {
return;
}

const data = getRequestSpanData(span);
getParentHub().addBreadcrumb(

@mydeamydeaSep 4, 2023

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.

Technically, the most correct (?) would be to add the breadcrumb both to the current and the parent hub 🤔 does that make sense? We could also make it e.g.:

consthub=getCurrentHub();constparentHub=getParentHub();hub.addBreadcrumb(breadcrumb);if(hub!==parentHub){parentHub.addBreadcrumb(breadcrumb);}

To be on the very safe side? The breadcrumb to the "actual current" hub would only really be relevant/visible if something happened inside of the OTEL internals, I believe (but it's a bit hard to say with all the callbacks/nested function scopes/etc.)

@Lms24Lms24Sep 5, 2023

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.

Without being too deep into this, it sounds reasonable to me to add it to both.

{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
// request, ???
response,
},
);
}
}

Expand Down
8 changes: 7 additions & 1 deletion packages/node-experimental/src/sdk/otelContextManager.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { Carrier, Hub } from '@sentry/core';
import { ensureHubOnCarrier, getCurrentHub, getHubFromCarrier } from '@sentry/core';

export const OTEL_CONTEXT_HUB_KEY = api.createContextKey('sentry_hub');
export const OTEL_CONTEXT_PARENT_KEY = api.createContextKey('sentry_parent_context');

function createNewHub(parent: Hub | undefined): Hub {
const carrier: Carrier = {};
Expand DownExpand Up@@ -33,6 +34,11 @@ export class SentryContextManager extends AsyncLocalStorageContextManager {
const existingHub = getCurrentHub();
const newHub = createNewHub(existingHub);

return super.with(context.setValue(OTEL_CONTEXT_HUB_KEY, newHub), fn, thisArg, ...args);
return super.with(
context.setValue(OTEL_CONTEXT_HUB_KEY, newHub).setValue(OTEL_CONTEXT_PARENT_KEY, context),
fn,
thisArg,
...args,
);
}
}
21 changes: 21 additions & 0 deletions packages/node-experimental/src/utils/getParentHub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import * as api from '@opentelemetry/api';
import { getCurrentHub } from '@sentry/core';
import type { Hub } from '@sentry/types';

import { OTEL_CONTEXT_HUB_KEY, OTEL_CONTEXT_PARENT_KEY } from '../sdk/otelContextManager';

/**
* Get the hub of the parent context.
* Can be useful if you e.g. need to add a breadcrumb from inside of an ongoing span.
*
* Without this, if you e.g. try to add a breadcrumb from an instrumentation's `onSpan` callback or similar,
* you'll always attach it to the current hub, which in that case will be hyper specific to the instrumentation.
*/
export function getParentHub(): Hub {
const ctx = api.context.active();
const parentContext = ctx?.getValue(OTEL_CONTEXT_PARENT_KEY) as api.Context | undefined;

const parentHub = parentContext && (parentContext.getValue(OTEL_CONTEXT_HUB_KEY) as Hub | undefined);

return parentHub || getCurrentHub();
}
7 changes: 1 addition & 6 deletions packages/node-experimental/src/utils/getRequestSpanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,11 @@ import type { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type { SanitizedRequestData } from '@sentry/types';
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

/**
* Get sanitizied request data from an OTEL span.
*/
export function getRequestSpanData(
span: OtelSpan,
_request: ClientRequest | IncomingMessage,
_response: IncomingMessage | ServerResponse,
): SanitizedRequestData {
export function getRequestSpanData(span: OtelSpan): SanitizedRequestData {
const data: SanitizedRequestData = {
url: span.attributes[SemanticAttributes.HTTP_URL] as string,
'http.method': (span.attributes[SemanticAttributes.HTTP_METHOD] as string) || 'GET',
Expand Down
, '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

fix(node-experimental): Ensure http breadcrumbs are correctly added#8937

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 1 commit into from
Closed

fix(node-experimental): Ensure http breadcrumbs are correctly added #8937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 56 additions & 48 deletions packages/node-experimental/src/integrations/http.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import type { EventProcessor, Hub, Integration } from '@sentry/types';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

import type { NodeExperimentalClient } from '../sdk/client';
import { getParentHub } from '../utils/getParentHub';
import { getRequestSpanData } from '../utils/getRequestSpanData';

interface TracingOptions {
Expand DownExpand Up@@ -95,8 +96,11 @@ export class Http implements Integration {
new HttpInstrumentation({
requireParentforOutgoingSpans: true,
requireParentforIncomingSpans: false,
applyCustomAttributesOnSpan: (span, req, res) => {
this._onSpan(span as unknown as OtelSpan, req, res);
requestHook: (span, req) => {
this._updateSentrySpan(span as unknown as OtelSpan, req);
},
responseHook: (span, res) => {
this._addRequestBreadcrumb(span as unknown as OtelSpan, res);
},
}),
],
Expand DownExpand Up@@ -136,64 +140,68 @@ export class Http implements Integration {
return;
};

/** Handle an emitted span from the HTTP instrumentation. */
private _onSpan(
span: OtelSpan,
request: ClientRequest | IncomingMessage,
response: IncomingMessage | ServerResponse,
): void {
const data = getRequestSpanData(span, request, response);
/** Update the Sentry span data based on the OTEL span. */
private _updateSentrySpan(span: OtelSpan, request: ClientRequest | IncomingMessage): void {
const data = getRequestSpanData(span);
const { attributes } = span;

const sentrySpan = _INTERNAL_getSentrySpan(span.spanContext().spanId);
if (sentrySpan) {
sentrySpan.origin = 'auto.http.otel.http';
if (!sentrySpan) {
return;
}

const additionalData: Record<string, unknown> = {
url: data.url,
};
sentrySpan.origin = 'auto.http.otel.http';

if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}
const additionalData: Record<string, unknown> = {
url: data.url,
};

if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;
if (sentrySpan instanceof Transaction && span.kind === SpanKind.SERVER) {
sentrySpan.setMetadata({ request });
}

sentrySpan.setTag('http.status_code', statusCode);
}
if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string;
additionalData['http.response.status_code'] = statusCode;

if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}
sentrySpan.setTag('http.status_code', statusCode);
}

Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
if (data['http.query']) {
additionalData['http.query'] = data['http.query'].slice(1);
}
if (data['http.fragment']) {
additionalData['http.fragment'] = data['http.fragment'].slice(1);
}

if (this._breadcrumbs) {
getCurrentHub().addBreadcrumb(
{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
request,
response,
},
);
Object.keys(additionalData).forEach(prop => {
const value = additionalData[prop];
sentrySpan.setData(prop, value);
});
}

/** Add a breadcrumb for outgoing requests. */
private _addRequestBreadcrumb(span: OtelSpan, response: IncomingMessage | ServerResponse): void {
if (!this._breadcrumbs || span.kind !== SpanKind.CLIENT) {
return;
}

const data = getRequestSpanData(span);
getParentHub().addBreadcrumb(

@mydeamydeaSep 4, 2023

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.

Technically, the most correct (?) would be to add the breadcrumb both to the current and the parent hub 🤔 does that make sense? We could also make it e.g.:

consthub=getCurrentHub();constparentHub=getParentHub();hub.addBreadcrumb(breadcrumb);if(hub!==parentHub){parentHub.addBreadcrumb(breadcrumb);}

To be on the very safe side? The breadcrumb to the "actual current" hub would only really be relevant/visible if something happened inside of the OTEL internals, I believe (but it's a bit hard to say with all the callbacks/nested function scopes/etc.)

@Lms24Lms24Sep 5, 2023

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.

Without being too deep into this, it sounds reasonable to me to add it to both.

{
category: 'http',
data: {
status_code: response.statusCode,
...data,
},
type: 'http',
},
{
event: 'response',
// request, ???
response,
},
);
}
}

Expand Down
8 changes: 7 additions & 1 deletion packages/node-experimental/src/sdk/otelContextManager.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import type { Carrier, Hub } from '@sentry/core';
import { ensureHubOnCarrier, getCurrentHub, getHubFromCarrier } from '@sentry/core';

export const OTEL_CONTEXT_HUB_KEY = api.createContextKey('sentry_hub');
export const OTEL_CONTEXT_PARENT_KEY = api.createContextKey('sentry_parent_context');

function createNewHub(parent: Hub | undefined): Hub {
const carrier: Carrier = {};
Expand DownExpand Up@@ -33,6 +34,11 @@ export class SentryContextManager extends AsyncLocalStorageContextManager {
const existingHub = getCurrentHub();
const newHub = createNewHub(existingHub);

return super.with(context.setValue(OTEL_CONTEXT_HUB_KEY, newHub), fn, thisArg, ...args);
return super.with(
context.setValue(OTEL_CONTEXT_HUB_KEY, newHub).setValue(OTEL_CONTEXT_PARENT_KEY, context),
fn,
thisArg,
...args,
);
}
}
21 changes: 21 additions & 0 deletions packages/node-experimental/src/utils/getParentHub.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
import * as api from '@opentelemetry/api';
import { getCurrentHub } from '@sentry/core';
import type { Hub } from '@sentry/types';

import { OTEL_CONTEXT_HUB_KEY, OTEL_CONTEXT_PARENT_KEY } from '../sdk/otelContextManager';

/**
* Get the hub of the parent context.
* Can be useful if you e.g. need to add a breadcrumb from inside of an ongoing span.
*
* Without this, if you e.g. try to add a breadcrumb from an instrumentation's `onSpan` callback or similar,
* you'll always attach it to the current hub, which in that case will be hyper specific to the instrumentation.
*/
export function getParentHub(): Hub {
const ctx = api.context.active();
const parentContext = ctx?.getValue(OTEL_CONTEXT_PARENT_KEY) as api.Context | undefined;

const parentHub = parentContext && (parentContext.getValue(OTEL_CONTEXT_HUB_KEY) as Hub | undefined);

return parentHub || getCurrentHub();
}
7 changes: 1 addition & 6 deletions packages/node-experimental/src/utils/getRequestSpanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,16 +2,11 @@ import type { Span as OtelSpan } from '@opentelemetry/sdk-trace-base';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type { SanitizedRequestData } from '@sentry/types';
import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';

/**
* Get sanitizied request data from an OTEL span.
*/
export function getRequestSpanData(
span: OtelSpan,
_request: ClientRequest | IncomingMessage,
_response: IncomingMessage | ServerResponse,
): SanitizedRequestData {
export function getRequestSpanData(span: OtelSpan): SanitizedRequestData {
const data: SanitizedRequestData = {
url: span.attributes[SemanticAttributes.HTTP_URL] as string,
'http.method': (span.attributes[SemanticAttributes.HTTP_METHOD] as string) || 'GET',
Expand Down