feat(sdk-trace-base): improve log messages when dropping span events (o…

…pen-telemetry#4223)
rdeavila94 · Jan 3, 2024 · fb6d8dc · fb6d8dc
1 parent 22cea00
commit fb6d8dc
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,8 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 ### :rocket: (Enhancement)
 
+* feat(sdk-trace-base): improve log messages when dropping span events [#4223](https://github.com/open-telemetry/opentelemetry-js/pull/4223) @mkubliniak
+
 ### :bug: (Bug Fix)
 
 ### :books: (Refine Doc)

diff --git a/packages/opentelemetry-sdk-trace-base/src/Span.ts b/packages/opentelemetry-sdk-trace-base/src/Span.ts
@@ -185,7 +185,9 @@ export class Span implements APISpan, ReadableSpan {
       return this;
     }
     if (this.events.length >= this._spanLimits.eventCountLimit!) {
-      diag.warn('Dropping extra events.');
+      if (this._droppedEventsCount === 0) {
+        diag.debug('Dropping extra events.');
+      }
       this.events.shift();
       this._droppedEventsCount++;
     }
@@ -242,6 +244,12 @@ export class Span implements APISpan, ReadableSpan {
       this._duration = [0, 0];
     }
 
+    if (this._droppedEventsCount > 0) {
+      diag.warn(
+        `Dropped ${this._droppedEventsCount} events because eventCountLimit reached`
+      );
+    }
+
     this._spanProcessor.onEnd(this);
   }
 

diff --git a/packages/opentelemetry-sdk-trace-base/test/common/Span.test.ts b/packages/opentelemetry-sdk-trace-base/test/common/Span.test.ts
@@ -15,6 +15,7 @@
  */
 
 import {
+  diag,
   SpanStatusCode,
   Exception,
   ROOT_CONTEXT,
@@ -786,13 +787,23 @@ describe('Span', () => {
       spanContext,
       SpanKind.CLIENT
     );
+
+    const debugStub = sinon.spy(diag, 'debug');
+    const warnStub = sinon.spy(diag, 'warn');
+
     for (let i = 0; i < 150; i++) {
       span.addEvent('sent' + i);
     }
     span.end();
 
     assert.strictEqual(span.events.length, 100);
     assert.strictEqual(span.events[span.events.length - 1].name, 'sent149');
+
+    sinon.assert.calledOnceWithExactly(debugStub, 'Dropping extra events.');
+    sinon.assert.calledOnceWithExactly(
+      warnStub,
+      'Dropped 50 events because eventCountLimit reached'
+    );
   });
 
   it('should store the count of dropped events in droppedEventsCount', () => {