-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(core): Deprecate
Transaction.getDynamicSamplingContext in favo…
…ur of `getDynamicSamplingContextFromSpan` (#10094) Deprecate `Transaction.getDynamicSamplingContext` and introduce its direct replacement, a top-level utility function. Note that this only is an intermediate step we should take to rework how we generate and handle the DSC creation. More details in #10095
- Loading branch information
Showing
24 changed files
with
276 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
124 changes: 124 additions & 0 deletions
124
packages/core/test/lib/tracing/dynamicSamplingContext.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| import type { TransactionSource } from '@sentry/types'; | ||
| import { Hub, SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, makeMain } from '../../../src'; | ||
| import { Transaction, getDynamicSamplingContextFromSpan, startInactiveSpan } from '../../../src/tracing'; | ||
| import { addTracingExtensions } from '../../../src/tracing'; | ||
| import { TestClient, getDefaultTestClientOptions } from '../../mocks/client'; | ||
|
|
||
| describe('getDynamicSamplingContextFromSpan', () => { | ||
| let hub: Hub; | ||
| beforeEach(() => { | ||
| const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0, release: '1.0.1' }); | ||
| const client = new TestClient(options); | ||
| hub = new Hub(client); | ||
| hub.bindClient(client); | ||
| makeMain(hub); | ||
| addTracingExtensions(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| jest.resetAllMocks(); | ||
| }); | ||
|
|
||
| test('returns the DSC provided during transaction creation', () => { | ||
| const transaction = new Transaction({ | ||
| name: 'tx', | ||
| metadata: { dynamicSamplingContext: { environment: 'myEnv' } }, | ||
| }); | ||
|
|
||
| const dynamicSamplingContext = getDynamicSamplingContextFromSpan(transaction); | ||
|
|
||
| expect(dynamicSamplingContext).toStrictEqual({ environment: 'myEnv' }); | ||
| }); | ||
|
|
||
| test('returns a new DSC, if no DSC was provided during transaction creation (via attributes)', () => { | ||
| const transaction = startInactiveSpan({ name: 'tx' }); | ||
|
|
||
| // Setting the attribute should overwrite the computed values | ||
| transaction?.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, 0.56); | ||
| transaction?.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route'); | ||
|
|
||
| const dynamicSamplingContext = getDynamicSamplingContextFromSpan(transaction!); | ||
|
|
||
| expect(dynamicSamplingContext).toStrictEqual({ | ||
| release: '1.0.1', | ||
| environment: 'production', | ||
| sampled: 'true', | ||
| sample_rate: '0.56', | ||
| trace_id: expect.any(String), | ||
| transaction: 'tx', | ||
| }); | ||
| }); | ||
|
|
||
| test('returns a new DSC, if no DSC was provided during transaction creation (via deprecated metadata)', () => { | ||
| const transaction = startInactiveSpan({ | ||
| name: 'tx', | ||
| }); | ||
|
|
||
| const dynamicSamplingContext = getDynamicSamplingContextFromSpan(transaction!); | ||
|
|
||
| expect(dynamicSamplingContext).toStrictEqual({ | ||
| release: '1.0.1', | ||
| environment: 'production', | ||
| sampled: 'true', | ||
| sample_rate: '1', | ||
| trace_id: expect.any(String), | ||
| transaction: 'tx', | ||
| }); | ||
| }); | ||
|
|
||
| test('returns a new DSC, if no DSC was provided during transaction creation (via new Txn and deprecated metadata)', () => { | ||
| const transaction = new Transaction({ | ||
| name: 'tx', | ||
| metadata: { | ||
| sampleRate: 0.56, | ||
| source: 'route', | ||
| }, | ||
| sampled: true, | ||
| }); | ||
|
|
||
| const dynamicSamplingContext = getDynamicSamplingContextFromSpan(transaction!); | ||
|
|
||
| expect(dynamicSamplingContext).toStrictEqual({ | ||
| release: '1.0.1', | ||
| environment: 'production', | ||
| sampled: 'true', | ||
| sample_rate: '0.56', | ||
| trace_id: expect.any(String), | ||
| transaction: 'tx', | ||
| }); | ||
| }); | ||
|
|
||
| describe('Including transaction name in DSC', () => { | ||
| test('is not included if transaction source is url', () => { | ||
| const transaction = new Transaction({ | ||
| name: 'tx', | ||
| metadata: { | ||
| source: 'url', | ||
| sampleRate: 0.56, | ||
| }, | ||
| }); | ||
|
|
||
| const dsc = getDynamicSamplingContextFromSpan(transaction); | ||
| expect(dsc.transaction).toBeUndefined(); | ||
| }); | ||
|
|
||
| test.each([ | ||
| ['is included if transaction source is parameterized route/url', 'route'], | ||
| ['is included if transaction source is a custom name', 'custom'], | ||
| ])('%s', (_: string, source) => { | ||
| const transaction = new Transaction({ | ||
| name: 'tx', | ||
| metadata: { | ||
| ...(source && { source: source as TransactionSource }), | ||
| }, | ||
| }); | ||
|
|
||
| // Only setting the attribute manually because we're directly calling new Transaction() | ||
| transaction?.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, source); | ||
|
|
||
| const dsc = getDynamicSamplingContextFromSpan(transaction); | ||
|
|
||
| expect(dsc.transaction).toEqual('tx'); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.