Skip to content

ref: Remove user segment #10575

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.

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
merged 2 commits into from
Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ sentryTest(

await page.evaluate(() => {
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setUser({ id: 'user123' });
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
Expand All @@ -53,7 +53,6 @@ sentryTest(
expect(envHeader.trace).toBeDefined();
expect(envHeader.trace).toEqual({
environment: 'production',
user_segment: 'segmentB',
sample_rate: '1',
trace_id: expect.any(String),
public_key: 'public',
Expand Down Expand Up @@ -84,7 +83,7 @@ sentryTest(

await page.evaluate(() => {
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setUser({ id: 'user123' });
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
Expand All @@ -101,7 +100,6 @@ sentryTest(
expect(envHeader.trace).toBeDefined();
expect(envHeader.trace).toEqual({
environment: 'production',
user_segment: 'segmentB',
sample_rate: '1',
trace_id: expect.any(String),
public_key: 'public',
Expand Down Expand Up @@ -144,7 +142,7 @@ sentryTest(

await page.evaluate(() => {
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setUser({ id: 'user123' });
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
Expand All @@ -162,7 +160,6 @@ sentryTest(
expect(envHeader.trace).toBeDefined();
expect(envHeader.trace).toEqual({
environment: 'production',
user_segment: 'segmentB',
sample_rate: '1',
trace_id: expect.any(String),
public_key: 'public',
Expand Down Expand Up @@ -195,7 +192,7 @@ sentryTest(

await page.evaluate(async () => {
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setUser({ id: 'user123' });
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
Expand All @@ -213,7 +210,6 @@ sentryTest(
expect(envHeader.trace).toBeDefined();
expect(envHeader.trace).toEqual({
environment: 'production',
user_segment: 'segmentB',
sample_rate: '1',
trace_id: expect.any(String),
public_key: 'public',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Sentry.init({
});

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setUser({ id: 'user123' });
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ sentryTest(
expect(envHeader.trace).toBeDefined();
expect(envHeader.trace).toEqual({
environment: 'production',
user_segment: 'segmentB',
sample_rate: '1',
transaction: expect.stringContaining('/index.html'),
trace_id: expect.any(String),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Sentry.init({
});

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setUser({ id: 'user123' });
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ sentryTest(
expect(envHeader.trace).toBeDefined();
expect(envHeader.trace).toEqual({
environment: 'production',
user_segment: 'segmentB',
sample_rate: '1',
trace_id: expect.any(String),
public_key: 'public',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Sentry.init({
transport: loggingTransport,
});

Sentry.setUser({ id: 'user123', segment: 'SegmentA' });
Sentry.setUser({ id: 'user123' });

app.use(Sentry.Handlers.requestHandler());
app.use(Sentry.Handlers.tracingHandler());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ test('should attach a baggage header to an outgoing request.', async () => {
test_data: {
host: 'somewhere.not.sentry',
baggage:
'sentry-environment=prod,sentry-release=1.0,sentry-user_segment=SegmentA,sentry-public_key=public' +
'sentry-environment=prod,sentry-release=1.0,sentry-public_key=public' +
',sentry-trace_id=86f39e84263a4de99c326acab3bfe3bd,sentry-sample_rate=1,sentry-transaction=GET%20%2Ftest%2Fexpress' +
',sentry-sampled=true',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Sentry.init({
transport: loggingTransport,
});

Sentry.setUser({ id: 'user123', segment: 'SegmentA' });
Sentry.setUser({ id: 'user123' });

app.use(Sentry.Handlers.requestHandler());
app.use(Sentry.Handlers.tracingHandler());
Expand Down
2 changes: 1 addition & 1 deletion packages/astro/src/server/meta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export function getTracingMetaTags(
: dsc
? dsc
: client
? getDynamicSamplingContextFromClient(traceId, client, scope)
? getDynamicSamplingContextFromClient(traceId, client)
: undefined;

const baggage = dynamicSamplingContextToSentryBaggageHeader(dynamicSamplingContext);
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/baseclient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -679,7 +679,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
...evt.contexts,
};

const dynamicSamplingContext = dsc ? dsc : getDynamicSamplingContextFromClient(trace_id, this, scope);
const dynamicSamplingContext = dsc ? dsc : getDynamicSamplingContextFromClient(trace_id, this);

evt.sdkProcessingMetadata = {
dynamicSamplingContext,
Expand Down
1 change: 0 additions & 1 deletion packages/core/src/scope.ts
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,6 @@ export class Scope implements ScopeInterface {
email: undefined,
id: undefined,
ip_address: undefined,
segment: undefined,
username: undefined,
};

Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/server-runtime-client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,6 @@ export class ServerRuntimeClient<
return [dsc, traceContext];
}

return [getDynamicSamplingContextFromClient(traceId, this, scope), traceContext];
return [getDynamicSamplingContextFromClient(traceId, this), traceContext];
}
}
16 changes: 4 additions & 12 deletions packages/core/src/tracing/dynamicSamplingContext.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type { Client, DynamicSamplingContext, Scope, Span, Transaction } from '@sentry/types';
import type { Client, DynamicSamplingContext, Span, Transaction } from '@sentry/types';
import { dropUndefinedKeys } from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getClient, getCurrentScope } from '../exports';
import { getClient } from '../exports';
import { getRootSpan } from '../utils/getRootSpan';
import { spanIsSampled, spanToJSON } from '../utils/spanUtils';

Expand All @@ -11,22 +11,14 @@ import { spanIsSampled, spanToJSON } from '../utils/spanUtils';
*
* Dispatches the `createDsc` lifecycle hook as a side effect.
*/
export function getDynamicSamplingContextFromClient(
trace_id: string,
client: Client,
scope?: Scope,
): DynamicSamplingContext {
export function getDynamicSamplingContextFromClient(trace_id: string, client: Client): DynamicSamplingContext {
const options = client.getOptions();

const { publicKey: public_key } = client.getDsn() || {};
// TODO(v8): Remove segment from User
// eslint-disable-next-line deprecation/deprecation
const { segment: user_segment } = (scope && scope.getUser()) || {};

const dsc = dropUndefinedKeys({
environment: options.environment || DEFAULT_ENVIRONMENT,
release: options.release,
user_segment,
public_key,
trace_id,
}) as DynamicSamplingContext;
Expand Down Expand Up @@ -55,7 +47,7 @@ export function getDynamicSamplingContextFromSpan(span: Span): Readonly<Partial<
}

// passing emit=false here to only emit later once the DSC is actually populated
const dsc = getDynamicSamplingContextFromClient(spanToJSON(span).trace_id || '', client, getCurrentScope());
const dsc = getDynamicSamplingContextFromClient(spanToJSON(span).trace_id || '', client);

// TODO (v8): Remove v7FrozenDsc as a Transaction will no longer have _frozenDynamicSamplingContext
const txn = getRootSpan(span) as TransactionWithV7FrozenDsc | undefined;
Expand Down
2 changes: 0 additions & 2 deletions packages/core/test/lib/envelope.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ describe('createEventEnvelope', () => {
environment: 'prod',
release: '1.0.0',
transaction: 'TX',
user_segment: 'segmentA',
sample_rate: '0.95',
public_key: 'pubKey123',
trace_id: '1234',
Expand All @@ -52,7 +51,6 @@ describe('createEventEnvelope', () => {
environment: 'prod',
release: '1.0.0',
transaction: 'TX',
user_segment: 'segmentA',
sample_rate: '0.95',
public_key: 'pubKey123',
trace_id: '1234',
Expand Down
2 changes: 1 addition & 1 deletion packages/node/src/integrations/http.ts
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ function _createWrappedRequestMethodFactory(
dsc ||
(requestSpan
? getDynamicSamplingContextFromSpan(requestSpan)
: getDynamicSamplingContextFromClient(traceId, client, scope)),
: getDynamicSamplingContextFromClient(traceId, client)),
);

addHeadersToRequestOptions(requestOptions, requestUrl, sentryTraceHeader, sentryBaggageHeader);
Expand Down
5 changes: 1 addition & 4 deletions packages/node/src/integrations/undici/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -214,10 +214,7 @@ export class Undici implements Integration {
const sentryTraceHeader = span ? spanToTraceHeader(span) : generateSentryTraceHeader(traceId, spanId, sampled);

const sentryBaggageHeader = dynamicSamplingContextToSentryBaggageHeader(
dsc ||
(span
? getDynamicSamplingContextFromSpan(span)
: getDynamicSamplingContextFromClient(traceId, client, scope)),
dsc || (span ? getDynamicSamplingContextFromSpan(span) : getDynamicSamplingContextFromClient(traceId, client)),
);

setHeadersOnRequest(request, sentryTraceHeader, sentryBaggageHeader);
Expand Down
11 changes: 5 additions & 6 deletions packages/node/test/integrations/http.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ describe('tracing', () => {

setUser({
id: 'uid123',
segment: 'segmentA',
});

const transaction = startInactiveSpan({
Expand Down Expand Up @@ -139,7 +138,7 @@ describe('tracing', () => {

expect(baggageHeader).toEqual(
'sentry-environment=production,sentry-release=1.0.0,' +
'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
'sentry-public_key=dogsarebadatkeepingsecrets,' +
'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1,' +
'sentry-transaction=dogpark,sentry-sampled=true',
);
Expand All @@ -155,7 +154,7 @@ describe('tracing', () => {

expect(baggageHeader[0]).toEqual('dog=great');
expect(baggageHeader[1]).toEqual(
'sentry-environment=production,sentry-release=1.0.0,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1,sentry-transaction=dogpark,sentry-sampled=true',
'sentry-environment=production,sentry-release=1.0.0,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1,sentry-transaction=dogpark,sentry-sampled=true',
);
});

Expand All @@ -169,7 +168,7 @@ describe('tracing', () => {

expect(baggageHeader).toEqual([
'dog=great',
'sentry-environment=production,sentry-release=1.0.0,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1,sentry-transaction=dogpark,sentry-sampled=true',
'sentry-environment=production,sentry-release=1.0.0,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1,sentry-transaction=dogpark,sentry-sampled=true',
]);
});

Expand All @@ -183,7 +182,7 @@ describe('tracing', () => {

expect(baggageHeader).toEqual([
'dog=great',
'sentry-environment=production,sentry-release=1.0.0,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1,sentry-sampled=true',
'sentry-environment=production,sentry-release=1.0.0,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1,sentry-sampled=true',
]);
});

Expand Down Expand Up @@ -220,7 +219,7 @@ describe('tracing', () => {
expect(parts[1]).toEqual(expect.any(String));

expect(baggageHeader).toEqual(
`sentry-environment=production,sentry-release=1.0.0,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=${traceId}`,
`sentry-environment=production,sentry-release=1.0.0,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=${traceId}`,
);
});

Expand Down
8 changes: 2 additions & 6 deletions packages/opentelemetry/src/propagator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import { SENTRY_BAGGAGE_KEY_PREFIX, generateSentryTraceHeader, propagationContex

import { SENTRY_BAGGAGE_HEADER, SENTRY_TRACE_HEADER } from './constants';
import { getPropagationContextFromContext, setPropagationContextOnContext } from './utils/contextData';
import { getSpanScope } from './utils/spanData';

/**
* Injects and extracts `sentry-trace` and `baggage` headers from carriers.
Expand All @@ -25,7 +24,7 @@ export class SentryPropagator extends W3CBaggagePropagator {

const propagationContext = getPropagationContextFromContext(context);
const { spanId, traceId, sampled } = getSentryTraceData(context, propagationContext);
const dynamicSamplingContext = propagationContext ? getDsc(context, propagationContext, traceId) : undefined;
const dynamicSamplingContext = propagationContext ? getDsc(propagationContext, traceId) : undefined;

if (dynamicSamplingContext) {
baggage = Object.entries(dynamicSamplingContext).reduce<Baggage>((b, [dscKey, dscValue]) => {
Expand Down Expand Up @@ -79,7 +78,6 @@ export class SentryPropagator extends W3CBaggagePropagator {
}

function getDsc(
context: Context,
propagationContext: PropagationContext,
traceId: string | undefined,
): Partial<DynamicSamplingContext> | undefined {
Expand All @@ -90,11 +88,9 @@ function getDsc(

// Else, we try to generate a new one
const client = getClient();
const activeSpan = trace.getSpan(context);
const scope = activeSpan ? getSpanScope(activeSpan) : undefined;

if (client) {
return getDynamicSamplingContextFromClient(traceId || propagationContext.traceId, client, scope);
return getDynamicSamplingContextFromClient(traceId || propagationContext.traceId, client);
}

return undefined;
Expand Down
8 changes: 7 additions & 1 deletion packages/profiling-node/clang-format.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@ const child_process = require('child_process');
const args = ['--Werror', '-i', '--style=file', 'bindings/cpu_profiler.cc'];
const cmd = `./node_modules/.bin/clang-format ${args.join(' ')}`;

child_process.execSync(cmd);
try {
child_process.execSync(cmd);
} catch (e) {
// This fails on linux_arm64
// eslint-disable-next-line no-console
console.log('Running clang format command failed.');
}

// eslint-disable-next-line no-console
console.log('clang-format: done, checking tree...');
Expand Down
3 changes: 1 addition & 2 deletions packages/sveltekit/test/server/handle.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ describe('handleSentry', () => {
if (key === 'baggage') {
return (
'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
'sentry-public_key=dogsarebadatkeepingsecrets,' +
'sentry-trace_id=1234567890abcdef1234567890abcdef,sentry-sample_rate=1'
);
}
Expand Down Expand Up @@ -258,7 +258,6 @@ describe('handleSentry', () => {
sample_rate: '1',
trace_id: '1234567890abcdef1234567890abcdef',
transaction: 'dogpark',
user_segment: 'segmentA',
});
});

Expand Down
4 changes: 1 addition & 3 deletions packages/sveltekit/test/server/load.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ function getServerOnlyArgs() {
if (key === 'baggage') {
return (
'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
'sentry-public_key=dogsarebadatkeepingsecrets,' +
'sentry-trace_id=1234567890abcdef1234567890abcdef,sentry-sample_rate=1'
);
}
Expand Down Expand Up @@ -274,7 +274,6 @@ describe('wrapServerLoadWithSentry calls trace', () => {
sample_rate: '1',
trace_id: '1234567890abcdef1234567890abcdef',
transaction: 'dogpark',
user_segment: 'segmentA',
},
source: 'route',
},
Expand Down Expand Up @@ -365,7 +364,6 @@ describe('wrapServerLoadWithSentry calls trace', () => {
sample_rate: '1',
trace_id: '1234567890abcdef1234567890abcdef',
transaction: 'dogpark',
user_segment: 'segmentA',
},
source: 'url',
},
Expand Down
Loading