Skip to content

Commit

Permalink
Merge pull request #10205 from getsentry/DominikB2014/add-span-domain…
Browse files Browse the repository at this point in the history 
…-to-span-data

feat(core): Add domain information to resource span data
  • Loading branch information
@DominikB2014
DominikB2014 committed Jan 18, 2024
2 parents acf58d3 + da68244 commit caad0bc
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 14 deletions.
21 changes: 16 additions & 5 deletions packages/tracing-internal/src/browser/metrics/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import type { IdleTransaction, Transaction } from '@sentry/core';
import { getActiveTransaction, setMeasurement } from '@sentry/core';
import type { Measurements, SpanContext } from '@sentry/types';
import { browserPerformanceTimeOrigin, getComponentName, htmlTreeAsString, logger } from '@sentry/utils';
import { browserPerformanceTimeOrigin, getComponentName, htmlTreeAsString, logger, parseUrl } from '@sentry/utils';

import { spanToJSON } from '@sentry/core';
import { DEBUG_BUILD } from '../../common/debug-build';
Expand Down Expand Up @@ -226,8 +226,7 @@ export function addPerformanceEntries(transaction: Transaction): void {
break;
}
case 'resource': {
const resourceName = (entry.name as string).replace(WINDOW.location.origin, '');
_addResourceSpans(transaction, entry, resourceName, startTime, duration, timeOrigin);
_addResourceSpans(transaction, entry, entry.name as string, startTime, duration, timeOrigin);
break;
}
default:
Expand Down Expand Up @@ -408,7 +407,7 @@ export interface ResourceEntry extends Record<string, unknown> {
export function _addResourceSpans(
transaction: Transaction,
entry: ResourceEntry,
resourceName: string,
resourceUrl: string,
startTime: number,
duration: number,
timeOrigin: number,
Expand All @@ -419,20 +418,32 @@ export function _addResourceSpans(
return;
}

const parsedUrl = parseUrl(resourceUrl);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const data: Record<string, any> = {};
setResourceEntrySizeData(data, entry, 'transferSize', 'http.response_transfer_size');
setResourceEntrySizeData(data, entry, 'encodedBodySize', 'http.response_content_length');
setResourceEntrySizeData(data, entry, 'decodedBodySize', 'http.decoded_response_content_length');

if ('renderBlockingStatus' in entry) {
data['resource.render_blocking_status'] = entry.renderBlockingStatus;
}
if (parsedUrl.protocol) {
data['url.scheme'] = parsedUrl.protocol.split(':').pop(); // the protocol returned by parseUrl includes a :, but OTEL spec does not, so we remove it.
}

if (parsedUrl.host) {
data['server.address'] = parsedUrl.host;
}

data['url.same_origin'] = resourceUrl.includes(WINDOW.location.origin);

const startTimestamp = timeOrigin + startTime;
const endTimestamp = startTimestamp + duration;

_startChild(transaction, {
description: resourceName,
description: resourceUrl.replace(WINDOW.location.origin, ''),
endTimestamp,
op: entry.initiatorType ? `resource.${entry.initiatorType}` : 'resource.other',
origin: 'auto.resource.browser.metrics',
Expand Down
74 changes: 65 additions & 9 deletions packages/tracing-internal/test/browser/metrics/index.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@
import { Transaction } from '../../../src';
import type { ResourceEntry } from '../../../src/browser/metrics';
import { _addMeasureSpans, _addResourceSpans } from '../../../src/browser/metrics';
import { WINDOW } from '../../../src/browser/types';

const mockWindowLocation = {
ancestorOrigins: {},
href: 'https://example.com/path/to/something',
origin: 'https://example.com',
protocol: 'https',
host: 'example.com',
hostname: 'example.com',
port: '',
pathname: '/path/to/something',
search: '',
hash: '',
} as Window['location'];

const originalLocation = WINDOW.location;

const resourceEntryName = 'https://example.com/assets/to/css';

describe('_addMeasureSpans', () => {
// eslint-disable-next-line deprecation/deprecation
const transaction = new Transaction({ op: 'pageload', name: '/' });

beforeEach(() => {
// eslint-disable-next-line deprecation/deprecation
transaction.startChild = jest.fn();
Expand Down Expand Up @@ -42,6 +61,15 @@ describe('_addMeasureSpans', () => {
describe('_addResourceSpans', () => {
// eslint-disable-next-line deprecation/deprecation
const transaction = new Transaction({ op: 'pageload', name: '/' });

beforeAll(() => {
setGlobalLocation(mockWindowLocation);
});

afterAll(() => {
resetGlobalLocation();
});

beforeEach(() => {
// eslint-disable-next-line deprecation/deprecation
transaction.startChild = jest.fn();
Expand All @@ -56,7 +84,7 @@ describe('_addResourceSpans', () => {
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
};
_addResourceSpans(transaction, entry, '/assets/to/me', 123, 456, 100);
_addResourceSpans(transaction, entry, resourceEntryName, 123, 456, 100);

// eslint-disable-next-line @typescript-eslint/unbound-method, deprecation/deprecation
expect(transaction.startChild).toHaveBeenCalledTimes(0);
Expand All @@ -70,7 +98,7 @@ describe('_addResourceSpans', () => {
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
};
_addResourceSpans(transaction, entry, '/assets/to/me', 123, 456, 100);
_addResourceSpans(transaction, entry, 'https://example.com/assets/to/me', 123, 456, 100);

// eslint-disable-next-line @typescript-eslint/unbound-method, deprecation/deprecation
expect(transaction.startChild).toHaveBeenCalledTimes(0);
Expand All @@ -89,7 +117,7 @@ describe('_addResourceSpans', () => {
const startTime = 23;
const duration = 356;

_addResourceSpans(transaction, entry, '/assets/to/css', startTime, duration, timeOrigin);
_addResourceSpans(transaction, entry, resourceEntryName, startTime, duration, timeOrigin);

// eslint-disable-next-line @typescript-eslint/unbound-method, deprecation/deprecation
expect(transaction.startChild).toHaveBeenCalledTimes(1);
Expand All @@ -100,6 +128,9 @@ describe('_addResourceSpans', () => {
['http.response_content_length']: entry.encodedBodySize,
['http.response_transfer_size']: entry.transferSize,
['resource.render_blocking_status']: entry.renderBlockingStatus,
['url.scheme']: 'https',
['server.address']: 'example.com',
['url.same_origin']: true,
},
description: '/assets/to/css',
endTimestamp: timeOrigin + startTime + duration,
Expand Down Expand Up @@ -137,7 +168,7 @@ describe('_addResourceSpans', () => {
const entry: ResourceEntry = {
initiatorType,
};
_addResourceSpans(transaction, entry, '/assets/to/me', 123, 234, 465);
_addResourceSpans(transaction, entry, 'https://example.com/assets/to/me', 123, 234, 465);

// eslint-disable-next-line @typescript-eslint/unbound-method, deprecation/deprecation
expect(transaction.startChild).toHaveBeenLastCalledWith(
Expand All @@ -157,7 +188,7 @@ describe('_addResourceSpans', () => {
renderBlockingStatus: 'non-blocking',
};

_addResourceSpans(transaction, entry, '/assets/to/css', 100, 23, 345);
_addResourceSpans(transaction, entry, resourceEntryName, 100, 23, 345);

// eslint-disable-next-line @typescript-eslint/unbound-method, deprecation/deprecation
expect(transaction.startChild).toHaveBeenCalledTimes(1);
Expand All @@ -169,6 +200,9 @@ describe('_addResourceSpans', () => {
['http.response_content_length']: entry.encodedBodySize,
['http.response_transfer_size']: entry.transferSize,
['resource.render_blocking_status']: entry.renderBlockingStatus,
['url.scheme']: 'https',
['server.address']: 'example.com',
['url.same_origin']: true,
},
}),
);
Expand All @@ -182,14 +216,19 @@ describe('_addResourceSpans', () => {
decodedBodySize: 2147483647,
};

_addResourceSpans(transaction, entry, '/assets/to/css', 100, 23, 345);
_addResourceSpans(transaction, entry, resourceEntryName, 100, 23, 345);

// eslint-disable-next-line @typescript-eslint/unbound-method, deprecation/deprecation
expect(transaction.startChild).toHaveBeenCalledTimes(1);
// eslint-disable-next-line @typescript-eslint/unbound-method, deprecation/deprecation
expect(transaction.startChild).toHaveBeenLastCalledWith(
expect.objectContaining({
data: {},
data: { 'server.address': 'example.com', 'url.same_origin': true, 'url.scheme': 'https' },
description: '/assets/to/css',
endTimestamp: 468,
op: 'resource.css',
origin: 'auto.resource.browser.metrics',
startTimestamp: 445,
}),
);
});
Expand All @@ -204,15 +243,32 @@ describe('_addResourceSpans', () => {
decodedBodySize: null,
} as unknown as ResourceEntry;

_addResourceSpans(transaction, entry, '/assets/to/css', 100, 23, 345);
_addResourceSpans(transaction, entry, resourceEntryName, 100, 23, 345);

// eslint-disable-next-line @typescript-eslint/unbound-method, deprecation/deprecation
expect(transaction.startChild).toHaveBeenCalledTimes(1);
// eslint-disable-next-line @typescript-eslint/unbound-method, deprecation/deprecation
expect(transaction.startChild).toHaveBeenLastCalledWith(
expect.objectContaining({
data: {},
data: { 'server.address': 'example.com', 'url.same_origin': true, 'url.scheme': 'https' },
description: '/assets/to/css',
endTimestamp: 468,
op: 'resource.css',
origin: 'auto.resource.browser.metrics',
startTimestamp: 445,
}),
);
});
});

const setGlobalLocation = (location: Location) => {
// @ts-expect-error need to delete this in order to set to new value
delete WINDOW.location;
WINDOW.location = location;
};

const resetGlobalLocation = () => {
// @ts-expect-error need to delete this in order to set to new value
delete WINDOW.location;
WINDOW.location = originalLocation;
};

0 comments on commit caad0bc

Please sign in to comment.