feat(core): Add spanGetMetadata() & spanSetMetadata() APIs#10041

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 2 commits into from
Closed

feat(core): Add spanGetMetadata() & spanSetMetadata() APIs #10041

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
558988e
feat(core): Add `spanGetMetadata()` & `spanSetMetadata()` APIs
mydea Jan 3, 2024
d34f47d
fix test
mydea Jan 5, 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@@ -64,6 +64,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.
* `transaction.setMetadata(metadata)`: Use `spanSetMetadata(span, metadata)` utility function instead.
* `transaction.metadata`: Use `spanGetMetadata(span)` utility function instead.

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

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 { spanSetMetadata } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -32,7 +33,7 @@ app.get('/test/express', (_req, res) => {
const transaction = Sentry.getCurrentHub().getScope().getTransaction();
if (transaction) {
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { 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
3 changes: 2 additions & 1 deletion 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 { spanSetMetadata } 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@@ -119,7 +120,7 @@ export class TraceService implements OnDestroy {
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
}
}),
);
Expand Down
7 changes: 5 additions & 2 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';

import * as SentryCore from '@sentry/core';
import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
import { AppComponent, TestEnv } from './utils/index';
Expand All@@ -11,7 +12,6 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
};

return transaction;
Expand All@@ -31,9 +31,12 @@ jest.mock('@sentry/browser', () => {
};
});

const mockSpanSetMetadata = jest.spyOn(SentryCore, 'spanSetMetadata');

