ref(tracing): Unify DSC key names in envelope and baggage headers#5302

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
Lms24 merged 3 commits into from
Jun 24, 2022
Merged

ref(tracing): Unify DSC key names in envelope and baggage headers #5302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31a1753
ref(tracing): Unify DSC key names in envelope header and baggage header
Lms24 Jun 23, 2022
41d814e
apply code review suggestions
Lms24 Jun 24, 2022
db7945a
fix linter error
Lms24 Jun 24, 2022
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
25 changes: 6 additions & 19 deletions packages/core/src/envelope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import {
Baggage,
DsnComponents,
DynamicSamplingContext,
Event,
EventEnvelope,
EventEnvelopeHeaders,
EventItem,
EventTraceContext,
SdkInfo,
SdkMetadata,
Session,
Expand DownExpand Up@@ -100,31 +101,17 @@ function createEventEnvelopeHeaders(
tunnel: string | undefined,
dsn: DsnComponents,
): EventEnvelopeHeaders {
const baggage = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
const { environment, release, transaction, userid, usersegment, samplerate, publickey, traceid } =
(baggage && getSentryBaggageItems(baggage)) || {};
const baggage: Baggage | undefined = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
const dynamicSamplingContext = baggage && getSentryBaggageItems(baggage);

return {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && { dsn: dsnToString(dsn) }),
...(event.type === 'transaction' &&
baggage && {
trace: dropUndefinedKeys({
trace_id: traceid,
public_key: publickey,
sample_rate: samplerate,
environment,
release,
transaction,
...((userid || usersegment) && {
user: {
id: userid,
segment: usersegment,
},
}),
}) as EventTraceContext,
dynamicSamplingContext && {
trace: dropUndefinedKeys({ ...dynamicSamplingContext }) as DynamicSamplingContext,
}),
};
}
27 changes: 14 additions & 13 deletions packages/core/test/lib/envelope.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { DsnComponents, Event, EventTraceContext } from '@sentry/types';
import { DsnComponents, DynamicSamplingContext, Event } from '@sentry/types';

import { createEventEnvelope } from '../../src/envelope';

Expand All@@ -14,13 +14,13 @@ describe('createEventEnvelope', () => {
expect(envelopeHeaders.trace).toBeUndefined();
});

const testTable: Array<[string, Event, EventTraceContext]> = [
const testTable: Array<[string, Event, DynamicSamplingContext]> = [
[
'adds minimal baggage items',
{
type: 'transaction',
sdkProcessingMetadata: {
baggage: [{ traceid: '1234', publickey: 'pubKey123' }, '', false],
baggage: [{ trace_id: '1234', public_key: 'pubKey123' }, '', false],
},
},
{ trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -30,7 +30,7 @@ describe('createEventEnvelope', () => {
{
type: 'transaction',
sdkProcessingMetadata: {
baggage: [{ environment: 'prod', release: '1.0.0', publickey: 'pubKey123', traceid: '1234' }, '', false],
baggage: [{ environment: 'prod', release: '1.0.0', public_key: 'pubKey123', trace_id: '1234' }, '', false],
},
},
{ release: '1.0.0', environment: 'prod', trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -44,26 +44,27 @@ describe('createEventEnvelope', () => {
{
environment: 'prod',
release: '1.0.0',
userid: 'bob',
usersegment: 'segmentA',
transaction: 'TX',
samplerate: '0.95',
publickey: 'pubKey123',
traceid: '1234',
user_id: 'bob',
user_segment: 'segmentA',
sample_rate: '0.95',
public_key: 'pubKey123',
trace_id: '1234',
},
'',
false,
],
},
},
{
release: '1.0.0',
environment: 'prod',
user: { id: 'bob', segment: 'segmentA' },
release: '1.0.0',
transaction: 'TX',
trace_id: '1234',
public_key: 'pubKey123',
user_id: 'bob',
user_segment: 'segmentA',
sample_rate: '0.95',
public_key: 'pubKey123',
trace_id: '1234',
},
],
];
Expand Down
2 changes: 1 addition & 1 deletion packages/integration-tests/suites/tracing/browsertracing/meta/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
<meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-1" />
<meta
name="baggage"
content="sentry-release=2.1.12,sentry-publickey=public,sentry-traceid=123,sentry-samplerate=0.3232"
content="sentry-release=2.1.12,sentry-public_key=public,sentry-trace_id=123,sentry-sample_rate=0.3232"
/>
</head>
</html>
8 changes: 3 additions & 5 deletions packages/integration-tests/suites/tracing/envelope-header/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ import { sentryTest } from '../../../utils/fixtures';
import { envelopeHeaderRequestParser, getFirstSentryEnvelopeRequest } from '../../../utils/helpers';

sentryTest(
'should send dynamic sampling context data in transaction envelope header',
'should send dynamic sampling context data in trace envelope header of a transaction envelope',
async ({ getLocalTestPath, page }) => {
const url = await getLocalTestPath({ testDir: __dirname });

Expand All@@ -15,10 +15,8 @@ sentryTest(
expect(envHeader.trace).toEqual({
environment: 'production',
transaction: expect.stringContaining('index.html'),
user: {
id: 'user123',
segment: 'segmentB',
},
user_id: 'user123',
user_segment: 'segmentB',
sample_rate: '1',
trace_id: expect.any(String),
public_key: 'public',
Expand Down
6 changes: 3 additions & 3 deletions packages/node-integration-tests/suites/express/sentry-trace/baggage-header-assign/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,8 +78,8 @@ test('Should populate and propagate sentry baggage if sentry-trace header does n
test_data: {
host: 'somewhere.not.sentry',
baggage: expect.stringContaining(
'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,sentry-samplerate=1,' +
'sentry-publickey=public,sentry-traceid=',
'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
'sentry-public_key=public,sentry-trace_id=',
),
},
});
Expand All@@ -99,7 +99,7 @@ test('Should populate Sentry and propagate 3rd party content if sentry-trace hea
// TraceId changes, hence we only expect that the string contains the traceid key
baggage: expect.stringContaining(
'foo=bar,bar=baz,sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
'sentry-samplerate=1,sentry-publickey=public,sentry-traceid=',
'sentry-public_key=public,sentry-trace_id=',
),
},
});
Expand Down
12 changes: 7 additions & 5 deletions packages/node/test/integrations/http.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,10 +108,11 @@ describe('tracing', () => {
const baggageHeader = request.getHeader('baggage') as string;

expect(baggageHeader).toBeDefined();
expect(typeof baggageHeader).toEqual('string');
expect(baggageHeader).toEqual(
'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-userid=uid123,' +
'sentry-usersegment=segmentA,sentry-samplerate=1,sentry-publickey=dogsarebadatkeepingsecrets,' +
'sentry-traceid=12312012123120121231201212312012',
'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_id=uid123,' +
'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
);
});

Expand All@@ -124,10 +125,11 @@ describe('tracing', () => {
const baggageHeader = request.getHeader('baggage') as string;

expect(baggageHeader).toBeDefined();
expect(typeof baggageHeader).toEqual('string');
expect(baggageHeader).toEqual(
'dog=great,sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
'sentry-userid=uid123,sentry-usersegment=segmentA,sentry-samplerate=1,' +
'sentry-publickey=dogsarebadatkeepingsecrets,sentry-traceid=12312012123120121231201212312012',
'sentry-user_id=uid123,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
);
});

Expand Down
69 changes: 32 additions & 37 deletions packages/tracing/src/transaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { getCurrentHub, Hub } from '@sentry/hub';
import {
Baggage,
BaggageObj,
Event,
Measurements,
Transaction as TransactionInterface,
Expand All@@ -10,11 +11,11 @@ import {
import {
createBaggage,
dropUndefinedKeys,
getSentryBaggageItems,
getThirdPartyBaggage,
isBaggageMutable,
isSentryBaggageEmpty,
logger,
setBaggageImmutable,
setBaggageValue,
} from '@sentry/utils';

import { Span as SpanClass, SpanRecorder } from './span';
Expand DownExpand Up@@ -228,40 +229,34 @@ export class Transaction extends SpanClass implements TransactionInterface {
const hub: Hub = this._hub || getCurrentHub();
const client = hub && hub.getClient();

const { environment, release } = (client && client.getOptions()) || {};
const { publicKey } = (client && client.getDsn()) || {};

const sampleRate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
const traceId = this.traceId;
const transactionName = this.name;

let userId, userSegment;
hub.configureScope(scope => {
const { id, segment } = scope.getUser() || {};
userId = id;
userSegment = segment;
});

environment && setBaggageValue(baggage, 'environment', environment);
release && setBaggageValue(baggage, 'release', release);
transactionName && setBaggageValue(baggage, 'transaction', transactionName);
userId && setBaggageValue(baggage, 'userid', userId);
userSegment && setBaggageValue(baggage, 'usersegment', userSegment);
sampleRate &&
setBaggageValue(
baggage,
'samplerate',
// This will make sure that expnent notation (e.g. 1.45e-14) is converted to simple decimal representation
// Another edge case would be something like Number.NEGATIVE_INFINITY in which case we could still
// add something like .replace(/-?∞/, '0'). For the sake of saving bytes, I'll not add this until
// it becomes a problem
sampleRate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 }),
);
publicKey && setBaggageValue(baggage, 'publickey', publicKey);
traceId && setBaggageValue(baggage, 'traceid', traceId);

setBaggageImmutable(baggage);

return baggage;
if (!client) return baggage;

const { environment, release } = client.getOptions() || {};
const { publicKey: public_key } = client.getDsn() || {};

const rate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
const sample_rate =
rate !== undefined
? rate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 })
: undefined;

const scope = hub.getScope();
const { id: user_id, segment: user_segment } = (scope && scope.getUser()) || {};

return createBaggage(
dropUndefinedKeys({
environment,
release,
transaction: this.name,
user_id,
user_segment,
public_key,
trace_id: this.traceId,
sample_rate,
...getSentryBaggageItems(baggage), // keep user-added values
} as BaggageObj),
getThirdPartyBaggage(baggage), // TODO: remove once we ignore 3rd party baggage
false, // set baggage immutable
);
}
}
4 changes: 2 additions & 2 deletions packages/tracing/test/browser/browsertracing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -507,9 +507,9 @@ describe('BrowserTracing', () => {
expect(baggage[0]).toEqual({
release: '1.0.0',
environment: 'production',
publickey: 'pubKey',
traceid: expect.any(String),
transaction: 'blank',
public_key: 'pubKey',
trace_id: expect.not.stringMatching('12312012123120121231201212312012'),
});
expect(baggage[1]).toBeDefined();
expect(baggage[1]).toEqual('');
Expand Down
8 changes: 4 additions & 4 deletions packages/tracing/test/span.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -444,8 +444,8 @@ describe('Span', () => {
release: '1.0.1',
environment: 'production',
transaction: 'tx',
samplerate: '0.56',
traceid: expect.any(String),
sample_rate: '0.56',
trace_id: expect.any(String),
});
expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
});
Expand All@@ -468,8 +468,8 @@ describe('Span', () => {
release: '1.0.1',
environment: 'production',
transaction: 'tx',
samplerate: '0.0000000000000145',
traceid: expect.any(String),
sample_rate: '0.0000000000000145',
trace_id: expect.any(String),
});
expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
});
Expand Down
12 changes: 3 additions & 9 deletions packages/types/src/baggage.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
export type AllowedBaggageKeys =
| 'environment'
| 'release'
| 'transaction'
| 'userid'
| 'usersegment'
| 'samplerate'
| 'traceid'
| 'publickey';
import { DynamicSamplingContext } from './envelope';

export type AllowedBaggageKeys = keyof DynamicSamplingContext;

export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;

Expand Down
10 changes: 4 additions & 6 deletions packages/types/src/envelope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@ import { UserFeedback } from './user';
// Based on: https://develop.sentry.dev/sdk/envelopes/

// Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
export type EventTraceContext = {
export type DynamicSamplingContext = {
trace_id: Transaction['traceId'];
public_key: DsnComponents['publicKey'];
sample_rate?: string;
release?: string;
user?: {
id?: string;
segment?: string;
};
environment?: string;
transaction?: string;
user_id?: string;
user_segment?: string;
};

export type EnvelopeItemType =
Expand DownExpand Up@@ -74,7 +72,7 @@ export type SessionItem =
| BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: EventTraceContext };
export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
type SessionEnvelopeHeaders = { sent_at: string };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;

Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,13 @@ export type {
BaseEnvelopeItemHeaders,
ClientReportEnvelope,
ClientReportItem,
DynamicSamplingContext,
Envelope,
EnvelopeItemType,
EnvelopeItem,
EventEnvelope,
EventEnvelopeHeaders,
EventItem,
EventTraceContext,
SessionEnvelope,
SessionItem,
UserFeedbackItem,
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ref(tracing): Unify DSC key names in envelope and baggage headers#5302

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 3 commits into

from

Jun 24, 2022
 Merged


ref(tracing): Unify DSC key names in envelope and baggage headers
#5302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
31a1753

ref(tracing): Unify DSC key names in envelope header and baggage header


Lms24 Jun 23, 2022
41d814e

apply code review suggestions


Lms24 Jun 24, 2022
db7945a

fix linter error


Lms24 Jun 24, 2022

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


25 changes: 6 additions & 19 deletions
packages/core/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import {
 Baggage,
 DsnComponents,
 DynamicSamplingContext,
 Event,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SdkInfo,
 SdkMetadata,
 Session,
Expand DownExpand Up@@ -100,31 +101,17 @@ function createEventEnvelopeHeaders(
 tunnel: string | undefined,
 dsn: DsnComponents,
): EventEnvelopeHeaders {
 const baggage = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const { environment, release, transaction, userid, usersegment, samplerate, publickey, traceid } =
 (baggage && getSentryBaggageItems(baggage)) || {};
 const baggage: Baggage | undefined = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const dynamicSamplingContext = baggage && getSentryBaggageItems(baggage);

 return {
 event_id: event.event_id as string,
 sent_at: new Date().toISOString(),
 ...(sdkInfo && { sdk: sdkInfo }),
 ...(!!tunnel && { dsn: dsnToString(dsn) }),
 ...(event.type === 'transaction' &&
 baggage && {
 trace: dropUndefinedKeys({
 trace_id: traceid,
 public_key: publickey,
 sample_rate: samplerate,
 environment,
 release,
 transaction,
 ...((userid || usersegment) && {
 user: {
 id: userid,
 segment: usersegment,
 },
 }),
 }) as EventTraceContext,
 dynamicSamplingContext && {
 trace: dropUndefinedKeys({ ...dynamicSamplingContext }) as DynamicSamplingContext,
 }),
 };
}

27 changes: 14 additions & 13 deletions
packages/core/test/lib/envelope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { DsnComponents, Event, EventTraceContext } from '@sentry/types';
import { DsnComponents, DynamicSamplingContext, Event } from '@sentry/types';

import { createEventEnvelope } from '../../src/envelope';

Expand All@@ -14,13 +14,13 @@ describe('createEventEnvelope', () => {
 expect(envelopeHeaders.trace).toBeUndefined();
 });

 const testTable: Array<[string, Event, EventTraceContext]> = [
 const testTable: Array<[string, Event, DynamicSamplingContext]> = [
 [
 'adds minimal baggage items',
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ traceid: '1234', publickey: 'pubKey123' }, '', false],
 baggage: [{ trace_id: '1234', public_key: 'pubKey123' }, '', false],
 },
 },
 { trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -30,7 +30,7 @@ describe('createEventEnvelope', () => {
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ environment: 'prod', release: '1.0.0', publickey: 'pubKey123', traceid: '1234' }, '', false],
 baggage: [{ environment: 'prod', release: '1.0.0', public_key: 'pubKey123', trace_id: '1234' }, '', false],
 },
 },
 { release: '1.0.0', environment: 'prod', trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -44,26 +44,27 @@ describe('createEventEnvelope', () => {
 {
 environment: 'prod',
 release: '1.0.0',
 userid: 'bob',
 usersegment: 'segmentA',
 transaction: 'TX',
 samplerate: '0.95',
 publickey: 'pubKey123',
 traceid: '1234',
 user_id: 'bob',
 user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 '',
 false,
 ],
 },
 },
 {
 release: '1.0.0',
 environment: 'prod',
user: { id: 'bob', segment: 'segmentA' },
release: '1.0.0',
 transaction: 'TX',
trace_id: '1234',
public_key: 'pubKey123',
user_id: 'bob',
user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 ],
 ];
Expand Down

2 changes: 1 addition & 1 deletion
packages/integration-tests/suites/tracing/browsertracing/meta/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 <meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-1" />
 <meta
 name="baggage"
 content="sentry-release=2.1.12,sentry-publickey=public,sentry-traceid=123,sentry-samplerate=0.3232"
 content="sentry-release=2.1.12,sentry-public_key=public,sentry-trace_id=123,sentry-sample_rate=0.3232"
 />
 </head>
</html>

8 changes: 3 additions & 5 deletions
packages/integration-tests/suites/tracing/envelope-header/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ import { sentryTest } from '../../../utils/fixtures';
import { envelopeHeaderRequestParser, getFirstSentryEnvelopeRequest } from '../../../utils/helpers';

sentryTest(
 'should send dynamic sampling context data in transaction envelope header',
 'should send dynamic sampling context data in trace envelope header of a transaction envelope',
 async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

Expand All@@ -15,10 +15,8 @@ sentryTest(
 expect(envHeader.trace).toEqual({
 environment: 'production',
 transaction: expect.stringContaining('index.html'),
 user: {
 id: 'user123',
 segment: 'segmentB',
 },
 user_id: 'user123',
 user_segment: 'segmentB',
 sample_rate: '1',
 trace_id: expect.any(String),
 public_key: 'public',
Expand Down

6 changes: 3 additions & 3 deletions
packages/node-integration-tests/suites/express/sentry-trace/baggage-header-assign/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,8 +78,8 @@ test('Should populate and propagate sentry baggage if sentry-trace header does n
 test_data: {
 host: 'somewhere.not.sentry',
 baggage: expect.stringContaining(
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,sentry-samplerate=1,' +
 'sentry-publickey=public,sentry-traceid=',
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand All@@ -99,7 +99,7 @@ test('Should populate Sentry and propagate 3rd party content if sentry-trace hea
 // TraceId changes, hence we only expect that the string contains the traceid key
 baggage: expect.stringContaining(
 'foo=bar,bar=baz,sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-samplerate=1,sentry-publickey=public,sentry-traceid=',
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand Down

12 changes: 7 additions & 5 deletions
packages/node/test/integrations/http.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,10 +108,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-userid=uid123,' +
 'sentry-usersegment=segmentA,sentry-samplerate=1,sentry-publickey=dogsarebadatkeepingsecrets,' +
 'sentry-traceid=12312012123120121231201212312012',
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_id=uid123,' +
 'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand All@@ -124,10 +125,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'dog=great,sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
 'sentry-userid=uid123,sentry-usersegment=segmentA,sentry-samplerate=1,' +
 'sentry-publickey=dogsarebadatkeepingsecrets,sentry-traceid=12312012123120121231201212312012',
 'sentry-user_id=uid123,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand Down

69 changes: 32 additions & 37 deletions
packages/tracing/src/transaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { getCurrentHub, Hub } from '@sentry/hub';
import {
 Baggage,
 BaggageObj,
 Event,
 Measurements,
 Transaction as TransactionInterface,
Expand All@@ -10,11 +11,11 @@ import {
import {
 createBaggage,
 dropUndefinedKeys,
 getSentryBaggageItems,
 getThirdPartyBaggage,
 isBaggageMutable,
 isSentryBaggageEmpty,
 logger,
 setBaggageImmutable,
 setBaggageValue,
} from '@sentry/utils';

import { Span as SpanClass, SpanRecorder } from './span';
Expand DownExpand Up@@ -228,40 +229,34 @@ export class Transaction extends SpanClass implements TransactionInterface {
 const hub: Hub = this._hub || getCurrentHub();
 const client = hub && hub.getClient();

 const { environment, release } = (client && client.getOptions()) || {};
 const { publicKey } = (client && client.getDsn()) || {};

 const sampleRate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const traceId = this.traceId;
 const transactionName = this.name;

 let userId, userSegment;
 hub.configureScope(scope => {
 const { id, segment } = scope.getUser() || {};
 userId = id;
 userSegment = segment;
 });

 environment && setBaggageValue(baggage, 'environment', environment);
 release && setBaggageValue(baggage, 'release', release);
 transactionName && setBaggageValue(baggage, 'transaction', transactionName);
 userId && setBaggageValue(baggage, 'userid', userId);
 userSegment && setBaggageValue(baggage, 'usersegment', userSegment);
 sampleRate &&
 setBaggageValue(
 baggage,
 'samplerate',
 // This will make sure that expnent notation (e.g. 1.45e-14) is converted to simple decimal representation
 // Another edge case would be something like Number.NEGATIVE_INFINITY in which case we could still
 // add something like .replace(/-?∞/, '0'). For the sake of saving bytes, I'll not add this until
 // it becomes a problem
 sampleRate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 }),
 );
 publicKey && setBaggageValue(baggage, 'publickey', publicKey);
 traceId && setBaggageValue(baggage, 'traceid', traceId);

 setBaggageImmutable(baggage);

 return baggage;
 if (!client) return baggage;

 const { environment, release } = client.getOptions() || {};
 const { publicKey: public_key } = client.getDsn() || {};

 const rate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const sample_rate =
 rate !== undefined
 ? rate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 })
 : undefined;

 const scope = hub.getScope();
 const { id: user_id, segment: user_segment } = (scope && scope.getUser()) || {};

 return createBaggage(
 dropUndefinedKeys({
 environment,
 release,
 transaction: this.name,
 user_id,
 user_segment,
 public_key,
 trace_id: this.traceId,
 sample_rate,
 ...getSentryBaggageItems(baggage), // keep user-added values
 } as BaggageObj),
 getThirdPartyBaggage(baggage), // TODO: remove once we ignore 3rd party baggage
 false, // set baggage immutable
 );
 }
}

4 changes: 2 additions & 2 deletions
packages/tracing/test/browser/browsertracing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,9 +507,9 @@ describe('BrowserTracing', () => {
 expect(baggage[0]).toEqual({
 release: '1.0.0',
 environment: 'production',
 publickey: 'pubKey',
 traceid: expect.any(String),
 transaction: 'blank',
 public_key: 'pubKey',
 trace_id: expect.not.stringMatching('12312012123120121231201212312012'),
 });
 expect(baggage[1]).toBeDefined();
 expect(baggage[1]).toEqual('');
Expand Down

8 changes: 4 additions & 4 deletions
packages/tracing/test/span.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -444,8 +444,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.56',
traceid: expect.any(String),
sample_rate: '0.56',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand All@@ -468,8 +468,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.0000000000000145',
traceid: expect.any(String),
sample_rate: '0.0000000000000145',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand Down

12 changes: 3 additions & 9 deletions
packages/types/src/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
export type AllowedBaggageKeys =
 | 'environment'
 | 'release'
 | 'transaction'
 | 'userid'
 | 'usersegment'
 | 'samplerate'
 | 'traceid'
 | 'publickey';
import { DynamicSamplingContext } from './envelope';

export type AllowedBaggageKeys = keyof DynamicSamplingContext;

export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;

Expand Down

10 changes: 4 additions & 6 deletions
packages/types/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@ import { UserFeedback } from './user';
// Based on: https://develop.sentry.dev/sdk/envelopes/

// Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
export type EventTraceContext = {
export type DynamicSamplingContext = {
 trace_id: Transaction['traceId'];
 public_key: DsnComponents['publicKey'];
 sample_rate?: string;
 release?: string;
 user?: {
 id?: string;
 segment?: string;
 };
 environment?: string;
 transaction?: string;
 user_id?: string;
 user_segment?: string;
};

export type EnvelopeItemType =
Expand DownExpand Up@@ -74,7 +72,7 @@ export type SessionItem =
 | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: EventTraceContext };
export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
type SessionEnvelopeHeaders = { sent_at: string };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;

Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,13 @@ export type {
 BaseEnvelopeItemHeaders,
 ClientReportEnvelope,
 ClientReportItem,
 DynamicSamplingContext,
 Envelope,
 EnvelopeItemType,
 EnvelopeItem,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SessionEnvelope,
 SessionItem,
 UserFeedbackItem,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(tracing): Unify DSC key names in envelope and baggage headers#5302

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 3 commits into

from

Jun 24, 2022
 Merged


ref(tracing): Unify DSC key names in envelope and baggage headers
#5302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
31a1753

ref(tracing): Unify DSC key names in envelope header and baggage header


Lms24 Jun 23, 2022
41d814e

apply code review suggestions


Lms24 Jun 24, 2022
db7945a

fix linter error


Lms24 Jun 24, 2022

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


25 changes: 6 additions & 19 deletions
packages/core/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import {
 Baggage,
 DsnComponents,
 DynamicSamplingContext,
 Event,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SdkInfo,
 SdkMetadata,
 Session,
Expand DownExpand Up@@ -100,31 +101,17 @@ function createEventEnvelopeHeaders(
 tunnel: string | undefined,
 dsn: DsnComponents,
): EventEnvelopeHeaders {
 const baggage = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const { environment, release, transaction, userid, usersegment, samplerate, publickey, traceid } =
 (baggage && getSentryBaggageItems(baggage)) || {};
 const baggage: Baggage | undefined = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const dynamicSamplingContext = baggage && getSentryBaggageItems(baggage);

 return {
 event_id: event.event_id as string,
 sent_at: new Date().toISOString(),
 ...(sdkInfo && { sdk: sdkInfo }),
 ...(!!tunnel && { dsn: dsnToString(dsn) }),
 ...(event.type === 'transaction' &&
 baggage && {
 trace: dropUndefinedKeys({
 trace_id: traceid,
 public_key: publickey,
 sample_rate: samplerate,
 environment,
 release,
 transaction,
 ...((userid || usersegment) && {
 user: {
 id: userid,
 segment: usersegment,
 },
 }),
 }) as EventTraceContext,
 dynamicSamplingContext && {
 trace: dropUndefinedKeys({ ...dynamicSamplingContext }) as DynamicSamplingContext,
 }),
 };
}

27 changes: 14 additions & 13 deletions
packages/core/test/lib/envelope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { DsnComponents, Event, EventTraceContext } from '@sentry/types';
import { DsnComponents, DynamicSamplingContext, Event } from '@sentry/types';

import { createEventEnvelope } from '../../src/envelope';

Expand All@@ -14,13 +14,13 @@ describe('createEventEnvelope', () => {
 expect(envelopeHeaders.trace).toBeUndefined();
 });

 const testTable: Array<[string, Event, EventTraceContext]> = [
 const testTable: Array<[string, Event, DynamicSamplingContext]> = [
 [
 'adds minimal baggage items',
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ traceid: '1234', publickey: 'pubKey123' }, '', false],
 baggage: [{ trace_id: '1234', public_key: 'pubKey123' }, '', false],
 },
 },
 { trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -30,7 +30,7 @@ describe('createEventEnvelope', () => {
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ environment: 'prod', release: '1.0.0', publickey: 'pubKey123', traceid: '1234' }, '', false],
 baggage: [{ environment: 'prod', release: '1.0.0', public_key: 'pubKey123', trace_id: '1234' }, '', false],
 },
 },
 { release: '1.0.0', environment: 'prod', trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -44,26 +44,27 @@ describe('createEventEnvelope', () => {
 {
 environment: 'prod',
 release: '1.0.0',
 userid: 'bob',
 usersegment: 'segmentA',
 transaction: 'TX',
 samplerate: '0.95',
 publickey: 'pubKey123',
 traceid: '1234',
 user_id: 'bob',
 user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 '',
 false,
 ],
 },
 },
 {
 release: '1.0.0',
 environment: 'prod',
user: { id: 'bob', segment: 'segmentA' },
release: '1.0.0',
 transaction: 'TX',
trace_id: '1234',
public_key: 'pubKey123',
user_id: 'bob',
user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 ],
 ];
Expand Down

2 changes: 1 addition & 1 deletion
packages/integration-tests/suites/tracing/browsertracing/meta/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 <meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-1" />
 <meta
 name="baggage"
 content="sentry-release=2.1.12,sentry-publickey=public,sentry-traceid=123,sentry-samplerate=0.3232"
 content="sentry-release=2.1.12,sentry-public_key=public,sentry-trace_id=123,sentry-sample_rate=0.3232"
 />
 </head>
</html>

8 changes: 3 additions & 5 deletions
packages/integration-tests/suites/tracing/envelope-header/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ import { sentryTest } from '../../../utils/fixtures';
import { envelopeHeaderRequestParser, getFirstSentryEnvelopeRequest } from '../../../utils/helpers';

sentryTest(
 'should send dynamic sampling context data in transaction envelope header',
 'should send dynamic sampling context data in trace envelope header of a transaction envelope',
 async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

Expand All@@ -15,10 +15,8 @@ sentryTest(
 expect(envHeader.trace).toEqual({
 environment: 'production',
 transaction: expect.stringContaining('index.html'),
 user: {
 id: 'user123',
 segment: 'segmentB',
 },
 user_id: 'user123',
 user_segment: 'segmentB',
 sample_rate: '1',
 trace_id: expect.any(String),
 public_key: 'public',
Expand Down

6 changes: 3 additions & 3 deletions
packages/node-integration-tests/suites/express/sentry-trace/baggage-header-assign/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,8 +78,8 @@ test('Should populate and propagate sentry baggage if sentry-trace header does n
 test_data: {
 host: 'somewhere.not.sentry',
 baggage: expect.stringContaining(
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,sentry-samplerate=1,' +
 'sentry-publickey=public,sentry-traceid=',
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand All@@ -99,7 +99,7 @@ test('Should populate Sentry and propagate 3rd party content if sentry-trace hea
 // TraceId changes, hence we only expect that the string contains the traceid key
 baggage: expect.stringContaining(
 'foo=bar,bar=baz,sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-samplerate=1,sentry-publickey=public,sentry-traceid=',
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand Down

12 changes: 7 additions & 5 deletions
packages/node/test/integrations/http.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,10 +108,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-userid=uid123,' +
 'sentry-usersegment=segmentA,sentry-samplerate=1,sentry-publickey=dogsarebadatkeepingsecrets,' +
 'sentry-traceid=12312012123120121231201212312012',
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_id=uid123,' +
 'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand All@@ -124,10 +125,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'dog=great,sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
 'sentry-userid=uid123,sentry-usersegment=segmentA,sentry-samplerate=1,' +
 'sentry-publickey=dogsarebadatkeepingsecrets,sentry-traceid=12312012123120121231201212312012',
 'sentry-user_id=uid123,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand Down

69 changes: 32 additions & 37 deletions
packages/tracing/src/transaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { getCurrentHub, Hub } from '@sentry/hub';
import {
 Baggage,
 BaggageObj,
 Event,
 Measurements,
 Transaction as TransactionInterface,
Expand All@@ -10,11 +11,11 @@ import {
import {
 createBaggage,
 dropUndefinedKeys,
 getSentryBaggageItems,
 getThirdPartyBaggage,
 isBaggageMutable,
 isSentryBaggageEmpty,
 logger,
 setBaggageImmutable,
 setBaggageValue,
} from '@sentry/utils';

import { Span as SpanClass, SpanRecorder } from './span';
Expand DownExpand Up@@ -228,40 +229,34 @@ export class Transaction extends SpanClass implements TransactionInterface {
 const hub: Hub = this._hub || getCurrentHub();
 const client = hub && hub.getClient();

 const { environment, release } = (client && client.getOptions()) || {};
 const { publicKey } = (client && client.getDsn()) || {};

 const sampleRate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const traceId = this.traceId;
 const transactionName = this.name;

 let userId, userSegment;
 hub.configureScope(scope => {
 const { id, segment } = scope.getUser() || {};
 userId = id;
 userSegment = segment;
 });

 environment && setBaggageValue(baggage, 'environment', environment);
 release && setBaggageValue(baggage, 'release', release);
 transactionName && setBaggageValue(baggage, 'transaction', transactionName);
 userId && setBaggageValue(baggage, 'userid', userId);
 userSegment && setBaggageValue(baggage, 'usersegment', userSegment);
 sampleRate &&
 setBaggageValue(
 baggage,
 'samplerate',
 // This will make sure that expnent notation (e.g. 1.45e-14) is converted to simple decimal representation
 // Another edge case would be something like Number.NEGATIVE_INFINITY in which case we could still
 // add something like .replace(/-?∞/, '0'). For the sake of saving bytes, I'll not add this until
 // it becomes a problem
 sampleRate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 }),
 );
 publicKey && setBaggageValue(baggage, 'publickey', publicKey);
 traceId && setBaggageValue(baggage, 'traceid', traceId);

 setBaggageImmutable(baggage);

 return baggage;
 if (!client) return baggage;

 const { environment, release } = client.getOptions() || {};
 const { publicKey: public_key } = client.getDsn() || {};

 const rate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const sample_rate =
 rate !== undefined
 ? rate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 })
 : undefined;

 const scope = hub.getScope();
 const { id: user_id, segment: user_segment } = (scope && scope.getUser()) || {};

 return createBaggage(
 dropUndefinedKeys({
 environment,
 release,
 transaction: this.name,
 user_id,
 user_segment,
 public_key,
 trace_id: this.traceId,
 sample_rate,
 ...getSentryBaggageItems(baggage), // keep user-added values
 } as BaggageObj),
 getThirdPartyBaggage(baggage), // TODO: remove once we ignore 3rd party baggage
 false, // set baggage immutable
 );
 }
}

4 changes: 2 additions & 2 deletions
packages/tracing/test/browser/browsertracing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,9 +507,9 @@ describe('BrowserTracing', () => {
 expect(baggage[0]).toEqual({
 release: '1.0.0',
 environment: 'production',
 publickey: 'pubKey',
 traceid: expect.any(String),
 transaction: 'blank',
 public_key: 'pubKey',
 trace_id: expect.not.stringMatching('12312012123120121231201212312012'),
 });
 expect(baggage[1]).toBeDefined();
 expect(baggage[1]).toEqual('');
Expand Down

8 changes: 4 additions & 4 deletions
packages/tracing/test/span.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -444,8 +444,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.56',
traceid: expect.any(String),
sample_rate: '0.56',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand All@@ -468,8 +468,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.0000000000000145',
traceid: expect.any(String),
sample_rate: '0.0000000000000145',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand Down

12 changes: 3 additions & 9 deletions
packages/types/src/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
export type AllowedBaggageKeys =
 | 'environment'
 | 'release'
 | 'transaction'
 | 'userid'
 | 'usersegment'
 | 'samplerate'
 | 'traceid'
 | 'publickey';
import { DynamicSamplingContext } from './envelope';

export type AllowedBaggageKeys = keyof DynamicSamplingContext;

export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;

Expand Down

10 changes: 4 additions & 6 deletions
packages/types/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@ import { UserFeedback } from './user';
// Based on: https://develop.sentry.dev/sdk/envelopes/

// Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
export type EventTraceContext = {
export type DynamicSamplingContext = {
 trace_id: Transaction['traceId'];
 public_key: DsnComponents['publicKey'];
 sample_rate?: string;
 release?: string;
 user?: {
 id?: string;
 segment?: string;
 };
 environment?: string;
 transaction?: string;
 user_id?: string;
 user_segment?: string;
};

export type EnvelopeItemType =
Expand DownExpand Up@@ -74,7 +72,7 @@ export type SessionItem =
 | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: EventTraceContext };
export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
type SessionEnvelopeHeaders = { sent_at: string };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;

Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,13 @@ export type {
 BaseEnvelopeItemHeaders,
 ClientReportEnvelope,
 ClientReportItem,
 DynamicSamplingContext,
 Envelope,
 EnvelopeItemType,
 EnvelopeItem,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SessionEnvelope,
 SessionItem,
 UserFeedbackItem,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 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
ref(tracing): Unify DSC key names in envelope and baggage headers#5302

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 3 commits into

from

Jun 24, 2022
 Merged


ref(tracing): Unify DSC key names in envelope and baggage headers
#5302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
31a1753

ref(tracing): Unify DSC key names in envelope header and baggage header


Lms24 Jun 23, 2022
41d814e

apply code review suggestions


Lms24 Jun 24, 2022
db7945a

fix linter error


Lms24 Jun 24, 2022

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


25 changes: 6 additions & 19 deletions
packages/core/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import {
 Baggage,
 DsnComponents,
 DynamicSamplingContext,
 Event,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SdkInfo,
 SdkMetadata,
 Session,
Expand DownExpand Up@@ -100,31 +101,17 @@ function createEventEnvelopeHeaders(
 tunnel: string | undefined,
 dsn: DsnComponents,
): EventEnvelopeHeaders {
 const baggage = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const { environment, release, transaction, userid, usersegment, samplerate, publickey, traceid } =
 (baggage && getSentryBaggageItems(baggage)) || {};
 const baggage: Baggage | undefined = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const dynamicSamplingContext = baggage && getSentryBaggageItems(baggage);

 return {
 event_id: event.event_id as string,
 sent_at: new Date().toISOString(),
 ...(sdkInfo && { sdk: sdkInfo }),
 ...(!!tunnel && { dsn: dsnToString(dsn) }),
 ...(event.type === 'transaction' &&
 baggage && {
 trace: dropUndefinedKeys({
 trace_id: traceid,
 public_key: publickey,
 sample_rate: samplerate,
 environment,
 release,
 transaction,
 ...((userid || usersegment) && {
 user: {
 id: userid,
 segment: usersegment,
 },
 }),
 }) as EventTraceContext,
 dynamicSamplingContext && {
 trace: dropUndefinedKeys({ ...dynamicSamplingContext }) as DynamicSamplingContext,
 }),
 };
}

27 changes: 14 additions & 13 deletions
packages/core/test/lib/envelope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { DsnComponents, Event, EventTraceContext } from '@sentry/types';
import { DsnComponents, DynamicSamplingContext, Event } from '@sentry/types';

import { createEventEnvelope } from '../../src/envelope';

Expand All@@ -14,13 +14,13 @@ describe('createEventEnvelope', () => {
 expect(envelopeHeaders.trace).toBeUndefined();
 });

 const testTable: Array<[string, Event, EventTraceContext]> = [
 const testTable: Array<[string, Event, DynamicSamplingContext]> = [
 [
 'adds minimal baggage items',
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ traceid: '1234', publickey: 'pubKey123' }, '', false],
 baggage: [{ trace_id: '1234', public_key: 'pubKey123' }, '', false],
 },
 },
 { trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -30,7 +30,7 @@ describe('createEventEnvelope', () => {
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ environment: 'prod', release: '1.0.0', publickey: 'pubKey123', traceid: '1234' }, '', false],
 baggage: [{ environment: 'prod', release: '1.0.0', public_key: 'pubKey123', trace_id: '1234' }, '', false],
 },
 },
 { release: '1.0.0', environment: 'prod', trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -44,26 +44,27 @@ describe('createEventEnvelope', () => {
 {
 environment: 'prod',
 release: '1.0.0',
 userid: 'bob',
 usersegment: 'segmentA',
 transaction: 'TX',
 samplerate: '0.95',
 publickey: 'pubKey123',
 traceid: '1234',
 user_id: 'bob',
 user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 '',
 false,
 ],
 },
 },
 {
 release: '1.0.0',
 environment: 'prod',
user: { id: 'bob', segment: 'segmentA' },
release: '1.0.0',
 transaction: 'TX',
trace_id: '1234',
public_key: 'pubKey123',
user_id: 'bob',
user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 ],
 ];
Expand Down

2 changes: 1 addition & 1 deletion
packages/integration-tests/suites/tracing/browsertracing/meta/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 <meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-1" />
 <meta
 name="baggage"
 content="sentry-release=2.1.12,sentry-publickey=public,sentry-traceid=123,sentry-samplerate=0.3232"
 content="sentry-release=2.1.12,sentry-public_key=public,sentry-trace_id=123,sentry-sample_rate=0.3232"
 />
 </head>
</html>

8 changes: 3 additions & 5 deletions
packages/integration-tests/suites/tracing/envelope-header/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ import { sentryTest } from '../../../utils/fixtures';
import { envelopeHeaderRequestParser, getFirstSentryEnvelopeRequest } from '../../../utils/helpers';

sentryTest(
 'should send dynamic sampling context data in transaction envelope header',
 'should send dynamic sampling context data in trace envelope header of a transaction envelope',
 async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

Expand All@@ -15,10 +15,8 @@ sentryTest(
 expect(envHeader.trace).toEqual({
 environment: 'production',
 transaction: expect.stringContaining('index.html'),
 user: {
 id: 'user123',
 segment: 'segmentB',
 },
 user_id: 'user123',
 user_segment: 'segmentB',
 sample_rate: '1',
 trace_id: expect.any(String),
 public_key: 'public',
Expand Down

6 changes: 3 additions & 3 deletions
packages/node-integration-tests/suites/express/sentry-trace/baggage-header-assign/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,8 +78,8 @@ test('Should populate and propagate sentry baggage if sentry-trace header does n
 test_data: {
 host: 'somewhere.not.sentry',
 baggage: expect.stringContaining(
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,sentry-samplerate=1,' +
 'sentry-publickey=public,sentry-traceid=',
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand All@@ -99,7 +99,7 @@ test('Should populate Sentry and propagate 3rd party content if sentry-trace hea
 // TraceId changes, hence we only expect that the string contains the traceid key
 baggage: expect.stringContaining(
 'foo=bar,bar=baz,sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-samplerate=1,sentry-publickey=public,sentry-traceid=',
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand Down

12 changes: 7 additions & 5 deletions
packages/node/test/integrations/http.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,10 +108,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-userid=uid123,' +
 'sentry-usersegment=segmentA,sentry-samplerate=1,sentry-publickey=dogsarebadatkeepingsecrets,' +
 'sentry-traceid=12312012123120121231201212312012',
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_id=uid123,' +
 'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand All@@ -124,10 +125,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'dog=great,sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
 'sentry-userid=uid123,sentry-usersegment=segmentA,sentry-samplerate=1,' +
 'sentry-publickey=dogsarebadatkeepingsecrets,sentry-traceid=12312012123120121231201212312012',
 'sentry-user_id=uid123,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand Down

69 changes: 32 additions & 37 deletions
packages/tracing/src/transaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { getCurrentHub, Hub } from '@sentry/hub';
import {
 Baggage,
 BaggageObj,
 Event,
 Measurements,
 Transaction as TransactionInterface,
Expand All@@ -10,11 +11,11 @@ import {
import {
 createBaggage,
 dropUndefinedKeys,
 getSentryBaggageItems,
 getThirdPartyBaggage,
 isBaggageMutable,
 isSentryBaggageEmpty,
 logger,
 setBaggageImmutable,
 setBaggageValue,
} from '@sentry/utils';

import { Span as SpanClass, SpanRecorder } from './span';
Expand DownExpand Up@@ -228,40 +229,34 @@ export class Transaction extends SpanClass implements TransactionInterface {
 const hub: Hub = this._hub || getCurrentHub();
 const client = hub && hub.getClient();

 const { environment, release } = (client && client.getOptions()) || {};
 const { publicKey } = (client && client.getDsn()) || {};

 const sampleRate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const traceId = this.traceId;
 const transactionName = this.name;

 let userId, userSegment;
 hub.configureScope(scope => {
 const { id, segment } = scope.getUser() || {};
 userId = id;
 userSegment = segment;
 });

 environment && setBaggageValue(baggage, 'environment', environment);
 release && setBaggageValue(baggage, 'release', release);
 transactionName && setBaggageValue(baggage, 'transaction', transactionName);
 userId && setBaggageValue(baggage, 'userid', userId);
 userSegment && setBaggageValue(baggage, 'usersegment', userSegment);
 sampleRate &&
 setBaggageValue(
 baggage,
 'samplerate',
 // This will make sure that expnent notation (e.g. 1.45e-14) is converted to simple decimal representation
 // Another edge case would be something like Number.NEGATIVE_INFINITY in which case we could still
 // add something like .replace(/-?∞/, '0'). For the sake of saving bytes, I'll not add this until
 // it becomes a problem
 sampleRate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 }),
 );
 publicKey && setBaggageValue(baggage, 'publickey', publicKey);
 traceId && setBaggageValue(baggage, 'traceid', traceId);

 setBaggageImmutable(baggage);

 return baggage;
 if (!client) return baggage;

 const { environment, release } = client.getOptions() || {};
 const { publicKey: public_key } = client.getDsn() || {};

 const rate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const sample_rate =
 rate !== undefined
 ? rate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 })
 : undefined;

 const scope = hub.getScope();
 const { id: user_id, segment: user_segment } = (scope && scope.getUser()) || {};

 return createBaggage(
 dropUndefinedKeys({
 environment,
 release,
 transaction: this.name,
 user_id,
 user_segment,
 public_key,
 trace_id: this.traceId,
 sample_rate,
 ...getSentryBaggageItems(baggage), // keep user-added values
 } as BaggageObj),
 getThirdPartyBaggage(baggage), // TODO: remove once we ignore 3rd party baggage
 false, // set baggage immutable
 );
 }
}

4 changes: 2 additions & 2 deletions
packages/tracing/test/browser/browsertracing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,9 +507,9 @@ describe('BrowserTracing', () => {
 expect(baggage[0]).toEqual({
 release: '1.0.0',
 environment: 'production',
 publickey: 'pubKey',
 traceid: expect.any(String),
 transaction: 'blank',
 public_key: 'pubKey',
 trace_id: expect.not.stringMatching('12312012123120121231201212312012'),
 });
 expect(baggage[1]).toBeDefined();
 expect(baggage[1]).toEqual('');
Expand Down

8 changes: 4 additions & 4 deletions
packages/tracing/test/span.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -444,8 +444,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.56',
traceid: expect.any(String),
sample_rate: '0.56',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand All@@ -468,8 +468,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.0000000000000145',
traceid: expect.any(String),
sample_rate: '0.0000000000000145',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand Down

12 changes: 3 additions & 9 deletions
packages/types/src/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
export type AllowedBaggageKeys =
 | 'environment'
 | 'release'
 | 'transaction'
 | 'userid'
 | 'usersegment'
 | 'samplerate'
 | 'traceid'
 | 'publickey';
import { DynamicSamplingContext } from './envelope';

export type AllowedBaggageKeys = keyof DynamicSamplingContext;

export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;

Expand Down

10 changes: 4 additions & 6 deletions
packages/types/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@ import { UserFeedback } from './user';
// Based on: https://develop.sentry.dev/sdk/envelopes/

// Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
export type EventTraceContext = {
export type DynamicSamplingContext = {
 trace_id: Transaction['traceId'];
 public_key: DsnComponents['publicKey'];
 sample_rate?: string;
 release?: string;
 user?: {
 id?: string;
 segment?: string;
 };
 environment?: string;
 transaction?: string;
 user_id?: string;
 user_segment?: string;
};

export type EnvelopeItemType =
Expand DownExpand Up@@ -74,7 +72,7 @@ export type SessionItem =
 | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: EventTraceContext };
export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
type SessionEnvelopeHeaders = { sent_at: string };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;

Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,13 @@ export type {
 BaseEnvelopeItemHeaders,
 ClientReportEnvelope,
 ClientReportItem,
 DynamicSamplingContext,
 Envelope,
 EnvelopeItemType,
 EnvelopeItem,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SessionEnvelope,
 SessionItem,
 UserFeedbackItem,
Expand Down

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

Skip to content
ref(tracing): Unify DSC key names in envelope and baggage headers#5302

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 3 commits into

from

Jun 24, 2022
 Merged


ref(tracing): Unify DSC key names in envelope and baggage headers
#5302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
31a1753

ref(tracing): Unify DSC key names in envelope header and baggage header


Lms24 Jun 23, 2022
41d814e

apply code review suggestions


Lms24 Jun 24, 2022
db7945a

fix linter error


Lms24 Jun 24, 2022

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


25 changes: 6 additions & 19 deletions
packages/core/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import {
 Baggage,
 DsnComponents,
 DynamicSamplingContext,
 Event,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SdkInfo,
 SdkMetadata,
 Session,
Expand DownExpand Up@@ -100,31 +101,17 @@ function createEventEnvelopeHeaders(
 tunnel: string | undefined,
 dsn: DsnComponents,
): EventEnvelopeHeaders {
 const baggage = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const { environment, release, transaction, userid, usersegment, samplerate, publickey, traceid } =
 (baggage && getSentryBaggageItems(baggage)) || {};
 const baggage: Baggage | undefined = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const dynamicSamplingContext = baggage && getSentryBaggageItems(baggage);

 return {
 event_id: event.event_id as string,
 sent_at: new Date().toISOString(),
 ...(sdkInfo && { sdk: sdkInfo }),
 ...(!!tunnel && { dsn: dsnToString(dsn) }),
 ...(event.type === 'transaction' &&
 baggage && {
 trace: dropUndefinedKeys({
 trace_id: traceid,
 public_key: publickey,
 sample_rate: samplerate,
 environment,
 release,
 transaction,
 ...((userid || usersegment) && {
 user: {
 id: userid,
 segment: usersegment,
 },
 }),
 }) as EventTraceContext,
 dynamicSamplingContext && {
 trace: dropUndefinedKeys({ ...dynamicSamplingContext }) as DynamicSamplingContext,
 }),
 };
}

27 changes: 14 additions & 13 deletions
packages/core/test/lib/envelope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { DsnComponents, Event, EventTraceContext } from '@sentry/types';
import { DsnComponents, DynamicSamplingContext, Event } from '@sentry/types';

import { createEventEnvelope } from '../../src/envelope';

Expand All@@ -14,13 +14,13 @@ describe('createEventEnvelope', () => {
 expect(envelopeHeaders.trace).toBeUndefined();
 });

 const testTable: Array<[string, Event, EventTraceContext]> = [
 const testTable: Array<[string, Event, DynamicSamplingContext]> = [
 [
 'adds minimal baggage items',
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ traceid: '1234', publickey: 'pubKey123' }, '', false],
 baggage: [{ trace_id: '1234', public_key: 'pubKey123' }, '', false],
 },
 },
 { trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -30,7 +30,7 @@ describe('createEventEnvelope', () => {
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ environment: 'prod', release: '1.0.0', publickey: 'pubKey123', traceid: '1234' }, '', false],
 baggage: [{ environment: 'prod', release: '1.0.0', public_key: 'pubKey123', trace_id: '1234' }, '', false],
 },
 },
 { release: '1.0.0', environment: 'prod', trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -44,26 +44,27 @@ describe('createEventEnvelope', () => {
 {
 environment: 'prod',
 release: '1.0.0',
 userid: 'bob',
 usersegment: 'segmentA',
 transaction: 'TX',
 samplerate: '0.95',
 publickey: 'pubKey123',
 traceid: '1234',
 user_id: 'bob',
 user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 '',
 false,
 ],
 },
 },
 {
 release: '1.0.0',
 environment: 'prod',
user: { id: 'bob', segment: 'segmentA' },
release: '1.0.0',
 transaction: 'TX',
trace_id: '1234',
public_key: 'pubKey123',
user_id: 'bob',
user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 ],
 ];
Expand Down

2 changes: 1 addition & 1 deletion
packages/integration-tests/suites/tracing/browsertracing/meta/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 <meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-1" />
 <meta
 name="baggage"
 content="sentry-release=2.1.12,sentry-publickey=public,sentry-traceid=123,sentry-samplerate=0.3232"
 content="sentry-release=2.1.12,sentry-public_key=public,sentry-trace_id=123,sentry-sample_rate=0.3232"
 />
 </head>
</html>

8 changes: 3 additions & 5 deletions
packages/integration-tests/suites/tracing/envelope-header/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ import { sentryTest } from '../../../utils/fixtures';
import { envelopeHeaderRequestParser, getFirstSentryEnvelopeRequest } from '../../../utils/helpers';

sentryTest(
 'should send dynamic sampling context data in transaction envelope header',
 'should send dynamic sampling context data in trace envelope header of a transaction envelope',
 async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

Expand All@@ -15,10 +15,8 @@ sentryTest(
 expect(envHeader.trace).toEqual({
 environment: 'production',
 transaction: expect.stringContaining('index.html'),
 user: {
 id: 'user123',
 segment: 'segmentB',
 },
 user_id: 'user123',
 user_segment: 'segmentB',
 sample_rate: '1',
 trace_id: expect.any(String),
 public_key: 'public',
Expand Down

6 changes: 3 additions & 3 deletions
packages/node-integration-tests/suites/express/sentry-trace/baggage-header-assign/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,8 +78,8 @@ test('Should populate and propagate sentry baggage if sentry-trace header does n
 test_data: {
 host: 'somewhere.not.sentry',
 baggage: expect.stringContaining(
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,sentry-samplerate=1,' +
 'sentry-publickey=public,sentry-traceid=',
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand All@@ -99,7 +99,7 @@ test('Should populate Sentry and propagate 3rd party content if sentry-trace hea
 // TraceId changes, hence we only expect that the string contains the traceid key
 baggage: expect.stringContaining(
 'foo=bar,bar=baz,sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-samplerate=1,sentry-publickey=public,sentry-traceid=',
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand Down

12 changes: 7 additions & 5 deletions
packages/node/test/integrations/http.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,10 +108,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-userid=uid123,' +
 'sentry-usersegment=segmentA,sentry-samplerate=1,sentry-publickey=dogsarebadatkeepingsecrets,' +
 'sentry-traceid=12312012123120121231201212312012',
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_id=uid123,' +
 'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand All@@ -124,10 +125,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'dog=great,sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
 'sentry-userid=uid123,sentry-usersegment=segmentA,sentry-samplerate=1,' +
 'sentry-publickey=dogsarebadatkeepingsecrets,sentry-traceid=12312012123120121231201212312012',
 'sentry-user_id=uid123,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand Down

69 changes: 32 additions & 37 deletions
packages/tracing/src/transaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { getCurrentHub, Hub } from '@sentry/hub';
import {
 Baggage,
 BaggageObj,
 Event,
 Measurements,
 Transaction as TransactionInterface,
Expand All@@ -10,11 +11,11 @@ import {
import {
 createBaggage,
 dropUndefinedKeys,
 getSentryBaggageItems,
 getThirdPartyBaggage,
 isBaggageMutable,
 isSentryBaggageEmpty,
 logger,
 setBaggageImmutable,
 setBaggageValue,
} from '@sentry/utils';

import { Span as SpanClass, SpanRecorder } from './span';
Expand DownExpand Up@@ -228,40 +229,34 @@ export class Transaction extends SpanClass implements TransactionInterface {
 const hub: Hub = this._hub || getCurrentHub();
 const client = hub && hub.getClient();

 const { environment, release } = (client && client.getOptions()) || {};
 const { publicKey } = (client && client.getDsn()) || {};

 const sampleRate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const traceId = this.traceId;
 const transactionName = this.name;

 let userId, userSegment;
 hub.configureScope(scope => {
 const { id, segment } = scope.getUser() || {};
 userId = id;
 userSegment = segment;
 });

 environment && setBaggageValue(baggage, 'environment', environment);
 release && setBaggageValue(baggage, 'release', release);
 transactionName && setBaggageValue(baggage, 'transaction', transactionName);
 userId && setBaggageValue(baggage, 'userid', userId);
 userSegment && setBaggageValue(baggage, 'usersegment', userSegment);
 sampleRate &&
 setBaggageValue(
 baggage,
 'samplerate',
 // This will make sure that expnent notation (e.g. 1.45e-14) is converted to simple decimal representation
 // Another edge case would be something like Number.NEGATIVE_INFINITY in which case we could still
 // add something like .replace(/-?∞/, '0'). For the sake of saving bytes, I'll not add this until
 // it becomes a problem
 sampleRate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 }),
 );
 publicKey && setBaggageValue(baggage, 'publickey', publicKey);
 traceId && setBaggageValue(baggage, 'traceid', traceId);

 setBaggageImmutable(baggage);

 return baggage;
 if (!client) return baggage;

 const { environment, release } = client.getOptions() || {};
 const { publicKey: public_key } = client.getDsn() || {};

 const rate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const sample_rate =
 rate !== undefined
 ? rate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 })
 : undefined;

 const scope = hub.getScope();
 const { id: user_id, segment: user_segment } = (scope && scope.getUser()) || {};

 return createBaggage(
 dropUndefinedKeys({
 environment,
 release,
 transaction: this.name,
 user_id,
 user_segment,
 public_key,
 trace_id: this.traceId,
 sample_rate,
 ...getSentryBaggageItems(baggage), // keep user-added values
 } as BaggageObj),
 getThirdPartyBaggage(baggage), // TODO: remove once we ignore 3rd party baggage
 false, // set baggage immutable
 );
 }
}

4 changes: 2 additions & 2 deletions
packages/tracing/test/browser/browsertracing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,9 +507,9 @@ describe('BrowserTracing', () => {
 expect(baggage[0]).toEqual({
 release: '1.0.0',
 environment: 'production',
 publickey: 'pubKey',
 traceid: expect.any(String),
 transaction: 'blank',
 public_key: 'pubKey',
 trace_id: expect.not.stringMatching('12312012123120121231201212312012'),
 });
 expect(baggage[1]).toBeDefined();
 expect(baggage[1]).toEqual('');
Expand Down

8 changes: 4 additions & 4 deletions
packages/tracing/test/span.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -444,8 +444,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.56',
traceid: expect.any(String),
sample_rate: '0.56',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand All@@ -468,8 +468,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.0000000000000145',
traceid: expect.any(String),
sample_rate: '0.0000000000000145',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand Down

12 changes: 3 additions & 9 deletions
packages/types/src/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
export type AllowedBaggageKeys =
 | 'environment'
 | 'release'
 | 'transaction'
 | 'userid'
 | 'usersegment'
 | 'samplerate'
 | 'traceid'
 | 'publickey';
import { DynamicSamplingContext } from './envelope';

export type AllowedBaggageKeys = keyof DynamicSamplingContext;

export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;

Expand Down

10 changes: 4 additions & 6 deletions
packages/types/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@ import { UserFeedback } from './user';
// Based on: https://develop.sentry.dev/sdk/envelopes/

// Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
export type EventTraceContext = {
export type DynamicSamplingContext = {
 trace_id: Transaction['traceId'];
 public_key: DsnComponents['publicKey'];
 sample_rate?: string;
 release?: string;
 user?: {
 id?: string;
 segment?: string;
 };
 environment?: string;
 transaction?: string;
 user_id?: string;
 user_segment?: string;
};

export type EnvelopeItemType =
Expand DownExpand Up@@ -74,7 +72,7 @@ export type SessionItem =
 | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: EventTraceContext };
export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
type SessionEnvelopeHeaders = { sent_at: string };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;

Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,13 @@ export type {
 BaseEnvelopeItemHeaders,
 ClientReportEnvelope,
 ClientReportItem,
 DynamicSamplingContext,
 Envelope,
 EnvelopeItemType,
 EnvelopeItem,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SessionEnvelope,
 SessionItem,
 UserFeedbackItem,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(tracing): Unify DSC key names in envelope and baggage headers#5302

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 3 commits into

from

Jun 24, 2022
 Merged


ref(tracing): Unify DSC key names in envelope and baggage headers
#5302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
31a1753

ref(tracing): Unify DSC key names in envelope header and baggage header


Lms24 Jun 23, 2022
41d814e

apply code review suggestions


Lms24 Jun 24, 2022
db7945a

fix linter error


Lms24 Jun 24, 2022

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


25 changes: 6 additions & 19 deletions
packages/core/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import {
 Baggage,
 DsnComponents,
 DynamicSamplingContext,
 Event,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SdkInfo,
 SdkMetadata,
 Session,
Expand DownExpand Up@@ -100,31 +101,17 @@ function createEventEnvelopeHeaders(
 tunnel: string | undefined,
 dsn: DsnComponents,
): EventEnvelopeHeaders {
 const baggage = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const { environment, release, transaction, userid, usersegment, samplerate, publickey, traceid } =
 (baggage && getSentryBaggageItems(baggage)) || {};
 const baggage: Baggage | undefined = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const dynamicSamplingContext = baggage && getSentryBaggageItems(baggage);

 return {
 event_id: event.event_id as string,
 sent_at: new Date().toISOString(),
 ...(sdkInfo && { sdk: sdkInfo }),
 ...(!!tunnel && { dsn: dsnToString(dsn) }),
 ...(event.type === 'transaction' &&
 baggage && {
 trace: dropUndefinedKeys({
 trace_id: traceid,
 public_key: publickey,
 sample_rate: samplerate,
 environment,
 release,
 transaction,
 ...((userid || usersegment) && {
 user: {
 id: userid,
 segment: usersegment,
 },
 }),
 }) as EventTraceContext,
 dynamicSamplingContext && {
 trace: dropUndefinedKeys({ ...dynamicSamplingContext }) as DynamicSamplingContext,
 }),
 };
}

27 changes: 14 additions & 13 deletions
packages/core/test/lib/envelope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { DsnComponents, Event, EventTraceContext } from '@sentry/types';
import { DsnComponents, DynamicSamplingContext, Event } from '@sentry/types';

import { createEventEnvelope } from '../../src/envelope';

Expand All@@ -14,13 +14,13 @@ describe('createEventEnvelope', () => {
 expect(envelopeHeaders.trace).toBeUndefined();
 });

 const testTable: Array<[string, Event, EventTraceContext]> = [
 const testTable: Array<[string, Event, DynamicSamplingContext]> = [
 [
 'adds minimal baggage items',
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ traceid: '1234', publickey: 'pubKey123' }, '', false],
 baggage: [{ trace_id: '1234', public_key: 'pubKey123' }, '', false],
 },
 },
 { trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -30,7 +30,7 @@ describe('createEventEnvelope', () => {
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ environment: 'prod', release: '1.0.0', publickey: 'pubKey123', traceid: '1234' }, '', false],
 baggage: [{ environment: 'prod', release: '1.0.0', public_key: 'pubKey123', trace_id: '1234' }, '', false],
 },
 },
 { release: '1.0.0', environment: 'prod', trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -44,26 +44,27 @@ describe('createEventEnvelope', () => {
 {
 environment: 'prod',
 release: '1.0.0',
 userid: 'bob',
 usersegment: 'segmentA',
 transaction: 'TX',
 samplerate: '0.95',
 publickey: 'pubKey123',
 traceid: '1234',
 user_id: 'bob',
 user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 '',
 false,
 ],
 },
 },
 {
 release: '1.0.0',
 environment: 'prod',
user: { id: 'bob', segment: 'segmentA' },
release: '1.0.0',
 transaction: 'TX',
trace_id: '1234',
public_key: 'pubKey123',
user_id: 'bob',
user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 ],
 ];
Expand Down

2 changes: 1 addition & 1 deletion
packages/integration-tests/suites/tracing/browsertracing/meta/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 <meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-1" />
 <meta
 name="baggage"
 content="sentry-release=2.1.12,sentry-publickey=public,sentry-traceid=123,sentry-samplerate=0.3232"
 content="sentry-release=2.1.12,sentry-public_key=public,sentry-trace_id=123,sentry-sample_rate=0.3232"
 />
 </head>
</html>

8 changes: 3 additions & 5 deletions
packages/integration-tests/suites/tracing/envelope-header/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ import { sentryTest } from '../../../utils/fixtures';
import { envelopeHeaderRequestParser, getFirstSentryEnvelopeRequest } from '../../../utils/helpers';

sentryTest(
 'should send dynamic sampling context data in transaction envelope header',
 'should send dynamic sampling context data in trace envelope header of a transaction envelope',
 async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

Expand All@@ -15,10 +15,8 @@ sentryTest(
 expect(envHeader.trace).toEqual({
 environment: 'production',
 transaction: expect.stringContaining('index.html'),
 user: {
 id: 'user123',
 segment: 'segmentB',
 },
 user_id: 'user123',
 user_segment: 'segmentB',
 sample_rate: '1',
 trace_id: expect.any(String),
 public_key: 'public',
Expand Down

6 changes: 3 additions & 3 deletions
packages/node-integration-tests/suites/express/sentry-trace/baggage-header-assign/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,8 +78,8 @@ test('Should populate and propagate sentry baggage if sentry-trace header does n
 test_data: {
 host: 'somewhere.not.sentry',
 baggage: expect.stringContaining(
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,sentry-samplerate=1,' +
 'sentry-publickey=public,sentry-traceid=',
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand All@@ -99,7 +99,7 @@ test('Should populate Sentry and propagate 3rd party content if sentry-trace hea
 // TraceId changes, hence we only expect that the string contains the traceid key
 baggage: expect.stringContaining(
 'foo=bar,bar=baz,sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-samplerate=1,sentry-publickey=public,sentry-traceid=',
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand Down

12 changes: 7 additions & 5 deletions
packages/node/test/integrations/http.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,10 +108,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-userid=uid123,' +
 'sentry-usersegment=segmentA,sentry-samplerate=1,sentry-publickey=dogsarebadatkeepingsecrets,' +
 'sentry-traceid=12312012123120121231201212312012',
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_id=uid123,' +
 'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand All@@ -124,10 +125,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'dog=great,sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
 'sentry-userid=uid123,sentry-usersegment=segmentA,sentry-samplerate=1,' +
 'sentry-publickey=dogsarebadatkeepingsecrets,sentry-traceid=12312012123120121231201212312012',
 'sentry-user_id=uid123,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand Down

69 changes: 32 additions & 37 deletions
packages/tracing/src/transaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { getCurrentHub, Hub } from '@sentry/hub';
import {
 Baggage,
 BaggageObj,
 Event,
 Measurements,
 Transaction as TransactionInterface,
Expand All@@ -10,11 +11,11 @@ import {
import {
 createBaggage,
 dropUndefinedKeys,
 getSentryBaggageItems,
 getThirdPartyBaggage,
 isBaggageMutable,
 isSentryBaggageEmpty,
 logger,
 setBaggageImmutable,
 setBaggageValue,
} from '@sentry/utils';

import { Span as SpanClass, SpanRecorder } from './span';
Expand DownExpand Up@@ -228,40 +229,34 @@ export class Transaction extends SpanClass implements TransactionInterface {
 const hub: Hub = this._hub || getCurrentHub();
 const client = hub && hub.getClient();

 const { environment, release } = (client && client.getOptions()) || {};
 const { publicKey } = (client && client.getDsn()) || {};

 const sampleRate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const traceId = this.traceId;
 const transactionName = this.name;

 let userId, userSegment;
 hub.configureScope(scope => {
 const { id, segment } = scope.getUser() || {};
 userId = id;
 userSegment = segment;
 });

 environment && setBaggageValue(baggage, 'environment', environment);
 release && setBaggageValue(baggage, 'release', release);
 transactionName && setBaggageValue(baggage, 'transaction', transactionName);
 userId && setBaggageValue(baggage, 'userid', userId);
 userSegment && setBaggageValue(baggage, 'usersegment', userSegment);
 sampleRate &&
 setBaggageValue(
 baggage,
 'samplerate',
 // This will make sure that expnent notation (e.g. 1.45e-14) is converted to simple decimal representation
 // Another edge case would be something like Number.NEGATIVE_INFINITY in which case we could still
 // add something like .replace(/-?∞/, '0'). For the sake of saving bytes, I'll not add this until
 // it becomes a problem
 sampleRate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 }),
 );
 publicKey && setBaggageValue(baggage, 'publickey', publicKey);
 traceId && setBaggageValue(baggage, 'traceid', traceId);

 setBaggageImmutable(baggage);

 return baggage;
 if (!client) return baggage;

 const { environment, release } = client.getOptions() || {};
 const { publicKey: public_key } = client.getDsn() || {};

 const rate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const sample_rate =
 rate !== undefined
 ? rate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 })
 : undefined;

 const scope = hub.getScope();
 const { id: user_id, segment: user_segment } = (scope && scope.getUser()) || {};

 return createBaggage(
 dropUndefinedKeys({
 environment,
 release,
 transaction: this.name,
 user_id,
 user_segment,
 public_key,
 trace_id: this.traceId,
 sample_rate,
 ...getSentryBaggageItems(baggage), // keep user-added values
 } as BaggageObj),
 getThirdPartyBaggage(baggage), // TODO: remove once we ignore 3rd party baggage
 false, // set baggage immutable
 );
 }
}

4 changes: 2 additions & 2 deletions
packages/tracing/test/browser/browsertracing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,9 +507,9 @@ describe('BrowserTracing', () => {
 expect(baggage[0]).toEqual({
 release: '1.0.0',
 environment: 'production',
 publickey: 'pubKey',
 traceid: expect.any(String),
 transaction: 'blank',
 public_key: 'pubKey',
 trace_id: expect.not.stringMatching('12312012123120121231201212312012'),
 });
 expect(baggage[1]).toBeDefined();
 expect(baggage[1]).toEqual('');
Expand Down

8 changes: 4 additions & 4 deletions
packages/tracing/test/span.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -444,8 +444,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.56',
traceid: expect.any(String),
sample_rate: '0.56',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand All@@ -468,8 +468,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.0000000000000145',
traceid: expect.any(String),
sample_rate: '0.0000000000000145',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand Down

12 changes: 3 additions & 9 deletions
packages/types/src/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
export type AllowedBaggageKeys =
 | 'environment'
 | 'release'
 | 'transaction'
 | 'userid'
 | 'usersegment'
 | 'samplerate'
 | 'traceid'
 | 'publickey';
import { DynamicSamplingContext } from './envelope';

export type AllowedBaggageKeys = keyof DynamicSamplingContext;

export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;

Expand Down

10 changes: 4 additions & 6 deletions
packages/types/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@ import { UserFeedback } from './user';
// Based on: https://develop.sentry.dev/sdk/envelopes/

// Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
export type EventTraceContext = {
export type DynamicSamplingContext = {
 trace_id: Transaction['traceId'];
 public_key: DsnComponents['publicKey'];
 sample_rate?: string;
 release?: string;
 user?: {
 id?: string;
 segment?: string;
 };
 environment?: string;
 transaction?: string;
 user_id?: string;
 user_segment?: string;
};

export type EnvelopeItemType =
Expand DownExpand Up@@ -74,7 +72,7 @@ export type SessionItem =
 | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: EventTraceContext };
export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
type SessionEnvelopeHeaders = { sent_at: string };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;

Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,13 @@ export type {
 BaseEnvelopeItemHeaders,
 ClientReportEnvelope,
 ClientReportItem,
 DynamicSamplingContext,
 Envelope,
 EnvelopeItemType,
 EnvelopeItem,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SessionEnvelope,
 SessionItem,
 UserFeedbackItem,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(tracing): Unify DSC key names in envelope and baggage headers#5302

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 3 commits into

from

Jun 24, 2022
 Merged


ref(tracing): Unify DSC key names in envelope and baggage headers
#5302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
31a1753

ref(tracing): Unify DSC key names in envelope header and baggage header


Lms24 Jun 23, 2022
41d814e

apply code review suggestions


Lms24 Jun 24, 2022
db7945a

fix linter error


Lms24 Jun 24, 2022

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


25 changes: 6 additions & 19 deletions
packages/core/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import {
 Baggage,
 DsnComponents,
 DynamicSamplingContext,
 Event,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SdkInfo,
 SdkMetadata,
 Session,
Expand DownExpand Up@@ -100,31 +101,17 @@ function createEventEnvelopeHeaders(
 tunnel: string | undefined,
 dsn: DsnComponents,
): EventEnvelopeHeaders {
 const baggage = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const { environment, release, transaction, userid, usersegment, samplerate, publickey, traceid } =
 (baggage && getSentryBaggageItems(baggage)) || {};
 const baggage: Baggage | undefined = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const dynamicSamplingContext = baggage && getSentryBaggageItems(baggage);

 return {
 event_id: event.event_id as string,
 sent_at: new Date().toISOString(),
 ...(sdkInfo && { sdk: sdkInfo }),
 ...(!!tunnel && { dsn: dsnToString(dsn) }),
 ...(event.type === 'transaction' &&
 baggage && {
 trace: dropUndefinedKeys({
 trace_id: traceid,
 public_key: publickey,
 sample_rate: samplerate,
 environment,
 release,
 transaction,
 ...((userid || usersegment) && {
 user: {
 id: userid,
 segment: usersegment,
 },
 }),
 }) as EventTraceContext,
 dynamicSamplingContext && {
 trace: dropUndefinedKeys({ ...dynamicSamplingContext }) as DynamicSamplingContext,
 }),
 };
}

27 changes: 14 additions & 13 deletions
packages/core/test/lib/envelope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { DsnComponents, Event, EventTraceContext } from '@sentry/types';
import { DsnComponents, DynamicSamplingContext, Event } from '@sentry/types';

import { createEventEnvelope } from '../../src/envelope';

Expand All@@ -14,13 +14,13 @@ describe('createEventEnvelope', () => {
 expect(envelopeHeaders.trace).toBeUndefined();
 });

 const testTable: Array<[string, Event, EventTraceContext]> = [
 const testTable: Array<[string, Event, DynamicSamplingContext]> = [
 [
 'adds minimal baggage items',
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ traceid: '1234', publickey: 'pubKey123' }, '', false],
 baggage: [{ trace_id: '1234', public_key: 'pubKey123' }, '', false],
 },
 },
 { trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -30,7 +30,7 @@ describe('createEventEnvelope', () => {
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ environment: 'prod', release: '1.0.0', publickey: 'pubKey123', traceid: '1234' }, '', false],
 baggage: [{ environment: 'prod', release: '1.0.0', public_key: 'pubKey123', trace_id: '1234' }, '', false],
 },
 },
 { release: '1.0.0', environment: 'prod', trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -44,26 +44,27 @@ describe('createEventEnvelope', () => {
 {
 environment: 'prod',
 release: '1.0.0',
 userid: 'bob',
 usersegment: 'segmentA',
 transaction: 'TX',
 samplerate: '0.95',
 publickey: 'pubKey123',
 traceid: '1234',
 user_id: 'bob',
 user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 '',
 false,
 ],
 },
 },
 {
 release: '1.0.0',
 environment: 'prod',
user: { id: 'bob', segment: 'segmentA' },
release: '1.0.0',
 transaction: 'TX',
trace_id: '1234',
public_key: 'pubKey123',
user_id: 'bob',
user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 ],
 ];
Expand Down

2 changes: 1 addition & 1 deletion
packages/integration-tests/suites/tracing/browsertracing/meta/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 <meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-1" />
 <meta
 name="baggage"
 content="sentry-release=2.1.12,sentry-publickey=public,sentry-traceid=123,sentry-samplerate=0.3232"
 content="sentry-release=2.1.12,sentry-public_key=public,sentry-trace_id=123,sentry-sample_rate=0.3232"
 />
 </head>
</html>

8 changes: 3 additions & 5 deletions
packages/integration-tests/suites/tracing/envelope-header/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ import { sentryTest } from '../../../utils/fixtures';
import { envelopeHeaderRequestParser, getFirstSentryEnvelopeRequest } from '../../../utils/helpers';

sentryTest(
 'should send dynamic sampling context data in transaction envelope header',
 'should send dynamic sampling context data in trace envelope header of a transaction envelope',
 async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

Expand All@@ -15,10 +15,8 @@ sentryTest(
 expect(envHeader.trace).toEqual({
 environment: 'production',
 transaction: expect.stringContaining('index.html'),
 user: {
 id: 'user123',
 segment: 'segmentB',
 },
 user_id: 'user123',
 user_segment: 'segmentB',
 sample_rate: '1',
 trace_id: expect.any(String),
 public_key: 'public',
Expand Down

6 changes: 3 additions & 3 deletions
packages/node-integration-tests/suites/express/sentry-trace/baggage-header-assign/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,8 +78,8 @@ test('Should populate and propagate sentry baggage if sentry-trace header does n
 test_data: {
 host: 'somewhere.not.sentry',
 baggage: expect.stringContaining(
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,sentry-samplerate=1,' +
 'sentry-publickey=public,sentry-traceid=',
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand All@@ -99,7 +99,7 @@ test('Should populate Sentry and propagate 3rd party content if sentry-trace hea
 // TraceId changes, hence we only expect that the string contains the traceid key
 baggage: expect.stringContaining(
 'foo=bar,bar=baz,sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-samplerate=1,sentry-publickey=public,sentry-traceid=',
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand Down

12 changes: 7 additions & 5 deletions
packages/node/test/integrations/http.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,10 +108,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-userid=uid123,' +
 'sentry-usersegment=segmentA,sentry-samplerate=1,sentry-publickey=dogsarebadatkeepingsecrets,' +
 'sentry-traceid=12312012123120121231201212312012',
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_id=uid123,' +
 'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand All@@ -124,10 +125,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'dog=great,sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
 'sentry-userid=uid123,sentry-usersegment=segmentA,sentry-samplerate=1,' +
 'sentry-publickey=dogsarebadatkeepingsecrets,sentry-traceid=12312012123120121231201212312012',
 'sentry-user_id=uid123,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand Down

69 changes: 32 additions & 37 deletions
packages/tracing/src/transaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { getCurrentHub, Hub } from '@sentry/hub';
import {
 Baggage,
 BaggageObj,
 Event,
 Measurements,
 Transaction as TransactionInterface,
Expand All@@ -10,11 +11,11 @@ import {
import {
 createBaggage,
 dropUndefinedKeys,
 getSentryBaggageItems,
 getThirdPartyBaggage,
 isBaggageMutable,
 isSentryBaggageEmpty,
 logger,
 setBaggageImmutable,
 setBaggageValue,
} from '@sentry/utils';

import { Span as SpanClass, SpanRecorder } from './span';
Expand DownExpand Up@@ -228,40 +229,34 @@ export class Transaction extends SpanClass implements TransactionInterface {
 const hub: Hub = this._hub || getCurrentHub();
 const client = hub && hub.getClient();

 const { environment, release } = (client && client.getOptions()) || {};
 const { publicKey } = (client && client.getDsn()) || {};

 const sampleRate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const traceId = this.traceId;
 const transactionName = this.name;

 let userId, userSegment;
 hub.configureScope(scope => {
 const { id, segment } = scope.getUser() || {};
 userId = id;
 userSegment = segment;
 });

 environment && setBaggageValue(baggage, 'environment', environment);
 release && setBaggageValue(baggage, 'release', release);
 transactionName && setBaggageValue(baggage, 'transaction', transactionName);
 userId && setBaggageValue(baggage, 'userid', userId);
 userSegment && setBaggageValue(baggage, 'usersegment', userSegment);
 sampleRate &&
 setBaggageValue(
 baggage,
 'samplerate',
 // This will make sure that expnent notation (e.g. 1.45e-14) is converted to simple decimal representation
 // Another edge case would be something like Number.NEGATIVE_INFINITY in which case we could still
 // add something like .replace(/-?∞/, '0'). For the sake of saving bytes, I'll not add this until
 // it becomes a problem
 sampleRate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 }),
 );
 publicKey && setBaggageValue(baggage, 'publickey', publicKey);
 traceId && setBaggageValue(baggage, 'traceid', traceId);

 setBaggageImmutable(baggage);

 return baggage;
 if (!client) return baggage;

 const { environment, release } = client.getOptions() || {};
 const { publicKey: public_key } = client.getDsn() || {};

 const rate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const sample_rate =
 rate !== undefined
 ? rate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 })
 : undefined;

 const scope = hub.getScope();
 const { id: user_id, segment: user_segment } = (scope && scope.getUser()) || {};

 return createBaggage(
 dropUndefinedKeys({
 environment,
 release,
 transaction: this.name,
 user_id,
 user_segment,
 public_key,
 trace_id: this.traceId,
 sample_rate,
 ...getSentryBaggageItems(baggage), // keep user-added values
 } as BaggageObj),
 getThirdPartyBaggage(baggage), // TODO: remove once we ignore 3rd party baggage
 false, // set baggage immutable
 );
 }
}

4 changes: 2 additions & 2 deletions
packages/tracing/test/browser/browsertracing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,9 +507,9 @@ describe('BrowserTracing', () => {
 expect(baggage[0]).toEqual({
 release: '1.0.0',
 environment: 'production',
 publickey: 'pubKey',
 traceid: expect.any(String),
 transaction: 'blank',
 public_key: 'pubKey',
 trace_id: expect.not.stringMatching('12312012123120121231201212312012'),
 });
 expect(baggage[1]).toBeDefined();
 expect(baggage[1]).toEqual('');
Expand Down

8 changes: 4 additions & 4 deletions
packages/tracing/test/span.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -444,8 +444,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.56',
traceid: expect.any(String),
sample_rate: '0.56',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand All@@ -468,8 +468,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.0000000000000145',
traceid: expect.any(String),
sample_rate: '0.0000000000000145',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand Down

12 changes: 3 additions & 9 deletions
packages/types/src/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
export type AllowedBaggageKeys =
 | 'environment'
 | 'release'
 | 'transaction'
 | 'userid'
 | 'usersegment'
 | 'samplerate'
 | 'traceid'
 | 'publickey';
import { DynamicSamplingContext } from './envelope';

export type AllowedBaggageKeys = keyof DynamicSamplingContext;

export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;

Expand Down

10 changes: 4 additions & 6 deletions
packages/types/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@ import { UserFeedback } from './user';
// Based on: https://develop.sentry.dev/sdk/envelopes/

// Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
export type EventTraceContext = {
export type DynamicSamplingContext = {
 trace_id: Transaction['traceId'];
 public_key: DsnComponents['publicKey'];
 sample_rate?: string;
 release?: string;
 user?: {
 id?: string;
 segment?: string;
 };
 environment?: string;
 transaction?: string;
 user_id?: string;
 user_segment?: string;
};

export type EnvelopeItemType =
Expand DownExpand Up@@ -74,7 +72,7 @@ export type SessionItem =
 | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: EventTraceContext };
export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
type SessionEnvelopeHeaders = { sent_at: string };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;

Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,13 @@ export type {
 BaseEnvelopeItemHeaders,
 ClientReportEnvelope,
 ClientReportItem,
 DynamicSamplingContext,
 Envelope,
 EnvelopeItemType,
 EnvelopeItem,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SessionEnvelope,
 SessionItem,
 UserFeedbackItem,
Expand Down

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

Skip to content
ref(tracing): Unify DSC key names in envelope and baggage headers#5302

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

Lms24
merged 3 commits into

from

Jun 24, 2022
 Merged


ref(tracing): Unify DSC key names in envelope and baggage headers
#5302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
31a1753

ref(tracing): Unify DSC key names in envelope header and baggage header


Lms24 Jun 23, 2022
41d814e

apply code review suggestions


Lms24 Jun 24, 2022
db7945a

fix linter error


Lms24 Jun 24, 2022

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


25 changes: 6 additions & 19 deletions
packages/core/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import {
 Baggage,
 DsnComponents,
 DynamicSamplingContext,
 Event,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SdkInfo,
 SdkMetadata,
 Session,
Expand DownExpand Up@@ -100,31 +101,17 @@ function createEventEnvelopeHeaders(
 tunnel: string | undefined,
 dsn: DsnComponents,
): EventEnvelopeHeaders {
 const baggage = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const { environment, release, transaction, userid, usersegment, samplerate, publickey, traceid } =
 (baggage && getSentryBaggageItems(baggage)) || {};
 const baggage: Baggage | undefined = event.sdkProcessingMetadata && event.sdkProcessingMetadata.baggage;
 const dynamicSamplingContext = baggage && getSentryBaggageItems(baggage);

 return {
 event_id: event.event_id as string,
 sent_at: new Date().toISOString(),
 ...(sdkInfo && { sdk: sdkInfo }),
 ...(!!tunnel && { dsn: dsnToString(dsn) }),
 ...(event.type === 'transaction' &&
 baggage && {
 trace: dropUndefinedKeys({
 trace_id: traceid,
 public_key: publickey,
 sample_rate: samplerate,
 environment,
 release,
 transaction,
 ...((userid || usersegment) && {
 user: {
 id: userid,
 segment: usersegment,
 },
 }),
 }) as EventTraceContext,
 dynamicSamplingContext && {
 trace: dropUndefinedKeys({ ...dynamicSamplingContext }) as DynamicSamplingContext,
 }),
 };
}

27 changes: 14 additions & 13 deletions
packages/core/test/lib/envelope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { DsnComponents, Event, EventTraceContext } from '@sentry/types';
import { DsnComponents, DynamicSamplingContext, Event } from '@sentry/types';

import { createEventEnvelope } from '../../src/envelope';

Expand All@@ -14,13 +14,13 @@ describe('createEventEnvelope', () => {
 expect(envelopeHeaders.trace).toBeUndefined();
 });

 const testTable: Array<[string, Event, EventTraceContext]> = [
 const testTable: Array<[string, Event, DynamicSamplingContext]> = [
 [
 'adds minimal baggage items',
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ traceid: '1234', publickey: 'pubKey123' }, '', false],
 baggage: [{ trace_id: '1234', public_key: 'pubKey123' }, '', false],
 },
 },
 { trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -30,7 +30,7 @@ describe('createEventEnvelope', () => {
 {
 type: 'transaction',
 sdkProcessingMetadata: {
 baggage: [{ environment: 'prod', release: '1.0.0', publickey: 'pubKey123', traceid: '1234' }, '', false],
 baggage: [{ environment: 'prod', release: '1.0.0', public_key: 'pubKey123', trace_id: '1234' }, '', false],
 },
 },
 { release: '1.0.0', environment: 'prod', trace_id: '1234', public_key: 'pubKey123' },
Expand All@@ -44,26 +44,27 @@ describe('createEventEnvelope', () => {
 {
 environment: 'prod',
 release: '1.0.0',
 userid: 'bob',
 usersegment: 'segmentA',
 transaction: 'TX',
 samplerate: '0.95',
 publickey: 'pubKey123',
 traceid: '1234',
 user_id: 'bob',
 user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 '',
 false,
 ],
 },
 },
 {
 release: '1.0.0',
 environment: 'prod',
user: { id: 'bob', segment: 'segmentA' },
release: '1.0.0',
 transaction: 'TX',
trace_id: '1234',
public_key: 'pubKey123',
user_id: 'bob',
user_segment: 'segmentA',
 sample_rate: '0.95',
 public_key: 'pubKey123',
 trace_id: '1234',
 },
 ],
 ];
Expand Down

2 changes: 1 addition & 1 deletion
packages/integration-tests/suites/tracing/browsertracing/meta/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 <meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-1" />
 <meta
 name="baggage"
 content="sentry-release=2.1.12,sentry-publickey=public,sentry-traceid=123,sentry-samplerate=0.3232"
 content="sentry-release=2.1.12,sentry-public_key=public,sentry-trace_id=123,sentry-sample_rate=0.3232"
 />
 </head>
</html>

8 changes: 3 additions & 5 deletions
packages/integration-tests/suites/tracing/envelope-header/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ import { sentryTest } from '../../../utils/fixtures';
import { envelopeHeaderRequestParser, getFirstSentryEnvelopeRequest } from '../../../utils/helpers';

sentryTest(
 'should send dynamic sampling context data in transaction envelope header',
 'should send dynamic sampling context data in trace envelope header of a transaction envelope',
 async ({ getLocalTestPath, page }) => {
 const url = await getLocalTestPath({ testDir: __dirname });

Expand All@@ -15,10 +15,8 @@ sentryTest(
 expect(envHeader.trace).toEqual({
 environment: 'production',
 transaction: expect.stringContaining('index.html'),
 user: {
 id: 'user123',
 segment: 'segmentB',
 },
 user_id: 'user123',
 user_segment: 'segmentB',
 sample_rate: '1',
 trace_id: expect.any(String),
 public_key: 'public',
Expand Down

6 changes: 3 additions & 3 deletions
packages/node-integration-tests/suites/express/sentry-trace/baggage-header-assign/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,8 +78,8 @@ test('Should populate and propagate sentry baggage if sentry-trace header does n
 test_data: {
 host: 'somewhere.not.sentry',
 baggage: expect.stringContaining(
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,sentry-samplerate=1,' +
 'sentry-publickey=public,sentry-traceid=',
 'sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand All@@ -99,7 +99,7 @@ test('Should populate Sentry and propagate 3rd party content if sentry-trace hea
 // TraceId changes, hence we only expect that the string contains the traceid key
 baggage: expect.stringContaining(
 'foo=bar,bar=baz,sentry-environment=prod,sentry-release=1.0,sentry-transaction=GET%20%2Ftest%2Fexpress,' +
 'sentry-samplerate=1,sentry-publickey=public,sentry-traceid=',
 'sentry-public_key=public,sentry-trace_id=',
 ),
 },
 });
Expand Down

12 changes: 7 additions & 5 deletions
packages/node/test/integrations/http.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,10 +108,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-userid=uid123,' +
 'sentry-usersegment=segmentA,sentry-samplerate=1,sentry-publickey=dogsarebadatkeepingsecrets,' +
 'sentry-traceid=12312012123120121231201212312012',
 'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_id=uid123,' +
 'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand All@@ -124,10 +125,11 @@ describe('tracing', () => {
 const baggageHeader = request.getHeader('baggage') as string;

 expect(baggageHeader).toBeDefined();
 expect(typeof baggageHeader).toEqual('string');
 expect(baggageHeader).toEqual(
 'dog=great,sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
 'sentry-userid=uid123,sentry-usersegment=segmentA,sentry-samplerate=1,' +
 'sentry-publickey=dogsarebadatkeepingsecrets,sentry-traceid=12312012123120121231201212312012',
 'sentry-user_id=uid123,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
 'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
 );
 });

Expand Down

69 changes: 32 additions & 37 deletions
packages/tracing/src/transaction.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { getCurrentHub, Hub } from '@sentry/hub';
import {
 Baggage,
 BaggageObj,
 Event,
 Measurements,
 Transaction as TransactionInterface,
Expand All@@ -10,11 +11,11 @@ import {
import {
 createBaggage,
 dropUndefinedKeys,
 getSentryBaggageItems,
 getThirdPartyBaggage,
 isBaggageMutable,
 isSentryBaggageEmpty,
 logger,
 setBaggageImmutable,
 setBaggageValue,
} from '@sentry/utils';

import { Span as SpanClass, SpanRecorder } from './span';
Expand DownExpand Up@@ -228,40 +229,34 @@ export class Transaction extends SpanClass implements TransactionInterface {
 const hub: Hub = this._hub || getCurrentHub();
 const client = hub && hub.getClient();

 const { environment, release } = (client && client.getOptions()) || {};
 const { publicKey } = (client && client.getDsn()) || {};

 const sampleRate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const traceId = this.traceId;
 const transactionName = this.name;

 let userId, userSegment;
 hub.configureScope(scope => {
 const { id, segment } = scope.getUser() || {};
 userId = id;
 userSegment = segment;
 });

 environment && setBaggageValue(baggage, 'environment', environment);
 release && setBaggageValue(baggage, 'release', release);
 transactionName && setBaggageValue(baggage, 'transaction', transactionName);
 userId && setBaggageValue(baggage, 'userid', userId);
 userSegment && setBaggageValue(baggage, 'usersegment', userSegment);
 sampleRate &&
 setBaggageValue(
 baggage,
 'samplerate',
 // This will make sure that expnent notation (e.g. 1.45e-14) is converted to simple decimal representation
 // Another edge case would be something like Number.NEGATIVE_INFINITY in which case we could still
 // add something like .replace(/-?∞/, '0'). For the sake of saving bytes, I'll not add this until
 // it becomes a problem
 sampleRate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 }),
 );
 publicKey && setBaggageValue(baggage, 'publickey', publicKey);
 traceId && setBaggageValue(baggage, 'traceid', traceId);

 setBaggageImmutable(baggage);

 return baggage;
 if (!client) return baggage;

 const { environment, release } = client.getOptions() || {};
 const { publicKey: public_key } = client.getDsn() || {};

 const rate = this.metadata && this.metadata.transactionSampling && this.metadata.transactionSampling.rate;
 const sample_rate =
 rate !== undefined
 ? rate.toLocaleString('fullwide', { useGrouping: false, maximumFractionDigits: 16 })
 : undefined;

 const scope = hub.getScope();
 const { id: user_id, segment: user_segment } = (scope && scope.getUser()) || {};

 return createBaggage(
 dropUndefinedKeys({
 environment,
 release,
 transaction: this.name,
 user_id,
 user_segment,
 public_key,
 trace_id: this.traceId,
 sample_rate,
 ...getSentryBaggageItems(baggage), // keep user-added values
 } as BaggageObj),
 getThirdPartyBaggage(baggage), // TODO: remove once we ignore 3rd party baggage
 false, // set baggage immutable
 );
 }
}

4 changes: 2 additions & 2 deletions
packages/tracing/test/browser/browsertracing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -507,9 +507,9 @@ describe('BrowserTracing', () => {
 expect(baggage[0]).toEqual({
 release: '1.0.0',
 environment: 'production',
 publickey: 'pubKey',
 traceid: expect.any(String),
 transaction: 'blank',
 public_key: 'pubKey',
 trace_id: expect.not.stringMatching('12312012123120121231201212312012'),
 });
 expect(baggage[1]).toBeDefined();
 expect(baggage[1]).toEqual('');
Expand Down

8 changes: 4 additions & 4 deletions
packages/tracing/test/span.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -444,8 +444,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.56',
traceid: expect.any(String),
sample_rate: '0.56',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand All@@ -468,8 +468,8 @@ describe('Span', () => {
 release: '1.0.1',
 environment: 'production',
 transaction: 'tx',
samplerate: '0.0000000000000145',
traceid: expect.any(String),
sample_rate: '0.0000000000000145',
trace_id: expect.any(String),
 });
 expect(baggage && getThirdPartyBaggage(baggage)).toStrictEqual('');
 });
Expand Down

12 changes: 3 additions & 9 deletions
packages/types/src/baggage.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
export type AllowedBaggageKeys =
 | 'environment'
 | 'release'
 | 'transaction'
 | 'userid'
 | 'usersegment'
 | 'samplerate'
 | 'traceid'
 | 'publickey';
import { DynamicSamplingContext } from './envelope';

export type AllowedBaggageKeys = keyof DynamicSamplingContext;

export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;

Expand Down

10 changes: 4 additions & 6 deletions
packages/types/src/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@ import { UserFeedback } from './user';
// Based on: https://develop.sentry.dev/sdk/envelopes/

// Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
export type EventTraceContext = {
export type DynamicSamplingContext = {
 trace_id: Transaction['traceId'];
 public_key: DsnComponents['publicKey'];
 sample_rate?: string;
 release?: string;
 user?: {
 id?: string;
 segment?: string;
 };
 environment?: string;
 transaction?: string;
 user_id?: string;
 user_segment?: string;
};

export type EnvelopeItemType =
Expand DownExpand Up@@ -74,7 +72,7 @@ export type SessionItem =
 | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;

export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: EventTraceContext };
export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
type SessionEnvelopeHeaders = { sent_at: string };
type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;

Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,13 @@ export type {
 BaseEnvelopeItemHeaders,
 ClientReportEnvelope,
 ClientReportItem,
 DynamicSamplingContext,
 Envelope,
 EnvelopeItemType,
 EnvelopeItem,
 EventEnvelope,
 EventEnvelopeHeaders,
 EventItem,
 EventTraceContext,
 SessionEnvelope,
 SessionItem,
 UserFeedbackItem,
Expand Down