fix(node): Pass inferred name & attributes to tracesSampler#12945

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

Merged
mydea merged 2 commits into from
Jul 18, 2024
Merged

fix(node): Pass inferred name & attributes to tracesSampler#12945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98eb57f
fix(node): Pass inferred name & attributes to `tracesSampler`
mydea Jul 17, 2024
32e6f04
properly handle op
mydea Jul 17, 2024
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
40 changes: 40 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
const { loggingTransport } = require('@sentry-internal/node-integration-tests');
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
tracesSampler: samplingContext => {
// The name we get here is inferred at span creation time
// At this point, we sadly do not have a http.route attribute yet,
// so we infer the name from the unparametrized route instead
return (
samplingContext.name === 'GET /test/123' &&
samplingContext.attributes['sentry.op'] === 'http.server' &&
samplingContext.attributes['http.method'] === 'GET'
);
},
debug: true,
});

// express must be required after Sentry is initialized
const express = require('express');
const cors = require('cors');
const { startExpressServerAndSendPortToRunner } = require('@sentry-internal/node-integration-tests');

const app = express();

app.use(cors());

app.get('/test/:id', (_req, res) => {
res.send('Success');
});

app.get('/test2', (_req, res) => {
res.send('Success');
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
24 changes: 24 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';

describe('express tracesSampler', () => {
afterAll(() => {
cleanupChildProcesses();
});

describe('CJS', () => {
test('correctly samples & passes data to tracesSampler', done => {
const runner = createRunner(__dirname, 'server.js')
.expect({
transaction: {
transaction: 'GET /test/:id',
},
})
.start(done);

// This is not sampled
runner.makeRequest('get', '/test2?q=1');
// This is sampled
runner.makeRequest('get', '/test/123?q=1');
});
});
});
34 changes: 28 additions & 6 deletions packages/opentelemetry/src/sampler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,12 @@ import { isSpanContextValid, trace } from '@opentelemetry/api';
import { TraceState } from '@opentelemetry/core';
import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-base';
import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, hasTracingEnabled, sampleSpan } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
hasTracingEnabled,
sampleSpan,
} from '@sentry/core';
import type { Client, SpanAttributes } from '@sentry/types';
import { logger } from '@sentry/utils';
import { SENTRY_TRACE_STATE_SAMPLED_NOT_RECORDING, SENTRY_TRACE_STATE_URL } from './constants';
Expand All@@ -13,6 +18,7 @@ import { SEMATTRS_HTTP_METHOD, SEMATTRS_HTTP_URL } from '@opentelemetry/semantic
import { DEBUG_BUILD } from './debug-build';
import { getPropagationContextFromSpan } from './propagator';
import { getSamplingDecision } from './utils/getSamplingDecision';
import { inferSpanData } from './utils/parseSpanDescription';
import { setIsSetup } from './utils/setupCheck';

