👌use single option + limit log with custom status

DataDog · Jan 6, 2022 · 331753d · 331753d
1 parent 3a47229
commit 331753d
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 36 deletions.
diff --git a/packages/core/src/domain/configuration/configuration.ts b/packages/core/src/domain/configuration/configuration.ts
@@ -59,7 +59,7 @@ export interface Configuration extends TransportConfiguration {
   silentMultipleInit: boolean
 
   // Event limits
-  maxErrorsPerMinute: number
+  eventRateLimiterThreshold: number // Limit the maximum number of actions, errors and logs per minutes
   maxInternalMonitoringMessagesPerPage: number
   requestErrorResponseLengthLimit: number
 
@@ -103,7 +103,7 @@ export function validateAndBuildConfiguration(
      */
     batchBytesLimit: 16 * ONE_KILO_BYTE,
 
-    maxErrorsPerMinute: 3000,
+    eventRateLimiterThreshold: 3000,
     maxInternalMonitoringMessagesPerPage: 15,
 
     /**

diff --git a/packages/logs/src/boot/startLogs.spec.ts b/packages/logs/src/boot/startLogs.spec.ts
@@ -340,14 +340,15 @@ describe('logs', () => {
     })
   })
   ;[
-    { status: StatusType.error, configuration: { maxErrorsPerMinute: 1 } },
-    { status: StatusType.warn, configuration: { maxWarningsPerMinute: 1 } },
-    { status: StatusType.info, configuration: { maxInfosPerMinute: 1 } },
-    { status: StatusType.debug, configuration: { maxDebugsPerMinute: 1 } },
-  ].forEach(({ status, configuration }) => {
+    { status: StatusType.error, message: 'Reached max number of errors by minute: 1' },
+    { status: StatusType.warn, message: 'Reached max number of warns by minute: 1' },
+    { status: StatusType.info, message: 'Reached max number of infos by minute: 1' },
+    { status: StatusType.debug, message: 'Reached max number of debugs by minute: 1' },
+    { status: 'unknown' as StatusType, message: 'Reached max number of customs by minute: 1' },
+  ].forEach(({ status, message }) => {
     describe(`${status} logs limitation`, () => {
       let clock: Clock
-
+      const configuration = { eventRateLimiterThreshold: 1 }
       beforeEach(() => {
         clock = mockClock()
       })
@@ -365,7 +366,7 @@ describe('logs', () => {
         expect(server.requests.length).toEqual(1)
         expect(getLoggedMessage(server, 0).message).toBe('foo')
         expect(sendLogSpy).toHaveBeenCalledOnceWith({
-          message: `Reached max number of ${status}s by minute: 1`,
+          message,
           status: StatusType.error,
           error: {
             origin: ErrorSource.AGENT,
@@ -376,7 +377,7 @@ describe('logs', () => {
         })
       })
 
-      it(`does not take discarded ${status}s into account`, () => {
+      it(`does not take discarded ${status} los into account`, () => {
         const sendLogSpy = jasmine.createSpy<(message: LogsMessage & { foo?: string }) => void>()
         const sendLog = startLogs({
           errorLogger: new Logger(sendLogSpy),

diff --git a/packages/logs/src/boot/startLogs.ts b/packages/logs/src/boot/startLogs.ts
@@ -103,10 +103,11 @@ export function buildAssemble(
   reportError: (error: RawError) => void
 ) {
   const logRateLimiters = {
-    [StatusType.error]: createEventRateLimiter(StatusType.error, configuration.maxErrorsPerMinute, reportError),
-    [StatusType.warn]: createEventRateLimiter(StatusType.warn, configuration.maxWarningsPerMinute, reportError),
-    [StatusType.info]: createEventRateLimiter(StatusType.info, configuration.maxInfosPerMinute, reportError),
-    [StatusType.debug]: createEventRateLimiter(StatusType.debug, configuration.maxDebugsPerMinute, reportError),
+    [StatusType.error]: createEventRateLimiter(StatusType.error, configuration.eventRateLimiterThreshold, reportError),
+    [StatusType.warn]: createEventRateLimiter(StatusType.warn, configuration.eventRateLimiterThreshold, reportError),
+    [StatusType.info]: createEventRateLimiter(StatusType.info, configuration.eventRateLimiterThreshold, reportError),
+    [StatusType.debug]: createEventRateLimiter(StatusType.debug, configuration.eventRateLimiterThreshold, reportError),
+    ['custom']: createEventRateLimiter('custom', configuration.eventRateLimiterThreshold, reportError),
   }
 
   return (message: LogsMessage, currentContext: Context) => {
@@ -126,7 +127,7 @@ export function buildAssemble(
 
     if (
       configuration.beforeSend?.(contextualizedMessage) === false ||
-      logRateLimiters[contextualizedMessage.status]?.isLimitReached()
+      (logRateLimiters[contextualizedMessage.status] ?? logRateLimiters['custom']).isLimitReached()
     ) {
       return undefined
     }

diff --git a/packages/logs/src/domain/configuration.ts b/packages/logs/src/domain/configuration.ts
@@ -11,11 +11,6 @@ export type HybridInitConfiguration = Omit<LogsInitConfiguration, 'clientToken'>
 
 export interface LogsConfiguration extends Configuration {
   forwardErrorsToLogs: boolean
-
-  // Event limits
-  maxWarningsPerMinute: number
-  maxInfosPerMinute: number
-  maxDebugsPerMinute: number
 }
 
 export function validateAndBuildLogsConfiguration(
@@ -30,8 +25,5 @@ export function validateAndBuildLogsConfiguration(
     ...baseConfiguration,
 
     forwardErrorsToLogs: !!initConfiguration.forwardErrorsToLogs,
-    maxWarningsPerMinute: 3000,
-    maxInfosPerMinute: 3000,
-    maxDebugsPerMinute: 3000,
   }
 }
diff --git a/packages/rum-core/src/domain/assembly.spec.ts b/packages/rum-core/src/domain/assembly.spec.ts
@@ -613,7 +613,7 @@ describe('rum assembly', () => {
     })
 
     it('stops sending error events when reaching the limit', () => {
-      const { lifeCycle } = setupBuilder.withConfiguration({ maxErrorsPerMinute: 1 }).build()
+      const { lifeCycle } = setupBuilder.withConfiguration({ eventRateLimiterThreshold: 1 }).build()
       notifyRawRumErrorEvent(lifeCycle, 'foo')
       notifyRawRumErrorEvent(lifeCycle, 'bar')
 
@@ -631,7 +631,7 @@ describe('rum assembly', () => {
     it('does not take discarded errors into account', () => {
       const { lifeCycle } = setupBuilder
         .withConfiguration({
-          maxErrorsPerMinute: 1,
+          eventRateLimiterThreshold: 1,
           beforeSend: (event) => {
             if (event.type === RumEventType.ERROR && (event as RumErrorEvent).error.message === 'discard me') {
               return false
@@ -649,7 +649,10 @@ describe('rum assembly', () => {
     })
 
     it('allows to send new errors after a minute', () => {
-      const { lifeCycle, clock } = setupBuilder.withFakeClock().withConfiguration({ maxErrorsPerMinute: 1 }).build()
+      const { lifeCycle, clock } = setupBuilder
+        .withFakeClock()
+        .withConfiguration({ eventRateLimiterThreshold: 1 })
+        .build()
       notifyRawRumErrorEvent(lifeCycle, 'foo')
       notifyRawRumErrorEvent(lifeCycle, 'bar')
       clock.tick(ONE_MINUTE)
@@ -680,7 +683,7 @@ describe('rum assembly', () => {
     })
 
     it('stops sending action events when reaching the limit', () => {
-      const { lifeCycle } = setupBuilder.withConfiguration({ maxActionsPerMinute: 1 }).build()
+      const { lifeCycle } = setupBuilder.withConfiguration({ eventRateLimiterThreshold: 1 }).build()
 
       notifyRumActionEvent(lifeCycle, 'foo')
       notifyRumActionEvent(lifeCycle, 'bar')
@@ -699,7 +702,7 @@ describe('rum assembly', () => {
     it('does not take discarded actions into account', () => {
       const { lifeCycle } = setupBuilder
         .withConfiguration({
-          maxErrorsPerMinute: 1,
+          eventRateLimiterThreshold: 1,
           beforeSend: (event) => {
             if (event.type === RumEventType.ACTION && (event as RumActionEvent).action.target?.name === 'discard me') {
               return false
@@ -717,7 +720,10 @@ describe('rum assembly', () => {
     })
 
     it('allows to send new actions after a minute', () => {
-      const { lifeCycle, clock } = setupBuilder.withFakeClock().withConfiguration({ maxActionsPerMinute: 1 }).build()
+      const { lifeCycle, clock } = setupBuilder
+        .withFakeClock()
+        .withConfiguration({ eventRateLimiterThreshold: 1 })
+        .build()
       notifyRumActionEvent(lifeCycle, 'foo')
       notifyRumActionEvent(lifeCycle, 'bar')
       clock.tick(ONE_MINUTE)

diff --git a/packages/rum-core/src/domain/assembly.ts b/packages/rum-core/src/domain/assembly.ts
@@ -70,8 +70,16 @@ export function startRumAssembly(
   }
 
   const eventRateLimiters = {
-    [RumEventType.ERROR]: createEventRateLimiter(RumEventType.ERROR, configuration.maxErrorsPerMinute, reportError),
-    [RumEventType.ACTION]: createEventRateLimiter(RumEventType.ACTION, configuration.maxActionsPerMinute, reportError),
+    [RumEventType.ERROR]: createEventRateLimiter(
+      RumEventType.ERROR,
+      configuration.eventRateLimiterThreshold,
+      reportError
+    ),
+    [RumEventType.ACTION]: createEventRateLimiter(
+      RumEventType.ACTION,
+      configuration.eventRateLimiterThreshold,
+      reportError
+    ),
   }
 
   const syntheticsContext = getSyntheticsContext()

diff --git a/packages/rum-core/src/domain/configuration.ts b/packages/rum-core/src/domain/configuration.ts
@@ -42,9 +42,6 @@ export interface RumConfiguration extends Configuration {
   replaySampleRate: number
   trackInteractions: boolean
   trackViewsManually: boolean
-
-  // Event limits
-  maxActionsPerMinute: number
 }
 
 export function validateAndBuildRumConfiguration(
@@ -88,7 +85,5 @@ export function validateAndBuildRumConfiguration(
     defaultPrivacyLevel: objectHasValue(DefaultPrivacyLevel, initConfiguration.defaultPrivacyLevel)
       ? initConfiguration.defaultPrivacyLevel
       : DefaultPrivacyLevel.MASK_USER_INPUT,
-
-    maxActionsPerMinute: 3000,
   }
 }