use sample rate

segmentio · Oct 8, 2024 · b4d35a4 · b4d35a4
1 parent 58ca71a
commit b4d35a4
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/packages/browser/src/browser/index.ts b/packages/browser/src/browser/index.ts
@@ -122,6 +122,15 @@ export interface CDNSettings {
         version: number
       }
     | {}
+  /**
+   * Settings for auto instrumentation
+   */
+  autoInstrumentationSettings?: {
+    /**
+     * A sample rate to determine what percentage of sessions should send signals, from [0,1]
+     */
+    sampleRate: number
+  }
 }
 
 export interface AnalyticsBrowserSettings {

diff --git a/packages/signals/signals/src/core/signals/signals.ts b/packages/signals/signals/src/core/signals/signals.ts
@@ -83,6 +83,12 @@ export class Signals implements ISignals {
    * - Registers custom signal generators.
    */
   async start(analytics: AnyAnalytics): Promise<void> {
+    if (
+      !analytics.settings.cdnSettings.autoInstrumentationSettings ||
+      Math.random() >
+        analytics.settings.cdnSettings.autoInstrumentationSettings.sampleRate
+    )
+      return
     const analyticsService = new AnalyticsService(analytics)
 
     this.globalSettings.update({

diff --git a/packages/signals/signals/src/types/analytics-api.ts b/packages/signals/signals/src/types/analytics-api.ts
@@ -9,6 +9,7 @@ export type EdgeFnCDNSettings = {
 }
 
 export interface CDNSettings {
+  autoInstrumentationSettings?: CDNSettingsAutoInstrumentation
   integrations: CDNSettingsIntegrations
   edgeFunction?: EdgeFnCDNSettings | { [key: string]: never }
 }
@@ -72,6 +73,10 @@ export interface CDNSettingsIntegrations {
   [integrationName: string]: { [key: string]: any }
 }
 
+export interface CDNSettingsAutoInstrumentation {
+  sampleRate: number
+}
+
 export type PluginType = 'before' | 'after' | 'destination'
 
 export interface Plugin<Analytics = AnyAnalytics, Ctx = Record<string, any>> {