Add telemetry_configuration ff and tests

DataDog · Oct 7, 2022 · b63fb59 · b63fb59
1 parent a9c9cee
commit b63fb59
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 10 deletions.
diff --git a/packages/core/src/domain/configuration/configuration.ts b/packages/core/src/domain/configuration/configuration.ts
@@ -63,6 +63,7 @@ export interface Configuration extends TransportConfiguration {
   cookieOptions: CookieOptions
   sampleRate: number
   telemetrySampleRate: number
+  telemetryConfigurationSampleRate: number
   service: string | undefined
   silentMultipleInit: boolean
 
@@ -105,6 +106,7 @@ export function validateAndBuildConfiguration(initConfiguration: InitConfigurati
       cookieOptions: buildCookieOptions(initConfiguration),
       sampleRate: initConfiguration.sampleRate ?? 100,
       telemetrySampleRate: initConfiguration.telemetrySampleRate ?? 20,
+      telemetryConfigurationSampleRate: 20,
       service: initConfiguration.service,
       silentMultipleInit: !!initConfiguration.silentMultipleInit,
 

diff --git a/packages/core/src/domain/telemetry/telemetry.spec.ts b/packages/core/src/domain/telemetry/telemetry.spec.ts
@@ -1,8 +1,19 @@
 import type { StackTrace } from '@datadog/browser-core'
 import { callMonitored } from '../../tools/monitor'
 import type { Configuration } from '../configuration'
-import { updateExperimentalFeatures, INTAKE_SITE_US1, INTAKE_SITE_US1_FED } from '../configuration'
-import { resetTelemetry, startTelemetry, scrubCustomerFrames, formatError } from './telemetry'
+import {
+  resetExperimentalFeatures,
+  updateExperimentalFeatures,
+  INTAKE_SITE_US1,
+  INTAKE_SITE_US1_FED,
+} from '../configuration'
+import {
+  resetTelemetry,
+  startTelemetry,
+  scrubCustomerFrames,
+  formatError,
+  addTelemetryConfiguration,
+} from './telemetry'
 
 function startAndSpyTelemetry(configuration?: Partial<Configuration>) {
   const telemetry = startTelemetry({
@@ -31,6 +42,39 @@ describe('telemetry', () => {
     expect(notifySpy).toHaveBeenCalledTimes(1)
   })
 
+  describe('addTelemetryConfiguration', () => {
+    afterEach(() => {
+      resetExperimentalFeatures()
+    })
+
+    it('should notify configuration when sampled and ff is enabled', () => {
+      updateExperimentalFeatures(['telemetry_configuration'])
+
+      const { notifySpy } = startAndSpyTelemetry({ telemetrySampleRate: 100, telemetryConfigurationSampleRate: 100 })
+
+      addTelemetryConfiguration({})
+
+      expect(notifySpy).toHaveBeenCalled()
+    })
+
+    it('should not notify configuration when sampled and ff is disabled', () => {
+      const { notifySpy } = startAndSpyTelemetry({ telemetrySampleRate: 100, telemetryConfigurationSampleRate: 100 })
+
+      addTelemetryConfiguration({})
+
+      expect(notifySpy).not.toHaveBeenCalled()
+    })
+
+    it('should not notify configuration when not sampled and ff is enabled', () => {
+      updateExperimentalFeatures(['telemetry_configuration'])
+      const { notifySpy } = startAndSpyTelemetry({ telemetrySampleRate: 100, telemetryConfigurationSampleRate: 0 })
+
+      addTelemetryConfiguration({})
+
+      expect(notifySpy).not.toHaveBeenCalled()
+    })
+  })
+
   it('should contains feature flags', () => {
     updateExperimentalFeatures(['foo'])
     const { notifySpy } = startAndSpyTelemetry()

diff --git a/packages/core/src/domain/telemetry/telemetry.ts b/packages/core/src/domain/telemetry/telemetry.ts
@@ -4,6 +4,7 @@ import { toStackTraceString } from '../../tools/error'
 import { assign, combine, jsonStringify, performDraw, includes, startsWith, arrayFrom } from '../../tools/utils'
 import type { Configuration } from '../configuration'
 import {
+  isExperimentalFeatureEnabled,
   getExperimentalFeatures,
   getSimulationLabel,
   INTAKE_SITE_STAGING,
@@ -35,13 +36,13 @@ export interface Telemetry {
 }
 
 const TELEMETRY_EXCLUDED_SITES: string[] = [INTAKE_SITE_US1_FED]
-const TELEMETRY_CONFIGURATION_SAMPLE_RATE = 20
 
 const telemetryConfiguration: {
   maxEventsPerPage: number
   sentEventCount: number
   telemetryEnabled: boolean
-} = { maxEventsPerPage: 0, sentEventCount: 0, telemetryEnabled: false }
+  telemetryConfigurationEnabled: boolean
+} = { maxEventsPerPage: 0, sentEventCount: 0, telemetryEnabled: false, telemetryConfigurationEnabled: false }
 
 let onRawTelemetryEventCollected: ((event: RawTelemetryEvent) => void) | undefined
 
@@ -50,6 +51,8 @@ export function startTelemetry(configuration: Configuration): Telemetry {
   const observable = new Observable<TelemetryEvent & Context>()
 
   telemetryConfiguration.telemetryEnabled = performDraw(configuration.telemetrySampleRate)
+  telemetryConfiguration.telemetryConfigurationEnabled =
+    telemetryConfiguration.telemetryEnabled && performDraw(configuration.telemetryConfigurationSampleRate)
 
   onRawTelemetryEventCollected = (event: RawTelemetryEvent) => {
     if (!includes(TELEMETRY_EXCLUDED_SITES, configuration.site) && telemetryConfiguration.telemetryEnabled) {
@@ -143,7 +146,7 @@ export function addTelemetryError(e: unknown) {
 }
 
 export function addTelemetryConfiguration(configuration: RawConfigurationTelemetryEvent['configuration']) {
-  if (performDraw(TELEMETRY_CONFIGURATION_SAMPLE_RATE)) {
+  if (isExperimentalFeatureEnabled('telemetry_configuration') && telemetryConfiguration.telemetryConfigurationEnabled) {
     addTelemetry({
       type: TelemetryType.configuration as const,
       configuration,

diff --git a/packages/logs/src/boot/startLogs.spec.ts b/packages/logs/src/boot/startLogs.spec.ts
@@ -36,7 +36,7 @@ const COMMON_CONTEXT = {
 }
 
 describe('logs', () => {
-  const initConfiguration = { clientToken: 'xxx', service: 'service' }
+  const initConfiguration = { clientToken: 'xxx', service: 'service', telemetrySampleRate: 0 }
   let baseConfiguration: LogsConfiguration
   let interceptor: ReturnType<typeof interceptRequests>
   let requests: Request[]

diff --git a/test/e2e/scenario/telemetry.scenario.ts b/test/e2e/scenario/telemetry.scenario.ts
@@ -16,8 +16,9 @@ describe('telemetry', () => {
         window.DD_LOGS!.logger.log('hop', context as any)
       })
       await flushEvents()
-      expect(serverEvents.telemetry.length).toBe(1)
-      const event = serverEvents.telemetry[0] as TelemetryErrorEvent
+
+      // get the last telemetry event because telemetry configuration may have been collected first
+      const event = serverEvents.telemetry[serverEvents.telemetry.length - 1] as TelemetryErrorEvent
       expect(event.telemetry.message).toBe('bar')
       expect(event.telemetry.error!.kind).toBe('Error')
       expect(event.telemetry.status).toBe('error')
@@ -37,8 +38,9 @@ describe('telemetry', () => {
         window.DD_RUM!.addAction('hop', context as any)
       })
       await flushEvents()
-      expect(serverEvents.telemetry.length).toBe(1)
-      const event = serverEvents.telemetry[0] as TelemetryErrorEvent
+
+      // get the last telemetry event because telemetry configuration may have been collected first
+      const event = serverEvents.telemetry[serverEvents.telemetry.length - 1] as TelemetryErrorEvent
       expect(event.telemetry.message).toBe('bar')
       expect(event.telemetry.error!.kind).toBe('Error')
       expect(event.telemetry.status).toBe('error')