Skip to content

feat(types): Add TransactionNameChange interface #5714

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
merged 4 commits into from
Sep 12, 2022
Merged

feat(types): Add TransactionNameChange interface #5714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fa90b33
feat(types): Add `TransactionNameChange` interface
AbhiPrasad Sep 9, 2022
e8aded9
fix tests
AbhiPrasad Sep 9, 2022
f651282
rename name_changes -> changes
AbhiPrasad Sep 12, 2022
203a3ed
remaining nameChanges
AbhiPrasad Sep 12, 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
2 changes: 2 additions & 0 deletions packages/nextjs/test/integration/test/server/tracing200.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ module.exports = async ({ url: urlBase, argv }) => {
transaction: 'GET /api/users',
transaction_info: {
source: 'route',
changes: [],
propagations: 0,
},
type: 'transaction',
request: {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/test/integration/test/server/tracing500.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ module.exports = async ({ url: urlBase, argv }) => {
transaction: 'GET /api/broken',
transaction_info: {
source: 'route',
changes: [],
propagations: 0,
},
type: 'transaction',
request: {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/test/integration/test/server/tracingHttp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ module.exports = async ({ url: urlBase, argv }) => {
transaction: 'GET /api/http',
transaction_info: {
source: 'route',
changes: [],
propagations: 0,
},
type: 'transaction',
request: {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/test/integration/test/server/tracingServerGetInitialProps.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ module.exports = async ({ url: urlBase, argv }) => {
transaction: '/[id]/withInitialProps',
transaction_info: {
source: 'route',
changes: [],
propagations: 0,
},
type: 'transaction',
request: {
Expand Down
2 changes: 2 additions & 0 deletions packages/nextjs/test/integration/test/server/tracingServerGetServerSideProps.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ module.exports = async ({ url: urlBase, argv }) => {
transaction: '/[id]/withServerSideProps',
transaction_info: {
source: 'route',
changes: [],
propagations: 0,
},
type: 'transaction',
request: {
Expand Down
6 changes: 6 additions & 0 deletions packages/node-integration-tests/suites/express/tracing/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ test('should set a correct transaction name for routes specified in RegEx', asyn
transaction: 'GET /\\/test\\/regex/',
transaction_info: {
source: 'route',
changes: [],
propagations: 0,
},
contexts: {
trace: {
Expand Down Expand Up @@ -66,6 +68,8 @@ test.each([['array1'], ['array5']])(
transaction: 'GET /test/array1,/\\/test\\/array[2-9]',
transaction_info: {
source: 'route',
changes: [],
propagations: 0,
},
contexts: {
trace: {
Expand Down Expand Up @@ -102,6 +106,8 @@ test.each([
transaction: 'GET /test/arr/:id,/\\/test\\/arr[0-9]*\\/required(path)?(\\/optionalPath)?\\/(lastParam)?',
transaction_info: {
source: 'route',
changes: [],
propagations: 0,
},
contexts: {
trace: {
Expand Down
2 changes: 2 additions & 0 deletions packages/remix/test/integration/test/server/loader.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ describe.each(['builtin', 'express'])('Remix API Loaders with adapter = %s', ada
transaction: 'routes/loader-json-response/$id',
transaction_info: {
source: 'route',
changes: [],
propagations: 0,
},
spans: [
{
Expand Down
4 changes: 4 additions & 0 deletions packages/tracing/src/transaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ export class Transaction extends SpanClass implements TransactionInterface {
this.metadata = {
...transactionContext.metadata,
spanMetadata: {},
changes: [],
propagations: 0,
};

this._trimEnd = transactionContext.trimEnd;
Expand Down Expand Up @@ -156,6 +158,8 @@ export class Transaction extends SpanClass implements TransactionInterface {
...(metadata.source && {
transaction_info: {
source: metadata.source,
changes: metadata.changes,
propagations: metadata.propagations,
},
}),
};
Expand Down
4 changes: 4 additions & 0 deletions packages/tracing/test/span.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,8 @@ describe('Span', () => {
expect.not.objectContaining({
transaction_info: {
source: expect.any(String),
changes: [],
propagations: 0,
},
}),
);
Expand All @@ -522,6 +524,8 @@ describe('Span', () => {
expect.objectContaining({
transaction_info: {
source: 'url',
changes: [],
propagations: 0,
},
}),
);
Expand Down
4 changes: 3 additions & 1 deletion packages/types/src/event.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { CaptureContext } from './scope';
import { SdkInfo } from './sdkinfo';
import { Severity, SeverityLevel } from './severity';
import { Span } from './span';
import { TransactionSource } from './transaction';
import { TransactionNameChange, TransactionSource } from './transaction';
import { User } from './user';

/** JSDoc */
Expand Down Expand Up @@ -49,6 +49,8 @@ export interface Event {
sdkProcessingMetadata?: { [key: string]: any };
transaction_info?: {
source: TransactionSource;
changes: TransactionNameChange[];
propagations: number;
};
}

Expand Down
1 change: 1 addition & 0 deletions packages/types/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ export type {
TransactionMetadata,
TransactionSamplingMethod,
TransactionSource,
TransactionNameChange,
} from './transaction';
export type {
DurationUnit,
Expand Down
23 changes: 23 additions & 0 deletions packages/types/src/transaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,12 @@ export interface TransactionMetadata {

/** Metadata for the transaction's spans, keyed by spanId */
spanMetadata: { [spanId: string]: { [key: string]: unknown } };

/** Metadata representing information about transaction name changes */
changes: TransactionNameChange[];

/** The total number of propagations that happened */
propagations: number;
Comment on lines +154 to +158
Copy link
Contributor

Choose a reason for hiding this comment

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

Just a train of thought: We could explore having two type definitions for all top level options. One that is user-facing, and one that is internal to us. That way we don't create technical breaking changes when we remove values like these again after testing.

Doesn't need action on your part. Just wanted to write that down.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think this is a great point - but it introduces some complexity where we'll need to cast appropriately when working between user-defined and internally defined types, which could cause a lot of trouble (esp in places like tests, or across package boundaries).

}

/**
Expand All @@ -169,3 +175,20 @@ export type TransactionSource =
| 'component'
/** Name of a background task (e.g. a Celery task) */
| 'task';

/**
* Object representing metadata about when a transaction name was changed.
*/
export interface TransactionNameChange {
/**
* Unix timestamp when the name was changed. Same type as the start and
* end timestamps of a transaction and span.
*/
timestamp: number;

/** New source applied for transaction name change */
source: TransactionSource;

/** Number of propagations since start of transaction */
propagations: number;
}