Skip to content

fix: Provide better descriptions for the performance navigation timing spans #3245

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
Apr 1, 2021
Merged

fix: Provide better descriptions for the performance navigation timing spans #3245

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f07895
fix: Provide better descriptions for the performance navigation timin…
dashed Feb 9, 2021
1732fe5
revert domainLookup span description
dashed Feb 10, 2021
83ab4e7
feedback
dashed Feb 18, 2021
e67b44a
prettier
dashed Feb 18, 2021
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
49 changes: 33 additions & 16 deletions packages/tracing/src/browser/metrics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,14 +282,28 @@ export class MetricsInstrumentation {

/** Instrument navigation entries */
function addNavigationSpans(transaction: Transaction, entry: Record<string, any>, timeOrigin: number): void {
addPerformanceNavigationTiming(transaction, entry, 'unloadEvent', timeOrigin);
addPerformanceNavigationTiming(transaction, entry, 'redirect', timeOrigin);
addPerformanceNavigationTiming(transaction, entry, 'domContentLoadedEvent', timeOrigin);
addPerformanceNavigationTiming(transaction, entry, 'loadEvent', timeOrigin);
addPerformanceNavigationTiming(transaction, entry, 'connect', timeOrigin);
addPerformanceNavigationTiming(transaction, entry, 'secureConnection', timeOrigin, 'connectEnd');
addPerformanceNavigationTiming(transaction, entry, 'fetch', timeOrigin, 'domainLookupStart');
addPerformanceNavigationTiming(transaction, entry, 'domainLookup', timeOrigin);
addPerformanceNavigationTiming({ transaction, entry, event: 'unloadEvent', timeOrigin });
addPerformanceNavigationTiming({ transaction, entry, event: 'redirect', timeOrigin });
addPerformanceNavigationTiming({ transaction, entry, event: 'domContentLoadedEvent', timeOrigin });
addPerformanceNavigationTiming({ transaction, entry, event: 'loadEvent', timeOrigin });
addPerformanceNavigationTiming({ transaction, entry, event: 'connect', timeOrigin });
addPerformanceNavigationTiming({
transaction,
entry,
event: 'secureConnection',
timeOrigin,
eventEnd: 'connectEnd',
description: 'TLS/SSL',
});
addPerformanceNavigationTiming({
transaction,
entry,
event: 'fetch',
timeOrigin,
eventEnd: 'domainLookupStart',
description: 'cache',
});
addPerformanceNavigationTiming({ transaction, entry, event: 'domainLookup', timeOrigin, description: 'DNS' });
addRequest(transaction, entry, timeOrigin);
}

Expand Down Expand Up @@ -362,21 +376,24 @@ export function addResourceSpans(
}

/** Create performance navigation related spans */
function addPerformanceNavigationTiming(
transaction: Transaction,
entry: Record<string, any>,
event: string,
timeOrigin: number,
eventEnd?: string,
): void {
function addPerformanceNavigationTiming(props: {
transaction: Transaction;
entry: Record<string, any>;
event: string;
timeOrigin: number;
eventEnd?: string;
description?: string;
}): void {
const { transaction, entry, event, timeOrigin, eventEnd, description } = props;
Copy link
Contributor

@rhcarvalho rhcarvalho Feb 12, 2021

Choose a reason for hiding this comment

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

Does it pay-off moving all args into a single object just to deconstruct it here?!

Copy link
Contributor

@rhcarvalho rhcarvalho Feb 12, 2021

Choose a reason for hiding this comment

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

Oh well, one advantage is being able to name an argument and omit others. 👍


const end = eventEnd ? (entry[eventEnd] as number | undefined) : (entry[`${event}End`] as number | undefined);
const start = entry[`${event}Start`] as number | undefined;
if (!start || !end) {
return;
}
_startChild(transaction, {
op: 'browser',
description: event,
description: description ?? event,
startTimestamp: timeOrigin + msToSec(start),
endTimestamp: timeOrigin + msToSec(end),
});
Expand Down