/**
Expand DownExpand Up@@ -56,12 +62,28 @@ export class SentrySampler implements Sampler {

const parentSampled = parentSpan ? getParentSampled(parentSpan, traceId, spanName) : undefined;

// We want to pass the inferred name & attributes to the sampler method
const {
description: inferredSpanName,
data: inferredAttributes,
op,
} = inferSpanData(spanName, spanAttributes, spanKind);

const mergedAttributes = {
...inferredAttributes,
...spanAttributes,
};

if (op) {
mergedAttributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
}

const mutableSamplingDecision = { decision: true };
this._client.emit(
'beforeSampling',
{
spanAttributes: spanAttributes,
spanName: spanName,
spanAttributes: mergedAttributes,
spanName: inferredSpanName,
parentSampled: parentSampled,
parentContext: parentContext,
},
Expand All@@ -72,10 +94,10 @@ export class SentrySampler implements Sampler {
}

const [sampled, sampleRate] = sampleSpan(options, {
name: spanName,
attributes: spanAttributes,
name: inferredSpanName,
attributes: mergedAttributes,
transactionContext: {
name: spanName,
name: inferredSpanName,
parentSampled,
},
parentSampled,
Expand Down
23 changes: 7 additions & 16 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,6 @@ export function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span:
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

@mydeamydeaJul 17, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I noticed that this was actually also not ideal, we just added the op attribute after the span was started, which means this was not sent to the sampler. Also, this is overall unnecessary, we can just add the attribute right away!


return handleCallbackErrors(
() => callback(span),
() => {
Expand DownExpand Up@@ -90,8 +88,6 @@ export function startSpanManual<T>(
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

return handleCallbackErrors(
() => callback(span, () => span.end()),
() => {
Expand DownExpand Up@@ -131,8 +127,6 @@ export function startInactiveSpan(options: OpenTelemetrySpanContext): Span {

const span = tracer.startSpan(name, spanOptions, ctx);

_applySentryAttributesToSpan(span, options);

return span;
});
}
Expand All@@ -156,22 +150,19 @@ function getTracer(): Tracer {
return (client && client.tracer) || trace.getTracer('@sentry/opentelemetry', SDK_VERSION);
}

function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanContext): void {
const { op } = options;

if (op) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, op);
}
}

function getSpanOptions(options: OpenTelemetrySpanContext): SpanOptions {
const { startTime, attributes, kind } = options;
const { startTime, attributes, kind, op } = options;

// OTEL expects timestamps in ms, not seconds
const fixedStartTime = typeof startTime === 'number' ? ensureTimestampInMilliseconds(startTime) : startTime;

return {
attributes,
attributes: op
? {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
...attributes,
}
: attributes,
kind,
startTime: fixedStartTime,
};
Expand Down
26 changes: 17 additions & 9 deletions packages/opentelemetry/src/utils/parseSpanDescription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import {
SEMATTRS_MESSAGING_SYSTEM,
SEMATTRS_RPC_SERVICE,
} from '@opentelemetry/semantic-conventions';
import type { TransactionSource } from '@sentry/types';
import type { SpanAttributes, TransactionSource } from '@sentry/types';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '@sentry/utils';

import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
Expand All@@ -27,14 +27,9 @@ interface SpanDescription {
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
* Infer the op & description for a set of name, attributes and kind of a span.
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';

export function inferSpanData(name: string, attributes: SpanAttributes, kind: SpanKind): SpanDescription {
// This attribute is intentionally exported as a SEMATTR constant because it should stay intimite API
if (attributes['sentry.skip_span_data_inference']) {
return {
Expand All@@ -54,7 +49,7 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
// conventions export an attribute key for it.
const httpMethod = attributes['http.request.method'] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind: getSpanKind(span) }, httpMethod);
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
}

const dbSystem = attributes[SEMATTRS_DB_SYSTEM];
Expand DownExpand Up@@ -97,6 +92,19 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
return { op: undefined, description: name, source: 'custom' };
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';
const kind = getSpanKind(span);

return inferSpanData(name, attributes, kind);
}

function descriptionForDbSystem({ attributes, name }: { attributes: Attributes; name: string }): SpanDescription {
// Use DB statement (Ex "SELECT * FROM table") if possible as description.
const statement = attributes[SEMATTRS_DB_STATEMENT];
Expand Down
23 changes: 15 additions & 8 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1320,9 +1320,7 @@ describe('trace (sampling)', () => {
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
},
attributes: {},
transactionContext: { name: 'outer', parentSampled: undefined },
});

Expand DownExpand Up@@ -1357,16 +1355,25 @@ describe('trace (sampling)', () => {

mockSdkInit({ tracesSampler });

startSpan({ name: 'outer' }, outerSpan => {
expect(outerSpan).toBeDefined();
});
startSpan(
{
name: 'outer',
op: 'test.op',
attributes: { attr1: 'yes', attr2: 1 },
},
outerSpan => {
expect(outerSpan).toBeDefined();
},
);

expect(tracesSampler).toBeCalledTimes(1);
expect(tracesSampler).toHaveBeenCalledTimes(1);
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
attr1: 'yes',
attr2: 1,
'sentry.op': 'test.op',
},
transactionContext: { name: 'outer', parentSampled: undefined },
});
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): Pass inferred name & attributes to tracesSampler#12945

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

Merged
mydea merged 2 commits into from
Jul 18, 2024
Merged

fix(node): Pass inferred name & attributes to tracesSampler#12945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98eb57f
fix(node): Pass inferred name & attributes to `tracesSampler`
mydea Jul 17, 2024
32e6f04
properly handle op
mydea Jul 17, 2024
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
40 changes: 40 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
const { loggingTransport } = require('@sentry-internal/node-integration-tests');
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
tracesSampler: samplingContext => {
// The name we get here is inferred at span creation time
// At this point, we sadly do not have a http.route attribute yet,
// so we infer the name from the unparametrized route instead
return (
samplingContext.name === 'GET /test/123' &&
samplingContext.attributes['sentry.op'] === 'http.server' &&
samplingContext.attributes['http.method'] === 'GET'
);
},
debug: true,
});

// express must be required after Sentry is initialized
const express = require('express');
const cors = require('cors');
const { startExpressServerAndSendPortToRunner } = require('@sentry-internal/node-integration-tests');

const app = express();

app.use(cors());

app.get('/test/:id', (_req, res) => {
res.send('Success');
});

app.get('/test2', (_req, res) => {
res.send('Success');
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
24 changes: 24 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';

describe('express tracesSampler', () => {
afterAll(() => {
cleanupChildProcesses();
});

describe('CJS', () => {
test('correctly samples & passes data to tracesSampler', done => {
const runner = createRunner(__dirname, 'server.js')
.expect({
transaction: {
transaction: 'GET /test/:id',
},
})
.start(done);

// This is not sampled
runner.makeRequest('get', '/test2?q=1');
// This is sampled
runner.makeRequest('get', '/test/123?q=1');
});
});
});
34 changes: 28 additions & 6 deletions packages/opentelemetry/src/sampler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,12 @@ import { isSpanContextValid, trace } from '@opentelemetry/api';
import { TraceState } from '@opentelemetry/core';
import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-base';
import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, hasTracingEnabled, sampleSpan } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
hasTracingEnabled,
sampleSpan,
} from '@sentry/core';
import type { Client, SpanAttributes } from '@sentry/types';
import { logger } from '@sentry/utils';
import { SENTRY_TRACE_STATE_SAMPLED_NOT_RECORDING, SENTRY_TRACE_STATE_URL } from './constants';
Expand All@@ -13,6 +18,7 @@ import { SEMATTRS_HTTP_METHOD, SEMATTRS_HTTP_URL } from '@opentelemetry/semantic
import { DEBUG_BUILD } from './debug-build';
import { getPropagationContextFromSpan } from './propagator';
import { getSamplingDecision } from './utils/getSamplingDecision';
import { inferSpanData } from './utils/parseSpanDescription';
import { setIsSetup } from './utils/setupCheck';

/**
Expand DownExpand Up@@ -56,12 +62,28 @@ export class SentrySampler implements Sampler {

const parentSampled = parentSpan ? getParentSampled(parentSpan, traceId, spanName) : undefined;

// We want to pass the inferred name & attributes to the sampler method
const {
description: inferredSpanName,
data: inferredAttributes,
op,
} = inferSpanData(spanName, spanAttributes, spanKind);

const mergedAttributes = {
...inferredAttributes,
...spanAttributes,
};

if (op) {
mergedAttributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
}

const mutableSamplingDecision = { decision: true };
this._client.emit(
'beforeSampling',
{
spanAttributes: spanAttributes,
spanName: spanName,
spanAttributes: mergedAttributes,
spanName: inferredSpanName,
parentSampled: parentSampled,
parentContext: parentContext,
},
Expand All@@ -72,10 +94,10 @@ export class SentrySampler implements Sampler {
}

const [sampled, sampleRate] = sampleSpan(options, {
name: spanName,
attributes: spanAttributes,
name: inferredSpanName,
attributes: mergedAttributes,
transactionContext: {
name: spanName,
name: inferredSpanName,
parentSampled,
},
parentSampled,
Expand Down
23 changes: 7 additions & 16 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,6 @@ export function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span:
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

@mydeamydeaJul 17, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I noticed that this was actually also not ideal, we just added the op attribute after the span was started, which means this was not sent to the sampler. Also, this is overall unnecessary, we can just add the attribute right away!


return handleCallbackErrors(
() => callback(span),
() => {
Expand DownExpand Up@@ -90,8 +88,6 @@ export function startSpanManual<T>(
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

return handleCallbackErrors(
() => callback(span, () => span.end()),
() => {
Expand DownExpand Up@@ -131,8 +127,6 @@ export function startInactiveSpan(options: OpenTelemetrySpanContext): Span {

const span = tracer.startSpan(name, spanOptions, ctx);

_applySentryAttributesToSpan(span, options);

return span;
});
}
Expand All@@ -156,22 +150,19 @@ function getTracer(): Tracer {
return (client && client.tracer) || trace.getTracer('@sentry/opentelemetry', SDK_VERSION);
}

function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanContext): void {
const { op } = options;

if (op) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, op);
}
}

function getSpanOptions(options: OpenTelemetrySpanContext): SpanOptions {
const { startTime, attributes, kind } = options;
const { startTime, attributes, kind, op } = options;

// OTEL expects timestamps in ms, not seconds
const fixedStartTime = typeof startTime === 'number' ? ensureTimestampInMilliseconds(startTime) : startTime;

return {
attributes,
attributes: op
? {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
...attributes,
}
: attributes,
kind,
startTime: fixedStartTime,
};
Expand Down
26 changes: 17 additions & 9 deletions packages/opentelemetry/src/utils/parseSpanDescription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import {
SEMATTRS_MESSAGING_SYSTEM,
SEMATTRS_RPC_SERVICE,
} from '@opentelemetry/semantic-conventions';
import type { TransactionSource } from '@sentry/types';
import type { SpanAttributes, TransactionSource } from '@sentry/types';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '@sentry/utils';

import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
Expand All@@ -27,14 +27,9 @@ interface SpanDescription {
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
* Infer the op & description for a set of name, attributes and kind of a span.
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';

export function inferSpanData(name: string, attributes: SpanAttributes, kind: SpanKind): SpanDescription {
// This attribute is intentionally exported as a SEMATTR constant because it should stay intimite API
if (attributes['sentry.skip_span_data_inference']) {
return {
Expand All@@ -54,7 +49,7 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
// conventions export an attribute key for it.
const httpMethod = attributes['http.request.method'] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind: getSpanKind(span) }, httpMethod);
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
}

const dbSystem = attributes[SEMATTRS_DB_SYSTEM];
Expand DownExpand Up@@ -97,6 +92,19 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
return { op: undefined, description: name, source: 'custom' };
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';
const kind = getSpanKind(span);

return inferSpanData(name, attributes, kind);
}

function descriptionForDbSystem({ attributes, name }: { attributes: Attributes; name: string }): SpanDescription {
// Use DB statement (Ex "SELECT * FROM table") if possible as description.
const statement = attributes[SEMATTRS_DB_STATEMENT];
Expand Down
23 changes: 15 additions & 8 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1320,9 +1320,7 @@ describe('trace (sampling)', () => {
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
},
attributes: {},
transactionContext: { name: 'outer', parentSampled: undefined },
});

Expand DownExpand Up@@ -1357,16 +1355,25 @@ describe('trace (sampling)', () => {

mockSdkInit({ tracesSampler });

startSpan({ name: 'outer' }, outerSpan => {
expect(outerSpan).toBeDefined();
});
startSpan(
{
name: 'outer',
op: 'test.op',
attributes: { attr1: 'yes', attr2: 1 },
},
outerSpan => {
expect(outerSpan).toBeDefined();
},
);

expect(tracesSampler).toBeCalledTimes(1);
expect(tracesSampler).toHaveBeenCalledTimes(1);
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
attr1: 'yes',
attr2: 1,
'sentry.op': 'test.op',
},
transactionContext: { name: 'outer', parentSampled: undefined },
});
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): Pass inferred name & attributes to tracesSampler#12945

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

Merged
mydea merged 2 commits into from
Jul 18, 2024
Merged

fix(node): Pass inferred name & attributes to tracesSampler#12945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98eb57f
fix(node): Pass inferred name & attributes to `tracesSampler`
mydea Jul 17, 2024
32e6f04
properly handle op
mydea Jul 17, 2024
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
40 changes: 40 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
const { loggingTransport } = require('@sentry-internal/node-integration-tests');
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
tracesSampler: samplingContext => {
// The name we get here is inferred at span creation time
// At this point, we sadly do not have a http.route attribute yet,
// so we infer the name from the unparametrized route instead
return (
samplingContext.name === 'GET /test/123' &&
samplingContext.attributes['sentry.op'] === 'http.server' &&
samplingContext.attributes['http.method'] === 'GET'
);
},
debug: true,
});

// express must be required after Sentry is initialized
const express = require('express');
const cors = require('cors');
const { startExpressServerAndSendPortToRunner } = require('@sentry-internal/node-integration-tests');

const app = express();

app.use(cors());

app.get('/test/:id', (_req, res) => {
res.send('Success');
});

app.get('/test2', (_req, res) => {
res.send('Success');
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
24 changes: 24 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';

describe('express tracesSampler', () => {
afterAll(() => {
cleanupChildProcesses();
});

describe('CJS', () => {
test('correctly samples & passes data to tracesSampler', done => {
const runner = createRunner(__dirname, 'server.js')
.expect({
transaction: {
transaction: 'GET /test/:id',
},
})
.start(done);

// This is not sampled
runner.makeRequest('get', '/test2?q=1');
// This is sampled
runner.makeRequest('get', '/test/123?q=1');
});
});
});
34 changes: 28 additions & 6 deletions packages/opentelemetry/src/sampler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,12 @@ import { isSpanContextValid, trace } from '@opentelemetry/api';
import { TraceState } from '@opentelemetry/core';
import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-base';
import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, hasTracingEnabled, sampleSpan } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
hasTracingEnabled,
sampleSpan,
} from '@sentry/core';
import type { Client, SpanAttributes } from '@sentry/types';
import { logger } from '@sentry/utils';
import { SENTRY_TRACE_STATE_SAMPLED_NOT_RECORDING, SENTRY_TRACE_STATE_URL } from './constants';
Expand All@@ -13,6 +18,7 @@ import { SEMATTRS_HTTP_METHOD, SEMATTRS_HTTP_URL } from '@opentelemetry/semantic
import { DEBUG_BUILD } from './debug-build';
import { getPropagationContextFromSpan } from './propagator';
import { getSamplingDecision } from './utils/getSamplingDecision';
import { inferSpanData } from './utils/parseSpanDescription';
import { setIsSetup } from './utils/setupCheck';

/**
Expand DownExpand Up@@ -56,12 +62,28 @@ export class SentrySampler implements Sampler {

const parentSampled = parentSpan ? getParentSampled(parentSpan, traceId, spanName) : undefined;

// We want to pass the inferred name & attributes to the sampler method
const {
description: inferredSpanName,
data: inferredAttributes,
op,
} = inferSpanData(spanName, spanAttributes, spanKind);

const mergedAttributes = {
...inferredAttributes,
...spanAttributes,
};

if (op) {
mergedAttributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
}

const mutableSamplingDecision = { decision: true };
this._client.emit(
'beforeSampling',
{
spanAttributes: spanAttributes,
spanName: spanName,
spanAttributes: mergedAttributes,
spanName: inferredSpanName,
parentSampled: parentSampled,
parentContext: parentContext,
},
Expand All@@ -72,10 +94,10 @@ export class SentrySampler implements Sampler {
}

const [sampled, sampleRate] = sampleSpan(options, {
name: spanName,
attributes: spanAttributes,
name: inferredSpanName,
attributes: mergedAttributes,
transactionContext: {
name: spanName,
name: inferredSpanName,
parentSampled,
},
parentSampled,
Expand Down
23 changes: 7 additions & 16 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,6 @@ export function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span:
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

@mydeamydeaJul 17, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I noticed that this was actually also not ideal, we just added the op attribute after the span was started, which means this was not sent to the sampler. Also, this is overall unnecessary, we can just add the attribute right away!


return handleCallbackErrors(
() => callback(span),
() => {
Expand DownExpand Up@@ -90,8 +88,6 @@ export function startSpanManual<T>(
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

return handleCallbackErrors(
() => callback(span, () => span.end()),
() => {
Expand DownExpand Up@@ -131,8 +127,6 @@ export function startInactiveSpan(options: OpenTelemetrySpanContext): Span {

const span = tracer.startSpan(name, spanOptions, ctx);

_applySentryAttributesToSpan(span, options);

return span;
});
}
Expand All@@ -156,22 +150,19 @@ function getTracer(): Tracer {
return (client && client.tracer) || trace.getTracer('@sentry/opentelemetry', SDK_VERSION);
}

function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanContext): void {
const { op } = options;

if (op) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, op);
}
}

function getSpanOptions(options: OpenTelemetrySpanContext): SpanOptions {
const { startTime, attributes, kind } = options;
const { startTime, attributes, kind, op } = options;

// OTEL expects timestamps in ms, not seconds
const fixedStartTime = typeof startTime === 'number' ? ensureTimestampInMilliseconds(startTime) : startTime;

return {
attributes,
attributes: op
? {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
...attributes,
}
: attributes,
kind,
startTime: fixedStartTime,
};
Expand Down
26 changes: 17 additions & 9 deletions packages/opentelemetry/src/utils/parseSpanDescription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import {
SEMATTRS_MESSAGING_SYSTEM,
SEMATTRS_RPC_SERVICE,
} from '@opentelemetry/semantic-conventions';
import type { TransactionSource } from '@sentry/types';
import type { SpanAttributes, TransactionSource } from '@sentry/types';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '@sentry/utils';

import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
Expand All@@ -27,14 +27,9 @@ interface SpanDescription {
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
* Infer the op & description for a set of name, attributes and kind of a span.
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';

export function inferSpanData(name: string, attributes: SpanAttributes, kind: SpanKind): SpanDescription {
// This attribute is intentionally exported as a SEMATTR constant because it should stay intimite API
if (attributes['sentry.skip_span_data_inference']) {
return {
Expand All@@ -54,7 +49,7 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
// conventions export an attribute key for it.
const httpMethod = attributes['http.request.method'] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind: getSpanKind(span) }, httpMethod);
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
}

const dbSystem = attributes[SEMATTRS_DB_SYSTEM];
Expand DownExpand Up@@ -97,6 +92,19 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
return { op: undefined, description: name, source: 'custom' };
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';
const kind = getSpanKind(span);

return inferSpanData(name, attributes, kind);
}

function descriptionForDbSystem({ attributes, name }: { attributes: Attributes; name: string }): SpanDescription {
// Use DB statement (Ex "SELECT * FROM table") if possible as description.
const statement = attributes[SEMATTRS_DB_STATEMENT];
Expand Down
23 changes: 15 additions & 8 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1320,9 +1320,7 @@ describe('trace (sampling)', () => {
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
},
attributes: {},
transactionContext: { name: 'outer', parentSampled: undefined },
});

Expand DownExpand Up@@ -1357,16 +1355,25 @@ describe('trace (sampling)', () => {

mockSdkInit({ tracesSampler });

startSpan({ name: 'outer' }, outerSpan => {
expect(outerSpan).toBeDefined();
});
startSpan(
{
name: 'outer',
op: 'test.op',
attributes: { attr1: 'yes', attr2: 1 },
},
outerSpan => {
expect(outerSpan).toBeDefined();
},
);

expect(tracesSampler).toBeCalledTimes(1);
expect(tracesSampler).toHaveBeenCalledTimes(1);
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
attr1: 'yes',
attr2: 1,
'sentry.op': 'test.op',
},
transactionContext: { name: 'outer', parentSampled: undefined },
});
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): Pass inferred name & attributes to tracesSampler#12945

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

Merged
mydea merged 2 commits into from
Jul 18, 2024
Merged

fix(node): Pass inferred name & attributes to tracesSampler#12945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98eb57f
fix(node): Pass inferred name & attributes to `tracesSampler`
mydea Jul 17, 2024
32e6f04
properly handle op
mydea Jul 17, 2024
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
40 changes: 40 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
const { loggingTransport } = require('@sentry-internal/node-integration-tests');
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
tracesSampler: samplingContext => {
// The name we get here is inferred at span creation time
// At this point, we sadly do not have a http.route attribute yet,
// so we infer the name from the unparametrized route instead
return (
samplingContext.name === 'GET /test/123' &&
samplingContext.attributes['sentry.op'] === 'http.server' &&
samplingContext.attributes['http.method'] === 'GET'
);
},
debug: true,
});

// express must be required after Sentry is initialized
const express = require('express');
const cors = require('cors');
const { startExpressServerAndSendPortToRunner } = require('@sentry-internal/node-integration-tests');

const app = express();

app.use(cors());

app.get('/test/:id', (_req, res) => {
res.send('Success');
});

app.get('/test2', (_req, res) => {
res.send('Success');
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
24 changes: 24 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';

describe('express tracesSampler', () => {
afterAll(() => {
cleanupChildProcesses();
});

describe('CJS', () => {
test('correctly samples & passes data to tracesSampler', done => {
const runner = createRunner(__dirname, 'server.js')
.expect({
transaction: {
transaction: 'GET /test/:id',
},
})
.start(done);

// This is not sampled
runner.makeRequest('get', '/test2?q=1');
// This is sampled
runner.makeRequest('get', '/test/123?q=1');
});
});
});
34 changes: 28 additions & 6 deletions packages/opentelemetry/src/sampler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,12 @@ import { isSpanContextValid, trace } from '@opentelemetry/api';
import { TraceState } from '@opentelemetry/core';
import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-base';
import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, hasTracingEnabled, sampleSpan } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
hasTracingEnabled,
sampleSpan,
} from '@sentry/core';
import type { Client, SpanAttributes } from '@sentry/types';
import { logger } from '@sentry/utils';
import { SENTRY_TRACE_STATE_SAMPLED_NOT_RECORDING, SENTRY_TRACE_STATE_URL } from './constants';
Expand All@@ -13,6 +18,7 @@ import { SEMATTRS_HTTP_METHOD, SEMATTRS_HTTP_URL } from '@opentelemetry/semantic
import { DEBUG_BUILD } from './debug-build';
import { getPropagationContextFromSpan } from './propagator';
import { getSamplingDecision } from './utils/getSamplingDecision';
import { inferSpanData } from './utils/parseSpanDescription';
import { setIsSetup } from './utils/setupCheck';

/**
Expand DownExpand Up@@ -56,12 +62,28 @@ export class SentrySampler implements Sampler {

const parentSampled = parentSpan ? getParentSampled(parentSpan, traceId, spanName) : undefined;

// We want to pass the inferred name & attributes to the sampler method
const {
description: inferredSpanName,
data: inferredAttributes,
op,
} = inferSpanData(spanName, spanAttributes, spanKind);

const mergedAttributes = {
...inferredAttributes,
...spanAttributes,
};

if (op) {
mergedAttributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
}

const mutableSamplingDecision = { decision: true };
this._client.emit(
'beforeSampling',
{
spanAttributes: spanAttributes,
spanName: spanName,
spanAttributes: mergedAttributes,
spanName: inferredSpanName,
parentSampled: parentSampled,
parentContext: parentContext,
},
Expand All@@ -72,10 +94,10 @@ export class SentrySampler implements Sampler {
}

const [sampled, sampleRate] = sampleSpan(options, {
name: spanName,
attributes: spanAttributes,
name: inferredSpanName,
attributes: mergedAttributes,
transactionContext: {
name: spanName,
name: inferredSpanName,
parentSampled,
},
parentSampled,
Expand Down
23 changes: 7 additions & 16 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,6 @@ export function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span:
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

@mydeamydeaJul 17, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I noticed that this was actually also not ideal, we just added the op attribute after the span was started, which means this was not sent to the sampler. Also, this is overall unnecessary, we can just add the attribute right away!


return handleCallbackErrors(
() => callback(span),
() => {
Expand DownExpand Up@@ -90,8 +88,6 @@ export function startSpanManual<T>(
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

return handleCallbackErrors(
() => callback(span, () => span.end()),
() => {
Expand DownExpand Up@@ -131,8 +127,6 @@ export function startInactiveSpan(options: OpenTelemetrySpanContext): Span {

const span = tracer.startSpan(name, spanOptions, ctx);

_applySentryAttributesToSpan(span, options);

return span;
});
}
Expand All@@ -156,22 +150,19 @@ function getTracer(): Tracer {
return (client && client.tracer) || trace.getTracer('@sentry/opentelemetry', SDK_VERSION);
}

function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanContext): void {
const { op } = options;

if (op) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, op);
}
}

function getSpanOptions(options: OpenTelemetrySpanContext): SpanOptions {
const { startTime, attributes, kind } = options;
const { startTime, attributes, kind, op } = options;

// OTEL expects timestamps in ms, not seconds
const fixedStartTime = typeof startTime === 'number' ? ensureTimestampInMilliseconds(startTime) : startTime;

return {
attributes,
attributes: op
? {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
...attributes,
}
: attributes,
kind,
startTime: fixedStartTime,
};
Expand Down
26 changes: 17 additions & 9 deletions packages/opentelemetry/src/utils/parseSpanDescription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import {
SEMATTRS_MESSAGING_SYSTEM,
SEMATTRS_RPC_SERVICE,
} from '@opentelemetry/semantic-conventions';
import type { TransactionSource } from '@sentry/types';
import type { SpanAttributes, TransactionSource } from '@sentry/types';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '@sentry/utils';

import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
Expand All@@ -27,14 +27,9 @@ interface SpanDescription {
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
* Infer the op & description for a set of name, attributes and kind of a span.
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';

export function inferSpanData(name: string, attributes: SpanAttributes, kind: SpanKind): SpanDescription {
// This attribute is intentionally exported as a SEMATTR constant because it should stay intimite API
if (attributes['sentry.skip_span_data_inference']) {
return {
Expand All@@ -54,7 +49,7 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
// conventions export an attribute key for it.
const httpMethod = attributes['http.request.method'] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind: getSpanKind(span) }, httpMethod);
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
}

const dbSystem = attributes[SEMATTRS_DB_SYSTEM];
Expand DownExpand Up@@ -97,6 +92,19 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
return { op: undefined, description: name, source: 'custom' };
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';
const kind = getSpanKind(span);

return inferSpanData(name, attributes, kind);
}

function descriptionForDbSystem({ attributes, name }: { attributes: Attributes; name: string }): SpanDescription {
// Use DB statement (Ex "SELECT * FROM table") if possible as description.
const statement = attributes[SEMATTRS_DB_STATEMENT];
Expand Down
23 changes: 15 additions & 8 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1320,9 +1320,7 @@ describe('trace (sampling)', () => {
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
},
attributes: {},
transactionContext: { name: 'outer', parentSampled: undefined },
});

Expand DownExpand Up@@ -1357,16 +1355,25 @@ describe('trace (sampling)', () => {

mockSdkInit({ tracesSampler });

startSpan({ name: 'outer' }, outerSpan => {
expect(outerSpan).toBeDefined();
});
startSpan(
{
name: 'outer',
op: 'test.op',
attributes: { attr1: 'yes', attr2: 1 },
},
outerSpan => {
expect(outerSpan).toBeDefined();
},
);

expect(tracesSampler).toBeCalledTimes(1);
expect(tracesSampler).toHaveBeenCalledTimes(1);
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
attr1: 'yes',
attr2: 1,
'sentry.op': 'test.op',
},
transactionContext: { name: 'outer', parentSampled: undefined },
});
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): Pass inferred name & attributes to tracesSampler#12945

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

Merged
mydea merged 2 commits into from
Jul 18, 2024
Merged

fix(node): Pass inferred name & attributes to tracesSampler#12945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98eb57f
fix(node): Pass inferred name & attributes to `tracesSampler`
mydea Jul 17, 2024
32e6f04
properly handle op
mydea Jul 17, 2024
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
40 changes: 40 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
const { loggingTransport } = require('@sentry-internal/node-integration-tests');
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
tracesSampler: samplingContext => {
// The name we get here is inferred at span creation time
// At this point, we sadly do not have a http.route attribute yet,
// so we infer the name from the unparametrized route instead
return (
samplingContext.name === 'GET /test/123' &&
samplingContext.attributes['sentry.op'] === 'http.server' &&
samplingContext.attributes['http.method'] === 'GET'
);
},
debug: true,
});

// express must be required after Sentry is initialized
const express = require('express');
const cors = require('cors');
const { startExpressServerAndSendPortToRunner } = require('@sentry-internal/node-integration-tests');

const app = express();

app.use(cors());

app.get('/test/:id', (_req, res) => {
res.send('Success');
});

app.get('/test2', (_req, res) => {
res.send('Success');
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
24 changes: 24 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';

describe('express tracesSampler', () => {
afterAll(() => {
cleanupChildProcesses();
});

describe('CJS', () => {
test('correctly samples & passes data to tracesSampler', done => {
const runner = createRunner(__dirname, 'server.js')
.expect({
transaction: {
transaction: 'GET /test/:id',
},
})
.start(done);

// This is not sampled
runner.makeRequest('get', '/test2?q=1');
// This is sampled
runner.makeRequest('get', '/test/123?q=1');
});
});
});
34 changes: 28 additions & 6 deletions packages/opentelemetry/src/sampler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,12 @@ import { isSpanContextValid, trace } from '@opentelemetry/api';
import { TraceState } from '@opentelemetry/core';
import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-base';
import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, hasTracingEnabled, sampleSpan } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
hasTracingEnabled,
sampleSpan,
} from '@sentry/core';
import type { Client, SpanAttributes } from '@sentry/types';
import { logger } from '@sentry/utils';
import { SENTRY_TRACE_STATE_SAMPLED_NOT_RECORDING, SENTRY_TRACE_STATE_URL } from './constants';
Expand All@@ -13,6 +18,7 @@ import { SEMATTRS_HTTP_METHOD, SEMATTRS_HTTP_URL } from '@opentelemetry/semantic
import { DEBUG_BUILD } from './debug-build';
import { getPropagationContextFromSpan } from './propagator';
import { getSamplingDecision } from './utils/getSamplingDecision';
import { inferSpanData } from './utils/parseSpanDescription';
import { setIsSetup } from './utils/setupCheck';

/**
Expand DownExpand Up@@ -56,12 +62,28 @@ export class SentrySampler implements Sampler {

const parentSampled = parentSpan ? getParentSampled(parentSpan, traceId, spanName) : undefined;

// We want to pass the inferred name & attributes to the sampler method
const {
description: inferredSpanName,
data: inferredAttributes,
op,
} = inferSpanData(spanName, spanAttributes, spanKind);

const mergedAttributes = {
...inferredAttributes,
...spanAttributes,
};

if (op) {
mergedAttributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
}

const mutableSamplingDecision = { decision: true };
this._client.emit(
'beforeSampling',
{
spanAttributes: spanAttributes,
spanName: spanName,
spanAttributes: mergedAttributes,
spanName: inferredSpanName,
parentSampled: parentSampled,
parentContext: parentContext,
},
Expand All@@ -72,10 +94,10 @@ export class SentrySampler implements Sampler {
}

const [sampled, sampleRate] = sampleSpan(options, {
name: spanName,
attributes: spanAttributes,
name: inferredSpanName,
attributes: mergedAttributes,
transactionContext: {
name: spanName,
name: inferredSpanName,
parentSampled,
},
parentSampled,
Expand Down
23 changes: 7 additions & 16 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,6 @@ export function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span:
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

@mydeamydeaJul 17, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I noticed that this was actually also not ideal, we just added the op attribute after the span was started, which means this was not sent to the sampler. Also, this is overall unnecessary, we can just add the attribute right away!


return handleCallbackErrors(
() => callback(span),
() => {
Expand DownExpand Up@@ -90,8 +88,6 @@ export function startSpanManual<T>(
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

return handleCallbackErrors(
() => callback(span, () => span.end()),
() => {
Expand DownExpand Up@@ -131,8 +127,6 @@ export function startInactiveSpan(options: OpenTelemetrySpanContext): Span {

const span = tracer.startSpan(name, spanOptions, ctx);

_applySentryAttributesToSpan(span, options);

return span;
});
}
Expand All@@ -156,22 +150,19 @@ function getTracer(): Tracer {
return (client && client.tracer) || trace.getTracer('@sentry/opentelemetry', SDK_VERSION);
}

function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanContext): void {
const { op } = options;

if (op) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, op);
}
}

function getSpanOptions(options: OpenTelemetrySpanContext): SpanOptions {
const { startTime, attributes, kind } = options;
const { startTime, attributes, kind, op } = options;

// OTEL expects timestamps in ms, not seconds
const fixedStartTime = typeof startTime === 'number' ? ensureTimestampInMilliseconds(startTime) : startTime;

return {
attributes,
attributes: op
? {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
...attributes,
}
: attributes,
kind,
startTime: fixedStartTime,
};
Expand Down
26 changes: 17 additions & 9 deletions packages/opentelemetry/src/utils/parseSpanDescription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import {
SEMATTRS_MESSAGING_SYSTEM,
SEMATTRS_RPC_SERVICE,
} from '@opentelemetry/semantic-conventions';
import type { TransactionSource } from '@sentry/types';
import type { SpanAttributes, TransactionSource } from '@sentry/types';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '@sentry/utils';

import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
Expand All@@ -27,14 +27,9 @@ interface SpanDescription {
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
* Infer the op & description for a set of name, attributes and kind of a span.
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';

export function inferSpanData(name: string, attributes: SpanAttributes, kind: SpanKind): SpanDescription {
// This attribute is intentionally exported as a SEMATTR constant because it should stay intimite API
if (attributes['sentry.skip_span_data_inference']) {
return {
Expand All@@ -54,7 +49,7 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
// conventions export an attribute key for it.
const httpMethod = attributes['http.request.method'] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind: getSpanKind(span) }, httpMethod);
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
}

const dbSystem = attributes[SEMATTRS_DB_SYSTEM];
Expand DownExpand Up@@ -97,6 +92,19 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
return { op: undefined, description: name, source: 'custom' };
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';
const kind = getSpanKind(span);

return inferSpanData(name, attributes, kind);
}

function descriptionForDbSystem({ attributes, name }: { attributes: Attributes; name: string }): SpanDescription {
// Use DB statement (Ex "SELECT * FROM table") if possible as description.
const statement = attributes[SEMATTRS_DB_STATEMENT];
Expand Down
23 changes: 15 additions & 8 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1320,9 +1320,7 @@ describe('trace (sampling)', () => {
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
},
attributes: {},
transactionContext: { name: 'outer', parentSampled: undefined },
});

Expand DownExpand Up@@ -1357,16 +1355,25 @@ describe('trace (sampling)', () => {

mockSdkInit({ tracesSampler });

startSpan({ name: 'outer' }, outerSpan => {
expect(outerSpan).toBeDefined();
});
startSpan(
{
name: 'outer',
op: 'test.op',
attributes: { attr1: 'yes', attr2: 1 },
},
outerSpan => {
expect(outerSpan).toBeDefined();
},
);

expect(tracesSampler).toBeCalledTimes(1);
expect(tracesSampler).toHaveBeenCalledTimes(1);
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
attr1: 'yes',
attr2: 1,
'sentry.op': 'test.op',
},
transactionContext: { name: 'outer', parentSampled: undefined },
});
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): Pass inferred name & attributes to tracesSampler#12945

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

Merged
mydea merged 2 commits into from
Jul 18, 2024
Merged

fix(node): Pass inferred name & attributes to tracesSampler#12945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98eb57f
fix(node): Pass inferred name & attributes to `tracesSampler`
mydea Jul 17, 2024
32e6f04
properly handle op
mydea Jul 17, 2024
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
40 changes: 40 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
const { loggingTransport } = require('@sentry-internal/node-integration-tests');
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
tracesSampler: samplingContext => {
// The name we get here is inferred at span creation time
// At this point, we sadly do not have a http.route attribute yet,
// so we infer the name from the unparametrized route instead
return (
samplingContext.name === 'GET /test/123' &&
samplingContext.attributes['sentry.op'] === 'http.server' &&
samplingContext.attributes['http.method'] === 'GET'
);
},
debug: true,
});

// express must be required after Sentry is initialized
const express = require('express');
const cors = require('cors');
const { startExpressServerAndSendPortToRunner } = require('@sentry-internal/node-integration-tests');

const app = express();

app.use(cors());

app.get('/test/:id', (_req, res) => {
res.send('Success');
});

app.get('/test2', (_req, res) => {
res.send('Success');
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
24 changes: 24 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';

describe('express tracesSampler', () => {
afterAll(() => {
cleanupChildProcesses();
});

describe('CJS', () => {
test('correctly samples & passes data to tracesSampler', done => {
const runner = createRunner(__dirname, 'server.js')
.expect({
transaction: {
transaction: 'GET /test/:id',
},
})
.start(done);

// This is not sampled
runner.makeRequest('get', '/test2?q=1');
// This is sampled
runner.makeRequest('get', '/test/123?q=1');
});
});
});
34 changes: 28 additions & 6 deletions packages/opentelemetry/src/sampler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,12 @@ import { isSpanContextValid, trace } from '@opentelemetry/api';
import { TraceState } from '@opentelemetry/core';
import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-base';
import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, hasTracingEnabled, sampleSpan } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
hasTracingEnabled,
sampleSpan,
} from '@sentry/core';
import type { Client, SpanAttributes } from '@sentry/types';
import { logger } from '@sentry/utils';
import { SENTRY_TRACE_STATE_SAMPLED_NOT_RECORDING, SENTRY_TRACE_STATE_URL } from './constants';
Expand All@@ -13,6 +18,7 @@ import { SEMATTRS_HTTP_METHOD, SEMATTRS_HTTP_URL } from '@opentelemetry/semantic
import { DEBUG_BUILD } from './debug-build';
import { getPropagationContextFromSpan } from './propagator';
import { getSamplingDecision } from './utils/getSamplingDecision';
import { inferSpanData } from './utils/parseSpanDescription';
import { setIsSetup } from './utils/setupCheck';

/**
Expand DownExpand Up@@ -56,12 +62,28 @@ export class SentrySampler implements Sampler {

const parentSampled = parentSpan ? getParentSampled(parentSpan, traceId, spanName) : undefined;

// We want to pass the inferred name & attributes to the sampler method
const {
description: inferredSpanName,
data: inferredAttributes,
op,
} = inferSpanData(spanName, spanAttributes, spanKind);

const mergedAttributes = {
...inferredAttributes,
...spanAttributes,
};

if (op) {
mergedAttributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
}

const mutableSamplingDecision = { decision: true };
this._client.emit(
'beforeSampling',
{
spanAttributes: spanAttributes,
spanName: spanName,
spanAttributes: mergedAttributes,
spanName: inferredSpanName,
parentSampled: parentSampled,
parentContext: parentContext,
},
Expand All@@ -72,10 +94,10 @@ export class SentrySampler implements Sampler {
}

const [sampled, sampleRate] = sampleSpan(options, {
name: spanName,
attributes: spanAttributes,
name: inferredSpanName,
attributes: mergedAttributes,
transactionContext: {
name: spanName,
name: inferredSpanName,
parentSampled,
},
parentSampled,
Expand Down
23 changes: 7 additions & 16 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,6 @@ export function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span:
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

@mydeamydeaJul 17, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I noticed that this was actually also not ideal, we just added the op attribute after the span was started, which means this was not sent to the sampler. Also, this is overall unnecessary, we can just add the attribute right away!


return handleCallbackErrors(
() => callback(span),
() => {
Expand DownExpand Up@@ -90,8 +88,6 @@ export function startSpanManual<T>(
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

return handleCallbackErrors(
() => callback(span, () => span.end()),
() => {
Expand DownExpand Up@@ -131,8 +127,6 @@ export function startInactiveSpan(options: OpenTelemetrySpanContext): Span {

const span = tracer.startSpan(name, spanOptions, ctx);

_applySentryAttributesToSpan(span, options);

return span;
});
}
Expand All@@ -156,22 +150,19 @@ function getTracer(): Tracer {
return (client && client.tracer) || trace.getTracer('@sentry/opentelemetry', SDK_VERSION);
}

function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanContext): void {
const { op } = options;

if (op) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, op);
}
}

function getSpanOptions(options: OpenTelemetrySpanContext): SpanOptions {
const { startTime, attributes, kind } = options;
const { startTime, attributes, kind, op } = options;

// OTEL expects timestamps in ms, not seconds
const fixedStartTime = typeof startTime === 'number' ? ensureTimestampInMilliseconds(startTime) : startTime;

return {
attributes,
attributes: op
? {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
...attributes,
}
: attributes,
kind,
startTime: fixedStartTime,
};
Expand Down
26 changes: 17 additions & 9 deletions packages/opentelemetry/src/utils/parseSpanDescription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import {
SEMATTRS_MESSAGING_SYSTEM,
SEMATTRS_RPC_SERVICE,
} from '@opentelemetry/semantic-conventions';
import type { TransactionSource } from '@sentry/types';
import type { SpanAttributes, TransactionSource } from '@sentry/types';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '@sentry/utils';

import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
Expand All@@ -27,14 +27,9 @@ interface SpanDescription {
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
* Infer the op & description for a set of name, attributes and kind of a span.
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';

export function inferSpanData(name: string, attributes: SpanAttributes, kind: SpanKind): SpanDescription {
// This attribute is intentionally exported as a SEMATTR constant because it should stay intimite API
if (attributes['sentry.skip_span_data_inference']) {
return {
Expand All@@ -54,7 +49,7 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
// conventions export an attribute key for it.
const httpMethod = attributes['http.request.method'] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind: getSpanKind(span) }, httpMethod);
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
}

const dbSystem = attributes[SEMATTRS_DB_SYSTEM];
Expand DownExpand Up@@ -97,6 +92,19 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
return { op: undefined, description: name, source: 'custom' };
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';
const kind = getSpanKind(span);

return inferSpanData(name, attributes, kind);
}

function descriptionForDbSystem({ attributes, name }: { attributes: Attributes; name: string }): SpanDescription {
// Use DB statement (Ex "SELECT * FROM table") if possible as description.
const statement = attributes[SEMATTRS_DB_STATEMENT];
Expand Down
23 changes: 15 additions & 8 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1320,9 +1320,7 @@ describe('trace (sampling)', () => {
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
},
attributes: {},
transactionContext: { name: 'outer', parentSampled: undefined },
});

Expand DownExpand Up@@ -1357,16 +1355,25 @@ describe('trace (sampling)', () => {

mockSdkInit({ tracesSampler });

startSpan({ name: 'outer' }, outerSpan => {
expect(outerSpan).toBeDefined();
});
startSpan(
{
name: 'outer',
op: 'test.op',
attributes: { attr1: 'yes', attr2: 1 },
},
outerSpan => {
expect(outerSpan).toBeDefined();
},
);

expect(tracesSampler).toBeCalledTimes(1);
expect(tracesSampler).toHaveBeenCalledTimes(1);
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
attr1: 'yes',
attr2: 1,
'sentry.op': 'test.op',
},
transactionContext: { name: 'outer', parentSampled: undefined },
});
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): Pass inferred name & attributes to tracesSampler#12945

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

Merged
mydea merged 2 commits into from
Jul 18, 2024
Merged

fix(node): Pass inferred name & attributes to tracesSampler#12945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98eb57f
fix(node): Pass inferred name & attributes to `tracesSampler`
mydea Jul 17, 2024
32e6f04
properly handle op
mydea Jul 17, 2024
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
40 changes: 40 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
const { loggingTransport } = require('@sentry-internal/node-integration-tests');
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
tracesSampler: samplingContext => {
// The name we get here is inferred at span creation time
// At this point, we sadly do not have a http.route attribute yet,
// so we infer the name from the unparametrized route instead
return (
samplingContext.name === 'GET /test/123' &&
samplingContext.attributes['sentry.op'] === 'http.server' &&
samplingContext.attributes['http.method'] === 'GET'
);
},
debug: true,
});

// express must be required after Sentry is initialized
const express = require('express');
const cors = require('cors');
const { startExpressServerAndSendPortToRunner } = require('@sentry-internal/node-integration-tests');

const app = express();

app.use(cors());

app.get('/test/:id', (_req, res) => {
res.send('Success');
});

app.get('/test2', (_req, res) => {
res.send('Success');
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
24 changes: 24 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';

describe('express tracesSampler', () => {
afterAll(() => {
cleanupChildProcesses();
});

describe('CJS', () => {
test('correctly samples & passes data to tracesSampler', done => {
const runner = createRunner(__dirname, 'server.js')
.expect({
transaction: {
transaction: 'GET /test/:id',
},
})
.start(done);

// This is not sampled
runner.makeRequest('get', '/test2?q=1');
// This is sampled
runner.makeRequest('get', '/test/123?q=1');
});
});
});
34 changes: 28 additions & 6 deletions packages/opentelemetry/src/sampler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,12 @@ import { isSpanContextValid, trace } from '@opentelemetry/api';
import { TraceState } from '@opentelemetry/core';
import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-base';
import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, hasTracingEnabled, sampleSpan } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
hasTracingEnabled,
sampleSpan,
} from '@sentry/core';
import type { Client, SpanAttributes } from '@sentry/types';
import { logger } from '@sentry/utils';
import { SENTRY_TRACE_STATE_SAMPLED_NOT_RECORDING, SENTRY_TRACE_STATE_URL } from './constants';
Expand All@@ -13,6 +18,7 @@ import { SEMATTRS_HTTP_METHOD, SEMATTRS_HTTP_URL } from '@opentelemetry/semantic
import { DEBUG_BUILD } from './debug-build';
import { getPropagationContextFromSpan } from './propagator';
import { getSamplingDecision } from './utils/getSamplingDecision';
import { inferSpanData } from './utils/parseSpanDescription';
import { setIsSetup } from './utils/setupCheck';

/**
Expand DownExpand Up@@ -56,12 +62,28 @@ export class SentrySampler implements Sampler {

const parentSampled = parentSpan ? getParentSampled(parentSpan, traceId, spanName) : undefined;

// We want to pass the inferred name & attributes to the sampler method
const {
description: inferredSpanName,
data: inferredAttributes,
op,
} = inferSpanData(spanName, spanAttributes, spanKind);

const mergedAttributes = {
...inferredAttributes,
...spanAttributes,
};

if (op) {
mergedAttributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
}

const mutableSamplingDecision = { decision: true };
this._client.emit(
'beforeSampling',
{
spanAttributes: spanAttributes,
spanName: spanName,
spanAttributes: mergedAttributes,
spanName: inferredSpanName,
parentSampled: parentSampled,
parentContext: parentContext,
},
Expand All@@ -72,10 +94,10 @@ export class SentrySampler implements Sampler {
}

const [sampled, sampleRate] = sampleSpan(options, {
name: spanName,
attributes: spanAttributes,
name: inferredSpanName,
attributes: mergedAttributes,
transactionContext: {
name: spanName,
name: inferredSpanName,
parentSampled,
},
parentSampled,
Expand Down
23 changes: 7 additions & 16 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,6 @@ export function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span:
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

@mydeamydeaJul 17, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I noticed that this was actually also not ideal, we just added the op attribute after the span was started, which means this was not sent to the sampler. Also, this is overall unnecessary, we can just add the attribute right away!


return handleCallbackErrors(
() => callback(span),
() => {
Expand DownExpand Up@@ -90,8 +88,6 @@ export function startSpanManual<T>(
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

return handleCallbackErrors(
() => callback(span, () => span.end()),
() => {
Expand DownExpand Up@@ -131,8 +127,6 @@ export function startInactiveSpan(options: OpenTelemetrySpanContext): Span {

const span = tracer.startSpan(name, spanOptions, ctx);

_applySentryAttributesToSpan(span, options);

return span;
});
}
Expand All@@ -156,22 +150,19 @@ function getTracer(): Tracer {
return (client && client.tracer) || trace.getTracer('@sentry/opentelemetry', SDK_VERSION);
}

function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanContext): void {
const { op } = options;

if (op) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, op);
}
}

function getSpanOptions(options: OpenTelemetrySpanContext): SpanOptions {
const { startTime, attributes, kind } = options;
const { startTime, attributes, kind, op } = options;

// OTEL expects timestamps in ms, not seconds
const fixedStartTime = typeof startTime === 'number' ? ensureTimestampInMilliseconds(startTime) : startTime;

return {
attributes,
attributes: op
? {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
...attributes,
}
: attributes,
kind,
startTime: fixedStartTime,
};
Expand Down
26 changes: 17 additions & 9 deletions packages/opentelemetry/src/utils/parseSpanDescription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import {
SEMATTRS_MESSAGING_SYSTEM,
SEMATTRS_RPC_SERVICE,
} from '@opentelemetry/semantic-conventions';
import type { TransactionSource } from '@sentry/types';
import type { SpanAttributes, TransactionSource } from '@sentry/types';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '@sentry/utils';

import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
Expand All@@ -27,14 +27,9 @@ interface SpanDescription {
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
* Infer the op & description for a set of name, attributes and kind of a span.
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';

export function inferSpanData(name: string, attributes: SpanAttributes, kind: SpanKind): SpanDescription {
// This attribute is intentionally exported as a SEMATTR constant because it should stay intimite API
if (attributes['sentry.skip_span_data_inference']) {
return {
Expand All@@ -54,7 +49,7 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
// conventions export an attribute key for it.
const httpMethod = attributes['http.request.method'] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind: getSpanKind(span) }, httpMethod);
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
}

const dbSystem = attributes[SEMATTRS_DB_SYSTEM];
Expand DownExpand Up@@ -97,6 +92,19 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
return { op: undefined, description: name, source: 'custom' };
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';
const kind = getSpanKind(span);

return inferSpanData(name, attributes, kind);
}

function descriptionForDbSystem({ attributes, name }: { attributes: Attributes; name: string }): SpanDescription {
// Use DB statement (Ex "SELECT * FROM table") if possible as description.
const statement = attributes[SEMATTRS_DB_STATEMENT];
Expand Down
23 changes: 15 additions & 8 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1320,9 +1320,7 @@ describe('trace (sampling)', () => {
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
},
attributes: {},
transactionContext: { name: 'outer', parentSampled: undefined },
});

Expand DownExpand Up@@ -1357,16 +1355,25 @@ describe('trace (sampling)', () => {

mockSdkInit({ tracesSampler });

startSpan({ name: 'outer' }, outerSpan => {
expect(outerSpan).toBeDefined();
});
startSpan(
{
name: 'outer',
op: 'test.op',
attributes: { attr1: 'yes', attr2: 1 },
},
outerSpan => {
expect(outerSpan).toBeDefined();
},
);

expect(tracesSampler).toBeCalledTimes(1);
expect(tracesSampler).toHaveBeenCalledTimes(1);
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
attr1: 'yes',
attr2: 1,
'sentry.op': 'test.op',
},
transactionContext: { name: 'outer', parentSampled: undefined },
});
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): Pass inferred name & attributes to tracesSampler#12945

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

Merged
mydea merged 2 commits into from
Jul 18, 2024
Merged

fix(node): Pass inferred name & attributes to tracesSampler#12945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98eb57f
fix(node): Pass inferred name & attributes to `tracesSampler`
mydea Jul 17, 2024
32e6f04
properly handle op
mydea Jul 17, 2024
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
40 changes: 40 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
const { loggingTransport } = require('@sentry-internal/node-integration-tests');
const Sentry = require('@sentry/node');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
tracesSampler: samplingContext => {
// The name we get here is inferred at span creation time
// At this point, we sadly do not have a http.route attribute yet,
// so we infer the name from the unparametrized route instead
return (
samplingContext.name === 'GET /test/123' &&
samplingContext.attributes['sentry.op'] === 'http.server' &&
samplingContext.attributes['http.method'] === 'GET'
);
},
debug: true,
});

// express must be required after Sentry is initialized
const express = require('express');
const cors = require('cors');
const { startExpressServerAndSendPortToRunner } = require('@sentry-internal/node-integration-tests');

const app = express();

app.use(cors());

app.get('/test/:id', (_req, res) => {
res.send('Success');
});

app.get('/test2', (_req, res) => {
res.send('Success');
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
24 changes: 24 additions & 0 deletions dev-packages/node-integration-tests/suites/express/tracing/tracesSampler/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';

describe('express tracesSampler', () => {
afterAll(() => {
cleanupChildProcesses();
});

describe('CJS', () => {
test('correctly samples & passes data to tracesSampler', done => {
const runner = createRunner(__dirname, 'server.js')
.expect({
transaction: {
transaction: 'GET /test/:id',
},
})
.start(done);

// This is not sampled
runner.makeRequest('get', '/test2?q=1');
// This is sampled
runner.makeRequest('get', '/test/123?q=1');
});
});
});
34 changes: 28 additions & 6 deletions packages/opentelemetry/src/sampler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,12 @@ import { isSpanContextValid, trace } from '@opentelemetry/api';
import { TraceState } from '@opentelemetry/core';
import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-base';
import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, hasTracingEnabled, sampleSpan } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
hasTracingEnabled,
sampleSpan,
} from '@sentry/core';
import type { Client, SpanAttributes } from '@sentry/types';
import { logger } from '@sentry/utils';
import { SENTRY_TRACE_STATE_SAMPLED_NOT_RECORDING, SENTRY_TRACE_STATE_URL } from './constants';
Expand All@@ -13,6 +18,7 @@ import { SEMATTRS_HTTP_METHOD, SEMATTRS_HTTP_URL } from '@opentelemetry/semantic
import { DEBUG_BUILD } from './debug-build';
import { getPropagationContextFromSpan } from './propagator';
import { getSamplingDecision } from './utils/getSamplingDecision';
import { inferSpanData } from './utils/parseSpanDescription';
import { setIsSetup } from './utils/setupCheck';

/**
Expand DownExpand Up@@ -56,12 +62,28 @@ export class SentrySampler implements Sampler {

const parentSampled = parentSpan ? getParentSampled(parentSpan, traceId, spanName) : undefined;

// We want to pass the inferred name & attributes to the sampler method
const {
description: inferredSpanName,
data: inferredAttributes,
op,
} = inferSpanData(spanName, spanAttributes, spanKind);

const mergedAttributes = {
...inferredAttributes,
...spanAttributes,
};

if (op) {
mergedAttributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] = op;
}

const mutableSamplingDecision = { decision: true };
this._client.emit(
'beforeSampling',
{
spanAttributes: spanAttributes,
spanName: spanName,
spanAttributes: mergedAttributes,
spanName: inferredSpanName,
parentSampled: parentSampled,
parentContext: parentContext,
},
Expand All@@ -72,10 +94,10 @@ export class SentrySampler implements Sampler {
}

const [sampled, sampleRate] = sampleSpan(options, {
name: spanName,
attributes: spanAttributes,
name: inferredSpanName,
attributes: mergedAttributes,
transactionContext: {
name: spanName,
name: inferredSpanName,
parentSampled,
},
parentSampled,
Expand Down
23 changes: 7 additions & 16 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,6 @@ export function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span:
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

@mydeamydeaJul 17, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I noticed that this was actually also not ideal, we just added the op attribute after the span was started, which means this was not sent to the sampler. Also, this is overall unnecessary, we can just add the attribute right away!


return handleCallbackErrors(
() => callback(span),
() => {
Expand DownExpand Up@@ -90,8 +88,6 @@ export function startSpanManual<T>(
const spanOptions = getSpanOptions(options);

return tracer.startActiveSpan(name, spanOptions, ctx, span => {
_applySentryAttributesToSpan(span, options);

return handleCallbackErrors(
() => callback(span, () => span.end()),
() => {
Expand DownExpand Up@@ -131,8 +127,6 @@ export function startInactiveSpan(options: OpenTelemetrySpanContext): Span {

const span = tracer.startSpan(name, spanOptions, ctx);

_applySentryAttributesToSpan(span, options);

return span;
});
}
Expand All@@ -156,22 +150,19 @@ function getTracer(): Tracer {
return (client && client.tracer) || trace.getTracer('@sentry/opentelemetry', SDK_VERSION);
}

function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanContext): void {
const { op } = options;

if (op) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, op);
}
}

function getSpanOptions(options: OpenTelemetrySpanContext): SpanOptions {
const { startTime, attributes, kind } = options;
const { startTime, attributes, kind, op } = options;

// OTEL expects timestamps in ms, not seconds
const fixedStartTime = typeof startTime === 'number' ? ensureTimestampInMilliseconds(startTime) : startTime;

return {
attributes,
attributes: op
? {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
...attributes,
}
: attributes,
kind,
startTime: fixedStartTime,
};
Expand Down
26 changes: 17 additions & 9 deletions packages/opentelemetry/src/utils/parseSpanDescription.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import {
SEMATTRS_MESSAGING_SYSTEM,
SEMATTRS_RPC_SERVICE,
} from '@opentelemetry/semantic-conventions';
import type { TransactionSource } from '@sentry/types';
import type { SpanAttributes, TransactionSource } from '@sentry/types';
import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '@sentry/utils';

import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
Expand All@@ -27,14 +27,9 @@ interface SpanDescription {
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
* Infer the op & description for a set of name, attributes and kind of a span.
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';

export function inferSpanData(name: string, attributes: SpanAttributes, kind: SpanKind): SpanDescription {
// This attribute is intentionally exported as a SEMATTR constant because it should stay intimite API
if (attributes['sentry.skip_span_data_inference']) {
return {
Expand All@@ -54,7 +49,7 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
// conventions export an attribute key for it.
const httpMethod = attributes['http.request.method'] || attributes[SEMATTRS_HTTP_METHOD];
if (httpMethod) {
return descriptionForHttpMethod({ attributes, name, kind: getSpanKind(span) }, httpMethod);
return descriptionForHttpMethod({ attributes, name, kind }, httpMethod);
}

const dbSystem = attributes[SEMATTRS_DB_SYSTEM];
Expand DownExpand Up@@ -97,6 +92,19 @@ export function parseSpanDescription(span: AbstractSpan): SpanDescription {
return { op: undefined, description: name, source: 'custom' };
}

/**
* Extract better op/description from an otel span.
*
* Based on https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7422ce2a06337f68a59b552b8c5a2ac125d6bae5/exporter/sentryexporter/sentry_exporter.go#L306
*/
export function parseSpanDescription(span: AbstractSpan): SpanDescription {
const attributes = spanHasAttributes(span) ? span.attributes : {};
const name = spanHasName(span) ? span.name : '<unknown>';
const kind = getSpanKind(span);

return inferSpanData(name, attributes, kind);
}

