record client report

Author: adinauer

sentry/src/main/java/io/sentry/logger/LoggerBatchProcessor.java

@@ -1,5 +1,6 @@
 package io.sentry.logger;
 
+import io.sentry.DataCategory;
 import io.sentry.ISentryClient;
 import io.sentry.ISentryExecutorService;
 import io.sentry.ISentryLifecycleToken;
@@ -8,8 +9,10 @@
 import io.sentry.SentryLogEvent;
 import io.sentry.SentryLogEvents;
 import io.sentry.SentryOptions;
+import io.sentry.clientreport.DiscardReason;
 import io.sentry.transport.ReusableCountLatch;
 import io.sentry.util.AutoClosableReentrantLock;
+import io.sentry.util.JsonSerializationUtils;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Queue;
@@ -48,6 +51,15 @@ public LoggerBatchProcessor(
   @Override
   public void add(final @NotNull SentryLogEvent logEvent) {
     if (pendingCount.getCount() >= MAX_QUEUE_SIZE) {
+      options
+          .getClientReportRecorder()
+          .recordLostEvent(DiscardReason.QUEUE_OVERFLOW, DataCategory.LogItem);
+      final long lostBytes =
+          JsonSerializationUtils.byteSizeOf(
+              options.getSerializer(), options.getLogger(), logEvent);
+      options
+          .getClientReportRecorder()
+          .recordLostEvent(DiscardReason.QUEUE_OVERFLOW, DataCategory.Attachment, lostBytes);
       return;
     }
     pendingCount.increment();

sentry/src/test/java/io/sentry/logger/LoggerBatchProcessorTest.kt

@@ -1,14 +1,19 @@
 package io.sentry.logger
 
+import io.sentry.DataCategory
 import io.sentry.ISentryClient
 import io.sentry.SentryLogEvent
 import io.sentry.SentryLogEvents
 import io.sentry.SentryLogLevel
 import io.sentry.SentryNanotimeDate
 import io.sentry.SentryOptions
+import io.sentry.clientreport.ClientReportTestHelper
+import io.sentry.clientreport.DiscardReason
+import io.sentry.clientreport.DiscardedEvent
 import io.sentry.protocol.SentryId
 import io.sentry.test.DeferredExecutorService
 import io.sentry.test.injectForField
+import io.sentry.util.JsonSerializationUtils
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
@@ -54,4 +59,43 @@ class LoggerBatchProcessorTest {
     assertTrue(log1000Found, "Log 1000 should have been sent")
     assertFalse(log1001Found, "Log 1001 should not have been sent")
   }
+
+  @Test
+  fun `records client report when log event is dropped due to queue overflow`() {
+    // given
+    val mockClient = mock<ISentryClient>()
+    val mockExecutor = DeferredExecutorService()
+    val options = SentryOptions()
+    val processor = LoggerBatchProcessor(options, mockClient)
+    processor.injectForField("executorService", mockExecutor)
+
+    // fill the queue to MAX_QUEUE_SIZE
+    for (i in 1..1000) {
+      val logEvent =
+        SentryLogEvent(SentryId(), SentryNanotimeDate(), "log message $i", SentryLogLevel.INFO)
+      processor.add(logEvent)
+    }
+
+    // add one more log event that should be dropped
+    val droppedLogEvent =
+      SentryLogEvent(SentryId(), SentryNanotimeDate(), "dropped log", SentryLogLevel.INFO)
+    processor.add(droppedLogEvent)
+
+    // calculate expected bytes for the dropped log event
+    val expectedBytes =
+      JsonSerializationUtils.byteSizeOf(options.serializer, options.logger, droppedLogEvent)
+
+    // verify that a client report was recorded for the dropped log item and bytes
+    val expectedEvents =
+      mutableListOf(
+        DiscardedEvent(DiscardReason.QUEUE_OVERFLOW.reason, DataCategory.LogItem.category, 1),
+        DiscardedEvent(
+          DiscardReason.QUEUE_OVERFLOW.reason,
+          DataCategory.Attachment.category,
+          expectedBytes,
+        ),
+      )
+
+    ClientReportTestHelper.assertClientReport(options.clientReportRecorder, expectedEvents)
+  }
 }