feat(core): Add client outcomes for breadcrumbs buffer (#15082)

ref getsentry/team-sdks#116

This PR implements a new client discard reason for `buffer_overflow`.
This will be used to track when the internal breadcrumbs buffer
overflows for the new logs product that we are working on. This is
documented in develop here:
getsentry/sentry-docs#12395

Note: The reason we have `buffer_overflow` as a separate item to
`queue_overflow` is that in the future when we send log items in
envelopes we'll increment `queue_overflow` for the transport queue. We
want to differentiate between the transport queue and the internal
buffer explicitly.

Author: AbhiPrasad

packages/core/src/scope.ts

@@ -479,9 +479,11 @@ export class Scope {
       ...breadcrumb,
     };
 
-    const breadcrumbs = this._breadcrumbs;
-    breadcrumbs.push(mergedBreadcrumb);
-    this._breadcrumbs = breadcrumbs.length > maxCrumbs ? breadcrumbs.slice(-maxCrumbs) : breadcrumbs;
+    this._breadcrumbs.push(mergedBreadcrumb);
+    if (this._breadcrumbs.length > maxCrumbs) {
+      this._breadcrumbs = this._breadcrumbs.slice(-maxCrumbs);
+      this._client?.recordDroppedEvent('buffer_overflow', 'log_item');
+    }
 
     this._notifyScopeListeners();
 

packages/core/src/types-hoist/clientreport.ts

@@ -8,7 +8,8 @@ export type EventDropReason =
   | 'ratelimit_backoff'
   | 'sample_rate'
   | 'send_error'
-  | 'internal_sdk_error';
+  | 'internal_sdk_error'
+  | 'buffer_overflow';
 
 export type Outcome = {
   reason: EventDropReason;

packages/core/src/types-hoist/datacategory.ts

@@ -14,7 +14,7 @@ export type DataCategory =
   | 'replay'
   // Events with `event_type` csp, hpkp, expectct, expectstaple
   | 'security'
-  // Attachment bytes stored (unused for rate limiting
+  // Attachment bytes stored (unused for rate limiting)
   | 'attachment'
   // Session update events
   | 'session'
@@ -28,5 +28,9 @@ export type DataCategory =
   | 'feedback'
   // Span
   | 'span'
+  // Log event
+  | 'log_item'
+  // Log bytes stored (unused for rate limiting)
+  | 'log_byte'
   // Unknown data category
   | 'unknown';

packages/core/test/lib/client.test.ts

@@ -164,6 +164,22 @@ describe('Client', () => {
       expect(isolationScopeBreadcrumbs).toEqual([{ message: 'hello3', timestamp: expect.any(Number) }]);
     });
 
+    test('it records `buffer_overflow` client discard reason when buffer overflows', () => {
+      const options = getDefaultTestClientOptions({ maxBreadcrumbs: 1 });
+      const client = new TestClient(options);
+      const recordLostEventSpy = jest.spyOn(client, 'recordDroppedEvent');
+      setCurrentClient(client);
+      getIsolationScope().setClient(client);
+      client.init();
+
+      addBreadcrumb({ message: 'hello1' });
+      addBreadcrumb({ message: 'hello2' });
+      addBreadcrumb({ message: 'hello3' });
+
+      expect(recordLostEventSpy).toHaveBeenCalledTimes(2);
+      expect(recordLostEventSpy).toHaveBeenLastCalledWith('buffer_overflow', 'log_item');
+    });
+
     test('calls `beforeBreadcrumb` and adds the breadcrumb without any changes', () => {
       const beforeBreadcrumb = jest.fn(breadcrumb => breadcrumb);
       const options = getDefaultTestClientOptions({ beforeBreadcrumb });