function descriptionForDbSystem({ attributes, name }: { attributes: Attributes; name: string }): SpanDescription {
// Use DB statement (Ex "SELECT * FROM table") if possible as description.
const statement = attributes[SEMATTRS_DB_STATEMENT];
Expand Down
23 changes: 15 additions & 8 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1320,9 +1320,7 @@ describe('trace (sampling)', () => {
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
},
attributes: {},
transactionContext: { name: 'outer', parentSampled: undefined },
});

Expand DownExpand Up@@ -1357,16 +1355,25 @@ describe('trace (sampling)', () => {

mockSdkInit({ tracesSampler });

startSpan({ name: 'outer' }, outerSpan => {
expect(outerSpan).toBeDefined();
});
startSpan(
{
name: 'outer',
op: 'test.op',
attributes: { attr1: 'yes', attr2: 1 },
},
outerSpan => {
expect(outerSpan).toBeDefined();
},
);

expect(tracesSampler).toBeCalledTimes(1);
expect(tracesSampler).toHaveBeenCalledTimes(1);
expect(tracesSampler).toHaveBeenLastCalledWith({
parentSampled: undefined,
name: 'outer',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
attr1: 'yes',
attr2: 1,
'sentry.op': 'test.op',
},
transactionContext: { name: 'outer', parentSampled: undefined },
});
Expand Down