describe('Angular Tracing', () => {
beforeEach(() => {
transaction = undefined;
mockSpanSetMetadata.mockClear();
});

describe('instrumentAngularRouting', () => {
Expand DownExpand Up@@ -329,7 +332,7 @@ describe('Angular Tracing', () => {
metadata: { source: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(mockSpanSetMetadata).toHaveBeenCalledWith(expect.anything(), { source: 'route' });

env.destroy();
});
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ export { createCheckInEnvelope } from './checkin';
export { hasTracingEnabled } from './utils/hasTracingEnabled';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { spanToTraceHeader } from './utils/spanUtils';
export { spanToTraceHeader, spanSetMetadata, spanGetMetadata } from './utils/spanUtils';
export { DEFAULT_ENVIRONMENT } from './constants';
export { ModuleMetadata } from './integrations/metadata';
export { RequestData } from './integrations/requestdata';
Expand Down
11 changes: 6 additions & 5 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanSetMetadata } from '../utils/spanUtils';
import type { Transaction } from './transaction';

/**
Expand All@@ -29,7 +30,7 @@ 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({
spanSetMetadata(transaction, {
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
Expand All@@ -41,20 +42,20 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate: Number(sampleRate),
});
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
spanSetMetadata(transaction, {
sampleRate,
});
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate,
});
}
Expand Down
48 changes: 36 additions & 12 deletions packages/core/src/tracing/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,12 @@ import { dropUndefinedKeys, logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../debug-build';
import type { Hub } from '../hub';
import { getCurrentHub } from '../hub';
import { spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { spanGetMetadata, spanSetMetadata, spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { getDynamicSamplingContextFromClient } from './dynamicSamplingContext';
import { Span as SpanClass, SpanRecorder } from './span';

/** JSDoc */
export class Transaction extends SpanClass implements TransactionInterface {
public metadata: TransactionMetadata;

/**
* The reference to the current hub.
*/
Expand DownExpand Up@@ -58,11 +56,11 @@ export class Transaction extends SpanClass implements TransactionInterface {

this._name = transactionContext.name || '';

this.metadata = {
spanSetMetadata(this, {
source: 'custom',
...transactionContext.metadata,
spanMetadata: {},
};
});

this._trimEnd = transactionContext.trimEnd;

Expand All@@ -71,13 +69,18 @@ export class Transaction extends SpanClass implements TransactionInterface {

// If Dynamic Sampling Context is provided during the creation of the transaction, we freeze it as it usually means
// there is incoming Dynamic Sampling Context. (Either through an incoming request, a baggage meta-tag, or other means)
const incomingDynamicSamplingContext = this.metadata.dynamicSamplingContext;
const incomingDynamicSamplingContext = (
spanGetMetadata(this) as { dynamicSamplingContext: DynamicSamplingContext | undefined }
).dynamicSamplingContext;
if (incomingDynamicSamplingContext) {
// We shallow copy this in case anything writes to the original reference of the passed in `dynamicSamplingContext`
this._frozenDynamicSamplingContext = { ...incomingDynamicSamplingContext };
}
}

// This sadly conflicts with the getter/setter ordering :(
/* eslint-disable @typescript-eslint/member-ordering */

/** Getter for `name` property */
public get name(): string {
return this._name;
Expand All@@ -91,14 +94,32 @@ export class Transaction extends SpanClass implements TransactionInterface {
this.setName(newName);
}

/**
* Get the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public get metadata(): TransactionMetadata {
return spanGetMetadata(this) as TransactionMetadata;
}

/**
* Update the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public set metadata(metadata: TransactionMetadata) {
spanSetMetadata(this, metadata);
}

/* eslint-enable @typescript-eslint/member-ordering */

/**
* Setter for `name` property, which also sets `source` on the metadata.
*
* @deprecated Use `updateName()` and `setMetadata()` instead.
*/
public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
this._name = name;
this.metadata.source = source;
spanSetMetadata(this, { source });
}

/** @inheritdoc */
Expand DownExpand Up@@ -138,10 +159,11 @@ export class Transaction extends SpanClass implements TransactionInterface {
}

/**
* @inheritDoc
* Set metadata for this transaction.
* @deprecated Use `spanSetMetadata(span, metadata)` instead.
*/
public setMetadata(newMetadata: Partial<TransactionMetadata>): void {
this.metadata = { ...this.metadata, ...newMetadata };
spanSetMetadata(this, newMetadata);
}

/**
Expand DownExpand Up@@ -202,13 +224,15 @@ export class Transaction extends SpanClass implements TransactionInterface {
const scope = hub.getScope();
const dsc = getDynamicSamplingContextFromClient(this.traceId, client, scope);

const maybeSampleRate = this.metadata.sampleRate;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const maybeSampleRate = metadata.sampleRate;
if (maybeSampleRate !== undefined) {
dsc.sample_rate = `${maybeSampleRate}`;
}

// We don't want to have a transaction name in the DSC if the source is "url" because URLs might contain PII
const source = this.metadata.source;
const source = metadata.source;
if (source && source !== 'url') {
dsc.transaction = this.name;
}
Expand DownExpand Up@@ -277,7 +301,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
}).endTimestamp;
}

const metadata = this.metadata;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const transaction: TransactionEvent = {
contexts: {
Expand Down
20 changes: 19 additions & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type { Span, SpanTimeInput, TraceContext } from '@sentry/types';
import type { Span, SpanMetadata, SpanTimeInput, TraceContext } from '@sentry/types';
import { dropUndefinedKeys, generateSentryTraceHeader, timestampInSeconds } from '@sentry/utils';

const SPAN_METADATA = new WeakMap<Span, SpanMetadata>();

/**
* Convert a span to a trace context, which can be sent as the `trace` context in an event.
*/
Expand DownExpand Up@@ -54,3 +56,19 @@ function ensureTimestampInSeconds(timestamp: number): number {
const isMs = timestamp > 9999999999;
return isMs ? timestamp / 1000 : timestamp;
}

/**
* Get the metadata for a span.
*/
export function spanGetMetadata(span: Span): SpanMetadata {
return SPAN_METADATA.get(span) || {};
}

/**
* Update metadata for a span.
* This will merge the given new metadata with existing metadata.
*/
export function spanSetMetadata(span: Span, newMetadata: SpanMetadata): void {
const existingMetadata = spanGetMetadata(span);
SPAN_METADATA.set(span, { ...existingMetadata, ...newMetadata });
}
12 changes: 7 additions & 5 deletions packages/core/test/lib/tracing/transaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { Transaction } from '../../../src';
import { spanSetMetadata } from '../../../src/utils/spanUtils';

describe('transaction', () => {
it('works with name', () => {
Expand All@@ -8,37 +9,38 @@ describe('transaction', () => {

it('allows to update the name via setter', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.name = 'new name';

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via setName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.setMetadata({ source: 'route' });

// eslint-disable-next-line deprecation/deprecation
transaction.setName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via updateName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.updateName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('route');
});
});
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): Add spanGetMetadata() & spanSetMetadata() APIs#10041

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 2 commits into from
Closed

feat(core): Add spanGetMetadata() & spanSetMetadata() APIs #10041

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
558988e
feat(core): Add `spanGetMetadata()` & `spanSetMetadata()` APIs
mydea Jan 3, 2024
d34f47d
fix test
mydea Jan 5, 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@@ -64,6 +64,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.
* `transaction.setMetadata(metadata)`: Use `spanSetMetadata(span, metadata)` utility function instead.
* `transaction.metadata`: Use `spanGetMetadata(span)` utility function instead.

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

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 { spanSetMetadata } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -32,7 +33,7 @@ app.get('/test/express', (_req, res) => {
const transaction = Sentry.getCurrentHub().getScope().getTransaction();
if (transaction) {
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { 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
3 changes: 2 additions & 1 deletion 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 { spanSetMetadata } 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@@ -119,7 +120,7 @@ export class TraceService implements OnDestroy {
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
}
}),
);
Expand Down
7 changes: 5 additions & 2 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';

import * as SentryCore from '@sentry/core';
import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
import { AppComponent, TestEnv } from './utils/index';
Expand All@@ -11,7 +12,6 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
};

return transaction;
Expand All@@ -31,9 +31,12 @@ jest.mock('@sentry/browser', () => {
};
});

const mockSpanSetMetadata = jest.spyOn(SentryCore, 'spanSetMetadata');

describe('Angular Tracing', () => {
beforeEach(() => {
transaction = undefined;
mockSpanSetMetadata.mockClear();
});

describe('instrumentAngularRouting', () => {
Expand DownExpand Up@@ -329,7 +332,7 @@ describe('Angular Tracing', () => {
metadata: { source: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(mockSpanSetMetadata).toHaveBeenCalledWith(expect.anything(), { source: 'route' });

env.destroy();
});
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ export { createCheckInEnvelope } from './checkin';
export { hasTracingEnabled } from './utils/hasTracingEnabled';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { spanToTraceHeader } from './utils/spanUtils';
export { spanToTraceHeader, spanSetMetadata, spanGetMetadata } from './utils/spanUtils';
export { DEFAULT_ENVIRONMENT } from './constants';
export { ModuleMetadata } from './integrations/metadata';
export { RequestData } from './integrations/requestdata';
Expand Down
11 changes: 6 additions & 5 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanSetMetadata } from '../utils/spanUtils';
import type { Transaction } from './transaction';

/**
Expand All@@ -29,7 +30,7 @@ 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({
spanSetMetadata(transaction, {
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
Expand All@@ -41,20 +42,20 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate: Number(sampleRate),
});
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
spanSetMetadata(transaction, {
sampleRate,
});
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate,
});
}
Expand Down
48 changes: 36 additions & 12 deletions packages/core/src/tracing/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,12 @@ import { dropUndefinedKeys, logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../debug-build';
import type { Hub } from '../hub';
import { getCurrentHub } from '../hub';
import { spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { spanGetMetadata, spanSetMetadata, spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { getDynamicSamplingContextFromClient } from './dynamicSamplingContext';
import { Span as SpanClass, SpanRecorder } from './span';

/** JSDoc */
export class Transaction extends SpanClass implements TransactionInterface {
public metadata: TransactionMetadata;

/**
* The reference to the current hub.
*/
Expand DownExpand Up@@ -58,11 +56,11 @@ export class Transaction extends SpanClass implements TransactionInterface {

this._name = transactionContext.name || '';

this.metadata = {
spanSetMetadata(this, {
source: 'custom',
...transactionContext.metadata,
spanMetadata: {},
};
});

this._trimEnd = transactionContext.trimEnd;

Expand All@@ -71,13 +69,18 @@ export class Transaction extends SpanClass implements TransactionInterface {

// If Dynamic Sampling Context is provided during the creation of the transaction, we freeze it as it usually means
// there is incoming Dynamic Sampling Context. (Either through an incoming request, a baggage meta-tag, or other means)
const incomingDynamicSamplingContext = this.metadata.dynamicSamplingContext;
const incomingDynamicSamplingContext = (
spanGetMetadata(this) as { dynamicSamplingContext: DynamicSamplingContext | undefined }
).dynamicSamplingContext;
if (incomingDynamicSamplingContext) {
// We shallow copy this in case anything writes to the original reference of the passed in `dynamicSamplingContext`
this._frozenDynamicSamplingContext = { ...incomingDynamicSamplingContext };
}
}

// This sadly conflicts with the getter/setter ordering :(
/* eslint-disable @typescript-eslint/member-ordering */

/** Getter for `name` property */
public get name(): string {
return this._name;
Expand All@@ -91,14 +94,32 @@ export class Transaction extends SpanClass implements TransactionInterface {
this.setName(newName);
}

/**
* Get the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public get metadata(): TransactionMetadata {
return spanGetMetadata(this) as TransactionMetadata;
}

/**
* Update the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public set metadata(metadata: TransactionMetadata) {
spanSetMetadata(this, metadata);
}

/* eslint-enable @typescript-eslint/member-ordering */

/**
* Setter for `name` property, which also sets `source` on the metadata.
*
* @deprecated Use `updateName()` and `setMetadata()` instead.
*/
public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
this._name = name;
this.metadata.source = source;
spanSetMetadata(this, { source });
}

/** @inheritdoc */
Expand DownExpand Up@@ -138,10 +159,11 @@ export class Transaction extends SpanClass implements TransactionInterface {
}

/**
* @inheritDoc
* Set metadata for this transaction.
* @deprecated Use `spanSetMetadata(span, metadata)` instead.
*/
public setMetadata(newMetadata: Partial<TransactionMetadata>): void {
this.metadata = { ...this.metadata, ...newMetadata };
spanSetMetadata(this, newMetadata);
}

/**
Expand DownExpand Up@@ -202,13 +224,15 @@ export class Transaction extends SpanClass implements TransactionInterface {
const scope = hub.getScope();
const dsc = getDynamicSamplingContextFromClient(this.traceId, client, scope);

const maybeSampleRate = this.metadata.sampleRate;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const maybeSampleRate = metadata.sampleRate;
if (maybeSampleRate !== undefined) {
dsc.sample_rate = `${maybeSampleRate}`;
}

// We don't want to have a transaction name in the DSC if the source is "url" because URLs might contain PII
const source = this.metadata.source;
const source = metadata.source;
if (source && source !== 'url') {
dsc.transaction = this.name;
}
Expand DownExpand Up@@ -277,7 +301,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
}).endTimestamp;
}

const metadata = this.metadata;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const transaction: TransactionEvent = {
contexts: {
Expand Down
20 changes: 19 additions & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type { Span, SpanTimeInput, TraceContext } from '@sentry/types';
import type { Span, SpanMetadata, SpanTimeInput, TraceContext } from '@sentry/types';
import { dropUndefinedKeys, generateSentryTraceHeader, timestampInSeconds } from '@sentry/utils';

const SPAN_METADATA = new WeakMap<Span, SpanMetadata>();

/**
* Convert a span to a trace context, which can be sent as the `trace` context in an event.
*/
Expand DownExpand Up@@ -54,3 +56,19 @@ function ensureTimestampInSeconds(timestamp: number): number {
const isMs = timestamp > 9999999999;
return isMs ? timestamp / 1000 : timestamp;
}

/**
* Get the metadata for a span.
*/
export function spanGetMetadata(span: Span): SpanMetadata {
return SPAN_METADATA.get(span) || {};
}

/**
* Update metadata for a span.
* This will merge the given new metadata with existing metadata.
*/
export function spanSetMetadata(span: Span, newMetadata: SpanMetadata): void {
const existingMetadata = spanGetMetadata(span);
SPAN_METADATA.set(span, { ...existingMetadata, ...newMetadata });
}
12 changes: 7 additions & 5 deletions packages/core/test/lib/tracing/transaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { Transaction } from '../../../src';
import { spanSetMetadata } from '../../../src/utils/spanUtils';

describe('transaction', () => {
it('works with name', () => {
Expand All@@ -8,37 +9,38 @@ describe('transaction', () => {

it('allows to update the name via setter', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.name = 'new name';

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via setName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.setMetadata({ source: 'route' });

// eslint-disable-next-line deprecation/deprecation
transaction.setName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via updateName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.updateName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('route');
});
});
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): Add spanGetMetadata() & spanSetMetadata() APIs#10041

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 2 commits into from
Closed

feat(core): Add spanGetMetadata() & spanSetMetadata() APIs #10041

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
558988e
feat(core): Add `spanGetMetadata()` & `spanSetMetadata()` APIs
mydea Jan 3, 2024
d34f47d
fix test
mydea Jan 5, 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@@ -64,6 +64,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.
* `transaction.setMetadata(metadata)`: Use `spanSetMetadata(span, metadata)` utility function instead.
* `transaction.metadata`: Use `spanGetMetadata(span)` utility function instead.

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

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 { spanSetMetadata } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -32,7 +33,7 @@ app.get('/test/express', (_req, res) => {
const transaction = Sentry.getCurrentHub().getScope().getTransaction();
if (transaction) {
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { 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
3 changes: 2 additions & 1 deletion 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 { spanSetMetadata } 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@@ -119,7 +120,7 @@ export class TraceService implements OnDestroy {
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
}
}),
);
Expand Down
7 changes: 5 additions & 2 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';

import * as SentryCore from '@sentry/core';
import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
import { AppComponent, TestEnv } from './utils/index';
Expand All@@ -11,7 +12,6 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
};

return transaction;
Expand All@@ -31,9 +31,12 @@ jest.mock('@sentry/browser', () => {
};
});

const mockSpanSetMetadata = jest.spyOn(SentryCore, 'spanSetMetadata');

describe('Angular Tracing', () => {
beforeEach(() => {
transaction = undefined;
mockSpanSetMetadata.mockClear();
});

describe('instrumentAngularRouting', () => {
Expand DownExpand Up@@ -329,7 +332,7 @@ describe('Angular Tracing', () => {
metadata: { source: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(mockSpanSetMetadata).toHaveBeenCalledWith(expect.anything(), { source: 'route' });

env.destroy();
});
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ export { createCheckInEnvelope } from './checkin';
export { hasTracingEnabled } from './utils/hasTracingEnabled';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { spanToTraceHeader } from './utils/spanUtils';
export { spanToTraceHeader, spanSetMetadata, spanGetMetadata } from './utils/spanUtils';
export { DEFAULT_ENVIRONMENT } from './constants';
export { ModuleMetadata } from './integrations/metadata';
export { RequestData } from './integrations/requestdata';
Expand Down
11 changes: 6 additions & 5 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanSetMetadata } from '../utils/spanUtils';
import type { Transaction } from './transaction';

/**
Expand All@@ -29,7 +30,7 @@ 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({
spanSetMetadata(transaction, {
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
Expand All@@ -41,20 +42,20 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate: Number(sampleRate),
});
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
spanSetMetadata(transaction, {
sampleRate,
});
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate,
});
}
Expand Down
48 changes: 36 additions & 12 deletions packages/core/src/tracing/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,12 @@ import { dropUndefinedKeys, logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../debug-build';
import type { Hub } from '../hub';
import { getCurrentHub } from '../hub';
import { spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { spanGetMetadata, spanSetMetadata, spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { getDynamicSamplingContextFromClient } from './dynamicSamplingContext';
import { Span as SpanClass, SpanRecorder } from './span';

/** JSDoc */
export class Transaction extends SpanClass implements TransactionInterface {
public metadata: TransactionMetadata;

/**
* The reference to the current hub.
*/
Expand DownExpand Up@@ -58,11 +56,11 @@ export class Transaction extends SpanClass implements TransactionInterface {

this._name = transactionContext.name || '';

this.metadata = {
spanSetMetadata(this, {
source: 'custom',
...transactionContext.metadata,
spanMetadata: {},
};
});

this._trimEnd = transactionContext.trimEnd;

Expand All@@ -71,13 +69,18 @@ export class Transaction extends SpanClass implements TransactionInterface {

// If Dynamic Sampling Context is provided during the creation of the transaction, we freeze it as it usually means
// there is incoming Dynamic Sampling Context. (Either through an incoming request, a baggage meta-tag, or other means)
const incomingDynamicSamplingContext = this.metadata.dynamicSamplingContext;
const incomingDynamicSamplingContext = (
spanGetMetadata(this) as { dynamicSamplingContext: DynamicSamplingContext | undefined }
).dynamicSamplingContext;
if (incomingDynamicSamplingContext) {
// We shallow copy this in case anything writes to the original reference of the passed in `dynamicSamplingContext`
this._frozenDynamicSamplingContext = { ...incomingDynamicSamplingContext };
}
}

// This sadly conflicts with the getter/setter ordering :(
/* eslint-disable @typescript-eslint/member-ordering */

/** Getter for `name` property */
public get name(): string {
return this._name;
Expand All@@ -91,14 +94,32 @@ export class Transaction extends SpanClass implements TransactionInterface {
this.setName(newName);
}

/**
* Get the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public get metadata(): TransactionMetadata {
return spanGetMetadata(this) as TransactionMetadata;
}

/**
* Update the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public set metadata(metadata: TransactionMetadata) {
spanSetMetadata(this, metadata);
}

/* eslint-enable @typescript-eslint/member-ordering */

/**
* Setter for `name` property, which also sets `source` on the metadata.
*
* @deprecated Use `updateName()` and `setMetadata()` instead.
*/
public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
this._name = name;
this.metadata.source = source;
spanSetMetadata(this, { source });
}

/** @inheritdoc */
Expand DownExpand Up@@ -138,10 +159,11 @@ export class Transaction extends SpanClass implements TransactionInterface {
}

/**
* @inheritDoc
* Set metadata for this transaction.
* @deprecated Use `spanSetMetadata(span, metadata)` instead.
*/
public setMetadata(newMetadata: Partial<TransactionMetadata>): void {
this.metadata = { ...this.metadata, ...newMetadata };
spanSetMetadata(this, newMetadata);
}

/**
Expand DownExpand Up@@ -202,13 +224,15 @@ export class Transaction extends SpanClass implements TransactionInterface {
const scope = hub.getScope();
const dsc = getDynamicSamplingContextFromClient(this.traceId, client, scope);

const maybeSampleRate = this.metadata.sampleRate;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const maybeSampleRate = metadata.sampleRate;
if (maybeSampleRate !== undefined) {
dsc.sample_rate = `${maybeSampleRate}`;
}

// We don't want to have a transaction name in the DSC if the source is "url" because URLs might contain PII
const source = this.metadata.source;
const source = metadata.source;
if (source && source !== 'url') {
dsc.transaction = this.name;
}
Expand DownExpand Up@@ -277,7 +301,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
}).endTimestamp;
}

const metadata = this.metadata;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const transaction: TransactionEvent = {
contexts: {
Expand Down
20 changes: 19 additions & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type { Span, SpanTimeInput, TraceContext } from '@sentry/types';
import type { Span, SpanMetadata, SpanTimeInput, TraceContext } from '@sentry/types';
import { dropUndefinedKeys, generateSentryTraceHeader, timestampInSeconds } from '@sentry/utils';

const SPAN_METADATA = new WeakMap<Span, SpanMetadata>();

/**
* Convert a span to a trace context, which can be sent as the `trace` context in an event.
*/
Expand DownExpand Up@@ -54,3 +56,19 @@ function ensureTimestampInSeconds(timestamp: number): number {
const isMs = timestamp > 9999999999;
return isMs ? timestamp / 1000 : timestamp;
}

/**
* Get the metadata for a span.
*/
export function spanGetMetadata(span: Span): SpanMetadata {
return SPAN_METADATA.get(span) || {};
}

/**
* Update metadata for a span.
* This will merge the given new metadata with existing metadata.
*/
export function spanSetMetadata(span: Span, newMetadata: SpanMetadata): void {
const existingMetadata = spanGetMetadata(span);
SPAN_METADATA.set(span, { ...existingMetadata, ...newMetadata });
}
12 changes: 7 additions & 5 deletions packages/core/test/lib/tracing/transaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { Transaction } from '../../../src';
import { spanSetMetadata } from '../../../src/utils/spanUtils';

describe('transaction', () => {
it('works with name', () => {
Expand All@@ -8,37 +9,38 @@ describe('transaction', () => {

it('allows to update the name via setter', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.name = 'new name';

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via setName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.setMetadata({ source: 'route' });

// eslint-disable-next-line deprecation/deprecation
transaction.setName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via updateName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.updateName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('route');
});
});
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): Add spanGetMetadata() & spanSetMetadata() APIs#10041

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 2 commits into from
Closed

feat(core): Add spanGetMetadata() & spanSetMetadata() APIs #10041

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
558988e
feat(core): Add `spanGetMetadata()` & `spanSetMetadata()` APIs
mydea Jan 3, 2024
d34f47d
fix test
mydea Jan 5, 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@@ -64,6 +64,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.
* `transaction.setMetadata(metadata)`: Use `spanSetMetadata(span, metadata)` utility function instead.
* `transaction.metadata`: Use `spanGetMetadata(span)` utility function instead.

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

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 { spanSetMetadata } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -32,7 +33,7 @@ app.get('/test/express', (_req, res) => {
const transaction = Sentry.getCurrentHub().getScope().getTransaction();
if (transaction) {
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { 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
3 changes: 2 additions & 1 deletion 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 { spanSetMetadata } 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@@ -119,7 +120,7 @@ export class TraceService implements OnDestroy {
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
}
}),
);
Expand Down
7 changes: 5 additions & 2 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';

import * as SentryCore from '@sentry/core';
import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
import { AppComponent, TestEnv } from './utils/index';
Expand All@@ -11,7 +12,6 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
};

return transaction;
Expand All@@ -31,9 +31,12 @@ jest.mock('@sentry/browser', () => {
};
});

const mockSpanSetMetadata = jest.spyOn(SentryCore, 'spanSetMetadata');

describe('Angular Tracing', () => {
beforeEach(() => {
transaction = undefined;
mockSpanSetMetadata.mockClear();
});

describe('instrumentAngularRouting', () => {
Expand DownExpand Up@@ -329,7 +332,7 @@ describe('Angular Tracing', () => {
metadata: { source: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(mockSpanSetMetadata).toHaveBeenCalledWith(expect.anything(), { source: 'route' });

env.destroy();
});
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ export { createCheckInEnvelope } from './checkin';
export { hasTracingEnabled } from './utils/hasTracingEnabled';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { spanToTraceHeader } from './utils/spanUtils';
export { spanToTraceHeader, spanSetMetadata, spanGetMetadata } from './utils/spanUtils';
export { DEFAULT_ENVIRONMENT } from './constants';
export { ModuleMetadata } from './integrations/metadata';
export { RequestData } from './integrations/requestdata';
Expand Down
11 changes: 6 additions & 5 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanSetMetadata } from '../utils/spanUtils';
import type { Transaction } from './transaction';

/**
Expand All@@ -29,7 +30,7 @@ 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({
spanSetMetadata(transaction, {
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
Expand All@@ -41,20 +42,20 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate: Number(sampleRate),
});
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
spanSetMetadata(transaction, {
sampleRate,
});
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate,
});
}
Expand Down
48 changes: 36 additions & 12 deletions packages/core/src/tracing/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,12 @@ import { dropUndefinedKeys, logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../debug-build';
import type { Hub } from '../hub';
import { getCurrentHub } from '../hub';
import { spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { spanGetMetadata, spanSetMetadata, spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { getDynamicSamplingContextFromClient } from './dynamicSamplingContext';
import { Span as SpanClass, SpanRecorder } from './span';

/** JSDoc */
export class Transaction extends SpanClass implements TransactionInterface {
public metadata: TransactionMetadata;

/**
* The reference to the current hub.
*/
Expand DownExpand Up@@ -58,11 +56,11 @@ export class Transaction extends SpanClass implements TransactionInterface {

this._name = transactionContext.name || '';

this.metadata = {
spanSetMetadata(this, {
source: 'custom',
...transactionContext.metadata,
spanMetadata: {},
};
});

this._trimEnd = transactionContext.trimEnd;

Expand All@@ -71,13 +69,18 @@ export class Transaction extends SpanClass implements TransactionInterface {

// If Dynamic Sampling Context is provided during the creation of the transaction, we freeze it as it usually means
// there is incoming Dynamic Sampling Context. (Either through an incoming request, a baggage meta-tag, or other means)
const incomingDynamicSamplingContext = this.metadata.dynamicSamplingContext;
const incomingDynamicSamplingContext = (
spanGetMetadata(this) as { dynamicSamplingContext: DynamicSamplingContext | undefined }
).dynamicSamplingContext;
if (incomingDynamicSamplingContext) {
// We shallow copy this in case anything writes to the original reference of the passed in `dynamicSamplingContext`
this._frozenDynamicSamplingContext = { ...incomingDynamicSamplingContext };
}
}

// This sadly conflicts with the getter/setter ordering :(
/* eslint-disable @typescript-eslint/member-ordering */

/** Getter for `name` property */
public get name(): string {
return this._name;
Expand All@@ -91,14 +94,32 @@ export class Transaction extends SpanClass implements TransactionInterface {
this.setName(newName);
}

/**
* Get the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public get metadata(): TransactionMetadata {
return spanGetMetadata(this) as TransactionMetadata;
}

/**
* Update the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public set metadata(metadata: TransactionMetadata) {
spanSetMetadata(this, metadata);
}

/* eslint-enable @typescript-eslint/member-ordering */

/**
* Setter for `name` property, which also sets `source` on the metadata.
*
* @deprecated Use `updateName()` and `setMetadata()` instead.
*/
public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
this._name = name;
this.metadata.source = source;
spanSetMetadata(this, { source });
}

/** @inheritdoc */
Expand DownExpand Up@@ -138,10 +159,11 @@ export class Transaction extends SpanClass implements TransactionInterface {
}

/**
* @inheritDoc
* Set metadata for this transaction.
* @deprecated Use `spanSetMetadata(span, metadata)` instead.
*/
public setMetadata(newMetadata: Partial<TransactionMetadata>): void {
this.metadata = { ...this.metadata, ...newMetadata };
spanSetMetadata(this, newMetadata);
}

/**
Expand DownExpand Up@@ -202,13 +224,15 @@ export class Transaction extends SpanClass implements TransactionInterface {
const scope = hub.getScope();
const dsc = getDynamicSamplingContextFromClient(this.traceId, client, scope);

const maybeSampleRate = this.metadata.sampleRate;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const maybeSampleRate = metadata.sampleRate;
if (maybeSampleRate !== undefined) {
dsc.sample_rate = `${maybeSampleRate}`;
}

// We don't want to have a transaction name in the DSC if the source is "url" because URLs might contain PII
const source = this.metadata.source;
const source = metadata.source;
if (source && source !== 'url') {
dsc.transaction = this.name;
}
Expand DownExpand Up@@ -277,7 +301,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
}).endTimestamp;
}

const metadata = this.metadata;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const transaction: TransactionEvent = {
contexts: {
Expand Down
20 changes: 19 additions & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type { Span, SpanTimeInput, TraceContext } from '@sentry/types';
import type { Span, SpanMetadata, SpanTimeInput, TraceContext } from '@sentry/types';
import { dropUndefinedKeys, generateSentryTraceHeader, timestampInSeconds } from '@sentry/utils';

const SPAN_METADATA = new WeakMap<Span, SpanMetadata>();

/**
* Convert a span to a trace context, which can be sent as the `trace` context in an event.
*/
Expand DownExpand Up@@ -54,3 +56,19 @@ function ensureTimestampInSeconds(timestamp: number): number {
const isMs = timestamp > 9999999999;
return isMs ? timestamp / 1000 : timestamp;
}

/**
* Get the metadata for a span.
*/
export function spanGetMetadata(span: Span): SpanMetadata {
return SPAN_METADATA.get(span) || {};
}

/**
* Update metadata for a span.
* This will merge the given new metadata with existing metadata.
*/
export function spanSetMetadata(span: Span, newMetadata: SpanMetadata): void {
const existingMetadata = spanGetMetadata(span);
SPAN_METADATA.set(span, { ...existingMetadata, ...newMetadata });
}
12 changes: 7 additions & 5 deletions packages/core/test/lib/tracing/transaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { Transaction } from '../../../src';
import { spanSetMetadata } from '../../../src/utils/spanUtils';

describe('transaction', () => {
it('works with name', () => {
Expand All@@ -8,37 +9,38 @@ describe('transaction', () => {

it('allows to update the name via setter', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.name = 'new name';

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via setName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.setMetadata({ source: 'route' });

// eslint-disable-next-line deprecation/deprecation
transaction.setName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via updateName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.updateName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('route');
});
});
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): Add spanGetMetadata() & spanSetMetadata() APIs#10041

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 2 commits into from
Closed

feat(core): Add spanGetMetadata() & spanSetMetadata() APIs #10041

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
558988e
feat(core): Add `spanGetMetadata()` & `spanSetMetadata()` APIs
mydea Jan 3, 2024
d34f47d
fix test
mydea Jan 5, 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@@ -64,6 +64,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.
* `transaction.setMetadata(metadata)`: Use `spanSetMetadata(span, metadata)` utility function instead.
* `transaction.metadata`: Use `spanGetMetadata(span)` utility function instead.

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

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 { spanSetMetadata } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -32,7 +33,7 @@ app.get('/test/express', (_req, res) => {
const transaction = Sentry.getCurrentHub().getScope().getTransaction();
if (transaction) {
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { 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
3 changes: 2 additions & 1 deletion 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 { spanSetMetadata } 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@@ -119,7 +120,7 @@ export class TraceService implements OnDestroy {
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
}
}),
);
Expand Down
7 changes: 5 additions & 2 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';

import * as SentryCore from '@sentry/core';
import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
import { AppComponent, TestEnv } from './utils/index';
Expand All@@ -11,7 +12,6 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
};

return transaction;
Expand All@@ -31,9 +31,12 @@ jest.mock('@sentry/browser', () => {
};
});

const mockSpanSetMetadata = jest.spyOn(SentryCore, 'spanSetMetadata');

describe('Angular Tracing', () => {
beforeEach(() => {
transaction = undefined;
mockSpanSetMetadata.mockClear();
});

describe('instrumentAngularRouting', () => {
Expand DownExpand Up@@ -329,7 +332,7 @@ describe('Angular Tracing', () => {
metadata: { source: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(mockSpanSetMetadata).toHaveBeenCalledWith(expect.anything(), { source: 'route' });

env.destroy();
});
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ export { createCheckInEnvelope } from './checkin';
export { hasTracingEnabled } from './utils/hasTracingEnabled';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { spanToTraceHeader } from './utils/spanUtils';
export { spanToTraceHeader, spanSetMetadata, spanGetMetadata } from './utils/spanUtils';
export { DEFAULT_ENVIRONMENT } from './constants';
export { ModuleMetadata } from './integrations/metadata';
export { RequestData } from './integrations/requestdata';
Expand Down
11 changes: 6 additions & 5 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanSetMetadata } from '../utils/spanUtils';
import type { Transaction } from './transaction';

/**
Expand All@@ -29,7 +30,7 @@ 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({
spanSetMetadata(transaction, {
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
Expand All@@ -41,20 +42,20 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate: Number(sampleRate),
});
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
spanSetMetadata(transaction, {
sampleRate,
});
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate,
});
}
Expand Down
48 changes: 36 additions & 12 deletions packages/core/src/tracing/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,12 @@ import { dropUndefinedKeys, logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../debug-build';
import type { Hub } from '../hub';
import { getCurrentHub } from '../hub';
import { spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { spanGetMetadata, spanSetMetadata, spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { getDynamicSamplingContextFromClient } from './dynamicSamplingContext';
import { Span as SpanClass, SpanRecorder } from './span';

/** JSDoc */
export class Transaction extends SpanClass implements TransactionInterface {
public metadata: TransactionMetadata;

/**
* The reference to the current hub.
*/
Expand DownExpand Up@@ -58,11 +56,11 @@ export class Transaction extends SpanClass implements TransactionInterface {

this._name = transactionContext.name || '';

this.metadata = {
spanSetMetadata(this, {
source: 'custom',
...transactionContext.metadata,
spanMetadata: {},
};
});

this._trimEnd = transactionContext.trimEnd;

Expand All@@ -71,13 +69,18 @@ export class Transaction extends SpanClass implements TransactionInterface {

// If Dynamic Sampling Context is provided during the creation of the transaction, we freeze it as it usually means
// there is incoming Dynamic Sampling Context. (Either through an incoming request, a baggage meta-tag, or other means)
const incomingDynamicSamplingContext = this.metadata.dynamicSamplingContext;
const incomingDynamicSamplingContext = (
spanGetMetadata(this) as { dynamicSamplingContext: DynamicSamplingContext | undefined }
).dynamicSamplingContext;
if (incomingDynamicSamplingContext) {
// We shallow copy this in case anything writes to the original reference of the passed in `dynamicSamplingContext`
this._frozenDynamicSamplingContext = { ...incomingDynamicSamplingContext };
}
}

// This sadly conflicts with the getter/setter ordering :(
/* eslint-disable @typescript-eslint/member-ordering */

/** Getter for `name` property */
public get name(): string {
return this._name;
Expand All@@ -91,14 +94,32 @@ export class Transaction extends SpanClass implements TransactionInterface {
this.setName(newName);
}

/**
* Get the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public get metadata(): TransactionMetadata {
return spanGetMetadata(this) as TransactionMetadata;
}

/**
* Update the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public set metadata(metadata: TransactionMetadata) {
spanSetMetadata(this, metadata);
}

/* eslint-enable @typescript-eslint/member-ordering */

/**
* Setter for `name` property, which also sets `source` on the metadata.
*
* @deprecated Use `updateName()` and `setMetadata()` instead.
*/
public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
this._name = name;
this.metadata.source = source;
spanSetMetadata(this, { source });
}

/** @inheritdoc */
Expand DownExpand Up@@ -138,10 +159,11 @@ export class Transaction extends SpanClass implements TransactionInterface {
}

/**
* @inheritDoc
* Set metadata for this transaction.
* @deprecated Use `spanSetMetadata(span, metadata)` instead.
*/
public setMetadata(newMetadata: Partial<TransactionMetadata>): void {
this.metadata = { ...this.metadata, ...newMetadata };
spanSetMetadata(this, newMetadata);
}

/**
Expand DownExpand Up@@ -202,13 +224,15 @@ export class Transaction extends SpanClass implements TransactionInterface {
const scope = hub.getScope();
const dsc = getDynamicSamplingContextFromClient(this.traceId, client, scope);

const maybeSampleRate = this.metadata.sampleRate;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const maybeSampleRate = metadata.sampleRate;
if (maybeSampleRate !== undefined) {
dsc.sample_rate = `${maybeSampleRate}`;
}

// We don't want to have a transaction name in the DSC if the source is "url" because URLs might contain PII
const source = this.metadata.source;
const source = metadata.source;
if (source && source !== 'url') {
dsc.transaction = this.name;
}
Expand DownExpand Up@@ -277,7 +301,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
}).endTimestamp;
}

const metadata = this.metadata;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const transaction: TransactionEvent = {
contexts: {
Expand Down
20 changes: 19 additions & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type { Span, SpanTimeInput, TraceContext } from '@sentry/types';
import type { Span, SpanMetadata, SpanTimeInput, TraceContext } from '@sentry/types';
import { dropUndefinedKeys, generateSentryTraceHeader, timestampInSeconds } from '@sentry/utils';

const SPAN_METADATA = new WeakMap<Span, SpanMetadata>();

/**
* Convert a span to a trace context, which can be sent as the `trace` context in an event.
*/
Expand DownExpand Up@@ -54,3 +56,19 @@ function ensureTimestampInSeconds(timestamp: number): number {
const isMs = timestamp > 9999999999;
return isMs ? timestamp / 1000 : timestamp;
}

/**
* Get the metadata for a span.
*/
export function spanGetMetadata(span: Span): SpanMetadata {
return SPAN_METADATA.get(span) || {};
}

/**
* Update metadata for a span.
* This will merge the given new metadata with existing metadata.
*/
export function spanSetMetadata(span: Span, newMetadata: SpanMetadata): void {
const existingMetadata = spanGetMetadata(span);
SPAN_METADATA.set(span, { ...existingMetadata, ...newMetadata });
}
12 changes: 7 additions & 5 deletions packages/core/test/lib/tracing/transaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { Transaction } from '../../../src';
import { spanSetMetadata } from '../../../src/utils/spanUtils';

describe('transaction', () => {
it('works with name', () => {
Expand All@@ -8,37 +9,38 @@ describe('transaction', () => {

it('allows to update the name via setter', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.name = 'new name';

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via setName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.setMetadata({ source: 'route' });

// eslint-disable-next-line deprecation/deprecation
transaction.setName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via updateName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.updateName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('route');
});
});
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): Add spanGetMetadata() & spanSetMetadata() APIs#10041

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 2 commits into from
Closed

feat(core): Add spanGetMetadata() & spanSetMetadata() APIs #10041

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
558988e
feat(core): Add `spanGetMetadata()` & `spanSetMetadata()` APIs
mydea Jan 3, 2024
d34f47d
fix test
mydea Jan 5, 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@@ -64,6 +64,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.
* `transaction.setMetadata(metadata)`: Use `spanSetMetadata(span, metadata)` utility function instead.
* `transaction.metadata`: Use `spanGetMetadata(span)` utility function instead.

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

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 { spanSetMetadata } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -32,7 +33,7 @@ app.get('/test/express', (_req, res) => {
const transaction = Sentry.getCurrentHub().getScope().getTransaction();
if (transaction) {
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { 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
3 changes: 2 additions & 1 deletion 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 { spanSetMetadata } 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@@ -119,7 +120,7 @@ export class TraceService implements OnDestroy {
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
}
}),
);
Expand Down
7 changes: 5 additions & 2 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';

import * as SentryCore from '@sentry/core';
import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
import { AppComponent, TestEnv } from './utils/index';
Expand All@@ -11,7 +12,6 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
};

return transaction;
Expand All@@ -31,9 +31,12 @@ jest.mock('@sentry/browser', () => {
};
});

const mockSpanSetMetadata = jest.spyOn(SentryCore, 'spanSetMetadata');

describe('Angular Tracing', () => {
beforeEach(() => {
transaction = undefined;
mockSpanSetMetadata.mockClear();
});

describe('instrumentAngularRouting', () => {
Expand DownExpand Up@@ -329,7 +332,7 @@ describe('Angular Tracing', () => {
metadata: { source: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(mockSpanSetMetadata).toHaveBeenCalledWith(expect.anything(), { source: 'route' });

env.destroy();
});
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ export { createCheckInEnvelope } from './checkin';
export { hasTracingEnabled } from './utils/hasTracingEnabled';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { spanToTraceHeader } from './utils/spanUtils';
export { spanToTraceHeader, spanSetMetadata, spanGetMetadata } from './utils/spanUtils';
export { DEFAULT_ENVIRONMENT } from './constants';
export { ModuleMetadata } from './integrations/metadata';
export { RequestData } from './integrations/requestdata';
Expand Down
11 changes: 6 additions & 5 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanSetMetadata } from '../utils/spanUtils';
import type { Transaction } from './transaction';

/**
Expand All@@ -29,7 +30,7 @@ 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({
spanSetMetadata(transaction, {
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
Expand All@@ -41,20 +42,20 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate: Number(sampleRate),
});
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
spanSetMetadata(transaction, {
sampleRate,
});
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate,
});
}
Expand Down
48 changes: 36 additions & 12 deletions packages/core/src/tracing/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,12 @@ import { dropUndefinedKeys, logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../debug-build';
import type { Hub } from '../hub';
import { getCurrentHub } from '../hub';
import { spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { spanGetMetadata, spanSetMetadata, spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { getDynamicSamplingContextFromClient } from './dynamicSamplingContext';
import { Span as SpanClass, SpanRecorder } from './span';

/** JSDoc */
export class Transaction extends SpanClass implements TransactionInterface {
public metadata: TransactionMetadata;

/**
* The reference to the current hub.
*/
Expand DownExpand Up@@ -58,11 +56,11 @@ export class Transaction extends SpanClass implements TransactionInterface {

this._name = transactionContext.name || '';

this.metadata = {
spanSetMetadata(this, {
source: 'custom',
...transactionContext.metadata,
spanMetadata: {},
};
});

this._trimEnd = transactionContext.trimEnd;

Expand All@@ -71,13 +69,18 @@ export class Transaction extends SpanClass implements TransactionInterface {

// If Dynamic Sampling Context is provided during the creation of the transaction, we freeze it as it usually means
// there is incoming Dynamic Sampling Context. (Either through an incoming request, a baggage meta-tag, or other means)
const incomingDynamicSamplingContext = this.metadata.dynamicSamplingContext;
const incomingDynamicSamplingContext = (
spanGetMetadata(this) as { dynamicSamplingContext: DynamicSamplingContext | undefined }
).dynamicSamplingContext;
if (incomingDynamicSamplingContext) {
// We shallow copy this in case anything writes to the original reference of the passed in `dynamicSamplingContext`
this._frozenDynamicSamplingContext = { ...incomingDynamicSamplingContext };
}
}

// This sadly conflicts with the getter/setter ordering :(
/* eslint-disable @typescript-eslint/member-ordering */

/** Getter for `name` property */
public get name(): string {
return this._name;
Expand All@@ -91,14 +94,32 @@ export class Transaction extends SpanClass implements TransactionInterface {
this.setName(newName);
}

/**
* Get the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public get metadata(): TransactionMetadata {
return spanGetMetadata(this) as TransactionMetadata;
}

/**
* Update the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public set metadata(metadata: TransactionMetadata) {
spanSetMetadata(this, metadata);
}

/* eslint-enable @typescript-eslint/member-ordering */

/**
* Setter for `name` property, which also sets `source` on the metadata.
*
* @deprecated Use `updateName()` and `setMetadata()` instead.
*/
public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
this._name = name;
this.metadata.source = source;
spanSetMetadata(this, { source });
}

/** @inheritdoc */
Expand DownExpand Up@@ -138,10 +159,11 @@ export class Transaction extends SpanClass implements TransactionInterface {
}

/**
* @inheritDoc
* Set metadata for this transaction.
* @deprecated Use `spanSetMetadata(span, metadata)` instead.
*/
public setMetadata(newMetadata: Partial<TransactionMetadata>): void {
this.metadata = { ...this.metadata, ...newMetadata };
spanSetMetadata(this, newMetadata);
}

/**
Expand DownExpand Up@@ -202,13 +224,15 @@ export class Transaction extends SpanClass implements TransactionInterface {
const scope = hub.getScope();
const dsc = getDynamicSamplingContextFromClient(this.traceId, client, scope);

const maybeSampleRate = this.metadata.sampleRate;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const maybeSampleRate = metadata.sampleRate;
if (maybeSampleRate !== undefined) {
dsc.sample_rate = `${maybeSampleRate}`;
}

// We don't want to have a transaction name in the DSC if the source is "url" because URLs might contain PII
const source = this.metadata.source;
const source = metadata.source;
if (source && source !== 'url') {
dsc.transaction = this.name;
}
Expand DownExpand Up@@ -277,7 +301,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
}).endTimestamp;
}

const metadata = this.metadata;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const transaction: TransactionEvent = {
contexts: {
Expand Down
20 changes: 19 additions & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type { Span, SpanTimeInput, TraceContext } from '@sentry/types';
import type { Span, SpanMetadata, SpanTimeInput, TraceContext } from '@sentry/types';
import { dropUndefinedKeys, generateSentryTraceHeader, timestampInSeconds } from '@sentry/utils';

const SPAN_METADATA = new WeakMap<Span, SpanMetadata>();

/**
* Convert a span to a trace context, which can be sent as the `trace` context in an event.
*/
Expand DownExpand Up@@ -54,3 +56,19 @@ function ensureTimestampInSeconds(timestamp: number): number {
const isMs = timestamp > 9999999999;
return isMs ? timestamp / 1000 : timestamp;
}

/**
* Get the metadata for a span.
*/
export function spanGetMetadata(span: Span): SpanMetadata {
return SPAN_METADATA.get(span) || {};
}

/**
* Update metadata for a span.
* This will merge the given new metadata with existing metadata.
*/
export function spanSetMetadata(span: Span, newMetadata: SpanMetadata): void {
const existingMetadata = spanGetMetadata(span);
SPAN_METADATA.set(span, { ...existingMetadata, ...newMetadata });
}
12 changes: 7 additions & 5 deletions packages/core/test/lib/tracing/transaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { Transaction } from '../../../src';
import { spanSetMetadata } from '../../../src/utils/spanUtils';

describe('transaction', () => {
it('works with name', () => {
Expand All@@ -8,37 +9,38 @@ describe('transaction', () => {

it('allows to update the name via setter', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.name = 'new name';

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via setName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.setMetadata({ source: 'route' });

// eslint-disable-next-line deprecation/deprecation
transaction.setName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via updateName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.updateName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('route');
});
});
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): Add spanGetMetadata() & spanSetMetadata() APIs#10041

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 2 commits into from
Closed

feat(core): Add spanGetMetadata() & spanSetMetadata() APIs #10041

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
558988e
feat(core): Add `spanGetMetadata()` & `spanSetMetadata()` APIs
mydea Jan 3, 2024
d34f47d
fix test
mydea Jan 5, 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@@ -64,6 +64,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.
* `transaction.setMetadata(metadata)`: Use `spanSetMetadata(span, metadata)` utility function instead.
* `transaction.metadata`: Use `spanGetMetadata(span)` utility function instead.

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

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 { spanSetMetadata } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -32,7 +33,7 @@ app.get('/test/express', (_req, res) => {
const transaction = Sentry.getCurrentHub().getScope().getTransaction();
if (transaction) {
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { 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
3 changes: 2 additions & 1 deletion 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 { spanSetMetadata } 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@@ -119,7 +120,7 @@ export class TraceService implements OnDestroy {
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
}
}),
);
Expand Down
7 changes: 5 additions & 2 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';

import * as SentryCore from '@sentry/core';
import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
import { AppComponent, TestEnv } from './utils/index';
Expand All@@ -11,7 +12,6 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
};

return transaction;
Expand All@@ -31,9 +31,12 @@ jest.mock('@sentry/browser', () => {
};
});

const mockSpanSetMetadata = jest.spyOn(SentryCore, 'spanSetMetadata');

describe('Angular Tracing', () => {
beforeEach(() => {
transaction = undefined;
mockSpanSetMetadata.mockClear();
});

describe('instrumentAngularRouting', () => {
Expand DownExpand Up@@ -329,7 +332,7 @@ describe('Angular Tracing', () => {
metadata: { source: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(mockSpanSetMetadata).toHaveBeenCalledWith(expect.anything(), { source: 'route' });

env.destroy();
});
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ export { createCheckInEnvelope } from './checkin';
export { hasTracingEnabled } from './utils/hasTracingEnabled';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { spanToTraceHeader } from './utils/spanUtils';
export { spanToTraceHeader, spanSetMetadata, spanGetMetadata } from './utils/spanUtils';
export { DEFAULT_ENVIRONMENT } from './constants';
export { ModuleMetadata } from './integrations/metadata';
export { RequestData } from './integrations/requestdata';
Expand Down
11 changes: 6 additions & 5 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanSetMetadata } from '../utils/spanUtils';
import type { Transaction } from './transaction';

/**
Expand All@@ -29,7 +30,7 @@ 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({
spanSetMetadata(transaction, {
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
Expand All@@ -41,20 +42,20 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate: Number(sampleRate),
});
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
spanSetMetadata(transaction, {
sampleRate,
});
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate,
});
}
Expand Down
48 changes: 36 additions & 12 deletions packages/core/src/tracing/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,12 @@ import { dropUndefinedKeys, logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../debug-build';
import type { Hub } from '../hub';
import { getCurrentHub } from '../hub';
import { spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { spanGetMetadata, spanSetMetadata, spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { getDynamicSamplingContextFromClient } from './dynamicSamplingContext';
import { Span as SpanClass, SpanRecorder } from './span';

/** JSDoc */
export class Transaction extends SpanClass implements TransactionInterface {
public metadata: TransactionMetadata;

/**
* The reference to the current hub.
*/
Expand DownExpand Up@@ -58,11 +56,11 @@ export class Transaction extends SpanClass implements TransactionInterface {

this._name = transactionContext.name || '';

this.metadata = {
spanSetMetadata(this, {
source: 'custom',
...transactionContext.metadata,
spanMetadata: {},
};
});

this._trimEnd = transactionContext.trimEnd;

Expand All@@ -71,13 +69,18 @@ export class Transaction extends SpanClass implements TransactionInterface {

// If Dynamic Sampling Context is provided during the creation of the transaction, we freeze it as it usually means
// there is incoming Dynamic Sampling Context. (Either through an incoming request, a baggage meta-tag, or other means)
const incomingDynamicSamplingContext = this.metadata.dynamicSamplingContext;
const incomingDynamicSamplingContext = (
spanGetMetadata(this) as { dynamicSamplingContext: DynamicSamplingContext | undefined }
).dynamicSamplingContext;
if (incomingDynamicSamplingContext) {
// We shallow copy this in case anything writes to the original reference of the passed in `dynamicSamplingContext`
this._frozenDynamicSamplingContext = { ...incomingDynamicSamplingContext };
}
}

// This sadly conflicts with the getter/setter ordering :(
/* eslint-disable @typescript-eslint/member-ordering */

/** Getter for `name` property */
public get name(): string {
return this._name;
Expand All@@ -91,14 +94,32 @@ export class Transaction extends SpanClass implements TransactionInterface {
this.setName(newName);
}

/**
* Get the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public get metadata(): TransactionMetadata {
return spanGetMetadata(this) as TransactionMetadata;
}

/**
* Update the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public set metadata(metadata: TransactionMetadata) {
spanSetMetadata(this, metadata);
}

/* eslint-enable @typescript-eslint/member-ordering */

/**
* Setter for `name` property, which also sets `source` on the metadata.
*
* @deprecated Use `updateName()` and `setMetadata()` instead.
*/
public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
this._name = name;
this.metadata.source = source;
spanSetMetadata(this, { source });
}

/** @inheritdoc */
Expand DownExpand Up@@ -138,10 +159,11 @@ export class Transaction extends SpanClass implements TransactionInterface {
}

/**
* @inheritDoc
* Set metadata for this transaction.
* @deprecated Use `spanSetMetadata(span, metadata)` instead.
*/
public setMetadata(newMetadata: Partial<TransactionMetadata>): void {
this.metadata = { ...this.metadata, ...newMetadata };
spanSetMetadata(this, newMetadata);
}

/**
Expand DownExpand Up@@ -202,13 +224,15 @@ export class Transaction extends SpanClass implements TransactionInterface {
const scope = hub.getScope();
const dsc = getDynamicSamplingContextFromClient(this.traceId, client, scope);

const maybeSampleRate = this.metadata.sampleRate;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const maybeSampleRate = metadata.sampleRate;
if (maybeSampleRate !== undefined) {
dsc.sample_rate = `${maybeSampleRate}`;
}

// We don't want to have a transaction name in the DSC if the source is "url" because URLs might contain PII
const source = this.metadata.source;
const source = metadata.source;
if (source && source !== 'url') {
dsc.transaction = this.name;
}
Expand DownExpand Up@@ -277,7 +301,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
}).endTimestamp;
}

const metadata = this.metadata;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const transaction: TransactionEvent = {
contexts: {
Expand Down
20 changes: 19 additions & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type { Span, SpanTimeInput, TraceContext } from '@sentry/types';
import type { Span, SpanMetadata, SpanTimeInput, TraceContext } from '@sentry/types';
import { dropUndefinedKeys, generateSentryTraceHeader, timestampInSeconds } from '@sentry/utils';

const SPAN_METADATA = new WeakMap<Span, SpanMetadata>();

/**
* Convert a span to a trace context, which can be sent as the `trace` context in an event.
*/
Expand DownExpand Up@@ -54,3 +56,19 @@ function ensureTimestampInSeconds(timestamp: number): number {
const isMs = timestamp > 9999999999;
return isMs ? timestamp / 1000 : timestamp;
}

/**
* Get the metadata for a span.
*/
export function spanGetMetadata(span: Span): SpanMetadata {
return SPAN_METADATA.get(span) || {};
}

/**
* Update metadata for a span.
* This will merge the given new metadata with existing metadata.
*/
export function spanSetMetadata(span: Span, newMetadata: SpanMetadata): void {
const existingMetadata = spanGetMetadata(span);
SPAN_METADATA.set(span, { ...existingMetadata, ...newMetadata });
}
12 changes: 7 additions & 5 deletions packages/core/test/lib/tracing/transaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { Transaction } from '../../../src';
import { spanSetMetadata } from '../../../src/utils/spanUtils';

describe('transaction', () => {
it('works with name', () => {
Expand All@@ -8,37 +9,38 @@ describe('transaction', () => {

it('allows to update the name via setter', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.name = 'new name';

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via setName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.setMetadata({ source: 'route' });

// eslint-disable-next-line deprecation/deprecation
transaction.setName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via updateName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.updateName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('route');
});
});
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): Add spanGetMetadata() & spanSetMetadata() APIs#10041

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
mydea wants to merge 2 commits into from
Closed

feat(core): Add spanGetMetadata() & spanSetMetadata() APIs #10041

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
558988e
feat(core): Add `spanGetMetadata()` & `spanSetMetadata()` APIs
mydea Jan 3, 2024
d34f47d
fix test
mydea Jan 5, 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@@ -64,6 +64,8 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.
* `transaction.setMetadata(metadata)`: Use `spanSetMetadata(span, metadata)` utility function instead.
* `transaction.metadata`: Use `spanGetMetadata(span)` utility function instead.

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

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 { spanSetMetadata } from '@sentry/core';
import * as Sentry from '@sentry/node';
import * as Tracing from '@sentry/tracing';
import cors from 'cors';
Expand DownExpand Up@@ -32,7 +33,7 @@ app.get('/test/express', (_req, res) => {
const transaction = Sentry.getCurrentHub().getScope().getTransaction();
if (transaction) {
transaction.traceId = '86f39e84263a4de99c326acab3bfe3bd';
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { 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
3 changes: 2 additions & 1 deletion 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 { spanSetMetadata } 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@@ -119,7 +120,7 @@ export class TraceService implements OnDestroy {
// TODO (v8 / #5416): revisit the source condition. Do we want to make the parameterized route the default?
if (transaction && transaction.metadata.source === 'url') {
transaction.updateName(route);
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
}
}),
);
Expand Down
7 changes: 5 additions & 2 deletions packages/angular/test/tracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { Component } from '@angular/core';
import type { ActivatedRouteSnapshot, CanActivate, RouterStateSnapshot } from '@angular/router';

import * as SentryCore from '@sentry/core';
import { TraceClassDecorator, TraceDirective, TraceMethodDecorator, instrumentAngularRouting } from '../src';
import { getParameterizedRouteFromSnapshot } from '../src/tracing';
import { AppComponent, TestEnv } from './utils/index';
Expand All@@ -11,7 +12,6 @@ const defaultStartTransaction = (ctx: any) => {
transaction = {
...ctx,
updateName: jest.fn(name => (transaction.name = name)),
setMetadata: jest.fn(),
};

return transaction;
Expand All@@ -31,9 +31,12 @@ jest.mock('@sentry/browser', () => {
};
});

const mockSpanSetMetadata = jest.spyOn(SentryCore, 'spanSetMetadata');

describe('Angular Tracing', () => {
beforeEach(() => {
transaction = undefined;
mockSpanSetMetadata.mockClear();
});

describe('instrumentAngularRouting', () => {
Expand DownExpand Up@@ -329,7 +332,7 @@ describe('Angular Tracing', () => {
metadata: { source: 'url' },
});
expect(transaction.updateName).toHaveBeenCalledWith(result);
expect(transaction.setMetadata).toHaveBeenCalledWith({ source: 'route' });
expect(mockSpanSetMetadata).toHaveBeenCalledWith(expect.anything(), { source: 'route' });

env.destroy();
});
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,7 +72,7 @@ export { createCheckInEnvelope } from './checkin';
export { hasTracingEnabled } from './utils/hasTracingEnabled';
export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { spanToTraceHeader } from './utils/spanUtils';
export { spanToTraceHeader, spanSetMetadata, spanGetMetadata } from './utils/spanUtils';
export { DEFAULT_ENVIRONMENT } from './constants';
export { ModuleMetadata } from './integrations/metadata';
export { RequestData } from './integrations/requestdata';
Expand Down
11 changes: 6 additions & 5 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import { isNaN, logger } from '@sentry/utils';

import { DEBUG_BUILD } from '../debug-build';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
import { spanSetMetadata } from '../utils/spanUtils';
import type { Transaction } from './transaction';

/**
Expand All@@ -29,7 +30,7 @@ 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({
spanSetMetadata(transaction, {
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
Expand All@@ -41,20 +42,20 @@ export function sampleTransaction<T extends Transaction>(
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate: Number(sampleRate),
});
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
} else if (typeof options.tracesSampleRate !== 'undefined') {
sampleRate = options.tracesSampleRate;
transaction.setMetadata({
sampleRate: Number(sampleRate),
spanSetMetadata(transaction, {
sampleRate,
});
} else {
// When `enableTracing === true`, we use a sample rate of 100%
sampleRate = 1;
transaction.setMetadata({
spanSetMetadata(transaction, {
sampleRate,
});
}
Expand Down
48 changes: 36 additions & 12 deletions packages/core/src/tracing/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,12 @@ import { dropUndefinedKeys, logger } from '@sentry/utils';
import { DEBUG_BUILD } from '../debug-build';
import type { Hub } from '../hub';
import { getCurrentHub } from '../hub';
import { spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { spanGetMetadata, spanSetMetadata, spanTimeInputToSeconds, spanToTraceContext } from '../utils/spanUtils';
import { getDynamicSamplingContextFromClient } from './dynamicSamplingContext';
import { Span as SpanClass, SpanRecorder } from './span';

/** JSDoc */
export class Transaction extends SpanClass implements TransactionInterface {
public metadata: TransactionMetadata;

/**
* The reference to the current hub.
*/
Expand DownExpand Up@@ -58,11 +56,11 @@ export class Transaction extends SpanClass implements TransactionInterface {

this._name = transactionContext.name || '';

this.metadata = {
spanSetMetadata(this, {
source: 'custom',
...transactionContext.metadata,
spanMetadata: {},
};
});

this._trimEnd = transactionContext.trimEnd;

Expand All@@ -71,13 +69,18 @@ export class Transaction extends SpanClass implements TransactionInterface {

// If Dynamic Sampling Context is provided during the creation of the transaction, we freeze it as it usually means
// there is incoming Dynamic Sampling Context. (Either through an incoming request, a baggage meta-tag, or other means)
const incomingDynamicSamplingContext = this.metadata.dynamicSamplingContext;
const incomingDynamicSamplingContext = (
spanGetMetadata(this) as { dynamicSamplingContext: DynamicSamplingContext | undefined }
).dynamicSamplingContext;
if (incomingDynamicSamplingContext) {
// We shallow copy this in case anything writes to the original reference of the passed in `dynamicSamplingContext`
this._frozenDynamicSamplingContext = { ...incomingDynamicSamplingContext };
}
}

// This sadly conflicts with the getter/setter ordering :(
/* eslint-disable @typescript-eslint/member-ordering */

/** Getter for `name` property */
public get name(): string {
return this._name;
Expand All@@ -91,14 +94,32 @@ export class Transaction extends SpanClass implements TransactionInterface {
this.setName(newName);
}

/**
* Get the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public get metadata(): TransactionMetadata {
return spanGetMetadata(this) as TransactionMetadata;
}

/**
* Update the metadata for this transaction.
* @deprecated Use `spanGetMetadata(transaction)` instead.
*/
public set metadata(metadata: TransactionMetadata) {
spanSetMetadata(this, metadata);
}

/* eslint-enable @typescript-eslint/member-ordering */

/**
* Setter for `name` property, which also sets `source` on the metadata.
*
* @deprecated Use `updateName()` and `setMetadata()` instead.
*/
public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
this._name = name;
this.metadata.source = source;
spanSetMetadata(this, { source });
}

/** @inheritdoc */
Expand DownExpand Up@@ -138,10 +159,11 @@ export class Transaction extends SpanClass implements TransactionInterface {
}

/**
* @inheritDoc
* Set metadata for this transaction.
* @deprecated Use `spanSetMetadata(span, metadata)` instead.
*/
public setMetadata(newMetadata: Partial<TransactionMetadata>): void {
this.metadata = { ...this.metadata, ...newMetadata };
spanSetMetadata(this, newMetadata);
}

/**
Expand DownExpand Up@@ -202,13 +224,15 @@ export class Transaction extends SpanClass implements TransactionInterface {
const scope = hub.getScope();
const dsc = getDynamicSamplingContextFromClient(this.traceId, client, scope);

const maybeSampleRate = this.metadata.sampleRate;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const maybeSampleRate = metadata.sampleRate;
if (maybeSampleRate !== undefined) {
dsc.sample_rate = `${maybeSampleRate}`;
}

// We don't want to have a transaction name in the DSC if the source is "url" because URLs might contain PII
const source = this.metadata.source;
const source = metadata.source;
if (source && source !== 'url') {
dsc.transaction = this.name;
}
Expand DownExpand Up@@ -277,7 +301,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
}).endTimestamp;
}

const metadata = this.metadata;
const metadata = spanGetMetadata(this) as TransactionMetadata;

const transaction: TransactionEvent = {
contexts: {
Expand Down
20 changes: 19 additions & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
import type { Span, SpanTimeInput, TraceContext } from '@sentry/types';
import type { Span, SpanMetadata, SpanTimeInput, TraceContext } from '@sentry/types';
import { dropUndefinedKeys, generateSentryTraceHeader, timestampInSeconds } from '@sentry/utils';

const SPAN_METADATA = new WeakMap<Span, SpanMetadata>();

/**
* Convert a span to a trace context, which can be sent as the `trace` context in an event.
*/
Expand DownExpand Up@@ -54,3 +56,19 @@ function ensureTimestampInSeconds(timestamp: number): number {
const isMs = timestamp > 9999999999;
return isMs ? timestamp / 1000 : timestamp;
}

/**
* Get the metadata for a span.
*/
export function spanGetMetadata(span: Span): SpanMetadata {
return SPAN_METADATA.get(span) || {};
}

/**
* Update metadata for a span.
* This will merge the given new metadata with existing metadata.
*/
export function spanSetMetadata(span: Span, newMetadata: SpanMetadata): void {
const existingMetadata = spanGetMetadata(span);
SPAN_METADATA.set(span, { ...existingMetadata, ...newMetadata });
}
12 changes: 7 additions & 5 deletions packages/core/test/lib/tracing/transaction.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { Transaction } from '../../../src';
import { spanSetMetadata } from '../../../src/utils/spanUtils';

describe('transaction', () => {
it('works with name', () => {
Expand All@@ -8,37 +9,38 @@ describe('transaction', () => {

it('allows to update the name via setter', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.name = 'new name';

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via setName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.setMetadata({ source: 'route' });

// eslint-disable-next-line deprecation/deprecation
transaction.setName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('custom');
});

it('allows to update the name via updateName', () => {
const transaction = new Transaction({ name: 'span name' });
transaction.setMetadata({ source: 'route' });
spanSetMetadata(transaction, { source: 'route' });
expect(transaction.name).toEqual('span name');

transaction.updateName('new name');

expect(transaction.name).toEqual('new name');
// eslint-disable-next-line deprecation/deprecation
expect(transaction.metadata.source).toEqual('route');
});
});
Loading