feat(shared): Add opt-out support for SDK telemetry #2099
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ialization to Clerk.load, implement opt-out for Next
|
brkalow
commented
Nov 9, 2023
Comment on lines
+328
to
+339
| if (this.#options.sdkMetadata) { | ||
| Clerk.sdkMetadata = this.#options.sdkMetadata; | ||
| } | ||
|
|
||
| this.#telemetry = new TelemetryCollector({ | ||
| clerkVersion: Clerk.version, | ||
| verbose: true, | ||
| samplingRate: 1, | ||
| // @ts-expect-error -- in v5 this will always be defined | ||
| publishableKey: this.publishableKey, | ||
| ...this.#options.telemetry, | ||
| }); |
There was a problem hiding this comment.
Moved the TelemetryCollector instantiation into Clerk.load() instead of the constructor. It's much easier to pass options this way.
brkalow
commented
Nov 9, 2023
| @@ -168,7 +173,6 @@ export default class IsomorphicClerk { | |||
| domain: this.domain, | |||
| } as any); | |||
|
|
|||
| c.sdkMetadata = this.options.sdkMetadata ?? SDK_METADATA; | |||
There was a problem hiding this comment.
Cleaning up this metadata thing by handling it in Clerk.load().
brkalow
commented
Nov 9, 2023
| @@ -186,18 +204,18 @@ export class TelemetryCollector { | |||
| 'Content-Type': 'application/json', | |||
| }, | |||
| }) | |||
| .catch(err => console.error(err)) | |||
| .catch(() => void 0) | |||
There was a problem hiding this comment.
Swallowing errors here to ensure we don't create noise as a result of our telemetry.
brkalow
commented
Nov 9, 2023
|
|
||
| jest.useFakeTimers(); | ||
|
|
||
| describe('TelemetryCollector', () => { |
There was a problem hiding this comment.
Added some high-level tests for the collector. Most importantly, validating that events aren't sent when disabled or debug are true.
LekoArts
reviewed
Nov 10, 2023
tmilewski
approved these changes
Nov 13, 2023
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 22, 2023
* feat(clerk-js): Spike out telemetry collection * feat(clerk-js): Add sampling rate and verbose option * feat(shared): Move TelemtryCollector into shared, make it isomorphic * feat(nextjs): Add telemtry collection for authMiddleware * feat(shared): Support passing multiple events to the telemetry endpoint * feat(shared): Abstract fetch into sendEvent * feat(shared): Refactor SDK metadata handling to get accurate value * feat(shared): Update endpoint, don't use no-cors * fix(nextjs): Fix merge conflict * feat(shared): Add batching to the telemetry collector * feat(shared): Add opt-out support for SDK telemetry (#2099) * feat(clerk-js): Add TelemetryCollector instance to backend client (#2134) * chore(repo): Add changeset * fix(shared): Fix tests that rely on fetch * feat(shared): Set production endpoint * feat(clerk-js): Make telemtry public, expose via isomorphicClerk * feat(shared): Add doc on the TelemetryCollector * feat(clerk-js): Support telemetry: false as a way to disable telemetry * chore(shared): Tweak comment * chore(shared): Tweak comment * fix(clerk-sdk-node): Add PACKAGE_ constants for tests * fix(fastify): Define PACKAGE_ constants in test environment * feat(shared): Refactor telemetry instrumentation to rely on helpers * feat(shared): Add telemetry notice * feat(shared): Add postinstall script * chore(shared): Add word * chore(shared): Swallow errors in postinstall * chore(repo): Allow scripts directory in subpaths-workaround * feat(shared): Adjust types to enforce the event structure from event factory methods * chore(shared): Simplify telemetry.record() API
desiprisg
pushed a commit
that referenced
this pull request
Nov 23, 2023
* feat(clerk-js): Spike out telemetry collection * feat(clerk-js): Add sampling rate and verbose option * feat(shared): Move TelemtryCollector into shared, make it isomorphic * feat(nextjs): Add telemtry collection for authMiddleware * feat(shared): Support passing multiple events to the telemetry endpoint * feat(shared): Abstract fetch into sendEvent * feat(shared): Refactor SDK metadata handling to get accurate value * feat(shared): Update endpoint, don't use no-cors * fix(nextjs): Fix merge conflict * feat(shared): Add batching to the telemetry collector * feat(shared): Add opt-out support for SDK telemetry (#2099) * feat(clerk-js): Add TelemetryCollector instance to backend client (#2134) * chore(repo): Add changeset * fix(shared): Fix tests that rely on fetch * feat(shared): Set production endpoint * feat(clerk-js): Make telemtry public, expose via isomorphicClerk * feat(shared): Add doc on the TelemetryCollector * feat(clerk-js): Support telemetry: false as a way to disable telemetry * chore(shared): Tweak comment * chore(shared): Tweak comment * fix(clerk-sdk-node): Add PACKAGE_ constants for tests * fix(fastify): Define PACKAGE_ constants in test environment * feat(shared): Refactor telemetry instrumentation to rely on helpers * feat(shared): Add telemetry notice * feat(shared): Add postinstall script * chore(shared): Add word * chore(shared): Swallow errors in postinstall * chore(repo): Allow scripts directory in subpaths-workaround * feat(shared): Adjust types to enforce the event structure from event factory methods * chore(shared): Simplify telemetry.record() API
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds opt-out support to the TelemetryCollector by way of the
disabledoption. We also moved the initialization ofTelemetryCollectortoClerk.loadinstead of its constructor to make it easier to pass options.fixes SDK-915
Checklist
npm testruns as expected.npm run buildruns as expected.Type of change
Packages affected
@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/clerk-expo@clerk/fastifygatsby-plugin-clerk@clerk/localizations@clerk/nextjs@clerk/clerk-react@clerk/remix@clerk/clerk-sdk-node@clerk/shared@clerk/themes@clerk/typesbuild/tooling/chore