chore(clerk-js,shared): Increase sampling for ui components on keyless#6514

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
panteliselef merged 10 commits into from
Aug 11, 2025
Merged

chore(clerk-js,shared): Increase sampling for ui components on keyless #6514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
52307bc
chore(clerk-js,shared): Increase sampling for ui components on keyless
panteliselef Aug 11, 2025
0f2a336
validate param
panteliselef Aug 11, 2025
9927e85
address rabbit feedback
panteliselef Aug 11, 2025
81720d0
bump bundlewatch.config.json
panteliselef Aug 11, 2025
6bd5a1b
update collector
panteliselef Aug 11, 2025
033ca87
remove previous approach
panteliselef Aug 11, 2025
0bbf54e
rename property
panteliselef Aug 11, 2025
b604cba
Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…
panteliselef Aug 11, 2025
5d18bb0
Update .changeset/slow-shoes-give.md
panteliselef Aug 11, 2025
19c3bf5
Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…
panteliselef Aug 11, 2025
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
5 changes: 5 additions & 0 deletions .changeset/bitter-waves-burn.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use throttling instead of sampling for telemetry events of UI components on keyless apps.
5 changes: 5 additions & 0 deletions .changeset/slow-shoes-give.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Update TelemetryCollector to accept a `perEventSampling` property for controling per-event sampling rates.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
{ "path": "./dist/clerk.js", "maxSize": "621KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "75KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "117KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "57KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "57.1KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "113KB" },
{ "path": "./dist/ui-common*.legacy.*.js", "maxSize": "118KB" },
{ "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
Expand Down
41 changes: 24 additions & 17 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -439,6 +439,7 @@ export class Clerk implements ClerkInterface {
this.telemetry = new TelemetryCollector({
clerkVersion: Clerk.version,
samplingRate: 1,
perEventSampling: this.#options.__internal_keyless_claimKeylessApplicationUrl ? false : undefined,
publishableKey: this.publishableKey,
...this.#options.telemetry,
});
Expand DownExpand Up@@ -537,12 +538,13 @@ export class Clerk implements ClerkInterface {
};

public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
const component = 'GoogleOneTap';
this.assertComponentsReady(this.#componentControls);
void this.#componentControls
.ensureMounted({ preloadHint: 'GoogleOneTap' })
.ensureMounted({ preloadHint: component })
.then(controls => controls.openModal('googleOneTap', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
};

public closeGoogleOneTap = (): void => {
Expand All@@ -560,12 +562,13 @@ export class Clerk implements ClerkInterface {
}
return;
}
const component = 'SignIn';
void this.#componentControls
.ensureMounted({ preloadHint: 'SignIn' })
.ensureMounted({ preloadHint: component })
.then(controls => controls.openModal('signIn', props || {}));

const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
this.telemetry?.record(eventPrebuiltComponentOpened(component, props, additionalData));
};

public closeSignIn = (): void => {
Expand DownExpand Up@@ -612,11 +615,12 @@ export class Clerk implements ClerkInterface {
}
return;
}
const component = 'PlanDetails';
void this.#componentControls
.ensureMounted({ preloadHint: 'PlanDetails' })
.ensureMounted({ preloadHint: component })
.then(controls => controls.openDrawer('planDetails', props || {}));

this.telemetry?.record(eventPrebuiltComponentOpened(`PlanDetails`, props));
this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
};

public __internal_closePlanDetails = (): void => {
Expand DownExpand Up@@ -718,7 +722,7 @@ export class Clerk implements ClerkInterface {
.ensureMounted({ preloadHint: 'UserProfile' })
.then(controls => controls.openModal('userProfile', props || {}));

const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
};

Expand DownExpand Up@@ -795,17 +799,18 @@ export class Clerk implements ClerkInterface {

public mountSignIn = (node: HTMLDivElement, props?: SignInProps): void => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted({ preloadHint: 'SignIn' }).then(controls =>
const component = 'SignIn';
void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
controls.mountComponent({
name: 'SignIn',
name: component,
appearanceKey: 'signIn',
node,
props,
}),
);

const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
};

public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -819,16 +824,17 @@ export class Clerk implements ClerkInterface {

public mountSignUp = (node: HTMLDivElement, props?: SignUpProps): void => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted({ preloadHint: 'SignUp' }).then(controls =>
const component = 'SignUp';
void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
controls.mountComponent({
name: 'SignUp',
name: component,
appearanceKey: 'signUp',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
};

public unmountSignUp = (node: HTMLDivElement): void => {
Expand All@@ -850,17 +856,18 @@ export class Clerk implements ClerkInterface {
}
return;
}
void this.#componentControls.ensureMounted({ preloadHint: 'UserProfile' }).then(controls =>
const component = 'UserProfile';
void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
controls.mountComponent({
name: 'UserProfile',
name: component,
appearanceKey: 'userProfile',
node,
props,
}),
);

const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
};

public unmountUserProfile = (node: HTMLDivElement): void => {
Expand Down
43 changes: 43 additions & 0 deletions packages/shared/src/__tests__/telemetry.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,49 @@ describe('TelemetryCollector', () => {

randomSpy.mockRestore();
});

test('ignores event-specific sampling rate when eventSampling is false', async () => {
windowSpy.mockImplementation(() => undefined);

const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

const collector = new TelemetryCollector({
publishableKey: TEST_PK,
samplingRate: 1.0, // Global sampling rate allows all events
perEventSampling: false, // Disable event-specific sampling
});

// This event would normally be rejected due to low eventSamplingRate (0.1 < 0.5)
// but should be sent because eventSampling is disabled
collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

jest.runAllTimers();

expect(fetchSpy).toHaveBeenCalled();

randomSpy.mockRestore();
});

test('respects event-specific sampling rate when eventSampling is true (default)', async () => {
windowSpy.mockImplementation(() => undefined);

const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

const collector = new TelemetryCollector({
publishableKey: TEST_PK,
samplingRate: 1.0, // Global sampling rate allows all events
perEventSampling: true, // Enable event-specific sampling (default)
});

// This event should be rejected due to low eventSamplingRate (0.1 < 0.5)
collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

jest.runAllTimers();

expect(fetchSpy).not.toHaveBeenCalled();

randomSpy.mockRestore();
});
});

describe('with client-side throttling', () => {
Expand Down
7 changes: 5 additions & 2 deletions packages/shared/src/telemetry/collector.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ function isWindowClerkWithMetadata(clerk: unknown): clerk is { constructor: { sd

type TelemetryCollectorConfig = Pick<
TelemetryCollectorOptions,
'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize'
'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize' | 'perEventSampling'
> & {
endpoint: string;
};
Expand DownExpand Up@@ -80,6 +80,7 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
this.#config = {
maxBufferSize: options.maxBufferSize ?? DEFAULT_CONFIG.maxBufferSize,
samplingRate: options.samplingRate ?? DEFAULT_CONFIG.samplingRate,
perEventSampling: options.perEventSampling ?? true,
disabled: options.disabled ?? false,
debug: options.debug ?? false,
endpoint: DEFAULT_CONFIG.endpoint,
Expand DownExpand Up@@ -167,7 +168,9 @@ export class TelemetryCollector implements TelemetryCollectorInterface {

const toBeSampled =
randomSeed <= this.#config.samplingRate &&
(typeof eventSamplingRate === 'undefined' || randomSeed <= eventSamplingRate);
(this.#config.perEventSampling === false ||
typeof eventSamplingRate === 'undefined' ||
randomSeed <= eventSamplingRate);

if (!toBeSampled) {
return false;
Expand Down
6 changes: 3 additions & 3 deletions packages/shared/src/telemetry/events/component-mounted.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ type EventPrebuiltComponent = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

/**
* @internal
*/
function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
return function (
component: string,
Expand DownExpand Up@@ -44,7 +47,6 @@ function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | ty
* @param component - The name of the component.
* @param props - The props passed to the component. Will be filtered to a known list of props.
* @param additionalPayload - Additional data to send with the event.
*
* @example
* telemetry.record(eventPrebuiltComponentMounted('SignUp', props));
*/
Expand All@@ -62,7 +64,6 @@ export function eventPrebuiltComponentMounted(
* @param component - The name of the component.
* @param props - The props passed to the component. Will be filtered to a known list of props.
* @param additionalPayload - Additional data to send with the event.
*
* @example
* telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
*/
Expand All@@ -81,7 +82,6 @@ export function eventPrebuiltComponentOpened(
*
* @param component - The name of the component.
* @param props - The props passed to the component. Ideally you only pass a handful of props here.
*
* @example
* telemetry.record(eventComponentMounted('SignUp', props));
*/
Expand Down
10 changes: 8 additions & 2 deletions packages/shared/src/telemetry/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,11 +8,17 @@ export type TelemetryCollectorOptions = {
*/
debug?: boolean;
/**
* Sampling rate, 0-1
* Sampling rate, 0-1.
*/
samplingRate?: number;
/**
* Set a custom buffer size to control how often events are sent
* If false, the sampling rates provided per event will be ignored and the global sampling rate will be used.
*
* @default true
*/
perEventSampling?: boolean;
/**
* Set a custom buffer size to control how often events are sent.
*/
maxBufferSize?: number;
/**
Expand Down
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
chore(clerk-js,shared): Increase sampling for ui components on keyless#6514

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

panteliselef
merged 10 commits into

from

Aug 11, 2025
 Merged


chore(clerk-js,shared): Increase sampling for ui components on keyless
#6514
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
52307bc

chore(clerk-js,shared): Increase sampling for ui components on keyless


panteliselef Aug 11, 2025
0f2a336

validate param


panteliselef Aug 11, 2025
9927e85

address rabbit feedback


panteliselef Aug 11, 2025
81720d0

bump bundlewatch.config.json


panteliselef Aug 11, 2025
6bd5a1b

update collector


panteliselef Aug 11, 2025
033ca87

remove previous approach


panteliselef Aug 11, 2025
0bbf54e

rename property


panteliselef Aug 11, 2025
b604cba

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025
5d18bb0

Update .changeset/slow-shoes-give.md


panteliselef Aug 11, 2025
19c3bf5

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/bitter-waves-burn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use throttling instead of sampling for telemetry events of UI components on keyless apps.

5 changes: 5 additions & 0 deletions
.changeset/slow-shoes-give.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Update TelemetryCollector to accept a `perEventSampling` property for controling per-event sampling rates.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
 { "path": "./dist/clerk.js", "maxSize": "621KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "117KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57.1KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "113KB" },
 { "path": "./dist/ui-common*.legacy.*.js", "maxSize": "118KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
Expand Down

41 changes: 24 additions & 17 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -439,6 +439,7 @@ export class Clerk implements ClerkInterface {
 this.telemetry = new TelemetryCollector({
 clerkVersion: Clerk.version,
 samplingRate: 1,
 perEventSampling: this.#options.__internal_keyless_claimKeylessApplicationUrl ? false : undefined,
 publishableKey: this.publishableKey,
 ...this.#options.telemetry,
 });
Expand DownExpand Up@@ -537,12 +538,13 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 const component = 'GoogleOneTap';
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -560,12 +562,13 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'SignIn';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand DownExpand Up@@ -612,11 +615,12 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'PlanDetails';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'PlanDetails' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openDrawer('planDetails', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`PlanDetails`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public __internal_closePlanDetails = (): void => {
Expand DownExpand Up@@ -718,7 +722,7 @@ export class Clerk implements ClerkInterface {
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

Expand DownExpand Up@@ -795,17 +799,18 @@ export class Clerk implements ClerkInterface {

 public mountSignIn = (node: HTMLDivElement, props?: SignInProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignIn' }).then(controls =>
 const component = 'SignIn';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignIn',
 name: component,
 appearanceKey: 'signIn',
 node,
 props,
 }),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -819,16 +824,17 @@ export class Clerk implements ClerkInterface {

 public mountSignUp = (node: HTMLDivElement, props?: SignUpProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignUp' }).then(controls =>
 const component = 'SignUp';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignUp',
 name: component,
 appearanceKey: 'signUp',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand All@@ -850,17 +856,18 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 void this.#componentControls.ensureMounted({ preloadHint: 'UserProfile' }).then(controls =>
 const component = 'UserProfile';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'UserProfile',
 name: component,
 appearanceKey: 'userProfile',
 node,
 props,
 }),
 );

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand Down

43 changes: 43 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,49 @@ describe('TelemetryCollector', () => {

 randomSpy.mockRestore();
 });

 test('ignores event-specific sampling rate when eventSampling is false', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: false, // Disable event-specific sampling
 });

 // This event would normally be rejected due to low eventSamplingRate (0.1 < 0.5)
 // but should be sent because eventSampling is disabled
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).toHaveBeenCalled();

 randomSpy.mockRestore();
 });

 test('respects event-specific sampling rate when eventSampling is true (default)', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: true, // Enable event-specific sampling (default)
 });

 // This event should be rejected due to low eventSamplingRate (0.1 < 0.5)
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).not.toHaveBeenCalled();

 randomSpy.mockRestore();
 });
 });

 describe('with client-side throttling', () => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ function isWindowClerkWithMetadata(clerk: unknown): clerk is { constructor: { sd

type TelemetryCollectorConfig = Pick<
 TelemetryCollectorOptions,
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize'
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize' | 'perEventSampling'
> & {
 endpoint: string;
};
Expand DownExpand Up@@ -80,6 +80,7 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#config = {
 maxBufferSize: options.maxBufferSize ?? DEFAULT_CONFIG.maxBufferSize,
 samplingRate: options.samplingRate ?? DEFAULT_CONFIG.samplingRate,
 perEventSampling: options.perEventSampling ?? true,
 disabled: options.disabled ?? false,
 debug: options.debug ?? false,
 endpoint: DEFAULT_CONFIG.endpoint,
Expand DownExpand Up@@ -167,7 +168,9 @@ export class TelemetryCollector implements TelemetryCollectorInterface {

 const toBeSampled =
 randomSeed <= this.#config.samplingRate &&
 (typeof eventSamplingRate === 'undefined' || randomSeed <= eventSamplingRate);
 (this.#config.perEventSampling === false ||
 typeof eventSamplingRate === 'undefined' ||
 randomSeed <= eventSamplingRate);

 if (!toBeSampled) {
 return false;
Expand Down

6 changes: 3 additions & 3 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ type EventPrebuiltComponent = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

/**
 * @internal
 */
function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
Expand DownExpand Up@@ -44,7 +47,6 @@ function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | ty
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentMounted('SignUp', props));
 */
Expand All@@ -62,7 +64,6 @@ export function eventPrebuiltComponentMounted(
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
Expand All@@ -81,7 +82,6 @@ export function eventPrebuiltComponentOpened(
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Ideally you only pass a handful of props here.
 *
 * @example
 * telemetry.record(eventComponentMounted('SignUp', props));
 */
Expand Down

10 changes: 8 additions & 2 deletions
packages/shared/src/telemetry/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,11 +8,17 @@ export type TelemetryCollectorOptions = {
 */
 debug?: boolean;
 /**
 * Sampling rate, 0-1
 * Sampling rate, 0-1.
 */
 samplingRate?: number;
 /**
 * Set a custom buffer size to control how often events are sent
 * If false, the sampling rates provided per event will be ignored and the global sampling rate will be used.
 *
 * @default true
 */
 perEventSampling?: boolean;
 /**
 * Set a custom buffer size to control how often events are sent.
 */
 maxBufferSize?: number;
 /**
Expand Down
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
chore(clerk-js,shared): Increase sampling for ui components on keyless#6514

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

panteliselef
merged 10 commits into

from

Aug 11, 2025
 Merged


chore(clerk-js,shared): Increase sampling for ui components on keyless
#6514
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
52307bc

chore(clerk-js,shared): Increase sampling for ui components on keyless


panteliselef Aug 11, 2025
0f2a336

validate param


panteliselef Aug 11, 2025
9927e85

address rabbit feedback


panteliselef Aug 11, 2025
81720d0

bump bundlewatch.config.json


panteliselef Aug 11, 2025
6bd5a1b

update collector


panteliselef Aug 11, 2025
033ca87

remove previous approach


panteliselef Aug 11, 2025
0bbf54e

rename property


panteliselef Aug 11, 2025
b604cba

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025
5d18bb0

Update .changeset/slow-shoes-give.md


panteliselef Aug 11, 2025
19c3bf5

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/bitter-waves-burn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use throttling instead of sampling for telemetry events of UI components on keyless apps.

5 changes: 5 additions & 0 deletions
.changeset/slow-shoes-give.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Update TelemetryCollector to accept a `perEventSampling` property for controling per-event sampling rates.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
 { "path": "./dist/clerk.js", "maxSize": "621KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "117KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57.1KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "113KB" },
 { "path": "./dist/ui-common*.legacy.*.js", "maxSize": "118KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
Expand Down

41 changes: 24 additions & 17 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -439,6 +439,7 @@ export class Clerk implements ClerkInterface {
 this.telemetry = new TelemetryCollector({
 clerkVersion: Clerk.version,
 samplingRate: 1,
 perEventSampling: this.#options.__internal_keyless_claimKeylessApplicationUrl ? false : undefined,
 publishableKey: this.publishableKey,
 ...this.#options.telemetry,
 });
Expand DownExpand Up@@ -537,12 +538,13 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 const component = 'GoogleOneTap';
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -560,12 +562,13 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'SignIn';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand DownExpand Up@@ -612,11 +615,12 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'PlanDetails';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'PlanDetails' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openDrawer('planDetails', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`PlanDetails`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public __internal_closePlanDetails = (): void => {
Expand DownExpand Up@@ -718,7 +722,7 @@ export class Clerk implements ClerkInterface {
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

Expand DownExpand Up@@ -795,17 +799,18 @@ export class Clerk implements ClerkInterface {

 public mountSignIn = (node: HTMLDivElement, props?: SignInProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignIn' }).then(controls =>
 const component = 'SignIn';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignIn',
 name: component,
 appearanceKey: 'signIn',
 node,
 props,
 }),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -819,16 +824,17 @@ export class Clerk implements ClerkInterface {

 public mountSignUp = (node: HTMLDivElement, props?: SignUpProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignUp' }).then(controls =>
 const component = 'SignUp';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignUp',
 name: component,
 appearanceKey: 'signUp',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand All@@ -850,17 +856,18 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 void this.#componentControls.ensureMounted({ preloadHint: 'UserProfile' }).then(controls =>
 const component = 'UserProfile';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'UserProfile',
 name: component,
 appearanceKey: 'userProfile',
 node,
 props,
 }),
 );

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand Down

43 changes: 43 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,49 @@ describe('TelemetryCollector', () => {

 randomSpy.mockRestore();
 });

 test('ignores event-specific sampling rate when eventSampling is false', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: false, // Disable event-specific sampling
 });

 // This event would normally be rejected due to low eventSamplingRate (0.1 < 0.5)
 // but should be sent because eventSampling is disabled
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).toHaveBeenCalled();

 randomSpy.mockRestore();
 });

 test('respects event-specific sampling rate when eventSampling is true (default)', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: true, // Enable event-specific sampling (default)
 });

 // This event should be rejected due to low eventSamplingRate (0.1 < 0.5)
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).not.toHaveBeenCalled();

 randomSpy.mockRestore();
 });
 });

 describe('with client-side throttling', () => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ function isWindowClerkWithMetadata(clerk: unknown): clerk is { constructor: { sd

type TelemetryCollectorConfig = Pick<
 TelemetryCollectorOptions,
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize'
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize' | 'perEventSampling'
> & {
 endpoint: string;
};
Expand DownExpand Up@@ -80,6 +80,7 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#config = {
 maxBufferSize: options.maxBufferSize ?? DEFAULT_CONFIG.maxBufferSize,
 samplingRate: options.samplingRate ?? DEFAULT_CONFIG.samplingRate,
 perEventSampling: options.perEventSampling ?? true,
 disabled: options.disabled ?? false,
 debug: options.debug ?? false,
 endpoint: DEFAULT_CONFIG.endpoint,
Expand DownExpand Up@@ -167,7 +168,9 @@ export class TelemetryCollector implements TelemetryCollectorInterface {

 const toBeSampled =
 randomSeed <= this.#config.samplingRate &&
 (typeof eventSamplingRate === 'undefined' || randomSeed <= eventSamplingRate);
 (this.#config.perEventSampling === false ||
 typeof eventSamplingRate === 'undefined' ||
 randomSeed <= eventSamplingRate);

 if (!toBeSampled) {
 return false;
Expand Down

6 changes: 3 additions & 3 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ type EventPrebuiltComponent = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

/**
 * @internal
 */
function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
Expand DownExpand Up@@ -44,7 +47,6 @@ function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | ty
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentMounted('SignUp', props));
 */
Expand All@@ -62,7 +64,6 @@ export function eventPrebuiltComponentMounted(
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
Expand All@@ -81,7 +82,6 @@ export function eventPrebuiltComponentOpened(
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Ideally you only pass a handful of props here.
 *
 * @example
 * telemetry.record(eventComponentMounted('SignUp', props));
 */
Expand Down

10 changes: 8 additions & 2 deletions
packages/shared/src/telemetry/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,11 +8,17 @@ export type TelemetryCollectorOptions = {
 */
 debug?: boolean;
 /**
 * Sampling rate, 0-1
 * Sampling rate, 0-1.
 */
 samplingRate?: number;
 /**
 * Set a custom buffer size to control how often events are sent
 * If false, the sampling rates provided per event will be ignored and the global sampling rate will be used.
 *
 * @default true
 */
 perEventSampling?: boolean;
 /**
 * Set a custom buffer size to control how often events are sent.
 */
 maxBufferSize?: number;
 /**
Expand Down
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
chore(clerk-js,shared): Increase sampling for ui components on keyless#6514

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

panteliselef
merged 10 commits into

from

Aug 11, 2025
 Merged


chore(clerk-js,shared): Increase sampling for ui components on keyless
#6514
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
52307bc

chore(clerk-js,shared): Increase sampling for ui components on keyless


panteliselef Aug 11, 2025
0f2a336

validate param


panteliselef Aug 11, 2025
9927e85

address rabbit feedback


panteliselef Aug 11, 2025
81720d0

bump bundlewatch.config.json


panteliselef Aug 11, 2025
6bd5a1b

update collector


panteliselef Aug 11, 2025
033ca87

remove previous approach


panteliselef Aug 11, 2025
0bbf54e

rename property


panteliselef Aug 11, 2025
b604cba

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025
5d18bb0

Update .changeset/slow-shoes-give.md


panteliselef Aug 11, 2025
19c3bf5

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/bitter-waves-burn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use throttling instead of sampling for telemetry events of UI components on keyless apps.

5 changes: 5 additions & 0 deletions
.changeset/slow-shoes-give.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Update TelemetryCollector to accept a `perEventSampling` property for controling per-event sampling rates.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
 { "path": "./dist/clerk.js", "maxSize": "621KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "117KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57.1KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "113KB" },
 { "path": "./dist/ui-common*.legacy.*.js", "maxSize": "118KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
Expand Down

41 changes: 24 additions & 17 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -439,6 +439,7 @@ export class Clerk implements ClerkInterface {
 this.telemetry = new TelemetryCollector({
 clerkVersion: Clerk.version,
 samplingRate: 1,
 perEventSampling: this.#options.__internal_keyless_claimKeylessApplicationUrl ? false : undefined,
 publishableKey: this.publishableKey,
 ...this.#options.telemetry,
 });
Expand DownExpand Up@@ -537,12 +538,13 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 const component = 'GoogleOneTap';
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -560,12 +562,13 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'SignIn';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand DownExpand Up@@ -612,11 +615,12 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'PlanDetails';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'PlanDetails' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openDrawer('planDetails', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`PlanDetails`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public __internal_closePlanDetails = (): void => {
Expand DownExpand Up@@ -718,7 +722,7 @@ export class Clerk implements ClerkInterface {
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

Expand DownExpand Up@@ -795,17 +799,18 @@ export class Clerk implements ClerkInterface {

 public mountSignIn = (node: HTMLDivElement, props?: SignInProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignIn' }).then(controls =>
 const component = 'SignIn';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignIn',
 name: component,
 appearanceKey: 'signIn',
 node,
 props,
 }),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -819,16 +824,17 @@ export class Clerk implements ClerkInterface {

 public mountSignUp = (node: HTMLDivElement, props?: SignUpProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignUp' }).then(controls =>
 const component = 'SignUp';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignUp',
 name: component,
 appearanceKey: 'signUp',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand All@@ -850,17 +856,18 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 void this.#componentControls.ensureMounted({ preloadHint: 'UserProfile' }).then(controls =>
 const component = 'UserProfile';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'UserProfile',
 name: component,
 appearanceKey: 'userProfile',
 node,
 props,
 }),
 );

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand Down

43 changes: 43 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,49 @@ describe('TelemetryCollector', () => {

 randomSpy.mockRestore();
 });

 test('ignores event-specific sampling rate when eventSampling is false', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: false, // Disable event-specific sampling
 });

 // This event would normally be rejected due to low eventSamplingRate (0.1 < 0.5)
 // but should be sent because eventSampling is disabled
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).toHaveBeenCalled();

 randomSpy.mockRestore();
 });

 test('respects event-specific sampling rate when eventSampling is true (default)', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: true, // Enable event-specific sampling (default)
 });

 // This event should be rejected due to low eventSamplingRate (0.1 < 0.5)
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).not.toHaveBeenCalled();

 randomSpy.mockRestore();
 });
 });

 describe('with client-side throttling', () => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ function isWindowClerkWithMetadata(clerk: unknown): clerk is { constructor: { sd

type TelemetryCollectorConfig = Pick<
 TelemetryCollectorOptions,
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize'
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize' | 'perEventSampling'
> & {
 endpoint: string;
};
Expand DownExpand Up@@ -80,6 +80,7 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#config = {
 maxBufferSize: options.maxBufferSize ?? DEFAULT_CONFIG.maxBufferSize,
 samplingRate: options.samplingRate ?? DEFAULT_CONFIG.samplingRate,
 perEventSampling: options.perEventSampling ?? true,
 disabled: options.disabled ?? false,
 debug: options.debug ?? false,
 endpoint: DEFAULT_CONFIG.endpoint,
Expand DownExpand Up@@ -167,7 +168,9 @@ export class TelemetryCollector implements TelemetryCollectorInterface {

 const toBeSampled =
 randomSeed <= this.#config.samplingRate &&
 (typeof eventSamplingRate === 'undefined' || randomSeed <= eventSamplingRate);
 (this.#config.perEventSampling === false ||
 typeof eventSamplingRate === 'undefined' ||
 randomSeed <= eventSamplingRate);

 if (!toBeSampled) {
 return false;
Expand Down

6 changes: 3 additions & 3 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ type EventPrebuiltComponent = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

/**
 * @internal
 */
function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
Expand DownExpand Up@@ -44,7 +47,6 @@ function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | ty
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentMounted('SignUp', props));
 */
Expand All@@ -62,7 +64,6 @@ export function eventPrebuiltComponentMounted(
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
Expand All@@ -81,7 +82,6 @@ export function eventPrebuiltComponentOpened(
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Ideally you only pass a handful of props here.
 *
 * @example
 * telemetry.record(eventComponentMounted('SignUp', props));
 */
Expand Down

10 changes: 8 additions & 2 deletions
packages/shared/src/telemetry/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,11 +8,17 @@ export type TelemetryCollectorOptions = {
 */
 debug?: boolean;
 /**
 * Sampling rate, 0-1
 * Sampling rate, 0-1.
 */
 samplingRate?: number;
 /**
 * Set a custom buffer size to control how often events are sent
 * If false, the sampling rates provided per event will be ignored and the global sampling rate will be used.
 *
 * @default true
 */
 perEventSampling?: boolean;
 /**
 * Set a custom buffer size to control how often events are sent.
 */
 maxBufferSize?: number;
 /**
Expand Down
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
chore(clerk-js,shared): Increase sampling for ui components on keyless#6514

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

panteliselef
merged 10 commits into

from

Aug 11, 2025
 Merged


chore(clerk-js,shared): Increase sampling for ui components on keyless
#6514
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
52307bc

chore(clerk-js,shared): Increase sampling for ui components on keyless


panteliselef Aug 11, 2025
0f2a336

validate param


panteliselef Aug 11, 2025
9927e85

address rabbit feedback


panteliselef Aug 11, 2025
81720d0

bump bundlewatch.config.json


panteliselef Aug 11, 2025
6bd5a1b

update collector


panteliselef Aug 11, 2025
033ca87

remove previous approach


panteliselef Aug 11, 2025
0bbf54e

rename property


panteliselef Aug 11, 2025
b604cba

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025
5d18bb0

Update .changeset/slow-shoes-give.md


panteliselef Aug 11, 2025
19c3bf5

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/bitter-waves-burn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use throttling instead of sampling for telemetry events of UI components on keyless apps.

5 changes: 5 additions & 0 deletions
.changeset/slow-shoes-give.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Update TelemetryCollector to accept a `perEventSampling` property for controling per-event sampling rates.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
 { "path": "./dist/clerk.js", "maxSize": "621KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "117KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57.1KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "113KB" },
 { "path": "./dist/ui-common*.legacy.*.js", "maxSize": "118KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
Expand Down

41 changes: 24 additions & 17 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -439,6 +439,7 @@ export class Clerk implements ClerkInterface {
 this.telemetry = new TelemetryCollector({
 clerkVersion: Clerk.version,
 samplingRate: 1,
 perEventSampling: this.#options.__internal_keyless_claimKeylessApplicationUrl ? false : undefined,
 publishableKey: this.publishableKey,
 ...this.#options.telemetry,
 });
Expand DownExpand Up@@ -537,12 +538,13 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 const component = 'GoogleOneTap';
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -560,12 +562,13 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'SignIn';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand DownExpand Up@@ -612,11 +615,12 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'PlanDetails';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'PlanDetails' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openDrawer('planDetails', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`PlanDetails`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public __internal_closePlanDetails = (): void => {
Expand DownExpand Up@@ -718,7 +722,7 @@ export class Clerk implements ClerkInterface {
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

Expand DownExpand Up@@ -795,17 +799,18 @@ export class Clerk implements ClerkInterface {

 public mountSignIn = (node: HTMLDivElement, props?: SignInProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignIn' }).then(controls =>
 const component = 'SignIn';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignIn',
 name: component,
 appearanceKey: 'signIn',
 node,
 props,
 }),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -819,16 +824,17 @@ export class Clerk implements ClerkInterface {

 public mountSignUp = (node: HTMLDivElement, props?: SignUpProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignUp' }).then(controls =>
 const component = 'SignUp';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignUp',
 name: component,
 appearanceKey: 'signUp',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand All@@ -850,17 +856,18 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 void this.#componentControls.ensureMounted({ preloadHint: 'UserProfile' }).then(controls =>
 const component = 'UserProfile';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'UserProfile',
 name: component,
 appearanceKey: 'userProfile',
 node,
 props,
 }),
 );

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand Down

43 changes: 43 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,49 @@ describe('TelemetryCollector', () => {

 randomSpy.mockRestore();
 });

 test('ignores event-specific sampling rate when eventSampling is false', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: false, // Disable event-specific sampling
 });

 // This event would normally be rejected due to low eventSamplingRate (0.1 < 0.5)
 // but should be sent because eventSampling is disabled
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).toHaveBeenCalled();

 randomSpy.mockRestore();
 });

 test('respects event-specific sampling rate when eventSampling is true (default)', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: true, // Enable event-specific sampling (default)
 });

 // This event should be rejected due to low eventSamplingRate (0.1 < 0.5)
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).not.toHaveBeenCalled();

 randomSpy.mockRestore();
 });
 });

 describe('with client-side throttling', () => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ function isWindowClerkWithMetadata(clerk: unknown): clerk is { constructor: { sd

type TelemetryCollectorConfig = Pick<
 TelemetryCollectorOptions,
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize'
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize' | 'perEventSampling'
> & {
 endpoint: string;
};
Expand DownExpand Up@@ -80,6 +80,7 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#config = {
 maxBufferSize: options.maxBufferSize ?? DEFAULT_CONFIG.maxBufferSize,
 samplingRate: options.samplingRate ?? DEFAULT_CONFIG.samplingRate,
 perEventSampling: options.perEventSampling ?? true,
 disabled: options.disabled ?? false,
 debug: options.debug ?? false,
 endpoint: DEFAULT_CONFIG.endpoint,
Expand DownExpand Up@@ -167,7 +168,9 @@ export class TelemetryCollector implements TelemetryCollectorInterface {

 const toBeSampled =
 randomSeed <= this.#config.samplingRate &&
 (typeof eventSamplingRate === 'undefined' || randomSeed <= eventSamplingRate);
 (this.#config.perEventSampling === false ||
 typeof eventSamplingRate === 'undefined' ||
 randomSeed <= eventSamplingRate);

 if (!toBeSampled) {
 return false;
Expand Down

6 changes: 3 additions & 3 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ type EventPrebuiltComponent = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

/**
 * @internal
 */
function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
Expand DownExpand Up@@ -44,7 +47,6 @@ function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | ty
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentMounted('SignUp', props));
 */
Expand All@@ -62,7 +64,6 @@ export function eventPrebuiltComponentMounted(
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
Expand All@@ -81,7 +82,6 @@ export function eventPrebuiltComponentOpened(
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Ideally you only pass a handful of props here.
 *
 * @example
 * telemetry.record(eventComponentMounted('SignUp', props));
 */
Expand Down

10 changes: 8 additions & 2 deletions
packages/shared/src/telemetry/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,11 +8,17 @@ export type TelemetryCollectorOptions = {
 */
 debug?: boolean;
 /**
 * Sampling rate, 0-1
 * Sampling rate, 0-1.
 */
 samplingRate?: number;
 /**
 * Set a custom buffer size to control how often events are sent
 * If false, the sampling rates provided per event will be ignored and the global sampling rate will be used.
 *
 * @default true
 */
 perEventSampling?: boolean;
 /**
 * Set a custom buffer size to control how often events are sent.
 */
 maxBufferSize?: number;
 /**
Expand Down
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
chore(clerk-js,shared): Increase sampling for ui components on keyless#6514

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

panteliselef
merged 10 commits into

from

Aug 11, 2025
 Merged


chore(clerk-js,shared): Increase sampling for ui components on keyless
#6514
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
52307bc

chore(clerk-js,shared): Increase sampling for ui components on keyless


panteliselef Aug 11, 2025
0f2a336

validate param


panteliselef Aug 11, 2025
9927e85

address rabbit feedback


panteliselef Aug 11, 2025
81720d0

bump bundlewatch.config.json


panteliselef Aug 11, 2025
6bd5a1b

update collector


panteliselef Aug 11, 2025
033ca87

remove previous approach


panteliselef Aug 11, 2025
0bbf54e

rename property


panteliselef Aug 11, 2025
b604cba

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025
5d18bb0

Update .changeset/slow-shoes-give.md


panteliselef Aug 11, 2025
19c3bf5

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/bitter-waves-burn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use throttling instead of sampling for telemetry events of UI components on keyless apps.

5 changes: 5 additions & 0 deletions
.changeset/slow-shoes-give.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Update TelemetryCollector to accept a `perEventSampling` property for controling per-event sampling rates.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
 { "path": "./dist/clerk.js", "maxSize": "621KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "117KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57.1KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "113KB" },
 { "path": "./dist/ui-common*.legacy.*.js", "maxSize": "118KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
Expand Down

41 changes: 24 additions & 17 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -439,6 +439,7 @@ export class Clerk implements ClerkInterface {
 this.telemetry = new TelemetryCollector({
 clerkVersion: Clerk.version,
 samplingRate: 1,
 perEventSampling: this.#options.__internal_keyless_claimKeylessApplicationUrl ? false : undefined,
 publishableKey: this.publishableKey,
 ...this.#options.telemetry,
 });
Expand DownExpand Up@@ -537,12 +538,13 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 const component = 'GoogleOneTap';
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -560,12 +562,13 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'SignIn';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand DownExpand Up@@ -612,11 +615,12 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'PlanDetails';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'PlanDetails' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openDrawer('planDetails', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`PlanDetails`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public __internal_closePlanDetails = (): void => {
Expand DownExpand Up@@ -718,7 +722,7 @@ export class Clerk implements ClerkInterface {
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

Expand DownExpand Up@@ -795,17 +799,18 @@ export class Clerk implements ClerkInterface {

 public mountSignIn = (node: HTMLDivElement, props?: SignInProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignIn' }).then(controls =>
 const component = 'SignIn';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignIn',
 name: component,
 appearanceKey: 'signIn',
 node,
 props,
 }),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -819,16 +824,17 @@ export class Clerk implements ClerkInterface {

 public mountSignUp = (node: HTMLDivElement, props?: SignUpProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignUp' }).then(controls =>
 const component = 'SignUp';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignUp',
 name: component,
 appearanceKey: 'signUp',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand All@@ -850,17 +856,18 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 void this.#componentControls.ensureMounted({ preloadHint: 'UserProfile' }).then(controls =>
 const component = 'UserProfile';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'UserProfile',
 name: component,
 appearanceKey: 'userProfile',
 node,
 props,
 }),
 );

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand Down

43 changes: 43 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,49 @@ describe('TelemetryCollector', () => {

 randomSpy.mockRestore();
 });

 test('ignores event-specific sampling rate when eventSampling is false', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: false, // Disable event-specific sampling
 });

 // This event would normally be rejected due to low eventSamplingRate (0.1 < 0.5)
 // but should be sent because eventSampling is disabled
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).toHaveBeenCalled();

 randomSpy.mockRestore();
 });

 test('respects event-specific sampling rate when eventSampling is true (default)', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: true, // Enable event-specific sampling (default)
 });

 // This event should be rejected due to low eventSamplingRate (0.1 < 0.5)
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).not.toHaveBeenCalled();

 randomSpy.mockRestore();
 });
 });

 describe('with client-side throttling', () => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ function isWindowClerkWithMetadata(clerk: unknown): clerk is { constructor: { sd

type TelemetryCollectorConfig = Pick<
 TelemetryCollectorOptions,
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize'
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize' | 'perEventSampling'
> & {
 endpoint: string;
};
Expand DownExpand Up@@ -80,6 +80,7 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#config = {
 maxBufferSize: options.maxBufferSize ?? DEFAULT_CONFIG.maxBufferSize,
 samplingRate: options.samplingRate ?? DEFAULT_CONFIG.samplingRate,
 perEventSampling: options.perEventSampling ?? true,
 disabled: options.disabled ?? false,
 debug: options.debug ?? false,
 endpoint: DEFAULT_CONFIG.endpoint,
Expand DownExpand Up@@ -167,7 +168,9 @@ export class TelemetryCollector implements TelemetryCollectorInterface {

 const toBeSampled =
 randomSeed <= this.#config.samplingRate &&
 (typeof eventSamplingRate === 'undefined' || randomSeed <= eventSamplingRate);
 (this.#config.perEventSampling === false ||
 typeof eventSamplingRate === 'undefined' ||
 randomSeed <= eventSamplingRate);

 if (!toBeSampled) {
 return false;
Expand Down

6 changes: 3 additions & 3 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ type EventPrebuiltComponent = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

/**
 * @internal
 */
function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
Expand DownExpand Up@@ -44,7 +47,6 @@ function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | ty
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentMounted('SignUp', props));
 */
Expand All@@ -62,7 +64,6 @@ export function eventPrebuiltComponentMounted(
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
Expand All@@ -81,7 +82,6 @@ export function eventPrebuiltComponentOpened(
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Ideally you only pass a handful of props here.
 *
 * @example
 * telemetry.record(eventComponentMounted('SignUp', props));
 */
Expand Down

10 changes: 8 additions & 2 deletions
packages/shared/src/telemetry/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,11 +8,17 @@ export type TelemetryCollectorOptions = {
 */
 debug?: boolean;
 /**
 * Sampling rate, 0-1
 * Sampling rate, 0-1.
 */
 samplingRate?: number;
 /**
 * Set a custom buffer size to control how often events are sent
 * If false, the sampling rates provided per event will be ignored and the global sampling rate will be used.
 *
 * @default true
 */
 perEventSampling?: boolean;
 /**
 * Set a custom buffer size to control how often events are sent.
 */
 maxBufferSize?: number;
 /**
Expand Down
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
chore(clerk-js,shared): Increase sampling for ui components on keyless#6514

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

panteliselef
merged 10 commits into

from

Aug 11, 2025
 Merged


chore(clerk-js,shared): Increase sampling for ui components on keyless
#6514
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
52307bc

chore(clerk-js,shared): Increase sampling for ui components on keyless


panteliselef Aug 11, 2025
0f2a336

validate param


panteliselef Aug 11, 2025
9927e85

address rabbit feedback


panteliselef Aug 11, 2025
81720d0

bump bundlewatch.config.json


panteliselef Aug 11, 2025
6bd5a1b

update collector


panteliselef Aug 11, 2025
033ca87

remove previous approach


panteliselef Aug 11, 2025
0bbf54e

rename property


panteliselef Aug 11, 2025
b604cba

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025
5d18bb0

Update .changeset/slow-shoes-give.md


panteliselef Aug 11, 2025
19c3bf5

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/bitter-waves-burn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use throttling instead of sampling for telemetry events of UI components on keyless apps.

5 changes: 5 additions & 0 deletions
.changeset/slow-shoes-give.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Update TelemetryCollector to accept a `perEventSampling` property for controling per-event sampling rates.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
 { "path": "./dist/clerk.js", "maxSize": "621KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "117KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57.1KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "113KB" },
 { "path": "./dist/ui-common*.legacy.*.js", "maxSize": "118KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
Expand Down

41 changes: 24 additions & 17 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -439,6 +439,7 @@ export class Clerk implements ClerkInterface {
 this.telemetry = new TelemetryCollector({
 clerkVersion: Clerk.version,
 samplingRate: 1,
 perEventSampling: this.#options.__internal_keyless_claimKeylessApplicationUrl ? false : undefined,
 publishableKey: this.publishableKey,
 ...this.#options.telemetry,
 });
Expand DownExpand Up@@ -537,12 +538,13 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 const component = 'GoogleOneTap';
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -560,12 +562,13 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'SignIn';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand DownExpand Up@@ -612,11 +615,12 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'PlanDetails';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'PlanDetails' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openDrawer('planDetails', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`PlanDetails`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public __internal_closePlanDetails = (): void => {
Expand DownExpand Up@@ -718,7 +722,7 @@ export class Clerk implements ClerkInterface {
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

Expand DownExpand Up@@ -795,17 +799,18 @@ export class Clerk implements ClerkInterface {

 public mountSignIn = (node: HTMLDivElement, props?: SignInProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignIn' }).then(controls =>
 const component = 'SignIn';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignIn',
 name: component,
 appearanceKey: 'signIn',
 node,
 props,
 }),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -819,16 +824,17 @@ export class Clerk implements ClerkInterface {

 public mountSignUp = (node: HTMLDivElement, props?: SignUpProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignUp' }).then(controls =>
 const component = 'SignUp';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignUp',
 name: component,
 appearanceKey: 'signUp',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand All@@ -850,17 +856,18 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 void this.#componentControls.ensureMounted({ preloadHint: 'UserProfile' }).then(controls =>
 const component = 'UserProfile';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'UserProfile',
 name: component,
 appearanceKey: 'userProfile',
 node,
 props,
 }),
 );

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand Down

43 changes: 43 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,49 @@ describe('TelemetryCollector', () => {

 randomSpy.mockRestore();
 });

 test('ignores event-specific sampling rate when eventSampling is false', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: false, // Disable event-specific sampling
 });

 // This event would normally be rejected due to low eventSamplingRate (0.1 < 0.5)
 // but should be sent because eventSampling is disabled
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).toHaveBeenCalled();

 randomSpy.mockRestore();
 });

 test('respects event-specific sampling rate when eventSampling is true (default)', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: true, // Enable event-specific sampling (default)
 });

 // This event should be rejected due to low eventSamplingRate (0.1 < 0.5)
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).not.toHaveBeenCalled();

 randomSpy.mockRestore();
 });
 });

 describe('with client-side throttling', () => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ function isWindowClerkWithMetadata(clerk: unknown): clerk is { constructor: { sd

type TelemetryCollectorConfig = Pick<
 TelemetryCollectorOptions,
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize'
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize' | 'perEventSampling'
> & {
 endpoint: string;
};
Expand DownExpand Up@@ -80,6 +80,7 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#config = {
 maxBufferSize: options.maxBufferSize ?? DEFAULT_CONFIG.maxBufferSize,
 samplingRate: options.samplingRate ?? DEFAULT_CONFIG.samplingRate,
 perEventSampling: options.perEventSampling ?? true,
 disabled: options.disabled ?? false,
 debug: options.debug ?? false,
 endpoint: DEFAULT_CONFIG.endpoint,
Expand DownExpand Up@@ -167,7 +168,9 @@ export class TelemetryCollector implements TelemetryCollectorInterface {

 const toBeSampled =
 randomSeed <= this.#config.samplingRate &&
 (typeof eventSamplingRate === 'undefined' || randomSeed <= eventSamplingRate);
 (this.#config.perEventSampling === false ||
 typeof eventSamplingRate === 'undefined' ||
 randomSeed <= eventSamplingRate);

 if (!toBeSampled) {
 return false;
Expand Down

6 changes: 3 additions & 3 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ type EventPrebuiltComponent = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

/**
 * @internal
 */
function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
Expand DownExpand Up@@ -44,7 +47,6 @@ function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | ty
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentMounted('SignUp', props));
 */
Expand All@@ -62,7 +64,6 @@ export function eventPrebuiltComponentMounted(
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
Expand All@@ -81,7 +82,6 @@ export function eventPrebuiltComponentOpened(
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Ideally you only pass a handful of props here.
 *
 * @example
 * telemetry.record(eventComponentMounted('SignUp', props));
 */
Expand Down

10 changes: 8 additions & 2 deletions
packages/shared/src/telemetry/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,11 +8,17 @@ export type TelemetryCollectorOptions = {
 */
 debug?: boolean;
 /**
 * Sampling rate, 0-1
 * Sampling rate, 0-1.
 */
 samplingRate?: number;
 /**
 * Set a custom buffer size to control how often events are sent
 * If false, the sampling rates provided per event will be ignored and the global sampling rate will be used.
 *
 * @default true
 */
 perEventSampling?: boolean;
 /**
 * Set a custom buffer size to control how often events are sent.
 */
 maxBufferSize?: number;
 /**
Expand Down
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
chore(clerk-js,shared): Increase sampling for ui components on keyless#6514

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

panteliselef
merged 10 commits into

from

Aug 11, 2025
 Merged


chore(clerk-js,shared): Increase sampling for ui components on keyless
#6514
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
52307bc

chore(clerk-js,shared): Increase sampling for ui components on keyless


panteliselef Aug 11, 2025
0f2a336

validate param


panteliselef Aug 11, 2025
9927e85

address rabbit feedback


panteliselef Aug 11, 2025
81720d0

bump bundlewatch.config.json


panteliselef Aug 11, 2025
6bd5a1b

update collector


panteliselef Aug 11, 2025
033ca87

remove previous approach


panteliselef Aug 11, 2025
0bbf54e

rename property


panteliselef Aug 11, 2025
b604cba

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025
5d18bb0

Update .changeset/slow-shoes-give.md


panteliselef Aug 11, 2025
19c3bf5

Merge branch 'main' into elef/user-3116-increase-telemetry-sampling-f…


panteliselef Aug 11, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/bitter-waves-burn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use throttling instead of sampling for telemetry events of UI components on keyless apps.

5 changes: 5 additions & 0 deletions
.changeset/slow-shoes-give.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Update TelemetryCollector to accept a `perEventSampling` property for controling per-event sampling rates.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
 { "path": "./dist/clerk.js", "maxSize": "621KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "117KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "57.1KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "113KB" },
 { "path": "./dist/ui-common*.legacy.*.js", "maxSize": "118KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
Expand Down

41 changes: 24 additions & 17 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -439,6 +439,7 @@ export class Clerk implements ClerkInterface {
 this.telemetry = new TelemetryCollector({
 clerkVersion: Clerk.version,
 samplingRate: 1,
 perEventSampling: this.#options.__internal_keyless_claimKeylessApplicationUrl ? false : undefined,
 publishableKey: this.publishableKey,
 ...this.#options.telemetry,
 });
Expand DownExpand Up@@ -537,12 +538,13 @@ export class Clerk implements ClerkInterface {
 };

 public openGoogleOneTap = (props?: GoogleOneTapProps): void => {
 const component = 'GoogleOneTap';
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls
 .ensureMounted({ preloadHint: 'GoogleOneTap' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('googleOneTap', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`GoogleOneTap`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public closeGoogleOneTap = (): void => {
Expand All@@ -560,12 +562,13 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'SignIn';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'SignIn' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openModal('signIn', props || {}));

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentOpened(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props, additionalData));
 };

 public closeSignIn = (): void => {
Expand DownExpand Up@@ -612,11 +615,12 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 const component = 'PlanDetails';
 void this.#componentControls
 .ensureMounted({ preloadHint: 'PlanDetails' })
 .ensureMounted({ preloadHint: component })
 .then(controls => controls.openDrawer('planDetails', props || {}));

 this.telemetry?.record(eventPrebuiltComponentOpened(`PlanDetails`, props));
 this.telemetry?.record(eventPrebuiltComponentOpened(component, props));
 };

 public __internal_closePlanDetails = (): void => {
Expand DownExpand Up@@ -718,7 +722,7 @@ export class Clerk implements ClerkInterface {
 .ensureMounted({ preloadHint: 'UserProfile' })
 .then(controls => controls.openModal('userProfile', props || {}));

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentOpened('UserProfile', props, additionalData));
 };

Expand DownExpand Up@@ -795,17 +799,18 @@ export class Clerk implements ClerkInterface {

 public mountSignIn = (node: HTMLDivElement, props?: SignInProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignIn' }).then(controls =>
 const component = 'SignIn';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignIn',
 name: component,
 appearanceKey: 'signIn',
 node,
 props,
 }),
 );

 const additionalData = { withSignUp: props?.withSignUp ?? this.#isCombinedSignInOrUpFlow() };
 this.telemetry?.record(eventPrebuiltComponentMounted(`SignIn`, props, additionalData));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountSignIn = (node: HTMLDivElement): void => {
Expand All@@ -819,16 +824,17 @@ export class Clerk implements ClerkInterface {

 public mountSignUp = (node: HTMLDivElement, props?: SignUpProps): void => {
 this.assertComponentsReady(this.#componentControls);
 void this.#componentControls.ensureMounted({ preloadHint: 'SignUp' }).then(controls =>
 const component = 'SignUp';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'SignUp',
 name: component,
 appearanceKey: 'signUp',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(`SignUp`, props));
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 public unmountSignUp = (node: HTMLDivElement): void => {
Expand All@@ -850,17 +856,18 @@ export class Clerk implements ClerkInterface {
 }
 return;
 }
 void this.#componentControls.ensureMounted({ preloadHint: 'UserProfile' }).then(controls =>
 const component = 'UserProfile';
 void this.#componentControls.ensureMounted({ preloadHint: component }).then(controls =>
 controls.mountComponent({
 name: 'UserProfile',
 name: component,
 appearanceKey: 'userProfile',
 node,
 props,
 }),
 );

 const additionalData = props?.customPages?.length || 0 > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted('UserProfile', props, additionalData));
 const additionalData = (props?.customPages?.length || 0) > 0 ? { customPages: true } : undefined;
 this.telemetry?.record(eventPrebuiltComponentMounted(component, props, additionalData));
 };

 public unmountUserProfile = (node: HTMLDivElement): void => {
Expand Down

43 changes: 43 additions & 0 deletions
packages/shared/src/__tests__/telemetry.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,49 @@ describe('TelemetryCollector', () => {

 randomSpy.mockRestore();
 });

 test('ignores event-specific sampling rate when eventSampling is false', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: false, // Disable event-specific sampling
 });

 // This event would normally be rejected due to low eventSamplingRate (0.1 < 0.5)
 // but should be sent because eventSampling is disabled
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).toHaveBeenCalled();

 randomSpy.mockRestore();
 });

 test('respects event-specific sampling rate when eventSampling is true (default)', async () => {
 windowSpy.mockImplementation(() => undefined);

 const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5);

 const collector = new TelemetryCollector({
 publishableKey: TEST_PK,
 samplingRate: 1.0, // Global sampling rate allows all events
 perEventSampling: true, // Enable event-specific sampling (default)
 });

 // This event should be rejected due to low eventSamplingRate (0.1 < 0.5)
 collector.record({ event: 'TEST_EVENT', eventSamplingRate: 0.1, payload: {} });

 jest.runAllTimers();

 expect(fetchSpy).not.toHaveBeenCalled();

 randomSpy.mockRestore();
 });
 });

 describe('with client-side throttling', () => {
Expand Down

7 changes: 5 additions & 2 deletions
packages/shared/src/telemetry/collector.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ function isWindowClerkWithMetadata(clerk: unknown): clerk is { constructor: { sd

type TelemetryCollectorConfig = Pick<
 TelemetryCollectorOptions,
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize'
 'samplingRate' | 'disabled' | 'debug' | 'maxBufferSize' | 'perEventSampling'
> & {
 endpoint: string;
};
Expand DownExpand Up@@ -80,6 +80,7 @@ export class TelemetryCollector implements TelemetryCollectorInterface {
 this.#config = {
 maxBufferSize: options.maxBufferSize ?? DEFAULT_CONFIG.maxBufferSize,
 samplingRate: options.samplingRate ?? DEFAULT_CONFIG.samplingRate,
 perEventSampling: options.perEventSampling ?? true,
 disabled: options.disabled ?? false,
 debug: options.debug ?? false,
 endpoint: DEFAULT_CONFIG.endpoint,
Expand DownExpand Up@@ -167,7 +168,9 @@ export class TelemetryCollector implements TelemetryCollectorInterface {

 const toBeSampled =
 randomSeed <= this.#config.samplingRate &&
 (typeof eventSamplingRate === 'undefined' || randomSeed <= eventSamplingRate);
 (this.#config.perEventSampling === false ||
 typeof eventSamplingRate === 'undefined' ||
 randomSeed <= eventSamplingRate);

 if (!toBeSampled) {
 return false;
Expand Down

6 changes: 3 additions & 3 deletions
packages/shared/src/telemetry/events/component-mounted.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,9 @@ type EventPrebuiltComponent = ComponentMountedBase & {

type EventComponentMounted = ComponentMountedBase & TelemetryEventRaw['payload'];

/**
 * @internal
 */
function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | typeof EVENT_COMPONENT_OPENED) {
 return function (
 component: string,
Expand DownExpand Up@@ -44,7 +47,6 @@ function createPrebuiltComponentEvent(event: typeof EVENT_COMPONENT_MOUNTED | ty
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentMounted('SignUp', props));
 */
Expand All@@ -62,7 +64,6 @@ export function eventPrebuiltComponentMounted(
 * @param component - The name of the component.
 * @param props - The props passed to the component. Will be filtered to a known list of props.
 * @param additionalPayload - Additional data to send with the event.
 *
 * @example
 * telemetry.record(eventPrebuiltComponentOpened('GoogleOneTap', props));
 */
Expand All@@ -81,7 +82,6 @@ export function eventPrebuiltComponentOpened(
 *
 * @param component - The name of the component.
 * @param props - The props passed to the component. Ideally you only pass a handful of props here.
 *
 * @example
 * telemetry.record(eventComponentMounted('SignUp', props));
 */
Expand Down

10 changes: 8 additions & 2 deletions
packages/shared/src/telemetry/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,11 +8,17 @@ export type TelemetryCollectorOptions = {
 */
 debug?: boolean;
 /**
 * Sampling rate, 0-1
 * Sampling rate, 0-1.
 */
 samplingRate?: number;
 /**
 * Set a custom buffer size to control how often events are sent
 * If false, the sampling rates provided per event will be ignored and the global sampling rate will be used.
 *
 * @default true
 */
 perEventSampling?: boolean;
 /**
 * Set a custom buffer size to control how often events are sent.
 */
 maxBufferSize?: number;
 /**
Expand Down
Loading