feat(profiling): Expose profiler as top level primitive#13512

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
JonasBa merged 7 commits into from
Aug 30, 2024
Merged

feat(profiling): Expose profiler as top level primitive #13512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
188e4c8
ref(profiling): expose continuous profiler on Sentry.profiler
JonasBa Aug 28, 2024
ecb8037
ref(profiling) add comment
JonasBa Aug 28, 2024
79731ac
test: fix profiling tests
JonasBa Aug 29, 2024
8bf0f0a
format fix
JonasBa Aug 29, 2024
96dab48
use import type for client
JonasBa Aug 29, 2024
f05e42b
ref: runtime safe call to start/stop
JonasBa Aug 29, 2024
2398c25
Add to all node-based packages
Aug 30, 2024
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
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export {
withMonitor,
withScope,
zodErrorsIntegration,
profiler,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
trpcMiddleware,
addOpenTelemetryInstrumentation,
zodErrorsIntegration,
profiler,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export {
trpcMiddleware,
addOpenTelemetryInstrumentation,
zodErrorsIntegration,
profiler,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,6 +100,7 @@ export { sessionTimingIntegration } from './integrations/sessiontiming';
export { zodErrorsIntegration } from './integrations/zoderrors';
export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
export { metrics } from './metrics/exports';
export { profiler } from './profiling';
export type { MetricData } from '@sentry/types';
export { metricsDefault } from './metrics/exports-default';
export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
Expand Down
72 changes: 72 additions & 0 deletions packages/core/src/profiling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import type { Profiler, ProfilingIntegration } from '@sentry/types';
import { logger } from '@sentry/utils';

import { getClient } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';

function isProfilingIntegrationWithProfiler(
integration: ProfilingIntegration<any> | undefined,
): integration is ProfilingIntegration<any> {
return (
!!integration &&
typeof integration['_profiler'] !== 'undefined' &&
typeof integration['_profiler']['start'] === 'function' &&
typeof integration['_profiler']['stop'] === 'function'
);
}
/**

@JonasBaJonasBaAug 29, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

These two calls are just thin wrappers around getIntegration and calling a method on that integration.

* Starts the Sentry continuous profiler.
* This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
* In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
*/
function startProfiler(): void {
const client = getClient();
if (!client) {
DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
return;
}

const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');

if (!integration) {
DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
return;
}

if (!isProfilingIntegrationWithProfiler(integration)) {
DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
return;
}

integration._profiler.start();
}

/**
* Stops the Sentry continuous profiler.
* Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
*/
function stopProfiler(): void {
const client = getClient();
if (!client) {
DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
return;
}

const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
if (!integration) {
DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
return;
}

if (!isProfilingIntegrationWithProfiler(integration)) {
DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
return;
}

integration._profiler.stop();
}

export const profiler: Profiler = {
startProfiler,
stopProfiler,
};
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
trpcMiddleware,
addOpenTelemetryInstrumentation,
zodErrorsIntegration,
profiler,
} from '@sentry/node';

export {
Expand Down
1 change: 1 addition & 0 deletions packages/node/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
spanToBaggageHeader,
trpcMiddleware,
zodErrorsIntegration,
profiler,
} from '@sentry/core';

export type {
Expand Down
14 changes: 7 additions & 7 deletions packages/profiling-node/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
spanToJSON,
} from '@sentry/core';
import type { NodeClient } from '@sentry/node';
import type { Event, Integration, IntegrationFn, Profile, ProfileChunk, Span } from '@sentry/types';
import type { Event, IntegrationFn, Profile, ProfileChunk, ProfilingIntegration, Span } from '@sentry/types';

import { LRUMap, logger, uuid4 } from '@sentry/utils';

Expand DownExpand Up@@ -159,6 +159,7 @@ interface ChunkData {
timer: NodeJS.Timeout | undefined;
startTraceID: string;
}

class ContinuousProfiler {
private _profilerId = uuid4();
private _client: NodeClient | undefined = undefined;
Expand DownExpand Up@@ -384,12 +385,8 @@ class ContinuousProfiler {
}
}

export interface ProfilingIntegration extends Integration {
_profiler: ContinuousProfiler;
}

/** Exported only for tests. */
export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
export const _nodeProfilingIntegration = ((): ProfilingIntegration<NodeClient> => {
if (DEBUG_BUILD && ![16, 18, 20, 22].includes(NODE_MAJOR)) {
logger.warn(
`[Profiling] You are using a Node.js version that does not have prebuilt binaries (${NODE_VERSION}).`,
Expand All@@ -407,7 +404,10 @@ export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
const options = client.getOptions();

const mode =
(options.profilesSampleRate === undefined || options.profilesSampleRate === 0) && !options.profilesSampler
(options.profilesSampleRate === undefined ||
options.profilesSampleRate === null ||
options.profilesSampleRate === 0) &&
!options.profilesSampler
? 'continuous'
: 'span';
switch (mode) {
Expand Down
63 changes: 47 additions & 16 deletions packages/profiling-node/test/spanProfileUtils.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,11 @@ import * as Sentry from '@sentry/node';

import { getMainCarrier } from '@sentry/core';
import type { NodeClientOptions } from '@sentry/node/build/types/types';
import type { ProfilingIntegration } from '@sentry/types';
import type { ProfileChunk, Transport } from '@sentry/types';
import { GLOBAL_OBJ, createEnvelope, logger } from '@sentry/utils';
import { CpuProfilerBindings } from '../src/cpu_profiler';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { _nodeProfilingIntegration } from '../src/integration';

function makeClientWithHooks(): [Sentry.NodeClient, Transport] {
const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -299,7 +300,7 @@ describe('automated span instrumentation', () => {
Sentry.setCurrentClient(client);
client.init();

const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand DownExpand Up@@ -390,7 +391,7 @@ describe('continuous profiling', () => {
});
afterEach(() => {
const client = Sentry.getClient();
const integration = client?.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client?.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

if (integration) {
integration._profiler.stop();
Expand DownExpand Up@@ -432,7 +433,7 @@ describe('continuous profiling', () => {

const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand All@@ -446,7 +447,7 @@ describe('continuous profiling', () => {
expect(profile.client_sdk.version).toEqual(expect.stringMatching(/\d+\.\d+\.\d+/));
});

it('initializes the continuous profiler and binds the sentry client', () => {
it('initializes the continuous profiler', () => {
const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');

const [client] = makeContinuousProfilingClient();
Expand All@@ -455,14 +456,13 @@ describe('continuous profiling', () => {

expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);

const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
integration._profiler.start();

expect(integration._profiler).toBeDefined();
expect(integration._profiler['_client']).toBe(client);
});

it('starts a continuous profile', () => {
Expand All@@ -473,7 +473,7 @@ describe('continuous profiling', () => {
client.init();

expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand All@@ -490,7 +490,7 @@ describe('continuous profiling', () => {
client.init();

expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand All@@ -509,7 +509,7 @@ describe('continuous profiling', () => {
client.init();

expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand All@@ -529,7 +529,7 @@ describe('continuous profiling', () => {
client.init();

expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand All@@ -548,7 +548,7 @@ describe('continuous profiling', () => {
client.init();

expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand DownExpand Up@@ -604,7 +604,7 @@ describe('continuous profiling', () => {

const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand DownExpand Up@@ -632,7 +632,7 @@ describe('continuous profiling', () => {
},
});

const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand DownExpand Up@@ -692,7 +692,7 @@ describe('span profiling mode', () => {
Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });

expect(startProfilingSpy).toHaveBeenCalled();
const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

if (!integration) {
throw new Error('Profiling integration not found');
Expand All@@ -703,6 +703,10 @@ describe('span profiling mode', () => {
});
});
describe('continuous profiling mode', () => {
beforeEach(() => {
jest.clearAllMocks();
});

it.each([
['profilesSampleRate=0', makeClientOptions({ profilesSampleRate: 0 })],
['profilesSampleRate=undefined', makeClientOptions({ profilesSampleRate: undefined })],
Expand DownExpand Up@@ -739,7 +743,7 @@ describe('continuous profiling mode', () => {

jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand All@@ -750,4 +754,31 @@ describe('continuous profiling mode', () => {
Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });
expect(startProfilingSpy).toHaveBeenCalledTimes(callCount);
});

it('top level methods proxy to integration', () => {
const client = new Sentry.NodeClient({
...makeClientOptions({ profilesSampleRate: undefined }),
dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
tracesSampleRate: 1,
transport: _opts =>
Sentry.makeNodeTransport({
url: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
recordDroppedEvent: () => {
return undefined;
},
}),
integrations: [_nodeProfilingIntegration()],
});

Sentry.setCurrentClient(client);
client.init();

const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');
const stopProfilingSpy = jest.spyOn(CpuProfilerBindings, 'stopProfiling');

Sentry.profiler.startProfiler();
expect(startProfilingSpy).toHaveBeenCalledTimes(1);
Sentry.profiler.stopProfiler();
expect(stopProfilingSpy).toHaveBeenCalledTimes(1);
});
});
5 changes: 3 additions & 2 deletions packages/profiling-node/test/spanProfileUtils.worker.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,8 @@ jest.setTimeout(10000);

import * as Sentry from '@sentry/node';
import type { Transport } from '@sentry/types';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { type ProfilingIntegration } from '@sentry/types';
import { _nodeProfilingIntegration } from '../src/integration';

function makeContinuousProfilingClient(): [Sentry.NodeClient, Transport] {
const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -49,7 +50,7 @@ it('worker threads context', () => {
},
});

const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
if (!integration) {
throw new Error('Profiling integration not found');
}
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -171,4 +171,5 @@ export type {
Metrics,
} from './metrics';
export type { ParameterizedString } from './parameterize';
export type { ContinuousProfiler, ProfilingIntegration, Profiler } from './profiling';
export type { ViewHierarchyData, ViewHierarchyWindow } from './view-hierarchy';
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(profiling): Expose profiler as top level primitive#13512

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

JonasBa
merged 7 commits into

from

Aug 30, 2024
 Merged


feat(profiling): Expose profiler as top level primitive
#13512
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
188e4c8

ref(profiling): expose continuous profiler on Sentry.profiler


JonasBa Aug 28, 2024
ecb8037

ref(profiling) add comment


JonasBa Aug 28, 2024
79731ac

test: fix profiling tests


JonasBa Aug 29, 2024
8bf0f0a

format fix


JonasBa Aug 29, 2024
96dab48

use import type for client


JonasBa Aug 29, 2024
f05e42b

ref: runtime safe call to start/stop


JonasBa Aug 29, 2024
2398c25

Add to all node-based packages

Aug 30, 2024

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


1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export {
 withMonitor,
 withScope,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,6 +100,7 @@ export { sessionTimingIntegration } from './integrations/sessiontiming';
export { zodErrorsIntegration } from './integrations/zoderrors';
export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
export { metrics } from './metrics/exports';
export { profiler } from './profiling';
export type { MetricData } from '@sentry/types';
export { metricsDefault } from './metrics/exports-default';
export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
Expand Down

72 changes: 72 additions & 0 deletions
packages/core/src/profiling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import type { Profiler, ProfilingIntegration } from '@sentry/types';
import { logger } from '@sentry/utils';

import { getClient } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';

function isProfilingIntegrationWithProfiler(
 integration: ProfilingIntegration<any> | undefined,
): integration is ProfilingIntegration<any> {
 return (
 !!integration &&
 typeof integration['_profiler'] !== 'undefined' &&
 typeof integration['_profiler']['start'] === 'function' &&
 typeof integration['_profiler']['stop'] === 'function'
 );
}
/**
@JonasBaJonasBaAug 29, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

These two calls are just thin wrappers around getIntegration and calling a method on that integration.
 * Starts the Sentry continuous profiler.
 * This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
 * In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
 */
function startProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');

 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.start();
}

/**
 * Stops the Sentry continuous profiler.
 * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
 */
function stopProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.stop();
}

export const profiler: Profiler = {
 startProfiler,
 stopProfiler,
};

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
 spanToBaggageHeader,
 trpcMiddleware,
 zodErrorsIntegration,
 profiler,
} from '@sentry/core';

export type {
Expand Down

14 changes: 7 additions & 7 deletions
packages/profiling-node/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { NodeClient } from '@sentry/node';
import type { Event, Integration, IntegrationFn, Profile, ProfileChunk, Span } from '@sentry/types';
import type { Event, IntegrationFn, Profile, ProfileChunk, ProfilingIntegration, Span } from '@sentry/types';

import { LRUMap, logger, uuid4 } from '@sentry/utils';

Expand DownExpand Up@@ -159,6 +159,7 @@ interface ChunkData {
 timer: NodeJS.Timeout | undefined;
 startTraceID: string;
}

class ContinuousProfiler {
 private _profilerId = uuid4();
 private _client: NodeClient | undefined = undefined;
Expand DownExpand Up@@ -384,12 +385,8 @@ class ContinuousProfiler {
 }
}

export interface ProfilingIntegration extends Integration {
 _profiler: ContinuousProfiler;
}

/** Exported only for tests. */
export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
export const _nodeProfilingIntegration = ((): ProfilingIntegration<NodeClient> => {
 if (DEBUG_BUILD && ![16, 18, 20, 22].includes(NODE_MAJOR)) {
 logger.warn(
 `[Profiling] You are using a Node.js version that does not have prebuilt binaries (${NODE_VERSION}).`,
Expand All@@ -407,7 +404,10 @@ export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
 const options = client.getOptions();

 const mode =
 (options.profilesSampleRate === undefined || options.profilesSampleRate === 0) && !options.profilesSampler
 (options.profilesSampleRate === undefined ||
 options.profilesSampleRate === null ||
 options.profilesSampleRate === 0) &&
 !options.profilesSampler
 ? 'continuous'
 : 'span';
 switch (mode) {
Expand Down

63 changes: 47 additions & 16 deletions
packages/profiling-node/test/spanProfileUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,11 @@ import * as Sentry from '@sentry/node';

import { getMainCarrier } from '@sentry/core';
import type { NodeClientOptions } from '@sentry/node/build/types/types';
import type { ProfilingIntegration } from '@sentry/types';
import type { ProfileChunk, Transport } from '@sentry/types';
import { GLOBAL_OBJ, createEnvelope, logger } from '@sentry/utils';
import { CpuProfilerBindings } from '../src/cpu_profiler';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { _nodeProfilingIntegration } from '../src/integration';

function makeClientWithHooks(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -299,7 +300,7 @@ describe('automated span instrumentation', () => {
 Sentry.setCurrentClient(client);
 client.init();

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -390,7 +391,7 @@ describe('continuous profiling', () => {
 });
 afterEach(() => {
 const client = Sentry.getClient();
 const integration = client?.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client?.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (integration) {
 integration._profiler.stop();
Expand DownExpand Up@@ -432,7 +433,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -446,7 +447,7 @@ describe('continuous profiling', () => {
 expect(profile.client_sdk.version).toEqual(expect.stringMatching(/\d+\.\d+\.\d+/));
 });

 it('initializes the continuous profiler and binds the sentry client', () => {
 it('initializes the continuous profiler', () => {
 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');

 const [client] = makeContinuousProfilingClient();
Expand All@@ -455,14 +456,13 @@ describe('continuous profiling', () => {

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
 integration._profiler.start();

 expect(integration._profiler).toBeDefined();
 expect(integration._profiler['_client']).toBe(client);
 });

 it('starts a continuous profile', () => {
Expand All@@ -473,7 +473,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -490,7 +490,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -509,7 +509,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -529,7 +529,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -548,7 +548,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -604,7 +604,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -632,7 +632,7 @@ describe('continuous profiling', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -692,7 +692,7 @@ describe('span profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });

 expect(startProfilingSpy).toHaveBeenCalled();
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (!integration) {
 throw new Error('Profiling integration not found');
Expand All@@ -703,6 +703,10 @@ describe('span profiling mode', () => {
 });
});
describe('continuous profiling mode', () => {
 beforeEach(() => {
 jest.clearAllMocks();
 });

 it.each([
 ['profilesSampleRate=0', makeClientOptions({ profilesSampleRate: 0 })],
 ['profilesSampleRate=undefined', makeClientOptions({ profilesSampleRate: undefined })],
Expand DownExpand Up@@ -739,7 +743,7 @@ describe('continuous profiling mode', () => {

 jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -750,4 +754,31 @@ describe('continuous profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });
 expect(startProfilingSpy).toHaveBeenCalledTimes(callCount);
 });

 it('top level methods proxy to integration', () => {
 const client = new Sentry.NodeClient({
 ...makeClientOptions({ profilesSampleRate: undefined }),
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 tracesSampleRate: 1,
 transport: _opts =>
 Sentry.makeNodeTransport({
 url: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 recordDroppedEvent: () => {
 return undefined;
 },
 }),
 integrations: [_nodeProfilingIntegration()],
 });

 Sentry.setCurrentClient(client);
 client.init();

 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');
 const stopProfilingSpy = jest.spyOn(CpuProfilerBindings, 'stopProfiling');

 Sentry.profiler.startProfiler();
 expect(startProfilingSpy).toHaveBeenCalledTimes(1);
 Sentry.profiler.stopProfiler();
 expect(stopProfilingSpy).toHaveBeenCalledTimes(1);
 });
});

5 changes: 3 additions & 2 deletions
packages/profiling-node/test/spanProfileUtils.worker.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,8 @@ jest.setTimeout(10000);

import * as Sentry from '@sentry/node';
import type { Transport } from '@sentry/types';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { type ProfilingIntegration } from '@sentry/types';
import { _nodeProfilingIntegration } from '../src/integration';

function makeContinuousProfilingClient(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -49,7 +50,7 @@ it('worker threads context', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,4 +171,5 @@ export type {
 Metrics,
} from './metrics';
export type { ParameterizedString } from './parameterize';
export type { ContinuousProfiler, ProfilingIntegration, Profiler } from './profiling';
export type { ViewHierarchyData, ViewHierarchyWindow } from './view-hierarchy';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(profiling): Expose profiler as top level primitive#13512

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

JonasBa
merged 7 commits into

from

Aug 30, 2024
 Merged


feat(profiling): Expose profiler as top level primitive
#13512
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
188e4c8

ref(profiling): expose continuous profiler on Sentry.profiler


JonasBa Aug 28, 2024
ecb8037

ref(profiling) add comment


JonasBa Aug 28, 2024
79731ac

test: fix profiling tests


JonasBa Aug 29, 2024
8bf0f0a

format fix


JonasBa Aug 29, 2024
96dab48

use import type for client


JonasBa Aug 29, 2024
f05e42b

ref: runtime safe call to start/stop


JonasBa Aug 29, 2024
2398c25

Add to all node-based packages

Aug 30, 2024

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


1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export {
 withMonitor,
 withScope,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,6 +100,7 @@ export { sessionTimingIntegration } from './integrations/sessiontiming';
export { zodErrorsIntegration } from './integrations/zoderrors';
export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
export { metrics } from './metrics/exports';
export { profiler } from './profiling';
export type { MetricData } from '@sentry/types';
export { metricsDefault } from './metrics/exports-default';
export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
Expand Down

72 changes: 72 additions & 0 deletions
packages/core/src/profiling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import type { Profiler, ProfilingIntegration } from '@sentry/types';
import { logger } from '@sentry/utils';

import { getClient } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';

function isProfilingIntegrationWithProfiler(
 integration: ProfilingIntegration<any> | undefined,
): integration is ProfilingIntegration<any> {
 return (
 !!integration &&
 typeof integration['_profiler'] !== 'undefined' &&
 typeof integration['_profiler']['start'] === 'function' &&
 typeof integration['_profiler']['stop'] === 'function'
 );
}
/**
@JonasBaJonasBaAug 29, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

These two calls are just thin wrappers around getIntegration and calling a method on that integration.
 * Starts the Sentry continuous profiler.
 * This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
 * In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
 */
function startProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');

 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.start();
}

/**
 * Stops the Sentry continuous profiler.
 * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
 */
function stopProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.stop();
}

export const profiler: Profiler = {
 startProfiler,
 stopProfiler,
};

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
 spanToBaggageHeader,
 trpcMiddleware,
 zodErrorsIntegration,
 profiler,
} from '@sentry/core';

export type {
Expand Down

14 changes: 7 additions & 7 deletions
packages/profiling-node/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { NodeClient } from '@sentry/node';
import type { Event, Integration, IntegrationFn, Profile, ProfileChunk, Span } from '@sentry/types';
import type { Event, IntegrationFn, Profile, ProfileChunk, ProfilingIntegration, Span } from '@sentry/types';

import { LRUMap, logger, uuid4 } from '@sentry/utils';

Expand DownExpand Up@@ -159,6 +159,7 @@ interface ChunkData {
 timer: NodeJS.Timeout | undefined;
 startTraceID: string;
}

class ContinuousProfiler {
 private _profilerId = uuid4();
 private _client: NodeClient | undefined = undefined;
Expand DownExpand Up@@ -384,12 +385,8 @@ class ContinuousProfiler {
 }
}

export interface ProfilingIntegration extends Integration {
 _profiler: ContinuousProfiler;
}

/** Exported only for tests. */
export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
export const _nodeProfilingIntegration = ((): ProfilingIntegration<NodeClient> => {
 if (DEBUG_BUILD && ![16, 18, 20, 22].includes(NODE_MAJOR)) {
 logger.warn(
 `[Profiling] You are using a Node.js version that does not have prebuilt binaries (${NODE_VERSION}).`,
Expand All@@ -407,7 +404,10 @@ export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
 const options = client.getOptions();

 const mode =
 (options.profilesSampleRate === undefined || options.profilesSampleRate === 0) && !options.profilesSampler
 (options.profilesSampleRate === undefined ||
 options.profilesSampleRate === null ||
 options.profilesSampleRate === 0) &&
 !options.profilesSampler
 ? 'continuous'
 : 'span';
 switch (mode) {
Expand Down

63 changes: 47 additions & 16 deletions
packages/profiling-node/test/spanProfileUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,11 @@ import * as Sentry from '@sentry/node';

import { getMainCarrier } from '@sentry/core';
import type { NodeClientOptions } from '@sentry/node/build/types/types';
import type { ProfilingIntegration } from '@sentry/types';
import type { ProfileChunk, Transport } from '@sentry/types';
import { GLOBAL_OBJ, createEnvelope, logger } from '@sentry/utils';
import { CpuProfilerBindings } from '../src/cpu_profiler';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { _nodeProfilingIntegration } from '../src/integration';

function makeClientWithHooks(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -299,7 +300,7 @@ describe('automated span instrumentation', () => {
 Sentry.setCurrentClient(client);
 client.init();

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -390,7 +391,7 @@ describe('continuous profiling', () => {
 });
 afterEach(() => {
 const client = Sentry.getClient();
 const integration = client?.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client?.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (integration) {
 integration._profiler.stop();
Expand DownExpand Up@@ -432,7 +433,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -446,7 +447,7 @@ describe('continuous profiling', () => {
 expect(profile.client_sdk.version).toEqual(expect.stringMatching(/\d+\.\d+\.\d+/));
 });

 it('initializes the continuous profiler and binds the sentry client', () => {
 it('initializes the continuous profiler', () => {
 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');

 const [client] = makeContinuousProfilingClient();
Expand All@@ -455,14 +456,13 @@ describe('continuous profiling', () => {

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
 integration._profiler.start();

 expect(integration._profiler).toBeDefined();
 expect(integration._profiler['_client']).toBe(client);
 });

 it('starts a continuous profile', () => {
Expand All@@ -473,7 +473,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -490,7 +490,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -509,7 +509,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -529,7 +529,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -548,7 +548,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -604,7 +604,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -632,7 +632,7 @@ describe('continuous profiling', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -692,7 +692,7 @@ describe('span profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });

 expect(startProfilingSpy).toHaveBeenCalled();
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (!integration) {
 throw new Error('Profiling integration not found');
Expand All@@ -703,6 +703,10 @@ describe('span profiling mode', () => {
 });
});
describe('continuous profiling mode', () => {
 beforeEach(() => {
 jest.clearAllMocks();
 });

 it.each([
 ['profilesSampleRate=0', makeClientOptions({ profilesSampleRate: 0 })],
 ['profilesSampleRate=undefined', makeClientOptions({ profilesSampleRate: undefined })],
Expand DownExpand Up@@ -739,7 +743,7 @@ describe('continuous profiling mode', () => {

 jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -750,4 +754,31 @@ describe('continuous profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });
 expect(startProfilingSpy).toHaveBeenCalledTimes(callCount);
 });

 it('top level methods proxy to integration', () => {
 const client = new Sentry.NodeClient({
 ...makeClientOptions({ profilesSampleRate: undefined }),
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 tracesSampleRate: 1,
 transport: _opts =>
 Sentry.makeNodeTransport({
 url: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 recordDroppedEvent: () => {
 return undefined;
 },
 }),
 integrations: [_nodeProfilingIntegration()],
 });

 Sentry.setCurrentClient(client);
 client.init();

 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');
 const stopProfilingSpy = jest.spyOn(CpuProfilerBindings, 'stopProfiling');

 Sentry.profiler.startProfiler();
 expect(startProfilingSpy).toHaveBeenCalledTimes(1);
 Sentry.profiler.stopProfiler();
 expect(stopProfilingSpy).toHaveBeenCalledTimes(1);
 });
});

5 changes: 3 additions & 2 deletions
packages/profiling-node/test/spanProfileUtils.worker.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,8 @@ jest.setTimeout(10000);

import * as Sentry from '@sentry/node';
import type { Transport } from '@sentry/types';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { type ProfilingIntegration } from '@sentry/types';
import { _nodeProfilingIntegration } from '../src/integration';

function makeContinuousProfilingClient(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -49,7 +50,7 @@ it('worker threads context', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,4 +171,5 @@ export type {
 Metrics,
} from './metrics';
export type { ParameterizedString } from './parameterize';
export type { ContinuousProfiler, ProfilingIntegration, Profiler } from './profiling';
export type { ViewHierarchyData, ViewHierarchyWindow } from './view-hierarchy';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(profiling): Expose profiler as top level primitive#13512

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

JonasBa
merged 7 commits into

from

Aug 30, 2024
 Merged


feat(profiling): Expose profiler as top level primitive
#13512
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
188e4c8

ref(profiling): expose continuous profiler on Sentry.profiler


JonasBa Aug 28, 2024
ecb8037

ref(profiling) add comment


JonasBa Aug 28, 2024
79731ac

test: fix profiling tests


JonasBa Aug 29, 2024
8bf0f0a

format fix


JonasBa Aug 29, 2024
96dab48

use import type for client


JonasBa Aug 29, 2024
f05e42b

ref: runtime safe call to start/stop


JonasBa Aug 29, 2024
2398c25

Add to all node-based packages

Aug 30, 2024

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


1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export {
 withMonitor,
 withScope,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,6 +100,7 @@ export { sessionTimingIntegration } from './integrations/sessiontiming';
export { zodErrorsIntegration } from './integrations/zoderrors';
export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
export { metrics } from './metrics/exports';
export { profiler } from './profiling';
export type { MetricData } from '@sentry/types';
export { metricsDefault } from './metrics/exports-default';
export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
Expand Down

72 changes: 72 additions & 0 deletions
packages/core/src/profiling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import type { Profiler, ProfilingIntegration } from '@sentry/types';
import { logger } from '@sentry/utils';

import { getClient } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';

function isProfilingIntegrationWithProfiler(
 integration: ProfilingIntegration<any> | undefined,
): integration is ProfilingIntegration<any> {
 return (
 !!integration &&
 typeof integration['_profiler'] !== 'undefined' &&
 typeof integration['_profiler']['start'] === 'function' &&
 typeof integration['_profiler']['stop'] === 'function'
 );
}
/**
@JonasBaJonasBaAug 29, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

These two calls are just thin wrappers around getIntegration and calling a method on that integration.
 * Starts the Sentry continuous profiler.
 * This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
 * In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
 */
function startProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');

 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.start();
}

/**
 * Stops the Sentry continuous profiler.
 * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
 */
function stopProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.stop();
}

export const profiler: Profiler = {
 startProfiler,
 stopProfiler,
};

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
 spanToBaggageHeader,
 trpcMiddleware,
 zodErrorsIntegration,
 profiler,
} from '@sentry/core';

export type {
Expand Down

14 changes: 7 additions & 7 deletions
packages/profiling-node/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { NodeClient } from '@sentry/node';
import type { Event, Integration, IntegrationFn, Profile, ProfileChunk, Span } from '@sentry/types';
import type { Event, IntegrationFn, Profile, ProfileChunk, ProfilingIntegration, Span } from '@sentry/types';

import { LRUMap, logger, uuid4 } from '@sentry/utils';

Expand DownExpand Up@@ -159,6 +159,7 @@ interface ChunkData {
 timer: NodeJS.Timeout | undefined;
 startTraceID: string;
}

class ContinuousProfiler {
 private _profilerId = uuid4();
 private _client: NodeClient | undefined = undefined;
Expand DownExpand Up@@ -384,12 +385,8 @@ class ContinuousProfiler {
 }
}

export interface ProfilingIntegration extends Integration {
 _profiler: ContinuousProfiler;
}

/** Exported only for tests. */
export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
export const _nodeProfilingIntegration = ((): ProfilingIntegration<NodeClient> => {
 if (DEBUG_BUILD && ![16, 18, 20, 22].includes(NODE_MAJOR)) {
 logger.warn(
 `[Profiling] You are using a Node.js version that does not have prebuilt binaries (${NODE_VERSION}).`,
Expand All@@ -407,7 +404,10 @@ export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
 const options = client.getOptions();

 const mode =
 (options.profilesSampleRate === undefined || options.profilesSampleRate === 0) && !options.profilesSampler
 (options.profilesSampleRate === undefined ||
 options.profilesSampleRate === null ||
 options.profilesSampleRate === 0) &&
 !options.profilesSampler
 ? 'continuous'
 : 'span';
 switch (mode) {
Expand Down

63 changes: 47 additions & 16 deletions
packages/profiling-node/test/spanProfileUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,11 @@ import * as Sentry from '@sentry/node';

import { getMainCarrier } from '@sentry/core';
import type { NodeClientOptions } from '@sentry/node/build/types/types';
import type { ProfilingIntegration } from '@sentry/types';
import type { ProfileChunk, Transport } from '@sentry/types';
import { GLOBAL_OBJ, createEnvelope, logger } from '@sentry/utils';
import { CpuProfilerBindings } from '../src/cpu_profiler';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { _nodeProfilingIntegration } from '../src/integration';

function makeClientWithHooks(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -299,7 +300,7 @@ describe('automated span instrumentation', () => {
 Sentry.setCurrentClient(client);
 client.init();

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -390,7 +391,7 @@ describe('continuous profiling', () => {
 });
 afterEach(() => {
 const client = Sentry.getClient();
 const integration = client?.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client?.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (integration) {
 integration._profiler.stop();
Expand DownExpand Up@@ -432,7 +433,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -446,7 +447,7 @@ describe('continuous profiling', () => {
 expect(profile.client_sdk.version).toEqual(expect.stringMatching(/\d+\.\d+\.\d+/));
 });

 it('initializes the continuous profiler and binds the sentry client', () => {
 it('initializes the continuous profiler', () => {
 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');

 const [client] = makeContinuousProfilingClient();
Expand All@@ -455,14 +456,13 @@ describe('continuous profiling', () => {

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
 integration._profiler.start();

 expect(integration._profiler).toBeDefined();
 expect(integration._profiler['_client']).toBe(client);
 });

 it('starts a continuous profile', () => {
Expand All@@ -473,7 +473,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -490,7 +490,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -509,7 +509,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -529,7 +529,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -548,7 +548,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -604,7 +604,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -632,7 +632,7 @@ describe('continuous profiling', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -692,7 +692,7 @@ describe('span profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });

 expect(startProfilingSpy).toHaveBeenCalled();
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (!integration) {
 throw new Error('Profiling integration not found');
Expand All@@ -703,6 +703,10 @@ describe('span profiling mode', () => {
 });
});
describe('continuous profiling mode', () => {
 beforeEach(() => {
 jest.clearAllMocks();
 });

 it.each([
 ['profilesSampleRate=0', makeClientOptions({ profilesSampleRate: 0 })],
 ['profilesSampleRate=undefined', makeClientOptions({ profilesSampleRate: undefined })],
Expand DownExpand Up@@ -739,7 +743,7 @@ describe('continuous profiling mode', () => {

 jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -750,4 +754,31 @@ describe('continuous profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });
 expect(startProfilingSpy).toHaveBeenCalledTimes(callCount);
 });

 it('top level methods proxy to integration', () => {
 const client = new Sentry.NodeClient({
 ...makeClientOptions({ profilesSampleRate: undefined }),
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 tracesSampleRate: 1,
 transport: _opts =>
 Sentry.makeNodeTransport({
 url: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 recordDroppedEvent: () => {
 return undefined;
 },
 }),
 integrations: [_nodeProfilingIntegration()],
 });

 Sentry.setCurrentClient(client);
 client.init();

 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');
 const stopProfilingSpy = jest.spyOn(CpuProfilerBindings, 'stopProfiling');

 Sentry.profiler.startProfiler();
 expect(startProfilingSpy).toHaveBeenCalledTimes(1);
 Sentry.profiler.stopProfiler();
 expect(stopProfilingSpy).toHaveBeenCalledTimes(1);
 });
});

5 changes: 3 additions & 2 deletions
packages/profiling-node/test/spanProfileUtils.worker.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,8 @@ jest.setTimeout(10000);

import * as Sentry from '@sentry/node';
import type { Transport } from '@sentry/types';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { type ProfilingIntegration } from '@sentry/types';
import { _nodeProfilingIntegration } from '../src/integration';

function makeContinuousProfilingClient(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -49,7 +50,7 @@ it('worker threads context', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,4 +171,5 @@ export type {
 Metrics,
} from './metrics';
export type { ParameterizedString } from './parameterize';
export type { ContinuousProfiler, ProfilingIntegration, Profiler } from './profiling';
export type { ViewHierarchyData, ViewHierarchyWindow } from './view-hierarchy';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(profiling): Expose profiler as top level primitive#13512

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

JonasBa
merged 7 commits into

from

Aug 30, 2024
 Merged


feat(profiling): Expose profiler as top level primitive
#13512
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
188e4c8

ref(profiling): expose continuous profiler on Sentry.profiler


JonasBa Aug 28, 2024
ecb8037

ref(profiling) add comment


JonasBa Aug 28, 2024
79731ac

test: fix profiling tests


JonasBa Aug 29, 2024
8bf0f0a

format fix


JonasBa Aug 29, 2024
96dab48

use import type for client


JonasBa Aug 29, 2024
f05e42b

ref: runtime safe call to start/stop


JonasBa Aug 29, 2024
2398c25

Add to all node-based packages

Aug 30, 2024

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


1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export {
 withMonitor,
 withScope,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,6 +100,7 @@ export { sessionTimingIntegration } from './integrations/sessiontiming';
export { zodErrorsIntegration } from './integrations/zoderrors';
export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
export { metrics } from './metrics/exports';
export { profiler } from './profiling';
export type { MetricData } from '@sentry/types';
export { metricsDefault } from './metrics/exports-default';
export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
Expand Down

72 changes: 72 additions & 0 deletions
packages/core/src/profiling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import type { Profiler, ProfilingIntegration } from '@sentry/types';
import { logger } from '@sentry/utils';

import { getClient } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';

function isProfilingIntegrationWithProfiler(
 integration: ProfilingIntegration<any> | undefined,
): integration is ProfilingIntegration<any> {
 return (
 !!integration &&
 typeof integration['_profiler'] !== 'undefined' &&
 typeof integration['_profiler']['start'] === 'function' &&
 typeof integration['_profiler']['stop'] === 'function'
 );
}
/**
@JonasBaJonasBaAug 29, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

These two calls are just thin wrappers around getIntegration and calling a method on that integration.
 * Starts the Sentry continuous profiler.
 * This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
 * In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
 */
function startProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');

 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.start();
}

/**
 * Stops the Sentry continuous profiler.
 * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
 */
function stopProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.stop();
}

export const profiler: Profiler = {
 startProfiler,
 stopProfiler,
};

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
 spanToBaggageHeader,
 trpcMiddleware,
 zodErrorsIntegration,
 profiler,
} from '@sentry/core';

export type {
Expand Down

14 changes: 7 additions & 7 deletions
packages/profiling-node/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { NodeClient } from '@sentry/node';
import type { Event, Integration, IntegrationFn, Profile, ProfileChunk, Span } from '@sentry/types';
import type { Event, IntegrationFn, Profile, ProfileChunk, ProfilingIntegration, Span } from '@sentry/types';

import { LRUMap, logger, uuid4 } from '@sentry/utils';

Expand DownExpand Up@@ -159,6 +159,7 @@ interface ChunkData {
 timer: NodeJS.Timeout | undefined;
 startTraceID: string;
}

class ContinuousProfiler {
 private _profilerId = uuid4();
 private _client: NodeClient | undefined = undefined;
Expand DownExpand Up@@ -384,12 +385,8 @@ class ContinuousProfiler {
 }
}

export interface ProfilingIntegration extends Integration {
 _profiler: ContinuousProfiler;
}

/** Exported only for tests. */
export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
export const _nodeProfilingIntegration = ((): ProfilingIntegration<NodeClient> => {
 if (DEBUG_BUILD && ![16, 18, 20, 22].includes(NODE_MAJOR)) {
 logger.warn(
 `[Profiling] You are using a Node.js version that does not have prebuilt binaries (${NODE_VERSION}).`,
Expand All@@ -407,7 +404,10 @@ export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
 const options = client.getOptions();

 const mode =
 (options.profilesSampleRate === undefined || options.profilesSampleRate === 0) && !options.profilesSampler
 (options.profilesSampleRate === undefined ||
 options.profilesSampleRate === null ||
 options.profilesSampleRate === 0) &&
 !options.profilesSampler
 ? 'continuous'
 : 'span';
 switch (mode) {
Expand Down

63 changes: 47 additions & 16 deletions
packages/profiling-node/test/spanProfileUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,11 @@ import * as Sentry from '@sentry/node';

import { getMainCarrier } from '@sentry/core';
import type { NodeClientOptions } from '@sentry/node/build/types/types';
import type { ProfilingIntegration } from '@sentry/types';
import type { ProfileChunk, Transport } from '@sentry/types';
import { GLOBAL_OBJ, createEnvelope, logger } from '@sentry/utils';
import { CpuProfilerBindings } from '../src/cpu_profiler';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { _nodeProfilingIntegration } from '../src/integration';

function makeClientWithHooks(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -299,7 +300,7 @@ describe('automated span instrumentation', () => {
 Sentry.setCurrentClient(client);
 client.init();

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -390,7 +391,7 @@ describe('continuous profiling', () => {
 });
 afterEach(() => {
 const client = Sentry.getClient();
 const integration = client?.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client?.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (integration) {
 integration._profiler.stop();
Expand DownExpand Up@@ -432,7 +433,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -446,7 +447,7 @@ describe('continuous profiling', () => {
 expect(profile.client_sdk.version).toEqual(expect.stringMatching(/\d+\.\d+\.\d+/));
 });

 it('initializes the continuous profiler and binds the sentry client', () => {
 it('initializes the continuous profiler', () => {
 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');

 const [client] = makeContinuousProfilingClient();
Expand All@@ -455,14 +456,13 @@ describe('continuous profiling', () => {

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
 integration._profiler.start();

 expect(integration._profiler).toBeDefined();
 expect(integration._profiler['_client']).toBe(client);
 });

 it('starts a continuous profile', () => {
Expand All@@ -473,7 +473,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -490,7 +490,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -509,7 +509,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -529,7 +529,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -548,7 +548,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -604,7 +604,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -632,7 +632,7 @@ describe('continuous profiling', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -692,7 +692,7 @@ describe('span profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });

 expect(startProfilingSpy).toHaveBeenCalled();
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (!integration) {
 throw new Error('Profiling integration not found');
Expand All@@ -703,6 +703,10 @@ describe('span profiling mode', () => {
 });
});
describe('continuous profiling mode', () => {
 beforeEach(() => {
 jest.clearAllMocks();
 });

 it.each([
 ['profilesSampleRate=0', makeClientOptions({ profilesSampleRate: 0 })],
 ['profilesSampleRate=undefined', makeClientOptions({ profilesSampleRate: undefined })],
Expand DownExpand Up@@ -739,7 +743,7 @@ describe('continuous profiling mode', () => {

 jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -750,4 +754,31 @@ describe('continuous profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });
 expect(startProfilingSpy).toHaveBeenCalledTimes(callCount);
 });

 it('top level methods proxy to integration', () => {
 const client = new Sentry.NodeClient({
 ...makeClientOptions({ profilesSampleRate: undefined }),
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 tracesSampleRate: 1,
 transport: _opts =>
 Sentry.makeNodeTransport({
 url: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 recordDroppedEvent: () => {
 return undefined;
 },
 }),
 integrations: [_nodeProfilingIntegration()],
 });

 Sentry.setCurrentClient(client);
 client.init();

 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');
 const stopProfilingSpy = jest.spyOn(CpuProfilerBindings, 'stopProfiling');

 Sentry.profiler.startProfiler();
 expect(startProfilingSpy).toHaveBeenCalledTimes(1);
 Sentry.profiler.stopProfiler();
 expect(stopProfilingSpy).toHaveBeenCalledTimes(1);
 });
});

5 changes: 3 additions & 2 deletions
packages/profiling-node/test/spanProfileUtils.worker.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,8 @@ jest.setTimeout(10000);

import * as Sentry from '@sentry/node';
import type { Transport } from '@sentry/types';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { type ProfilingIntegration } from '@sentry/types';
import { _nodeProfilingIntegration } from '../src/integration';

function makeContinuousProfilingClient(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -49,7 +50,7 @@ it('worker threads context', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,4 +171,5 @@ export type {
 Metrics,
} from './metrics';
export type { ParameterizedString } from './parameterize';
export type { ContinuousProfiler, ProfilingIntegration, Profiler } from './profiling';
export type { ViewHierarchyData, ViewHierarchyWindow } from './view-hierarchy';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(profiling): Expose profiler as top level primitive#13512

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

JonasBa
merged 7 commits into

from

Aug 30, 2024
 Merged


feat(profiling): Expose profiler as top level primitive
#13512
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
188e4c8

ref(profiling): expose continuous profiler on Sentry.profiler


JonasBa Aug 28, 2024
ecb8037

ref(profiling) add comment


JonasBa Aug 28, 2024
79731ac

test: fix profiling tests


JonasBa Aug 29, 2024
8bf0f0a

format fix


JonasBa Aug 29, 2024
96dab48

use import type for client


JonasBa Aug 29, 2024
f05e42b

ref: runtime safe call to start/stop


JonasBa Aug 29, 2024
2398c25

Add to all node-based packages

Aug 30, 2024

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


1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export {
 withMonitor,
 withScope,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,6 +100,7 @@ export { sessionTimingIntegration } from './integrations/sessiontiming';
export { zodErrorsIntegration } from './integrations/zoderrors';
export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
export { metrics } from './metrics/exports';
export { profiler } from './profiling';
export type { MetricData } from '@sentry/types';
export { metricsDefault } from './metrics/exports-default';
export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
Expand Down

72 changes: 72 additions & 0 deletions
packages/core/src/profiling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import type { Profiler, ProfilingIntegration } from '@sentry/types';
import { logger } from '@sentry/utils';

import { getClient } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';

function isProfilingIntegrationWithProfiler(
 integration: ProfilingIntegration<any> | undefined,
): integration is ProfilingIntegration<any> {
 return (
 !!integration &&
 typeof integration['_profiler'] !== 'undefined' &&
 typeof integration['_profiler']['start'] === 'function' &&
 typeof integration['_profiler']['stop'] === 'function'
 );
}
/**
@JonasBaJonasBaAug 29, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

These two calls are just thin wrappers around getIntegration and calling a method on that integration.
 * Starts the Sentry continuous profiler.
 * This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
 * In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
 */
function startProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');

 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.start();
}

/**
 * Stops the Sentry continuous profiler.
 * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
 */
function stopProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.stop();
}

export const profiler: Profiler = {
 startProfiler,
 stopProfiler,
};

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
 spanToBaggageHeader,
 trpcMiddleware,
 zodErrorsIntegration,
 profiler,
} from '@sentry/core';

export type {
Expand Down

14 changes: 7 additions & 7 deletions
packages/profiling-node/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { NodeClient } from '@sentry/node';
import type { Event, Integration, IntegrationFn, Profile, ProfileChunk, Span } from '@sentry/types';
import type { Event, IntegrationFn, Profile, ProfileChunk, ProfilingIntegration, Span } from '@sentry/types';

import { LRUMap, logger, uuid4 } from '@sentry/utils';

Expand DownExpand Up@@ -159,6 +159,7 @@ interface ChunkData {
 timer: NodeJS.Timeout | undefined;
 startTraceID: string;
}

class ContinuousProfiler {
 private _profilerId = uuid4();
 private _client: NodeClient | undefined = undefined;
Expand DownExpand Up@@ -384,12 +385,8 @@ class ContinuousProfiler {
 }
}

export interface ProfilingIntegration extends Integration {
 _profiler: ContinuousProfiler;
}

/** Exported only for tests. */
export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
export const _nodeProfilingIntegration = ((): ProfilingIntegration<NodeClient> => {
 if (DEBUG_BUILD && ![16, 18, 20, 22].includes(NODE_MAJOR)) {
 logger.warn(
 `[Profiling] You are using a Node.js version that does not have prebuilt binaries (${NODE_VERSION}).`,
Expand All@@ -407,7 +404,10 @@ export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
 const options = client.getOptions();

 const mode =
 (options.profilesSampleRate === undefined || options.profilesSampleRate === 0) && !options.profilesSampler
 (options.profilesSampleRate === undefined ||
 options.profilesSampleRate === null ||
 options.profilesSampleRate === 0) &&
 !options.profilesSampler
 ? 'continuous'
 : 'span';
 switch (mode) {
Expand Down

63 changes: 47 additions & 16 deletions
packages/profiling-node/test/spanProfileUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,11 @@ import * as Sentry from '@sentry/node';

import { getMainCarrier } from '@sentry/core';
import type { NodeClientOptions } from '@sentry/node/build/types/types';
import type { ProfilingIntegration } from '@sentry/types';
import type { ProfileChunk, Transport } from '@sentry/types';
import { GLOBAL_OBJ, createEnvelope, logger } from '@sentry/utils';
import { CpuProfilerBindings } from '../src/cpu_profiler';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { _nodeProfilingIntegration } from '../src/integration';

function makeClientWithHooks(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -299,7 +300,7 @@ describe('automated span instrumentation', () => {
 Sentry.setCurrentClient(client);
 client.init();

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -390,7 +391,7 @@ describe('continuous profiling', () => {
 });
 afterEach(() => {
 const client = Sentry.getClient();
 const integration = client?.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client?.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (integration) {
 integration._profiler.stop();
Expand DownExpand Up@@ -432,7 +433,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -446,7 +447,7 @@ describe('continuous profiling', () => {
 expect(profile.client_sdk.version).toEqual(expect.stringMatching(/\d+\.\d+\.\d+/));
 });

 it('initializes the continuous profiler and binds the sentry client', () => {
 it('initializes the continuous profiler', () => {
 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');

 const [client] = makeContinuousProfilingClient();
Expand All@@ -455,14 +456,13 @@ describe('continuous profiling', () => {

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
 integration._profiler.start();

 expect(integration._profiler).toBeDefined();
 expect(integration._profiler['_client']).toBe(client);
 });

 it('starts a continuous profile', () => {
Expand All@@ -473,7 +473,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -490,7 +490,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -509,7 +509,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -529,7 +529,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -548,7 +548,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -604,7 +604,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -632,7 +632,7 @@ describe('continuous profiling', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -692,7 +692,7 @@ describe('span profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });

 expect(startProfilingSpy).toHaveBeenCalled();
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (!integration) {
 throw new Error('Profiling integration not found');
Expand All@@ -703,6 +703,10 @@ describe('span profiling mode', () => {
 });
});
describe('continuous profiling mode', () => {
 beforeEach(() => {
 jest.clearAllMocks();
 });

 it.each([
 ['profilesSampleRate=0', makeClientOptions({ profilesSampleRate: 0 })],
 ['profilesSampleRate=undefined', makeClientOptions({ profilesSampleRate: undefined })],
Expand DownExpand Up@@ -739,7 +743,7 @@ describe('continuous profiling mode', () => {

 jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -750,4 +754,31 @@ describe('continuous profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });
 expect(startProfilingSpy).toHaveBeenCalledTimes(callCount);
 });

 it('top level methods proxy to integration', () => {
 const client = new Sentry.NodeClient({
 ...makeClientOptions({ profilesSampleRate: undefined }),
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 tracesSampleRate: 1,
 transport: _opts =>
 Sentry.makeNodeTransport({
 url: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 recordDroppedEvent: () => {
 return undefined;
 },
 }),
 integrations: [_nodeProfilingIntegration()],
 });

 Sentry.setCurrentClient(client);
 client.init();

 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');
 const stopProfilingSpy = jest.spyOn(CpuProfilerBindings, 'stopProfiling');

 Sentry.profiler.startProfiler();
 expect(startProfilingSpy).toHaveBeenCalledTimes(1);
 Sentry.profiler.stopProfiler();
 expect(stopProfilingSpy).toHaveBeenCalledTimes(1);
 });
});

5 changes: 3 additions & 2 deletions
packages/profiling-node/test/spanProfileUtils.worker.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,8 @@ jest.setTimeout(10000);

import * as Sentry from '@sentry/node';
import type { Transport } from '@sentry/types';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { type ProfilingIntegration } from '@sentry/types';
import { _nodeProfilingIntegration } from '../src/integration';

function makeContinuousProfilingClient(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -49,7 +50,7 @@ it('worker threads context', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,4 +171,5 @@ export type {
 Metrics,
} from './metrics';
export type { ParameterizedString } from './parameterize';
export type { ContinuousProfiler, ProfilingIntegration, Profiler } from './profiling';
export type { ViewHierarchyData, ViewHierarchyWindow } from './view-hierarchy';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(profiling): Expose profiler as top level primitive#13512

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

JonasBa
merged 7 commits into

from

Aug 30, 2024
 Merged


feat(profiling): Expose profiler as top level primitive
#13512
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
188e4c8

ref(profiling): expose continuous profiler on Sentry.profiler


JonasBa Aug 28, 2024
ecb8037

ref(profiling) add comment


JonasBa Aug 28, 2024
79731ac

test: fix profiling tests


JonasBa Aug 29, 2024
8bf0f0a

format fix


JonasBa Aug 29, 2024
96dab48

use import type for client


JonasBa Aug 29, 2024
f05e42b

ref: runtime safe call to start/stop


JonasBa Aug 29, 2024
2398c25

Add to all node-based packages

Aug 30, 2024

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


1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export {
 withMonitor,
 withScope,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,6 +100,7 @@ export { sessionTimingIntegration } from './integrations/sessiontiming';
export { zodErrorsIntegration } from './integrations/zoderrors';
export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
export { metrics } from './metrics/exports';
export { profiler } from './profiling';
export type { MetricData } from '@sentry/types';
export { metricsDefault } from './metrics/exports-default';
export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
Expand Down

72 changes: 72 additions & 0 deletions
packages/core/src/profiling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import type { Profiler, ProfilingIntegration } from '@sentry/types';
import { logger } from '@sentry/utils';

import { getClient } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';

function isProfilingIntegrationWithProfiler(
 integration: ProfilingIntegration<any> | undefined,
): integration is ProfilingIntegration<any> {
 return (
 !!integration &&
 typeof integration['_profiler'] !== 'undefined' &&
 typeof integration['_profiler']['start'] === 'function' &&
 typeof integration['_profiler']['stop'] === 'function'
 );
}
/**
@JonasBaJonasBaAug 29, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

These two calls are just thin wrappers around getIntegration and calling a method on that integration.
 * Starts the Sentry continuous profiler.
 * This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
 * In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
 */
function startProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');

 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.start();
}

/**
 * Stops the Sentry continuous profiler.
 * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
 */
function stopProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.stop();
}

export const profiler: Profiler = {
 startProfiler,
 stopProfiler,
};

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
 spanToBaggageHeader,
 trpcMiddleware,
 zodErrorsIntegration,
 profiler,
} from '@sentry/core';

export type {
Expand Down

14 changes: 7 additions & 7 deletions
packages/profiling-node/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { NodeClient } from '@sentry/node';
import type { Event, Integration, IntegrationFn, Profile, ProfileChunk, Span } from '@sentry/types';
import type { Event, IntegrationFn, Profile, ProfileChunk, ProfilingIntegration, Span } from '@sentry/types';

import { LRUMap, logger, uuid4 } from '@sentry/utils';

Expand DownExpand Up@@ -159,6 +159,7 @@ interface ChunkData {
 timer: NodeJS.Timeout | undefined;
 startTraceID: string;
}

class ContinuousProfiler {
 private _profilerId = uuid4();
 private _client: NodeClient | undefined = undefined;
Expand DownExpand Up@@ -384,12 +385,8 @@ class ContinuousProfiler {
 }
}

export interface ProfilingIntegration extends Integration {
 _profiler: ContinuousProfiler;
}

/** Exported only for tests. */
export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
export const _nodeProfilingIntegration = ((): ProfilingIntegration<NodeClient> => {
 if (DEBUG_BUILD && ![16, 18, 20, 22].includes(NODE_MAJOR)) {
 logger.warn(
 `[Profiling] You are using a Node.js version that does not have prebuilt binaries (${NODE_VERSION}).`,
Expand All@@ -407,7 +404,10 @@ export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
 const options = client.getOptions();

 const mode =
 (options.profilesSampleRate === undefined || options.profilesSampleRate === 0) && !options.profilesSampler
 (options.profilesSampleRate === undefined ||
 options.profilesSampleRate === null ||
 options.profilesSampleRate === 0) &&
 !options.profilesSampler
 ? 'continuous'
 : 'span';
 switch (mode) {
Expand Down

63 changes: 47 additions & 16 deletions
packages/profiling-node/test/spanProfileUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,11 @@ import * as Sentry from '@sentry/node';

import { getMainCarrier } from '@sentry/core';
import type { NodeClientOptions } from '@sentry/node/build/types/types';
import type { ProfilingIntegration } from '@sentry/types';
import type { ProfileChunk, Transport } from '@sentry/types';
import { GLOBAL_OBJ, createEnvelope, logger } from '@sentry/utils';
import { CpuProfilerBindings } from '../src/cpu_profiler';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { _nodeProfilingIntegration } from '../src/integration';

function makeClientWithHooks(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -299,7 +300,7 @@ describe('automated span instrumentation', () => {
 Sentry.setCurrentClient(client);
 client.init();

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -390,7 +391,7 @@ describe('continuous profiling', () => {
 });
 afterEach(() => {
 const client = Sentry.getClient();
 const integration = client?.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client?.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (integration) {
 integration._profiler.stop();
Expand DownExpand Up@@ -432,7 +433,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -446,7 +447,7 @@ describe('continuous profiling', () => {
 expect(profile.client_sdk.version).toEqual(expect.stringMatching(/\d+\.\d+\.\d+/));
 });

 it('initializes the continuous profiler and binds the sentry client', () => {
 it('initializes the continuous profiler', () => {
 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');

 const [client] = makeContinuousProfilingClient();
Expand All@@ -455,14 +456,13 @@ describe('continuous profiling', () => {

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
 integration._profiler.start();

 expect(integration._profiler).toBeDefined();
 expect(integration._profiler['_client']).toBe(client);
 });

 it('starts a continuous profile', () => {
Expand All@@ -473,7 +473,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -490,7 +490,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -509,7 +509,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -529,7 +529,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -548,7 +548,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -604,7 +604,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -632,7 +632,7 @@ describe('continuous profiling', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -692,7 +692,7 @@ describe('span profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });

 expect(startProfilingSpy).toHaveBeenCalled();
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (!integration) {
 throw new Error('Profiling integration not found');
Expand All@@ -703,6 +703,10 @@ describe('span profiling mode', () => {
 });
});
describe('continuous profiling mode', () => {
 beforeEach(() => {
 jest.clearAllMocks();
 });

 it.each([
 ['profilesSampleRate=0', makeClientOptions({ profilesSampleRate: 0 })],
 ['profilesSampleRate=undefined', makeClientOptions({ profilesSampleRate: undefined })],
Expand DownExpand Up@@ -739,7 +743,7 @@ describe('continuous profiling mode', () => {

 jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -750,4 +754,31 @@ describe('continuous profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });
 expect(startProfilingSpy).toHaveBeenCalledTimes(callCount);
 });

 it('top level methods proxy to integration', () => {
 const client = new Sentry.NodeClient({
 ...makeClientOptions({ profilesSampleRate: undefined }),
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 tracesSampleRate: 1,
 transport: _opts =>
 Sentry.makeNodeTransport({
 url: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 recordDroppedEvent: () => {
 return undefined;
 },
 }),
 integrations: [_nodeProfilingIntegration()],
 });

 Sentry.setCurrentClient(client);
 client.init();

 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');
 const stopProfilingSpy = jest.spyOn(CpuProfilerBindings, 'stopProfiling');

 Sentry.profiler.startProfiler();
 expect(startProfilingSpy).toHaveBeenCalledTimes(1);
 Sentry.profiler.stopProfiler();
 expect(stopProfilingSpy).toHaveBeenCalledTimes(1);
 });
});

5 changes: 3 additions & 2 deletions
packages/profiling-node/test/spanProfileUtils.worker.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,8 @@ jest.setTimeout(10000);

import * as Sentry from '@sentry/node';
import type { Transport } from '@sentry/types';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { type ProfilingIntegration } from '@sentry/types';
import { _nodeProfilingIntegration } from '../src/integration';

function makeContinuousProfilingClient(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -49,7 +50,7 @@ it('worker threads context', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,4 +171,5 @@ export type {
 Metrics,
} from './metrics';
export type { ParameterizedString } from './parameterize';
export type { ContinuousProfiler, ProfilingIntegration, Profiler } from './profiling';
export type { ViewHierarchyData, ViewHierarchyWindow } from './view-hierarchy';
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(profiling): Expose profiler as top level primitive#13512

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

JonasBa
merged 7 commits into

from

Aug 30, 2024
 Merged


feat(profiling): Expose profiler as top level primitive
#13512
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
188e4c8

ref(profiling): expose continuous profiler on Sentry.profiler


JonasBa Aug 28, 2024
ecb8037

ref(profiling) add comment


JonasBa Aug 28, 2024
79731ac

test: fix profiling tests


JonasBa Aug 29, 2024
8bf0f0a

format fix


JonasBa Aug 29, 2024
96dab48

use import type for client


JonasBa Aug 29, 2024
f05e42b

ref: runtime safe call to start/stop


JonasBa Aug 29, 2024
2398c25

Add to all node-based packages

Aug 30, 2024

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


1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export {
 withMonitor,
 withScope,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export { init } from './server/sdk';
Expand Down

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,6 +100,7 @@ export { sessionTimingIntegration } from './integrations/sessiontiming';
export { zodErrorsIntegration } from './integrations/zoderrors';
export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
export { metrics } from './metrics/exports';
export { profiler } from './profiling';
export type { MetricData } from '@sentry/types';
export { metricsDefault } from './metrics/exports-default';
export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
Expand Down

72 changes: 72 additions & 0 deletions
packages/core/src/profiling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
import type { Profiler, ProfilingIntegration } from '@sentry/types';
import { logger } from '@sentry/utils';

import { getClient } from './currentScopes';
import { DEBUG_BUILD } from './debug-build';

function isProfilingIntegrationWithProfiler(
 integration: ProfilingIntegration<any> | undefined,
): integration is ProfilingIntegration<any> {
 return (
 !!integration &&
 typeof integration['_profiler'] !== 'undefined' &&
 typeof integration['_profiler']['start'] === 'function' &&
 typeof integration['_profiler']['stop'] === 'function'
 );
}
/**
@JonasBaJonasBaAug 29, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

These two calls are just thin wrappers around getIntegration and calling a method on that integration.
 * Starts the Sentry continuous profiler.
 * This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
 * In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
 */
function startProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');

 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.start();
}

/**
 * Stops the Sentry continuous profiler.
 * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
 */
function stopProfiler(): void {
 const client = getClient();
 if (!client) {
 DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
 return;
 }

 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
 return;
 }

 if (!isProfilingIntegrationWithProfiler(integration)) {
 DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
 return;
 }

 integration._profiler.stop();
}

export const profiler: Profiler = {
 startProfiler,
 stopProfiler,
};

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,6 +107,7 @@ export {
 trpcMiddleware,
 addOpenTelemetryInstrumentation,
 zodErrorsIntegration,
 profiler,
} from '@sentry/node';

export {
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,7 @@ export {
 spanToBaggageHeader,
 trpcMiddleware,
 zodErrorsIntegration,
 profiler,
} from '@sentry/core';

export type {
Expand Down

14 changes: 7 additions & 7 deletions
packages/profiling-node/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { NodeClient } from '@sentry/node';
import type { Event, Integration, IntegrationFn, Profile, ProfileChunk, Span } from '@sentry/types';
import type { Event, IntegrationFn, Profile, ProfileChunk, ProfilingIntegration, Span } from '@sentry/types';

import { LRUMap, logger, uuid4 } from '@sentry/utils';

Expand DownExpand Up@@ -159,6 +159,7 @@ interface ChunkData {
 timer: NodeJS.Timeout | undefined;
 startTraceID: string;
}

class ContinuousProfiler {
 private _profilerId = uuid4();
 private _client: NodeClient | undefined = undefined;
Expand DownExpand Up@@ -384,12 +385,8 @@ class ContinuousProfiler {
 }
}

export interface ProfilingIntegration extends Integration {
 _profiler: ContinuousProfiler;
}

/** Exported only for tests. */
export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
export const _nodeProfilingIntegration = ((): ProfilingIntegration<NodeClient> => {
 if (DEBUG_BUILD && ![16, 18, 20, 22].includes(NODE_MAJOR)) {
 logger.warn(
 `[Profiling] You are using a Node.js version that does not have prebuilt binaries (${NODE_VERSION}).`,
Expand All@@ -407,7 +404,10 @@ export const _nodeProfilingIntegration = ((): ProfilingIntegration => {
 const options = client.getOptions();

 const mode =
 (options.profilesSampleRate === undefined || options.profilesSampleRate === 0) && !options.profilesSampler
 (options.profilesSampleRate === undefined ||
 options.profilesSampleRate === null ||
 options.profilesSampleRate === 0) &&
 !options.profilesSampler
 ? 'continuous'
 : 'span';
 switch (mode) {
Expand Down

63 changes: 47 additions & 16 deletions
packages/profiling-node/test/spanProfileUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,10 +2,11 @@ import * as Sentry from '@sentry/node';

import { getMainCarrier } from '@sentry/core';
import type { NodeClientOptions } from '@sentry/node/build/types/types';
import type { ProfilingIntegration } from '@sentry/types';
import type { ProfileChunk, Transport } from '@sentry/types';
import { GLOBAL_OBJ, createEnvelope, logger } from '@sentry/utils';
import { CpuProfilerBindings } from '../src/cpu_profiler';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { _nodeProfilingIntegration } from '../src/integration';

function makeClientWithHooks(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -299,7 +300,7 @@ describe('automated span instrumentation', () => {
 Sentry.setCurrentClient(client);
 client.init();

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -390,7 +391,7 @@ describe('continuous profiling', () => {
 });
 afterEach(() => {
 const client = Sentry.getClient();
 const integration = client?.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client?.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (integration) {
 integration._profiler.stop();
Expand DownExpand Up@@ -432,7 +433,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -446,7 +447,7 @@ describe('continuous profiling', () => {
 expect(profile.client_sdk.version).toEqual(expect.stringMatching(/\d+\.\d+\.\d+/));
 });

 it('initializes the continuous profiler and binds the sentry client', () => {
 it('initializes the continuous profiler', () => {
 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');

 const [client] = makeContinuousProfilingClient();
Expand All@@ -455,14 +456,13 @@ describe('continuous profiling', () => {

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
 integration._profiler.start();

 expect(integration._profiler).toBeDefined();
 expect(integration._profiler['_client']).toBe(client);
 });

 it('starts a continuous profile', () => {
Expand All@@ -473,7 +473,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -490,7 +490,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -509,7 +509,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -529,7 +529,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -548,7 +548,7 @@ describe('continuous profiling', () => {
 client.init();

 expect(startProfilingSpy).not.toHaveBeenCalledTimes(1);
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -604,7 +604,7 @@ describe('continuous profiling', () => {

 const transportSpy = jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -632,7 +632,7 @@ describe('continuous profiling', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand DownExpand Up@@ -692,7 +692,7 @@ describe('span profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });

 expect(startProfilingSpy).toHaveBeenCalled();
 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');

 if (!integration) {
 throw new Error('Profiling integration not found');
Expand All@@ -703,6 +703,10 @@ describe('span profiling mode', () => {
 });
});
describe('continuous profiling mode', () => {
 beforeEach(() => {
 jest.clearAllMocks();
 });

 it.each([
 ['profilesSampleRate=0', makeClientOptions({ profilesSampleRate: 0 })],
 ['profilesSampleRate=undefined', makeClientOptions({ profilesSampleRate: undefined })],
Expand DownExpand Up@@ -739,7 +743,7 @@ describe('continuous profiling mode', () => {

 jest.spyOn(transport, 'send').mockReturnValue(Promise.resolve({}));

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<Sentry.NodeClient>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand All@@ -750,4 +754,31 @@ describe('continuous profiling mode', () => {
 Sentry.startInactiveSpan({ forceTransaction: true, name: 'profile_hub' });
 expect(startProfilingSpy).toHaveBeenCalledTimes(callCount);
 });

 it('top level methods proxy to integration', () => {
 const client = new Sentry.NodeClient({
 ...makeClientOptions({ profilesSampleRate: undefined }),
 dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 tracesSampleRate: 1,
 transport: _opts =>
 Sentry.makeNodeTransport({
 url: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
 recordDroppedEvent: () => {
 return undefined;
 },
 }),
 integrations: [_nodeProfilingIntegration()],
 });

 Sentry.setCurrentClient(client);
 client.init();

 const startProfilingSpy = jest.spyOn(CpuProfilerBindings, 'startProfiling');
 const stopProfilingSpy = jest.spyOn(CpuProfilerBindings, 'stopProfiling');

 Sentry.profiler.startProfiler();
 expect(startProfilingSpy).toHaveBeenCalledTimes(1);
 Sentry.profiler.stopProfiler();
 expect(stopProfilingSpy).toHaveBeenCalledTimes(1);
 });
});

5 changes: 3 additions & 2 deletions
packages/profiling-node/test/spanProfileUtils.worker.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,8 @@ jest.setTimeout(10000);

import * as Sentry from '@sentry/node';
import type { Transport } from '@sentry/types';
import { type ProfilingIntegration, _nodeProfilingIntegration } from '../src/integration';
import { type ProfilingIntegration } from '@sentry/types';
import { _nodeProfilingIntegration } from '../src/integration';

function makeContinuousProfilingClient(): [Sentry.NodeClient, Transport] {
 const integration = _nodeProfilingIntegration();
Expand DownExpand Up@@ -49,7 +50,7 @@ it('worker threads context', () => {
 },
 });

 const integration = client.getIntegrationByName<ProfilingIntegration>('ProfilingIntegration');
 const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
 if (!integration) {
 throw new Error('Profiling integration not found');
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,4 +171,5 @@ export type {
 Metrics,
} from './metrics';
export type { ParameterizedString } from './parameterize';
export type { ContinuousProfiler, ProfilingIntegration, Profiler } from './profiling';
export type { ViewHierarchyData, ViewHierarchyWindow } from './view-hierarchy';
Loading