feat(core): Deprecate transaction metadata in favor of attributes#10097

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
Jan 9, 2024
Merged

feat(core): Deprecate transaction metadata in favor of attributes #10097

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
84c7991
feat(core): Deprecate transaction metadata in favor of attributes
mydea Jan 8, 2024
4d9763a
fix test
mydea Jan 9, 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
2 changes: 2 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.traceId`: Use `span.spanContext().traceId` instead.
* `span.name`: Use `spanToJSON(span).description` instead.
* `span.description`: Use `spanToJSON(span).description` instead.
* `transaction.setMetadata()`: Use attributes instead, or set data on the scope.
* `transaction.metadata`: Use attributes instead, or set data on the scope.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 2 additions & 4 deletions ...ges/browser-integration-tests/suites/public-api/startTransaction/circular_data/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,8 @@ const chicken = {};
const egg = { contains: chicken };
chicken.lays = egg;

const circularObject = chicken;

const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: circularObject });
const span = transaction.startChild({ op: 'circular_object_test_span', data: circularObject });
const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: { chicken } });
const span = transaction.startChild({ op: 'circular_object_test_span', data: { chicken } });

span.end();
transaction.end();
4 changes: 2 additions & 2 deletions ...ckages/browser-integration-tests/suites/public-api/startTransaction/circular_data/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,12 +17,12 @@ sentryTest('should be able to handle circular data', async ({ getLocalTestPath,

expect(eventData.contexts).toMatchObject({
trace: {
data: { lays: { contains: '[Circular ~]' } },

@mydeamydeaJan 8, 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.

Hah, this started failing because it depended on no other data being added to the transaction - but now under the hood it adds sample rate attribute, which lead to this not being the same at the root and one level deeper nesting. Making this an explicit data entry makes this test clearer IMHO.

data: { chicken: { lays: { contains: '[Circular ~]' } } },
},
});

expect(eventData?.spans?.[0]).toMatchObject({
data: { lays: { contains: '[Circular ~]' } },
data: { chicken: { lays: { contains: '[Circular ~]' } } },
op: 'circular_object_test_span',
});

Expand Down
3 changes: 2 additions & 1 deletion ...ges/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import http from 'http';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -34,7 +35,7 @@ app.get('/test/express', (_req, res) => {
if (transaction) {
// eslint-disable-next-line deprecation/deprecation
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
const headers = http.get('http://somewhere.not.sentry/').getHeaders();

Expand Down
5 changes: 3 additions & 2 deletions packages/angular-ivy/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular-ivy/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
5 changes: 3 additions & 2 deletions packages/angular/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
14 changes: 10 additions & 4 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router
import { NavigationCancel, NavigationError, Router } from '@angular/router';
import { NavigationEnd, NavigationStart, ResolveEnd } from '@angular/router';
import { WINDOW, getCurrentScope } from '@sentry/browser';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON } from '@sentry/core';
import type { Span, Transaction, TransactionContext } from '@sentry/types';
import { logger, stripUrlQueryAndFragment, timestampInSeconds } from '@sentry/utils';
import type { Observable } from 'rxjs';
Expand DownExpand Up@@ -39,7 +40,9 @@ export function routingInstrumentation(
name: WINDOW.location.pathname,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}
}
Expand DownExpand Up@@ -80,7 +83,9 @@ export class TraceService implements OnDestroy {
name: strippedUrl,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}

Expand DownExpand Up@@ -123,9 +128,10 @@ export class TraceService implements OnDestroy {
// eslint-disable-next-line deprecation/deprecation
const transaction = getActiveTransaction();
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
const attributes = (transaction && spanToJSON(transaction).data) || {};
if (transaction && attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
}),
);
Expand Down
32 changes: 22 additions & 10 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';

import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
Expand All@@ -11,7 +12,14 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
setAttribute: jest.fn(),
toJSON: () => ({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
...ctx.data,
...ctx.attributes,
},
}),
};

return transaction;
Expand DownExpand Up@@ -45,7 +53,7 @@ describe('Angular Tracing', () => {
name: '/',
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
});
});
Expand DownExpand Up@@ -107,11 +115,15 @@ describe('Angular Tracing', () => {
const customStartTransaction = jest.fn((ctx: any) => {
transaction = {
...ctx,
metadata: {
...ctx.metadata,
source: 'custom',
},
toJSON: () => ({
data: {
...ctx.data,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
},
}),
metadata: ctx.metadata,
updateName: jest.fn(name => (transaction.name = name)),
setAttribute: jest.fn(),
};

return transaction;
Expand All@@ -135,12 +147,12 @@ describe('Angular Tracing', () => {
name: url,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});

expect(transaction.updateName).toHaveBeenCalledTimes(0);
expect(transaction.name).toEqual(url);
expect(transaction.metadata.source).toBe('custom');
expect(transaction.toJSON().data).toEqual({ [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' });

env.destroy();
});
Expand DownExpand Up@@ -326,10 +338,10 @@ describe('Angular Tracing', () => {
name: url,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(transaction.setAttribute).toHaveBeenCalledWith(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');

env.destroy();
});
Expand Down
5 changes: 4 additions & 1 deletion packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import {
captureException,
continueTrace,
Expand DownExpand Up@@ -111,6 +112,7 @@ async function instrumentRequest(

try {
const interpolatedRoute = interpolateRouteFromUrlAndParams(ctx.url.pathname, ctx.params);
const source = interpolatedRoute ? 'route' : 'url';
// storing res in a variable instead of directly returning is necessary to
// invoke the catch block if next() throws
const res = await startSpan(
Expand All@@ -121,12 +123,13 @@ async function instrumentRequest(
origin: 'auto.http.astro',
status: 'ok',
metadata: {
// eslint-disable-next-line deprecation/deprecation
...traceCtx?.metadata,
source: interpolatedRoute ? 'route' : 'url',
},
data: {
method,
url: stripUrlQueryAndFragment(ctx.url.href),
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
...(ctx.url.search && { 'http.query': ctx.url.search }),
...(ctx.url.hash && { 'http.fragment': ctx.url.hash }),
...(options.trackHeaders && { headers: allHeaders }),
Expand Down
15 changes: 8 additions & 7 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as SentryNode from '@sentry/node';
import type { Client } from '@sentry/types';
import { vi } from 'vitest';
Expand DownExpand Up@@ -57,10 +58,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'https://mydomain.io/users/123/details',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
},
metadata: {
source: 'route',
},
metadata: {},
name: 'GET /users/[id]/details',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -94,10 +94,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'http://localhost:1234/a%xx',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
metadata: {
source: 'url',
},
metadata: {},
name: 'GET a%xx',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -159,8 +158,10 @@ describe('sentryMiddleware', () => {

expect(startSpanSpy).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
metadata: {
source: 'route',
dynamicSamplingContext: {
release: '1.0.0',
},
Expand Down
4 changes: 3 additions & 1 deletion packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Transaction,
captureException,
continueTrace,
Expand DownExpand Up@@ -54,6 +55,7 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
const parsedUrl = parseUrl(request.url);
const data: Record<string, unknown> = {
'http.request.method': request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
data['http.query'] = parsedUrl.search;
Expand All@@ -72,8 +74,8 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
...ctx,
data,
metadata: {
// eslint-disable-next-line deprecation/deprecation
...ctx.metadata,
source: 'url',
request: {
url,
method: request.method,
Expand Down
1 change: 1 addition & 0 deletions packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,7 @@ describe('Bun Serve Integration', () => {
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.isRecording()).toBe(true);

// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ export type { ServerRuntimeClientOptions } from './server-runtime-client';
export type { RequestDataIntegrationOptions } from './integrations/requestdata';

export * from './tracing';
export * from './semanticAttributes';
export { createEventEnvelope, createSessionEnvelope } from './envelope';
export {
addBreadcrumb,
Expand Down
11 changes: 11 additions & 0 deletions packages/core/src/semanticAttributes.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
/**
* Use this attribute to represent the source of a span.
* Should be one of: custom, url, route, view, component, task, unknown
*
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SOURCE = 'sentry.source';

@AbhiPrasadAbhiPrasadJan 8, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be a good thing to put under a subpath export @sentry/core/attributes, let's give it a try in v8.


/**
* Use this attribute to represent the sample rate used for a span.
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE = 'sentry.sample_rate';
19 changes: 6 additions & 13 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Options, SamplingContext } from '@sentry/types';
import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanToJSON } from '../utils/spanUtils';
import type { Transaction } from './transaction';
Expand DownExpand Up@@ -30,10 +31,8 @@ export function sampleTransaction<T extends Transaction>(
// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
// eslint-disable-next-line deprecation/deprecation
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(transaction.sampled));
return transaction;
}

Expand All@@ -42,22 +41,16 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
sampleRate,
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate);
}

// Since this is coming from the user (or from a function provided by the user), who knows what we might get. (The
Expand Down
Loading
, '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

feat(core): Deprecate transaction metadata in favor of attributes#10097

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
Jan 9, 2024
Merged

feat(core): Deprecate transaction metadata in favor of attributes #10097

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
84c7991
feat(core): Deprecate transaction metadata in favor of attributes
mydea Jan 8, 2024
4d9763a
fix test
mydea Jan 9, 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
2 changes: 2 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.traceId`: Use `span.spanContext().traceId` instead.
* `span.name`: Use `spanToJSON(span).description` instead.
* `span.description`: Use `spanToJSON(span).description` instead.
* `transaction.setMetadata()`: Use attributes instead, or set data on the scope.
* `transaction.metadata`: Use attributes instead, or set data on the scope.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 2 additions & 4 deletions ...ges/browser-integration-tests/suites/public-api/startTransaction/circular_data/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,8 @@ const chicken = {};
const egg = { contains: chicken };
chicken.lays = egg;

