🔉 [RUMF-1351] retry: add extra context to queue full log (#1714)

* 🔉 [RUMF-1351] retry: add extra context to queue full log * 👌 add endpoint type
DataDog · Aug 31, 2022 · 1754446 · 1754446
1 parent cc58e11
commit 1754446
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 13 deletions.
diff --git a/packages/core/src/domain/configuration/endpointBuilder.ts b/packages/core/src/domain/configuration/endpointBuilder.ts
@@ -19,7 +19,7 @@ const INTAKE_TRACKS = {
   sessionReplay: 'replay',
 }
 
-type EndpointType = keyof typeof ENDPOINTS
+export type EndpointType = keyof typeof ENDPOINTS
 
 export type EndpointBuilder = ReturnType<typeof createEndpointBuilder>
 

diff --git a/packages/core/src/domain/configuration/index.ts b/packages/core/src/domain/configuration/index.ts
@@ -5,7 +5,7 @@ export {
   DefaultPrivacyLevel,
   validateAndBuildConfiguration,
 } from './configuration'
-export { createEndpointBuilder, EndpointBuilder } from './endpointBuilder'
+export { createEndpointBuilder, EndpointBuilder, EndpointType } from './endpointBuilder'
 export {
   isExperimentalFeatureEnabled,
   updateExperimentalFeatures,

diff --git a/packages/core/src/transport/httpRequest.ts b/packages/core/src/transport/httpRequest.ts
@@ -33,7 +33,7 @@ export function createHttpRequest(endpointBuilder: EndpointBuilder, bytesLimit:
       if (!isExperimentalFeatureEnabled('retry')) {
         fetchKeepAliveStrategy(endpointBuilder, bytesLimit, payload)
       } else {
-        sendWithRetryStrategy(payload, retryState, sendStrategyForRetry)
+        sendWithRetryStrategy(payload, retryState, sendStrategyForRetry, endpointBuilder.endpointType)
       }
     },
     /**

diff --git a/packages/core/src/transport/sendWithRetryStrategy.spec.ts b/packages/core/src/transport/sendWithRetryStrategy.spec.ts
@@ -41,7 +41,7 @@ describe('sendWithRetryStrategy', () => {
         data: payload?.data ?? 'a',
         bytesCount: payload?.bytesCount ?? 1,
       }
-      sendWithRetryStrategy(effectivePayload, state, sendStub.sendStrategy)
+      sendWithRetryStrategy(effectivePayload, state, sendStub.sendStrategy, 'logs')
     }
   })
 

diff --git a/packages/core/src/transport/sendWithRetryStrategy.ts b/packages/core/src/transport/sendWithRetryStrategy.ts
@@ -1,4 +1,5 @@
 import { addTelemetryDebug } from '../domain/telemetry'
+import type { EndpointType } from '../domain/configuration'
 import { monitor } from '../tools/monitor'
 import { ONE_KIBI_BYTE, ONE_MEBI_BYTE, ONE_SECOND } from '../tools/utils'
 import type { Payload, HttpResponse } from './httpRequest'
@@ -25,25 +26,30 @@ export interface RetryState {
 
 type SendStrategy = (payload: Payload, onResponse: (r: HttpResponse) => void) => void
 
-export function sendWithRetryStrategy(payload: Payload, state: RetryState, sendStrategy: SendStrategy) {
+export function sendWithRetryStrategy(
+  payload: Payload,
+  state: RetryState,
+  sendStrategy: SendStrategy,
+  endpointType: EndpointType
+) {
   if (
     state.transportStatus === TransportStatus.UP &&
     state.queuedPayloads.size() === 0 &&
     state.bandwidthMonitor.canHandle(payload)
   ) {
     send(payload, state, sendStrategy, {
-      onSuccess: () => retryQueuedPayloads(state, sendStrategy),
+      onSuccess: () => retryQueuedPayloads(state, sendStrategy, 'request success', endpointType),
       onFailure: () => {
         state.queuedPayloads.enqueue(payload)
-        scheduleRetry(state, sendStrategy)
+        scheduleRetry(state, sendStrategy, endpointType)
       },
     })
   } else {
     state.queuedPayloads.enqueue(payload)
   }
 }
 
-function scheduleRetry(state: RetryState, sendStrategy: SendStrategy) {
+function scheduleRetry(state: RetryState, sendStrategy: SendStrategy, endpointType: EndpointType) {
   if (state.transportStatus !== TransportStatus.DOWN) {
     return
   }
@@ -62,11 +68,11 @@ function scheduleRetry(state: RetryState, sendStrategy: SendStrategy) {
             })
           }
           state.currentBackoffTime = INITIAL_BACKOFF_TIME
-          retryQueuedPayloads(state, sendStrategy)
+          retryQueuedPayloads(state, sendStrategy, 'transport down', endpointType)
         },
         onFailure: () => {
           state.currentBackoffTime = Math.min(MAX_BACKOFF_TIME, state.currentBackoffTime * 2)
-          scheduleRetry(state, sendStrategy)
+          scheduleRetry(state, sendStrategy, endpointType)
         },
       })
     }),
@@ -96,14 +102,22 @@ function send(
   })
 }
 
-function retryQueuedPayloads(state: RetryState, sendStrategy: SendStrategy) {
+function retryQueuedPayloads(
+  state: RetryState,
+  sendStrategy: SendStrategy,
+  reason: string,
+  endpointType: EndpointType
+) {
   const previousQueue = state.queuedPayloads
   if (previousQueue.isFull()) {
-    addTelemetryDebug('retry queue full')
+    addTelemetryDebug('retry queue full', {
+      reason,
+      endpointType,
+    })
   }
   state.queuedPayloads = newPayloadQueue()
   while (previousQueue.size() > 0) {
-    sendWithRetryStrategy(previousQueue.dequeue()!, state, sendStrategy)
+    sendWithRetryStrategy(previousQueue.dequeue()!, state, sendStrategy, endpointType)
   }
 }