const circularObject = chicken;

const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: circularObject });
const span = transaction.startChild({ op: 'circular_object_test_span', data: circularObject });
const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: { chicken } });
const span = transaction.startChild({ op: 'circular_object_test_span', data: { chicken } });

span.end();
transaction.end();
4 changes: 2 additions & 2 deletions ...ckages/browser-integration-tests/suites/public-api/startTransaction/circular_data/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,12 +17,12 @@ sentryTest('should be able to handle circular data', async ({ getLocalTestPath,

expect(eventData.contexts).toMatchObject({
trace: {
data: { lays: { contains: '[Circular ~]' } },

@mydeamydeaJan 8, 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.

Hah, this started failing because it depended on no other data being added to the transaction - but now under the hood it adds sample rate attribute, which lead to this not being the same at the root and one level deeper nesting. Making this an explicit data entry makes this test clearer IMHO.

data: { chicken: { lays: { contains: '[Circular ~]' } } },
},
});

expect(eventData?.spans?.[0]).toMatchObject({
data: { lays: { contains: '[Circular ~]' } },
data: { chicken: { lays: { contains: '[Circular ~]' } } },
op: 'circular_object_test_span',
});

Expand Down
3 changes: 2 additions & 1 deletion ...ges/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import http from 'http';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -34,7 +35,7 @@ app.get('/test/express', (_req, res) => {
if (transaction) {
// eslint-disable-next-line deprecation/deprecation
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
const headers = http.get('http://somewhere.not.sentry/').getHeaders();

Expand Down
5 changes: 3 additions & 2 deletions packages/angular-ivy/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular-ivy/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
5 changes: 3 additions & 2 deletions packages/angular/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
14 changes: 10 additions & 4 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router
import { NavigationCancel, NavigationError, Router } from '@angular/router';
import { NavigationEnd, NavigationStart, ResolveEnd } from '@angular/router';
import { WINDOW, getCurrentScope } from '@sentry/browser';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON } from '@sentry/core';
import type { Span, Transaction, TransactionContext } from '@sentry/types';
import { logger, stripUrlQueryAndFragment, timestampInSeconds } from '@sentry/utils';
import type { Observable } from 'rxjs';
Expand DownExpand Up@@ -39,7 +40,9 @@ export function routingInstrumentation(
name: WINDOW.location.pathname,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}
}
Expand DownExpand Up@@ -80,7 +83,9 @@ export class TraceService implements OnDestroy {
name: strippedUrl,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}

Expand DownExpand Up@@ -123,9 +128,10 @@ export class TraceService implements OnDestroy {
// eslint-disable-next-line deprecation/deprecation
const transaction = getActiveTransaction();
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
const attributes = (transaction && spanToJSON(transaction).data) || {};
if (transaction && attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
}),
);
Expand Down
32 changes: 22 additions & 10 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';

import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
Expand All@@ -11,7 +12,14 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
setAttribute: jest.fn(),
toJSON: () => ({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
...ctx.data,
...ctx.attributes,
},
}),
};

return transaction;
Expand DownExpand Up@@ -45,7 +53,7 @@ describe('Angular Tracing', () => {
name: '/',
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
});
});
Expand DownExpand Up@@ -107,11 +115,15 @@ describe('Angular Tracing', () => {
const customStartTransaction = jest.fn((ctx: any) => {
transaction = {
...ctx,
metadata: {
...ctx.metadata,
source: 'custom',
},
toJSON: () => ({
data: {
...ctx.data,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
},
}),
metadata: ctx.metadata,
updateName: jest.fn(name => (transaction.name = name)),
setAttribute: jest.fn(),
};

return transaction;
Expand All@@ -135,12 +147,12 @@ describe('Angular Tracing', () => {
name: url,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});

expect(transaction.updateName).toHaveBeenCalledTimes(0);
expect(transaction.name).toEqual(url);
expect(transaction.metadata.source).toBe('custom');
expect(transaction.toJSON().data).toEqual({ [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' });

env.destroy();
});
Expand DownExpand Up@@ -326,10 +338,10 @@ describe('Angular Tracing', () => {
name: url,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(transaction.setAttribute).toHaveBeenCalledWith(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');

env.destroy();
});
Expand Down
5 changes: 4 additions & 1 deletion packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import {
captureException,
continueTrace,
Expand DownExpand Up@@ -111,6 +112,7 @@ async function instrumentRequest(

try {
const interpolatedRoute = interpolateRouteFromUrlAndParams(ctx.url.pathname, ctx.params);
const source = interpolatedRoute ? 'route' : 'url';
// storing res in a variable instead of directly returning is necessary to
// invoke the catch block if next() throws
const res = await startSpan(
Expand All@@ -121,12 +123,13 @@ async function instrumentRequest(
origin: 'auto.http.astro',
status: 'ok',
metadata: {
// eslint-disable-next-line deprecation/deprecation
...traceCtx?.metadata,
source: interpolatedRoute ? 'route' : 'url',
},
data: {
method,
url: stripUrlQueryAndFragment(ctx.url.href),
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
...(ctx.url.search && { 'http.query': ctx.url.search }),
...(ctx.url.hash && { 'http.fragment': ctx.url.hash }),
...(options.trackHeaders && { headers: allHeaders }),
Expand Down
15 changes: 8 additions & 7 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as SentryNode from '@sentry/node';
import type { Client } from '@sentry/types';
import { vi } from 'vitest';
Expand DownExpand Up@@ -57,10 +58,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'https://mydomain.io/users/123/details',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
},
metadata: {
source: 'route',
},
metadata: {},
name: 'GET /users/[id]/details',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -94,10 +94,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'http://localhost:1234/a%xx',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
metadata: {
source: 'url',
},
metadata: {},
name: 'GET a%xx',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -159,8 +158,10 @@ describe('sentryMiddleware', () => {

expect(startSpanSpy).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
metadata: {
source: 'route',
dynamicSamplingContext: {
release: '1.0.0',
},
Expand Down
4 changes: 3 additions & 1 deletion packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Transaction,
captureException,
continueTrace,
Expand DownExpand Up@@ -54,6 +55,7 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
const parsedUrl = parseUrl(request.url);
const data: Record<string, unknown> = {
'http.request.method': request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
data['http.query'] = parsedUrl.search;
Expand All@@ -72,8 +74,8 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
...ctx,
data,
metadata: {
// eslint-disable-next-line deprecation/deprecation
...ctx.metadata,
source: 'url',
request: {
url,
method: request.method,
Expand Down
1 change: 1 addition & 0 deletions packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,7 @@ describe('Bun Serve Integration', () => {
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.isRecording()).toBe(true);

// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ export type { ServerRuntimeClientOptions } from './server-runtime-client';
export type { RequestDataIntegrationOptions } from './integrations/requestdata';

export * from './tracing';
export * from './semanticAttributes';
export { createEventEnvelope, createSessionEnvelope } from './envelope';
export {
addBreadcrumb,
Expand Down
11 changes: 11 additions & 0 deletions packages/core/src/semanticAttributes.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
/**
* Use this attribute to represent the source of a span.
* Should be one of: custom, url, route, view, component, task, unknown
*
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SOURCE = 'sentry.source';

@AbhiPrasadAbhiPrasadJan 8, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be a good thing to put under a subpath export @sentry/core/attributes, let's give it a try in v8.


/**
* Use this attribute to represent the sample rate used for a span.
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE = 'sentry.sample_rate';
19 changes: 6 additions & 13 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Options, SamplingContext } from '@sentry/types';
import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanToJSON } from '../utils/spanUtils';
import type { Transaction } from './transaction';
Expand DownExpand Up@@ -30,10 +31,8 @@ export function sampleTransaction<T extends Transaction>(
// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
// eslint-disable-next-line deprecation/deprecation
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(transaction.sampled));
return transaction;
}

Expand All@@ -42,22 +41,16 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
sampleRate,
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate);
}

// Since this is coming from the user (or from a function provided by the user), who knows what we might get. (The
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core): Deprecate transaction metadata in favor of attributes#10097

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
Jan 9, 2024
Merged

feat(core): Deprecate transaction metadata in favor of attributes #10097

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
84c7991
feat(core): Deprecate transaction metadata in favor of attributes
mydea Jan 8, 2024
4d9763a
fix test
mydea Jan 9, 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
2 changes: 2 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.traceId`: Use `span.spanContext().traceId` instead.
* `span.name`: Use `spanToJSON(span).description` instead.
* `span.description`: Use `spanToJSON(span).description` instead.
* `transaction.setMetadata()`: Use attributes instead, or set data on the scope.
* `transaction.metadata`: Use attributes instead, or set data on the scope.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 2 additions & 4 deletions ...ges/browser-integration-tests/suites/public-api/startTransaction/circular_data/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,8 @@ const chicken = {};
const egg = { contains: chicken };
chicken.lays = egg;

const circularObject = chicken;

const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: circularObject });
const span = transaction.startChild({ op: 'circular_object_test_span', data: circularObject });
const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: { chicken } });
const span = transaction.startChild({ op: 'circular_object_test_span', data: { chicken } });

span.end();
transaction.end();
4 changes: 2 additions & 2 deletions ...ckages/browser-integration-tests/suites/public-api/startTransaction/circular_data/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,12 +17,12 @@ sentryTest('should be able to handle circular data', async ({ getLocalTestPath,

expect(eventData.contexts).toMatchObject({
trace: {
data: { lays: { contains: '[Circular ~]' } },

@mydeamydeaJan 8, 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.

Hah, this started failing because it depended on no other data being added to the transaction - but now under the hood it adds sample rate attribute, which lead to this not being the same at the root and one level deeper nesting. Making this an explicit data entry makes this test clearer IMHO.

data: { chicken: { lays: { contains: '[Circular ~]' } } },
},
});

expect(eventData?.spans?.[0]).toMatchObject({
data: { lays: { contains: '[Circular ~]' } },
data: { chicken: { lays: { contains: '[Circular ~]' } } },
op: 'circular_object_test_span',
});

Expand Down
3 changes: 2 additions & 1 deletion ...ges/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import http from 'http';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -34,7 +35,7 @@ app.get('/test/express', (_req, res) => {
if (transaction) {
// eslint-disable-next-line deprecation/deprecation
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
const headers = http.get('http://somewhere.not.sentry/').getHeaders();

Expand Down
5 changes: 3 additions & 2 deletions packages/angular-ivy/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular-ivy/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
5 changes: 3 additions & 2 deletions packages/angular/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
14 changes: 10 additions & 4 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router
import { NavigationCancel, NavigationError, Router } from '@angular/router';
import { NavigationEnd, NavigationStart, ResolveEnd } from '@angular/router';
import { WINDOW, getCurrentScope } from '@sentry/browser';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON } from '@sentry/core';
import type { Span, Transaction, TransactionContext } from '@sentry/types';
import { logger, stripUrlQueryAndFragment, timestampInSeconds } from '@sentry/utils';
import type { Observable } from 'rxjs';
Expand DownExpand Up@@ -39,7 +40,9 @@ export function routingInstrumentation(
name: WINDOW.location.pathname,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}
}
Expand DownExpand Up@@ -80,7 +83,9 @@ export class TraceService implements OnDestroy {
name: strippedUrl,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}

Expand DownExpand Up@@ -123,9 +128,10 @@ export class TraceService implements OnDestroy {
// eslint-disable-next-line deprecation/deprecation
const transaction = getActiveTransaction();
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
const attributes = (transaction && spanToJSON(transaction).data) || {};
if (transaction && attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
}),
);
Expand Down
32 changes: 22 additions & 10 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';

import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
Expand All@@ -11,7 +12,14 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
setAttribute: jest.fn(),
toJSON: () => ({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
...ctx.data,
...ctx.attributes,
},
}),
};

return transaction;
Expand DownExpand Up@@ -45,7 +53,7 @@ describe('Angular Tracing', () => {
name: '/',
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
});
});
Expand DownExpand Up@@ -107,11 +115,15 @@ describe('Angular Tracing', () => {
const customStartTransaction = jest.fn((ctx: any) => {
transaction = {
...ctx,
metadata: {
...ctx.metadata,
source: 'custom',
},
toJSON: () => ({
data: {
...ctx.data,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
},
}),
metadata: ctx.metadata,
updateName: jest.fn(name => (transaction.name = name)),
setAttribute: jest.fn(),
};

return transaction;
Expand All@@ -135,12 +147,12 @@ describe('Angular Tracing', () => {
name: url,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});

expect(transaction.updateName).toHaveBeenCalledTimes(0);
expect(transaction.name).toEqual(url);
expect(transaction.metadata.source).toBe('custom');
expect(transaction.toJSON().data).toEqual({ [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' });

env.destroy();
});
Expand DownExpand Up@@ -326,10 +338,10 @@ describe('Angular Tracing', () => {
name: url,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(transaction.setAttribute).toHaveBeenCalledWith(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');

env.destroy();
});
Expand Down
5 changes: 4 additions & 1 deletion packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import {
captureException,
continueTrace,
Expand DownExpand Up@@ -111,6 +112,7 @@ async function instrumentRequest(

try {
const interpolatedRoute = interpolateRouteFromUrlAndParams(ctx.url.pathname, ctx.params);
const source = interpolatedRoute ? 'route' : 'url';
// storing res in a variable instead of directly returning is necessary to
// invoke the catch block if next() throws
const res = await startSpan(
Expand All@@ -121,12 +123,13 @@ async function instrumentRequest(
origin: 'auto.http.astro',
status: 'ok',
metadata: {
// eslint-disable-next-line deprecation/deprecation
...traceCtx?.metadata,
source: interpolatedRoute ? 'route' : 'url',
},
data: {
method,
url: stripUrlQueryAndFragment(ctx.url.href),
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
...(ctx.url.search && { 'http.query': ctx.url.search }),
...(ctx.url.hash && { 'http.fragment': ctx.url.hash }),
...(options.trackHeaders && { headers: allHeaders }),
Expand Down
15 changes: 8 additions & 7 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as SentryNode from '@sentry/node';
import type { Client } from '@sentry/types';
import { vi } from 'vitest';
Expand DownExpand Up@@ -57,10 +58,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'https://mydomain.io/users/123/details',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
},
metadata: {
source: 'route',
},
metadata: {},
name: 'GET /users/[id]/details',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -94,10 +94,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'http://localhost:1234/a%xx',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
metadata: {
source: 'url',
},
metadata: {},
name: 'GET a%xx',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -159,8 +158,10 @@ describe('sentryMiddleware', () => {

expect(startSpanSpy).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
metadata: {
source: 'route',
dynamicSamplingContext: {
release: '1.0.0',
},
Expand Down
4 changes: 3 additions & 1 deletion packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Transaction,
captureException,
continueTrace,
Expand DownExpand Up@@ -54,6 +55,7 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
const parsedUrl = parseUrl(request.url);
const data: Record<string, unknown> = {
'http.request.method': request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
data['http.query'] = parsedUrl.search;
Expand All@@ -72,8 +74,8 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
...ctx,
data,
metadata: {
// eslint-disable-next-line deprecation/deprecation
...ctx.metadata,
source: 'url',
request: {
url,
method: request.method,
Expand Down
1 change: 1 addition & 0 deletions packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,7 @@ describe('Bun Serve Integration', () => {
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.isRecording()).toBe(true);

// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ export type { ServerRuntimeClientOptions } from './server-runtime-client';
export type { RequestDataIntegrationOptions } from './integrations/requestdata';

export * from './tracing';
export * from './semanticAttributes';
export { createEventEnvelope, createSessionEnvelope } from './envelope';
export {
addBreadcrumb,
Expand Down
11 changes: 11 additions & 0 deletions packages/core/src/semanticAttributes.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
/**
* Use this attribute to represent the source of a span.
* Should be one of: custom, url, route, view, component, task, unknown
*
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SOURCE = 'sentry.source';

@AbhiPrasadAbhiPrasadJan 8, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be a good thing to put under a subpath export @sentry/core/attributes, let's give it a try in v8.


/**
* Use this attribute to represent the sample rate used for a span.
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE = 'sentry.sample_rate';
19 changes: 6 additions & 13 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Options, SamplingContext } from '@sentry/types';
import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanToJSON } from '../utils/spanUtils';
import type { Transaction } from './transaction';
Expand DownExpand Up@@ -30,10 +31,8 @@ export function sampleTransaction<T extends Transaction>(
// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
// eslint-disable-next-line deprecation/deprecation
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(transaction.sampled));
return transaction;
}

Expand All@@ -42,22 +41,16 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
sampleRate,
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate);
}

// Since this is coming from the user (or from a function provided by the user), who knows what we might get. (The
Expand Down
Loading
, '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

feat(core): Deprecate transaction metadata in favor of attributes#10097

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
Jan 9, 2024
Merged

feat(core): Deprecate transaction metadata in favor of attributes #10097

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
84c7991
feat(core): Deprecate transaction metadata in favor of attributes
mydea Jan 8, 2024
4d9763a
fix test
mydea Jan 9, 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
2 changes: 2 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.traceId`: Use `span.spanContext().traceId` instead.
* `span.name`: Use `spanToJSON(span).description` instead.
* `span.description`: Use `spanToJSON(span).description` instead.
* `transaction.setMetadata()`: Use attributes instead, or set data on the scope.
* `transaction.metadata`: Use attributes instead, or set data on the scope.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 2 additions & 4 deletions ...ges/browser-integration-tests/suites/public-api/startTransaction/circular_data/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,8 @@ const chicken = {};
const egg = { contains: chicken };
chicken.lays = egg;

const circularObject = chicken;

const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: circularObject });
const span = transaction.startChild({ op: 'circular_object_test_span', data: circularObject });
const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: { chicken } });
const span = transaction.startChild({ op: 'circular_object_test_span', data: { chicken } });

span.end();
transaction.end();
4 changes: 2 additions & 2 deletions ...ckages/browser-integration-tests/suites/public-api/startTransaction/circular_data/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,12 +17,12 @@ sentryTest('should be able to handle circular data', async ({ getLocalTestPath,

expect(eventData.contexts).toMatchObject({
trace: {
data: { lays: { contains: '[Circular ~]' } },

@mydeamydeaJan 8, 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.

Hah, this started failing because it depended on no other data being added to the transaction - but now under the hood it adds sample rate attribute, which lead to this not being the same at the root and one level deeper nesting. Making this an explicit data entry makes this test clearer IMHO.

data: { chicken: { lays: { contains: '[Circular ~]' } } },
},
});

expect(eventData?.spans?.[0]).toMatchObject({
data: { lays: { contains: '[Circular ~]' } },
data: { chicken: { lays: { contains: '[Circular ~]' } } },
op: 'circular_object_test_span',
});

Expand Down
3 changes: 2 additions & 1 deletion ...ges/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import http from 'http';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -34,7 +35,7 @@ app.get('/test/express', (_req, res) => {
if (transaction) {
// eslint-disable-next-line deprecation/deprecation
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
const headers = http.get('http://somewhere.not.sentry/').getHeaders();

Expand Down
5 changes: 3 additions & 2 deletions packages/angular-ivy/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular-ivy/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
5 changes: 3 additions & 2 deletions packages/angular/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
14 changes: 10 additions & 4 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router
import { NavigationCancel, NavigationError, Router } from '@angular/router';
import { NavigationEnd, NavigationStart, ResolveEnd } from '@angular/router';
import { WINDOW, getCurrentScope } from '@sentry/browser';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON } from '@sentry/core';
import type { Span, Transaction, TransactionContext } from '@sentry/types';
import { logger, stripUrlQueryAndFragment, timestampInSeconds } from '@sentry/utils';
import type { Observable } from 'rxjs';
Expand DownExpand Up@@ -39,7 +40,9 @@ export function routingInstrumentation(
name: WINDOW.location.pathname,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}
}
Expand DownExpand Up@@ -80,7 +83,9 @@ export class TraceService implements OnDestroy {
name: strippedUrl,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}

Expand DownExpand Up@@ -123,9 +128,10 @@ export class TraceService implements OnDestroy {
// eslint-disable-next-line deprecation/deprecation
const transaction = getActiveTransaction();
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
const attributes = (transaction && spanToJSON(transaction).data) || {};
if (transaction && attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
}),
);
Expand Down
32 changes: 22 additions & 10 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';

import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
Expand All@@ -11,7 +12,14 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
setAttribute: jest.fn(),
toJSON: () => ({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
...ctx.data,
...ctx.attributes,
},
}),
};

return transaction;
Expand DownExpand Up@@ -45,7 +53,7 @@ describe('Angular Tracing', () => {
name: '/',
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
});
});
Expand DownExpand Up@@ -107,11 +115,15 @@ describe('Angular Tracing', () => {
const customStartTransaction = jest.fn((ctx: any) => {
transaction = {
...ctx,
metadata: {
...ctx.metadata,
source: 'custom',
},
toJSON: () => ({
data: {
...ctx.data,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
},
}),
metadata: ctx.metadata,
updateName: jest.fn(name => (transaction.name = name)),
setAttribute: jest.fn(),
};

return transaction;
Expand All@@ -135,12 +147,12 @@ describe('Angular Tracing', () => {
name: url,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});

expect(transaction.updateName).toHaveBeenCalledTimes(0);
expect(transaction.name).toEqual(url);
expect(transaction.metadata.source).toBe('custom');
expect(transaction.toJSON().data).toEqual({ [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' });

env.destroy();
});
Expand DownExpand Up@@ -326,10 +338,10 @@ describe('Angular Tracing', () => {
name: url,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(transaction.setAttribute).toHaveBeenCalledWith(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');

env.destroy();
});
Expand Down
5 changes: 4 additions & 1 deletion packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import {
captureException,
continueTrace,
Expand DownExpand Up@@ -111,6 +112,7 @@ async function instrumentRequest(

try {
const interpolatedRoute = interpolateRouteFromUrlAndParams(ctx.url.pathname, ctx.params);
const source = interpolatedRoute ? 'route' : 'url';
// storing res in a variable instead of directly returning is necessary to
// invoke the catch block if next() throws
const res = await startSpan(
Expand All@@ -121,12 +123,13 @@ async function instrumentRequest(
origin: 'auto.http.astro',
status: 'ok',
metadata: {
// eslint-disable-next-line deprecation/deprecation
...traceCtx?.metadata,
source: interpolatedRoute ? 'route' : 'url',
},
data: {
method,
url: stripUrlQueryAndFragment(ctx.url.href),
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
...(ctx.url.search && { 'http.query': ctx.url.search }),
...(ctx.url.hash && { 'http.fragment': ctx.url.hash }),
...(options.trackHeaders && { headers: allHeaders }),
Expand Down
15 changes: 8 additions & 7 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as SentryNode from '@sentry/node';
import type { Client } from '@sentry/types';
import { vi } from 'vitest';
Expand DownExpand Up@@ -57,10 +58,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'https://mydomain.io/users/123/details',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
},
metadata: {
source: 'route',
},
metadata: {},
name: 'GET /users/[id]/details',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -94,10 +94,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'http://localhost:1234/a%xx',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
metadata: {
source: 'url',
},
metadata: {},
name: 'GET a%xx',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -159,8 +158,10 @@ describe('sentryMiddleware', () => {

expect(startSpanSpy).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
metadata: {
source: 'route',
dynamicSamplingContext: {
release: '1.0.0',
},
Expand Down
4 changes: 3 additions & 1 deletion packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Transaction,
captureException,
continueTrace,
Expand DownExpand Up@@ -54,6 +55,7 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
const parsedUrl = parseUrl(request.url);
const data: Record<string, unknown> = {
'http.request.method': request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
data['http.query'] = parsedUrl.search;
Expand All@@ -72,8 +74,8 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
...ctx,
data,
metadata: {
// eslint-disable-next-line deprecation/deprecation
...ctx.metadata,
source: 'url',
request: {
url,
method: request.method,
Expand Down
1 change: 1 addition & 0 deletions packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,7 @@ describe('Bun Serve Integration', () => {
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.isRecording()).toBe(true);

// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ export type { ServerRuntimeClientOptions } from './server-runtime-client';
export type { RequestDataIntegrationOptions } from './integrations/requestdata';

export * from './tracing';
export * from './semanticAttributes';
export { createEventEnvelope, createSessionEnvelope } from './envelope';
export {
addBreadcrumb,
Expand Down
11 changes: 11 additions & 0 deletions packages/core/src/semanticAttributes.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
/**
* Use this attribute to represent the source of a span.
* Should be one of: custom, url, route, view, component, task, unknown
*
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SOURCE = 'sentry.source';

@AbhiPrasadAbhiPrasadJan 8, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be a good thing to put under a subpath export @sentry/core/attributes, let's give it a try in v8.


/**
* Use this attribute to represent the sample rate used for a span.
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE = 'sentry.sample_rate';
19 changes: 6 additions & 13 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Options, SamplingContext } from '@sentry/types';
import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanToJSON } from '../utils/spanUtils';
import type { Transaction } from './transaction';
Expand DownExpand Up@@ -30,10 +31,8 @@ export function sampleTransaction<T extends Transaction>(
// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
// eslint-disable-next-line deprecation/deprecation
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(transaction.sampled));
return transaction;
}

Expand All@@ -42,22 +41,16 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
sampleRate,
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate);
}

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

feat(core): Deprecate transaction metadata in favor of attributes#10097

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
Jan 9, 2024
Merged

feat(core): Deprecate transaction metadata in favor of attributes #10097

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
84c7991
feat(core): Deprecate transaction metadata in favor of attributes
mydea Jan 8, 2024
4d9763a
fix test
mydea Jan 9, 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
2 changes: 2 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.traceId`: Use `span.spanContext().traceId` instead.
* `span.name`: Use `spanToJSON(span).description` instead.
* `span.description`: Use `spanToJSON(span).description` instead.
* `transaction.setMetadata()`: Use attributes instead, or set data on the scope.
* `transaction.metadata`: Use attributes instead, or set data on the scope.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 2 additions & 4 deletions ...ges/browser-integration-tests/suites/public-api/startTransaction/circular_data/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,8 @@ const chicken = {};
const egg = { contains: chicken };
chicken.lays = egg;

const circularObject = chicken;

const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: circularObject });
const span = transaction.startChild({ op: 'circular_object_test_span', data: circularObject });
const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: { chicken } });
const span = transaction.startChild({ op: 'circular_object_test_span', data: { chicken } });

span.end();
transaction.end();
4 changes: 2 additions & 2 deletions ...ckages/browser-integration-tests/suites/public-api/startTransaction/circular_data/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,12 +17,12 @@ sentryTest('should be able to handle circular data', async ({ getLocalTestPath,

expect(eventData.contexts).toMatchObject({
trace: {
data: { lays: { contains: '[Circular ~]' } },

@mydeamydeaJan 8, 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.

Hah, this started failing because it depended on no other data being added to the transaction - but now under the hood it adds sample rate attribute, which lead to this not being the same at the root and one level deeper nesting. Making this an explicit data entry makes this test clearer IMHO.

data: { chicken: { lays: { contains: '[Circular ~]' } } },
},
});

expect(eventData?.spans?.[0]).toMatchObject({
data: { lays: { contains: '[Circular ~]' } },
data: { chicken: { lays: { contains: '[Circular ~]' } } },
op: 'circular_object_test_span',
});

Expand Down
3 changes: 2 additions & 1 deletion ...ges/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import http from 'http';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -34,7 +35,7 @@ app.get('/test/express', (_req, res) => {
if (transaction) {
// eslint-disable-next-line deprecation/deprecation
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
const headers = http.get('http://somewhere.not.sentry/').getHeaders();

Expand Down
5 changes: 3 additions & 2 deletions packages/angular-ivy/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular-ivy/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
5 changes: 3 additions & 2 deletions packages/angular/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
14 changes: 10 additions & 4 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router
import { NavigationCancel, NavigationError, Router } from '@angular/router';
import { NavigationEnd, NavigationStart, ResolveEnd } from '@angular/router';
import { WINDOW, getCurrentScope } from '@sentry/browser';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON } from '@sentry/core';
import type { Span, Transaction, TransactionContext } from '@sentry/types';
import { logger, stripUrlQueryAndFragment, timestampInSeconds } from '@sentry/utils';
import type { Observable } from 'rxjs';
Expand DownExpand Up@@ -39,7 +40,9 @@ export function routingInstrumentation(
name: WINDOW.location.pathname,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}
}
Expand DownExpand Up@@ -80,7 +83,9 @@ export class TraceService implements OnDestroy {
name: strippedUrl,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}

Expand DownExpand Up@@ -123,9 +128,10 @@ export class TraceService implements OnDestroy {
// eslint-disable-next-line deprecation/deprecation
const transaction = getActiveTransaction();
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
const attributes = (transaction && spanToJSON(transaction).data) || {};
if (transaction && attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
}),
);
Expand Down
32 changes: 22 additions & 10 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';

import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
Expand All@@ -11,7 +12,14 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
setAttribute: jest.fn(),
toJSON: () => ({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
...ctx.data,
...ctx.attributes,
},
}),
};

return transaction;
Expand DownExpand Up@@ -45,7 +53,7 @@ describe('Angular Tracing', () => {
name: '/',
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
});
});
Expand DownExpand Up@@ -107,11 +115,15 @@ describe('Angular Tracing', () => {
const customStartTransaction = jest.fn((ctx: any) => {
transaction = {
...ctx,
metadata: {
...ctx.metadata,
source: 'custom',
},
toJSON: () => ({
data: {
...ctx.data,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
},
}),
metadata: ctx.metadata,
updateName: jest.fn(name => (transaction.name = name)),
setAttribute: jest.fn(),
};

return transaction;
Expand All@@ -135,12 +147,12 @@ describe('Angular Tracing', () => {
name: url,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});

expect(transaction.updateName).toHaveBeenCalledTimes(0);
expect(transaction.name).toEqual(url);
expect(transaction.metadata.source).toBe('custom');
expect(transaction.toJSON().data).toEqual({ [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' });

env.destroy();
});
Expand DownExpand Up@@ -326,10 +338,10 @@ describe('Angular Tracing', () => {
name: url,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(transaction.setAttribute).toHaveBeenCalledWith(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');

env.destroy();
});
Expand Down
5 changes: 4 additions & 1 deletion packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import {
captureException,
continueTrace,
Expand DownExpand Up@@ -111,6 +112,7 @@ async function instrumentRequest(

try {
const interpolatedRoute = interpolateRouteFromUrlAndParams(ctx.url.pathname, ctx.params);
const source = interpolatedRoute ? 'route' : 'url';
// storing res in a variable instead of directly returning is necessary to
// invoke the catch block if next() throws
const res = await startSpan(
Expand All@@ -121,12 +123,13 @@ async function instrumentRequest(
origin: 'auto.http.astro',
status: 'ok',
metadata: {
// eslint-disable-next-line deprecation/deprecation
...traceCtx?.metadata,
source: interpolatedRoute ? 'route' : 'url',
},
data: {
method,
url: stripUrlQueryAndFragment(ctx.url.href),
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
...(ctx.url.search && { 'http.query': ctx.url.search }),
...(ctx.url.hash && { 'http.fragment': ctx.url.hash }),
...(options.trackHeaders && { headers: allHeaders }),
Expand Down
15 changes: 8 additions & 7 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as SentryNode from '@sentry/node';
import type { Client } from '@sentry/types';
import { vi } from 'vitest';
Expand DownExpand Up@@ -57,10 +58,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'https://mydomain.io/users/123/details',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
},
metadata: {
source: 'route',
},
metadata: {},
name: 'GET /users/[id]/details',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -94,10 +94,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'http://localhost:1234/a%xx',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
metadata: {
source: 'url',
},
metadata: {},
name: 'GET a%xx',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -159,8 +158,10 @@ describe('sentryMiddleware', () => {

expect(startSpanSpy).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
metadata: {
source: 'route',
dynamicSamplingContext: {
release: '1.0.0',
},
Expand Down
4 changes: 3 additions & 1 deletion packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Transaction,
captureException,
continueTrace,
Expand DownExpand Up@@ -54,6 +55,7 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
const parsedUrl = parseUrl(request.url);
const data: Record<string, unknown> = {
'http.request.method': request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
data['http.query'] = parsedUrl.search;
Expand All@@ -72,8 +74,8 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
...ctx,
data,
metadata: {
// eslint-disable-next-line deprecation/deprecation
...ctx.metadata,
source: 'url',
request: {
url,
method: request.method,
Expand Down
1 change: 1 addition & 0 deletions packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,7 @@ describe('Bun Serve Integration', () => {
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.isRecording()).toBe(true);

// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ export type { ServerRuntimeClientOptions } from './server-runtime-client';
export type { RequestDataIntegrationOptions } from './integrations/requestdata';

export * from './tracing';
export * from './semanticAttributes';
export { createEventEnvelope, createSessionEnvelope } from './envelope';
export {
addBreadcrumb,
Expand Down
11 changes: 11 additions & 0 deletions packages/core/src/semanticAttributes.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
/**
* Use this attribute to represent the source of a span.
* Should be one of: custom, url, route, view, component, task, unknown
*
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SOURCE = 'sentry.source';

@AbhiPrasadAbhiPrasadJan 8, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be a good thing to put under a subpath export @sentry/core/attributes, let's give it a try in v8.


/**
* Use this attribute to represent the sample rate used for a span.
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE = 'sentry.sample_rate';
19 changes: 6 additions & 13 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Options, SamplingContext } from '@sentry/types';
import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanToJSON } from '../utils/spanUtils';
import type { Transaction } from './transaction';
Expand DownExpand Up@@ -30,10 +31,8 @@ export function sampleTransaction<T extends Transaction>(
// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
// eslint-disable-next-line deprecation/deprecation
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(transaction.sampled));
return transaction;
}

Expand All@@ -42,22 +41,16 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
sampleRate,
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate);
}

// Since this is coming from the user (or from a function provided by the user), who knows what we might get. (The
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core): Deprecate transaction metadata in favor of attributes#10097

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
Jan 9, 2024
Merged

feat(core): Deprecate transaction metadata in favor of attributes #10097

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
84c7991
feat(core): Deprecate transaction metadata in favor of attributes
mydea Jan 8, 2024
4d9763a
fix test
mydea Jan 9, 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
2 changes: 2 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.traceId`: Use `span.spanContext().traceId` instead.
* `span.name`: Use `spanToJSON(span).description` instead.
* `span.description`: Use `spanToJSON(span).description` instead.
* `transaction.setMetadata()`: Use attributes instead, or set data on the scope.
* `transaction.metadata`: Use attributes instead, or set data on the scope.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 2 additions & 4 deletions ...ges/browser-integration-tests/suites/public-api/startTransaction/circular_data/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,8 @@ const chicken = {};
const egg = { contains: chicken };
chicken.lays = egg;

const circularObject = chicken;

const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: circularObject });
const span = transaction.startChild({ op: 'circular_object_test_span', data: circularObject });
const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: { chicken } });
const span = transaction.startChild({ op: 'circular_object_test_span', data: { chicken } });

span.end();
transaction.end();
4 changes: 2 additions & 2 deletions ...ckages/browser-integration-tests/suites/public-api/startTransaction/circular_data/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,12 +17,12 @@ sentryTest('should be able to handle circular data', async ({ getLocalTestPath,

expect(eventData.contexts).toMatchObject({
trace: {
data: { lays: { contains: '[Circular ~]' } },

@mydeamydeaJan 8, 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.

Hah, this started failing because it depended on no other data being added to the transaction - but now under the hood it adds sample rate attribute, which lead to this not being the same at the root and one level deeper nesting. Making this an explicit data entry makes this test clearer IMHO.

data: { chicken: { lays: { contains: '[Circular ~]' } } },
},
});

expect(eventData?.spans?.[0]).toMatchObject({
data: { lays: { contains: '[Circular ~]' } },
data: { chicken: { lays: { contains: '[Circular ~]' } } },
op: 'circular_object_test_span',
});

Expand Down
3 changes: 2 additions & 1 deletion ...ges/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import http from 'http';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -34,7 +35,7 @@ app.get('/test/express', (_req, res) => {
if (transaction) {
// eslint-disable-next-line deprecation/deprecation
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
const headers = http.get('http://somewhere.not.sentry/').getHeaders();

Expand Down
5 changes: 3 additions & 2 deletions packages/angular-ivy/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular-ivy/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
5 changes: 3 additions & 2 deletions packages/angular/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
14 changes: 10 additions & 4 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router
import { NavigationCancel, NavigationError, Router } from '@angular/router';
import { NavigationEnd, NavigationStart, ResolveEnd } from '@angular/router';
import { WINDOW, getCurrentScope } from '@sentry/browser';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON } from '@sentry/core';
import type { Span, Transaction, TransactionContext } from '@sentry/types';
import { logger, stripUrlQueryAndFragment, timestampInSeconds } from '@sentry/utils';
import type { Observable } from 'rxjs';
Expand DownExpand Up@@ -39,7 +40,9 @@ export function routingInstrumentation(
name: WINDOW.location.pathname,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}
}
Expand DownExpand Up@@ -80,7 +83,9 @@ export class TraceService implements OnDestroy {
name: strippedUrl,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}

Expand DownExpand Up@@ -123,9 +128,10 @@ export class TraceService implements OnDestroy {
// eslint-disable-next-line deprecation/deprecation
const transaction = getActiveTransaction();
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
const attributes = (transaction && spanToJSON(transaction).data) || {};
if (transaction && attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
}),
);
Expand Down
32 changes: 22 additions & 10 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';

import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
Expand All@@ -11,7 +12,14 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
setAttribute: jest.fn(),
toJSON: () => ({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
...ctx.data,
...ctx.attributes,
},
}),
};

return transaction;
Expand DownExpand Up@@ -45,7 +53,7 @@ describe('Angular Tracing', () => {
name: '/',
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
});
});
Expand DownExpand Up@@ -107,11 +115,15 @@ describe('Angular Tracing', () => {
const customStartTransaction = jest.fn((ctx: any) => {
transaction = {
...ctx,
metadata: {
...ctx.metadata,
source: 'custom',
},
toJSON: () => ({
data: {
...ctx.data,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
},
}),
metadata: ctx.metadata,
updateName: jest.fn(name => (transaction.name = name)),
setAttribute: jest.fn(),
};

return transaction;
Expand All@@ -135,12 +147,12 @@ describe('Angular Tracing', () => {
name: url,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});

expect(transaction.updateName).toHaveBeenCalledTimes(0);
expect(transaction.name).toEqual(url);
expect(transaction.metadata.source).toBe('custom');
expect(transaction.toJSON().data).toEqual({ [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' });

env.destroy();
});
Expand DownExpand Up@@ -326,10 +338,10 @@ describe('Angular Tracing', () => {
name: url,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(transaction.setAttribute).toHaveBeenCalledWith(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');

env.destroy();
});
Expand Down
5 changes: 4 additions & 1 deletion packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import {
captureException,
continueTrace,
Expand DownExpand Up@@ -111,6 +112,7 @@ async function instrumentRequest(

try {
const interpolatedRoute = interpolateRouteFromUrlAndParams(ctx.url.pathname, ctx.params);
const source = interpolatedRoute ? 'route' : 'url';
// storing res in a variable instead of directly returning is necessary to
// invoke the catch block if next() throws
const res = await startSpan(
Expand All@@ -121,12 +123,13 @@ async function instrumentRequest(
origin: 'auto.http.astro',
status: 'ok',
metadata: {
// eslint-disable-next-line deprecation/deprecation
...traceCtx?.metadata,
source: interpolatedRoute ? 'route' : 'url',
},
data: {
method,
url: stripUrlQueryAndFragment(ctx.url.href),
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
...(ctx.url.search && { 'http.query': ctx.url.search }),
...(ctx.url.hash && { 'http.fragment': ctx.url.hash }),
...(options.trackHeaders && { headers: allHeaders }),
Expand Down
15 changes: 8 additions & 7 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as SentryNode from '@sentry/node';
import type { Client } from '@sentry/types';
import { vi } from 'vitest';
Expand DownExpand Up@@ -57,10 +58,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'https://mydomain.io/users/123/details',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
},
metadata: {
source: 'route',
},
metadata: {},
name: 'GET /users/[id]/details',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -94,10 +94,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'http://localhost:1234/a%xx',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
metadata: {
source: 'url',
},
metadata: {},
name: 'GET a%xx',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -159,8 +158,10 @@ describe('sentryMiddleware', () => {

expect(startSpanSpy).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
metadata: {
source: 'route',
dynamicSamplingContext: {
release: '1.0.0',
},
Expand Down
4 changes: 3 additions & 1 deletion packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Transaction,
captureException,
continueTrace,
Expand DownExpand Up@@ -54,6 +55,7 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
const parsedUrl = parseUrl(request.url);
const data: Record<string, unknown> = {
'http.request.method': request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
data['http.query'] = parsedUrl.search;
Expand All@@ -72,8 +74,8 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
...ctx,
data,
metadata: {
// eslint-disable-next-line deprecation/deprecation
...ctx.metadata,
source: 'url',
request: {
url,
method: request.method,
Expand Down
1 change: 1 addition & 0 deletions packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,7 @@ describe('Bun Serve Integration', () => {
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.isRecording()).toBe(true);

// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ export type { ServerRuntimeClientOptions } from './server-runtime-client';
export type { RequestDataIntegrationOptions } from './integrations/requestdata';

export * from './tracing';
export * from './semanticAttributes';
export { createEventEnvelope, createSessionEnvelope } from './envelope';
export {
addBreadcrumb,
Expand Down
11 changes: 11 additions & 0 deletions packages/core/src/semanticAttributes.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
/**
* Use this attribute to represent the source of a span.
* Should be one of: custom, url, route, view, component, task, unknown
*
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SOURCE = 'sentry.source';

@AbhiPrasadAbhiPrasadJan 8, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be a good thing to put under a subpath export @sentry/core/attributes, let's give it a try in v8.


/**
* Use this attribute to represent the sample rate used for a span.
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE = 'sentry.sample_rate';
19 changes: 6 additions & 13 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Options, SamplingContext } from '@sentry/types';
import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanToJSON } from '../utils/spanUtils';
import type { Transaction } from './transaction';
Expand DownExpand Up@@ -30,10 +31,8 @@ export function sampleTransaction<T extends Transaction>(
// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
// eslint-disable-next-line deprecation/deprecation
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(transaction.sampled));
return transaction;
}

Expand All@@ -42,22 +41,16 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
sampleRate,
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate);
}

// Since this is coming from the user (or from a function provided by the user), who knows what we might get. (The
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core): Deprecate transaction metadata in favor of attributes#10097

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
Jan 9, 2024
Merged

feat(core): Deprecate transaction metadata in favor of attributes #10097

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
84c7991
feat(core): Deprecate transaction metadata in favor of attributes
mydea Jan 8, 2024
4d9763a
fix test
mydea Jan 9, 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
2 changes: 2 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.traceId`: Use `span.spanContext().traceId` instead.
* `span.name`: Use `spanToJSON(span).description` instead.
* `span.description`: Use `spanToJSON(span).description` instead.
* `transaction.setMetadata()`: Use attributes instead, or set data on the scope.
* `transaction.metadata`: Use attributes instead, or set data on the scope.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 2 additions & 4 deletions ...ges/browser-integration-tests/suites/public-api/startTransaction/circular_data/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,8 @@ const chicken = {};
const egg = { contains: chicken };
chicken.lays = egg;

const circularObject = chicken;

const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: circularObject });
const span = transaction.startChild({ op: 'circular_object_test_span', data: circularObject });
const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: { chicken } });
const span = transaction.startChild({ op: 'circular_object_test_span', data: { chicken } });

span.end();
transaction.end();
4 changes: 2 additions & 2 deletions ...ckages/browser-integration-tests/suites/public-api/startTransaction/circular_data/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,12 +17,12 @@ sentryTest('should be able to handle circular data', async ({ getLocalTestPath,

expect(eventData.contexts).toMatchObject({
trace: {
data: { lays: { contains: '[Circular ~]' } },

@mydeamydeaJan 8, 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.

Hah, this started failing because it depended on no other data being added to the transaction - but now under the hood it adds sample rate attribute, which lead to this not being the same at the root and one level deeper nesting. Making this an explicit data entry makes this test clearer IMHO.

data: { chicken: { lays: { contains: '[Circular ~]' } } },
},
});

expect(eventData?.spans?.[0]).toMatchObject({
data: { lays: { contains: '[Circular ~]' } },
data: { chicken: { lays: { contains: '[Circular ~]' } } },
op: 'circular_object_test_span',
});

Expand Down
3 changes: 2 additions & 1 deletion ...ges/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import http from 'http';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -34,7 +35,7 @@ app.get('/test/express', (_req, res) => {
if (transaction) {
// eslint-disable-next-line deprecation/deprecation
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
const headers = http.get('http://somewhere.not.sentry/').getHeaders();

Expand Down
5 changes: 3 additions & 2 deletions packages/angular-ivy/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular-ivy/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
5 changes: 3 additions & 2 deletions packages/angular/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
14 changes: 10 additions & 4 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router
import { NavigationCancel, NavigationError, Router } from '@angular/router';
import { NavigationEnd, NavigationStart, ResolveEnd } from '@angular/router';
import { WINDOW, getCurrentScope } from '@sentry/browser';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON } from '@sentry/core';
import type { Span, Transaction, TransactionContext } from '@sentry/types';
import { logger, stripUrlQueryAndFragment, timestampInSeconds } from '@sentry/utils';
import type { Observable } from 'rxjs';
Expand DownExpand Up@@ -39,7 +40,9 @@ export function routingInstrumentation(
name: WINDOW.location.pathname,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}
}
Expand DownExpand Up@@ -80,7 +83,9 @@ export class TraceService implements OnDestroy {
name: strippedUrl,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}

Expand DownExpand Up@@ -123,9 +128,10 @@ export class TraceService implements OnDestroy {
// eslint-disable-next-line deprecation/deprecation
const transaction = getActiveTransaction();
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
const attributes = (transaction && spanToJSON(transaction).data) || {};
if (transaction && attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
}),
);
Expand Down
32 changes: 22 additions & 10 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';

import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
Expand All@@ -11,7 +12,14 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
setAttribute: jest.fn(),
toJSON: () => ({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
...ctx.data,
...ctx.attributes,
},
}),
};

return transaction;
Expand DownExpand Up@@ -45,7 +53,7 @@ describe('Angular Tracing', () => {
name: '/',
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
});
});
Expand DownExpand Up@@ -107,11 +115,15 @@ describe('Angular Tracing', () => {
const customStartTransaction = jest.fn((ctx: any) => {
transaction = {
...ctx,
metadata: {
...ctx.metadata,
source: 'custom',
},
toJSON: () => ({
data: {
...ctx.data,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
},
}),
metadata: ctx.metadata,
updateName: jest.fn(name => (transaction.name = name)),
setAttribute: jest.fn(),
};

return transaction;
Expand All@@ -135,12 +147,12 @@ describe('Angular Tracing', () => {
name: url,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});

expect(transaction.updateName).toHaveBeenCalledTimes(0);
expect(transaction.name).toEqual(url);
expect(transaction.metadata.source).toBe('custom');
expect(transaction.toJSON().data).toEqual({ [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' });

env.destroy();
});
Expand DownExpand Up@@ -326,10 +338,10 @@ describe('Angular Tracing', () => {
name: url,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(transaction.setAttribute).toHaveBeenCalledWith(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');

env.destroy();
});
Expand Down
5 changes: 4 additions & 1 deletion packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import {
captureException,
continueTrace,
Expand DownExpand Up@@ -111,6 +112,7 @@ async function instrumentRequest(

try {
const interpolatedRoute = interpolateRouteFromUrlAndParams(ctx.url.pathname, ctx.params);
const source = interpolatedRoute ? 'route' : 'url';
// storing res in a variable instead of directly returning is necessary to
// invoke the catch block if next() throws
const res = await startSpan(
Expand All@@ -121,12 +123,13 @@ async function instrumentRequest(
origin: 'auto.http.astro',
status: 'ok',
metadata: {
// eslint-disable-next-line deprecation/deprecation
...traceCtx?.metadata,
source: interpolatedRoute ? 'route' : 'url',
},
data: {
method,
url: stripUrlQueryAndFragment(ctx.url.href),
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
...(ctx.url.search && { 'http.query': ctx.url.search }),
...(ctx.url.hash && { 'http.fragment': ctx.url.hash }),
...(options.trackHeaders && { headers: allHeaders }),
Expand Down
15 changes: 8 additions & 7 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as SentryNode from '@sentry/node';
import type { Client } from '@sentry/types';
import { vi } from 'vitest';
Expand DownExpand Up@@ -57,10 +58,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'https://mydomain.io/users/123/details',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
},
metadata: {
source: 'route',
},
metadata: {},
name: 'GET /users/[id]/details',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -94,10 +94,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'http://localhost:1234/a%xx',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
metadata: {
source: 'url',
},
metadata: {},
name: 'GET a%xx',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -159,8 +158,10 @@ describe('sentryMiddleware', () => {

expect(startSpanSpy).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
metadata: {
source: 'route',
dynamicSamplingContext: {
release: '1.0.0',
},
Expand Down
4 changes: 3 additions & 1 deletion packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Transaction,
captureException,
continueTrace,
Expand DownExpand Up@@ -54,6 +55,7 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
const parsedUrl = parseUrl(request.url);
const data: Record<string, unknown> = {
'http.request.method': request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
data['http.query'] = parsedUrl.search;
Expand All@@ -72,8 +74,8 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
...ctx,
data,
metadata: {
// eslint-disable-next-line deprecation/deprecation
...ctx.metadata,
source: 'url',
request: {
url,
method: request.method,
Expand Down
1 change: 1 addition & 0 deletions packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,7 @@ describe('Bun Serve Integration', () => {
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.isRecording()).toBe(true);

// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ export type { ServerRuntimeClientOptions } from './server-runtime-client';
export type { RequestDataIntegrationOptions } from './integrations/requestdata';

export * from './tracing';
export * from './semanticAttributes';
export { createEventEnvelope, createSessionEnvelope } from './envelope';
export {
addBreadcrumb,
Expand Down
11 changes: 11 additions & 0 deletions packages/core/src/semanticAttributes.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
/**
* Use this attribute to represent the source of a span.
* Should be one of: custom, url, route, view, component, task, unknown
*
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SOURCE = 'sentry.source';

@AbhiPrasadAbhiPrasadJan 8, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be a good thing to put under a subpath export @sentry/core/attributes, let's give it a try in v8.


/**
* Use this attribute to represent the sample rate used for a span.
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE = 'sentry.sample_rate';
19 changes: 6 additions & 13 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Options, SamplingContext } from '@sentry/types';
import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanToJSON } from '../utils/spanUtils';
import type { Transaction } from './transaction';
Expand DownExpand Up@@ -30,10 +31,8 @@ export function sampleTransaction<T extends Transaction>(
// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
// eslint-disable-next-line deprecation/deprecation
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(transaction.sampled));
return transaction;
}

Expand All@@ -42,22 +41,16 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
sampleRate,
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate);
}

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

feat(core): Deprecate transaction metadata in favor of attributes#10097

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
Jan 9, 2024
Merged

feat(core): Deprecate transaction metadata in favor of attributes #10097

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
84c7991
feat(core): Deprecate transaction metadata in favor of attributes
mydea Jan 8, 2024
4d9763a
fix test
mydea Jan 9, 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
2 changes: 2 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.traceId`: Use `span.spanContext().traceId` instead.
* `span.name`: Use `spanToJSON(span).description` instead.
* `span.description`: Use `spanToJSON(span).description` instead.
* `transaction.setMetadata()`: Use attributes instead, or set data on the scope.
* `transaction.metadata`: Use attributes instead, or set data on the scope.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 2 additions & 4 deletions ...ges/browser-integration-tests/suites/public-api/startTransaction/circular_data/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,8 @@ const chicken = {};
const egg = { contains: chicken };
chicken.lays = egg;

const circularObject = chicken;

const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: circularObject });
const span = transaction.startChild({ op: 'circular_object_test_span', data: circularObject });
const transaction = Sentry.startTransaction({ name: 'circular_object_test_transaction', data: { chicken } });
const span = transaction.startChild({ op: 'circular_object_test_span', data: { chicken } });

span.end();
transaction.end();
4 changes: 2 additions & 2 deletions ...ckages/browser-integration-tests/suites/public-api/startTransaction/circular_data/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,12 +17,12 @@ sentryTest('should be able to handle circular data', async ({ getLocalTestPath,

expect(eventData.contexts).toMatchObject({
trace: {
data: { lays: { contains: '[Circular ~]' } },

@mydeamydeaJan 8, 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.

Hah, this started failing because it depended on no other data being added to the transaction - but now under the hood it adds sample rate attribute, which lead to this not being the same at the root and one level deeper nesting. Making this an explicit data entry makes this test clearer IMHO.

data: { chicken: { lays: { contains: '[Circular ~]' } } },
},
});

expect(eventData?.spans?.[0]).toMatchObject({
data: { lays: { contains: '[Circular ~]' } },
data: { chicken: { lays: { contains: '[Circular ~]' } } },
op: 'circular_object_test_span',
});

Expand Down
3 changes: 2 additions & 1 deletion ...ges/node-integration-tests/suites/express/sentry-trace/baggage-transaction-name/server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import http from 'http';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -34,7 +35,7 @@ app.get('/test/express', (_req, res) => {
if (transaction) {
// eslint-disable-next-line deprecation/deprecation
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
const headers = http.get('http://somewhere.not.sentry/').getHeaders();

Expand Down
5 changes: 3 additions & 2 deletions packages/angular-ivy/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"allowedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular-ivy/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
5 changes: 3 additions & 2 deletions packages/angular/ng-package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,10 @@
"entryFile": "src/index.ts",
"umdModuleIds": {
"@sentry/browser": "Sentry",
"@sentry/utils": "Sentry.util"
"@sentry/utils": "Sentry.util",
"@sentry/core": "Sentry.core"
}
},
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/utils", "@sentry/types", "tslib"],
"whitelistedNonPeerDependencies": ["@sentry/browser", "@sentry/core", "@sentry/utils", "@sentry/types", "tslib"],
"assets": ["README.md", "LICENSE"]
}
1 change: 1 addition & 0 deletions packages/angular/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
},
"dependencies": {
"@sentry/browser": "7.92.0",
"@sentry/core": "7.92.0",
"@sentry/types": "7.92.0",
"@sentry/utils": "7.92.0",
"tslib": "^2.4.1"
Expand Down
14 changes: 10 additions & 4 deletions packages/angular/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type { ActivatedRouteSnapshot, Event, RouterState } from '@angular/router
import { NavigationCancel, NavigationError, Router } from '@angular/router';
import { NavigationEnd, NavigationStart, ResolveEnd } from '@angular/router';
import { WINDOW, getCurrentScope } from '@sentry/browser';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, spanToJSON } from '@sentry/core';
import type { Span, Transaction, TransactionContext } from '@sentry/types';
import { logger, stripUrlQueryAndFragment, timestampInSeconds } from '@sentry/utils';
import type { Observable } from 'rxjs';
Expand DownExpand Up@@ -39,7 +40,9 @@ export function routingInstrumentation(
name: WINDOW.location.pathname,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}
}
Expand DownExpand Up@@ -80,7 +83,9 @@ export class TraceService implements OnDestroy {
name: strippedUrl,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
});
}

Expand DownExpand Up@@ -123,9 +128,10 @@ export class TraceService implements OnDestroy {
// eslint-disable-next-line deprecation/deprecation
const transaction = getActiveTransaction();
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
const attributes = (transaction && spanToJSON(transaction).data) || {};
if (transaction && attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
}
}),
);
Expand Down
32 changes: 22 additions & 10 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';

import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
Expand All@@ -11,7 +12,14 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
setAttribute: jest.fn(),
toJSON: () => ({
data: {
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
...ctx.data,
...ctx.attributes,
},
}),
};

return transaction;
Expand DownExpand Up@@ -45,7 +53,7 @@ describe('Angular Tracing', () => {
name: '/',
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
});
});
Expand DownExpand Up@@ -107,11 +115,15 @@ describe('Angular Tracing', () => {
const customStartTransaction = jest.fn((ctx: any) => {
transaction = {
...ctx,
metadata: {
...ctx.metadata,
source: 'custom',
},
toJSON: () => ({
data: {
...ctx.data,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
},
}),
metadata: ctx.metadata,
updateName: jest.fn(name => (transaction.name = name)),
setAttribute: jest.fn(),
};

return transaction;
Expand All@@ -135,12 +147,12 @@ describe('Angular Tracing', () => {
name: url,
op: 'pageload',
origin: 'auto.pageload.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});

expect(transaction.updateName).toHaveBeenCalledTimes(0);
expect(transaction.name).toEqual(url);
expect(transaction.metadata.source).toBe('custom');
expect(transaction.toJSON().data).toEqual({ [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' });

env.destroy();
});
Expand DownExpand Up@@ -326,10 +338,10 @@ describe('Angular Tracing', () => {
name: url,
op: 'navigation',
origin: 'auto.navigation.angular',
metadata: { source: 'url' },
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(transaction.setAttribute).toHaveBeenCalledWith(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');

env.destroy();
});
Expand Down
5 changes: 4 additions & 1 deletion packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import {
captureException,
continueTrace,
Expand DownExpand Up@@ -111,6 +112,7 @@ async function instrumentRequest(

try {
const interpolatedRoute = interpolateRouteFromUrlAndParams(ctx.url.pathname, ctx.params);
const source = interpolatedRoute ? 'route' : 'url';
// storing res in a variable instead of directly returning is necessary to
// invoke the catch block if next() throws
const res = await startSpan(
Expand All@@ -121,12 +123,13 @@ async function instrumentRequest(
origin: 'auto.http.astro',
status: 'ok',
metadata: {
// eslint-disable-next-line deprecation/deprecation
...traceCtx?.metadata,
source: interpolatedRoute ? 'route' : 'url',
},
data: {
method,
url: stripUrlQueryAndFragment(ctx.url.href),
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
...(ctx.url.search && { 'http.query': ctx.url.search }),
...(ctx.url.hash && { 'http.fragment': ctx.url.hash }),
...(options.trackHeaders && { headers: allHeaders }),
Expand Down
15 changes: 8 additions & 7 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
import * as SentryNode from '@sentry/node';
import type { Client } from '@sentry/types';
import { vi } from 'vitest';
Expand DownExpand Up@@ -57,10 +58,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'https://mydomain.io/users/123/details',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
},
metadata: {
source: 'route',
},
metadata: {},
name: 'GET /users/[id]/details',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -94,10 +94,9 @@ describe('sentryMiddleware', () => {
data: {
method: 'GET',
url: 'http://localhost:1234/a%xx',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
},
metadata: {
source: 'url',
},
metadata: {},
name: 'GET a%xx',
op: 'http.server',
origin: 'auto.http.astro',
Expand DownExpand Up@@ -159,8 +158,10 @@ describe('sentryMiddleware', () => {

expect(startSpanSpy).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
}),
metadata: {
source: 'route',
dynamicSamplingContext: {
release: '1.0.0',
},
Expand Down
4 changes: 3 additions & 1 deletion packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Transaction,
captureException,
continueTrace,
Expand DownExpand Up@@ -54,6 +55,7 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
const parsedUrl = parseUrl(request.url);
const data: Record<string, unknown> = {
'http.request.method': request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
data['http.query'] = parsedUrl.search;
Expand All@@ -72,8 +74,8 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
...ctx,
data,
metadata: {
// eslint-disable-next-line deprecation/deprecation
...ctx.metadata,
source: 'url',
request: {
url,
method: request.method,
Expand Down
1 change: 1 addition & 0 deletions packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,7 @@ describe('Bun Serve Integration', () => {
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.isRecording()).toBe(true);

// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ export type { ServerRuntimeClientOptions } from './server-runtime-client';
export type { RequestDataIntegrationOptions } from './integrations/requestdata';

export * from './tracing';
export * from './semanticAttributes';
export { createEventEnvelope, createSessionEnvelope } from './envelope';
export {
addBreadcrumb,
Expand Down
11 changes: 11 additions & 0 deletions packages/core/src/semanticAttributes.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
/**
* Use this attribute to represent the source of a span.
* Should be one of: custom, url, route, view, component, task, unknown
*
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SOURCE = 'sentry.source';

@AbhiPrasadAbhiPrasadJan 8, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be a good thing to put under a subpath export @sentry/core/attributes, let's give it a try in v8.


/**
* Use this attribute to represent the sample rate used for a span.
*/
export const SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE = 'sentry.sample_rate';
19 changes: 6 additions & 13 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type { Options, SamplingContext } from '@sentry/types';
import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE } from '../semanticAttributes';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanToJSON } from '../utils/spanUtils';
import type { Transaction } from './transaction';
Expand DownExpand Up@@ -30,10 +31,8 @@ export function sampleTransaction<T extends Transaction>(
// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
// eslint-disable-next-line deprecation/deprecation
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(transaction.sampled));
return transaction;
}

Expand All@@ -42,22 +41,16 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, Number(sampleRate));
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
sampleRate,
});
transaction.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate);
}

// Since this is coming from the user (or from a function provided by the user), who knows what we might get. (The
Expand Down
Loading