feat(sdk-trace-base): add dropped attributes and events count on span (#3576)

* feat(sdk-trace-base): add dropped attributes and events count on span

* feat(sdk-trace-base): sync with main

* feat(sdk-trace-base): [revert] sync with main

* feat(sdk-trace-base): fix tests, make both counts truthy

* feat(sdk-trace-base): Update dropped counts type to number

* feat(sdk-trace-base): Use exposed counts on ReadableSpan in jaeger and zipkin exporters

* feat(sdk-trace-base): WIP - revert tsconfig, add new attribute limits

* feat(sdk-trace-base): Update attribute truncate method

* Fix bad conflict resolution

* Remove unused import

* chore: lint

* feat(sdk-trace-base): Remove dropped event attributes logic, add Jaeger field

* feat(sdk-trace-base): Undo formatting in changelog

* fix(changelog): Update experimental changelog

* Update packages/opentelemetry-sdk-trace-base/src/Span.ts

Co-authored-by: Gerhard Stöbich <[email protected]>

* Update packages/opentelemetry-sdk-trace-base/src/Span.ts

Co-authored-by: Gerhard Stöbich <[email protected]>

* fix(sdk-trace-base): Resolve review comments

* fix(sdk-trace-base): Fix failing tests

* fix(sdk-trace-base): make droppedAttributesCount on event optional

* fix(changelog): Update changelog files

---------

Co-authored-by: Daniel Dyla <[email protected]>
Co-authored-by: Gerhard Stöbich <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -20,6 +20,7 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 * feat: support TraceState in SamplingResult [#3530](https://github.com/open-telemetry/opentelemetry-js/pull/3530) @raphael-theriault-swi
 * feat(sdk-trace-base): add diagnostic logging when spans are dropped [#3610](https://github.com/open-telemetry/opentelemetry-js/pull/3610) @neoeinstein
 * feat: add unit to view instrument selection criteria [#3647](https://github.com/open-telemetry/opentelemetry-js/pull/3647) @jlabatut
+* feat(tracing): expose dropped counts for attributes, events and links on span [#3576](https://github.com/open-telemetry/opentelemetry-js/pull/3576) @mohitk05
 
 ### :bug: (Bug Fix)
 

api/CHANGELOG.md

@@ -15,6 +15,7 @@ All notable changes to this project will be documented in this file.
 ### :rocket: (Enhancement)
 
 * feat(api): add `getActiveBaggage` API [#3385](https://github.com/open-telemetry/opentelemetry-js/pull/3385)
+* feat(api): add optional `droppedAttributesCount` property in the `Link` interface [#3576](https://github.com/open-telemetry/opentelemetry-js/pull/3576) @mohitk05
 
 ### :bug: (Bug Fix)
 

api/src/trace/link.ts

@@ -37,4 +37,6 @@ export interface Link {
   context: SpanContext;
   /** A set of {@link SpanAttributes} on the link. */
   attributes?: SpanAttributes;
+  /** Count of attributes of the link that were dropped due to collection limits */
+  droppedAttributesCount?: number;
 }

experimental/CHANGELOG.md

@@ -16,6 +16,7 @@ All notable changes to experimental packages in this project will be documented
 * feat(sdk-node): install diag logger with OTEL_LOG_LEVEL [#3627](https://github.com/open-telemetry/opentelemetry-js/pull/3627) @legendecas
 * feat(otlp-exporter-base): add retries [#3207](https://github.com/open-telemetry/opentelemetry-js/pull/3207) @svetlanabrennan
 * feat(sdk-node): override IdGenerator when using NodeSDK [#3645](https://github.com/open-telemetry/opentelemetry-js/pull/3645) @haddasbronfman
+* feat(otlp-transformer): expose dropped attributes, events and links counts on the transformed otlp span [#3576](https://github.com/open-telemetry/opentelemetry-js/pull/3576) @mohitk05
 
 ### :bug: (Bug Fix)
 

experimental/packages/exporter-trace-otlp-grpc/test/traceHelper.ts

@@ -61,22 +61,34 @@ export const mockedReadableSpan: ReadableSpan = {
     },
   ],
   events: [
-    { name: 'fetchStart', time: [1574120165, 429803070] },
+    {
+      name: 'fetchStart',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'domainLookupStart',
       time: [1574120165, 429803070],
     },
-    { name: 'domainLookupEnd', time: [1574120165, 429803070] },
+    {
+      name: 'domainLookupEnd',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'connectStart',
       time: [1574120165, 429803070],
     },
-    { name: 'connectEnd', time: [1574120165, 429803070] },
+    {
+      name: 'connectEnd',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'requestStart',
       time: [1574120165, 435513070],
     },
-    { name: 'responseStart', time: [1574120165, 436923070] },
+    {
+      name: 'responseStart',
+      time: [1574120165, 436923070],
+    },
     {
       name: 'responseEnd',
       time: [1574120165, 438688070],
@@ -91,6 +103,9 @@ export const mockedReadableSpan: ReadableSpan = {
     })
   ),
   instrumentationLibrary: { name: 'default', version: '0.0.1' },
+  droppedAttributesCount: 0,
+  droppedEventsCount: 0,
+  droppedLinksCount: 0,
 };
 
 export function ensureExportedEventsAreCorrect(events: IEvent[]) {

experimental/packages/exporter-trace-otlp-http/test/traceHelper.ts

@@ -72,22 +72,34 @@ export const mockedReadableSpan: ReadableSpan = {
     },
   ],
   events: [
-    { name: 'fetchStart', time: [1574120165, 429803070] },
+    {
+      name: 'fetchStart',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'domainLookupStart',
       time: [1574120165, 429803070],
     },
-    { name: 'domainLookupEnd', time: [1574120165, 429803070] },
+    {
+      name: 'domainLookupEnd',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'connectStart',
       time: [1574120165, 429803070],
     },
-    { name: 'connectEnd', time: [1574120165, 429803070] },
+    {
+      name: 'connectEnd',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'requestStart',
       time: [1574120165, 435513070],
     },
-    { name: 'responseStart', time: [1574120165, 436923070] },
+    {
+      name: 'responseStart',
+      time: [1574120165, 436923070],
+    },
     {
       name: 'responseEnd',
       time: [1574120165, 438688070],
@@ -102,6 +114,9 @@ export const mockedReadableSpan: ReadableSpan = {
     })
   ),
   instrumentationLibrary: { name: 'default', version: '0.0.1' },
+  droppedAttributesCount: 0,
+  droppedEventsCount: 0,
+  droppedLinksCount: 0,
 };
 
 export const mockedResources: Resource[] = [
@@ -142,6 +157,9 @@ export const basicTrace: ReadableSpan[] = [
     duration: [0, 8885000],
     resource: mockedResources[0],
     instrumentationLibrary: mockedInstrumentationLibraries[0],
+    droppedAttributesCount: 0,
+    droppedEventsCount: 0,
+    droppedLinksCount: 0,
   },
   {
     name: 'span2',
@@ -164,6 +182,9 @@ export const basicTrace: ReadableSpan[] = [
     duration: [0, 8775000],
     resource: mockedResources[0],
     instrumentationLibrary: mockedInstrumentationLibraries[0],
+    droppedAttributesCount: 0,
+    droppedEventsCount: 0,
+    droppedLinksCount: 0,
   },
   {
     name: 'span3',
@@ -186,6 +207,9 @@ export const basicTrace: ReadableSpan[] = [
     duration: [0, 8775000],
     resource: mockedResources[0],
     instrumentationLibrary: mockedInstrumentationLibraries[0],
+    droppedAttributesCount: 0,
+    droppedEventsCount: 0,
+    droppedLinksCount: 0,
   },
 ];
 

experimental/packages/exporter-trace-otlp-proto/test/traceHelper.ts

@@ -59,22 +59,34 @@ export const mockedReadableSpan: ReadableSpan = {
     },
   ],
   events: [
-    { name: 'fetchStart', time: [1574120165, 429803070] },
+    {
+      name: 'fetchStart',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'domainLookupStart',
       time: [1574120165, 429803070],
     },
-    { name: 'domainLookupEnd', time: [1574120165, 429803070] },
+    {
+      name: 'domainLookupEnd',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'connectStart',
       time: [1574120165, 429803070],
     },
-    { name: 'connectEnd', time: [1574120165, 429803070] },
+    {
+      name: 'connectEnd',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'requestStart',
       time: [1574120165, 435513070],
     },
-    { name: 'responseStart', time: [1574120165, 436923070] },
+    {
+      name: 'responseStart',
+      time: [1574120165, 436923070],
+    },
     {
       name: 'responseEnd',
       time: [1574120165, 438688070],
@@ -87,6 +99,9 @@ export const mockedReadableSpan: ReadableSpan = {
     cost: 112.12,
   }),
   instrumentationLibrary: { name: 'default', version: '0.0.1' },
+  droppedAttributesCount: 0,
+  droppedEventsCount: 0,
+  droppedLinksCount: 0,
 };
 
 export function ensureProtoEventsAreCorrect(events: IEvent[]) {

experimental/packages/otlp-grpc-exporter-base/test/traceHelper.ts

@@ -61,22 +61,34 @@ export const mockedReadableSpan: ReadableSpan = {
     },
   ],
   events: [
-    { name: 'fetchStart', time: [1574120165, 429803070] },
+    {
+      name: 'fetchStart',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'domainLookupStart',
       time: [1574120165, 429803070],
     },
-    { name: 'domainLookupEnd', time: [1574120165, 429803070] },
+    {
+      name: 'domainLookupEnd',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'connectStart',
       time: [1574120165, 429803070],
     },
-    { name: 'connectEnd', time: [1574120165, 429803070] },
+    {
+      name: 'connectEnd',
+      time: [1574120165, 429803070],
+    },
     {
       name: 'requestStart',
       time: [1574120165, 435513070],
     },
-    { name: 'responseStart', time: [1574120165, 436923070] },
+    {
+      name: 'responseStart',
+      time: [1574120165, 436923070],
+    },
     {
       name: 'responseEnd',
       time: [1574120165, 438688070],
@@ -91,6 +103,9 @@ export const mockedReadableSpan: ReadableSpan = {
     })
   ),
   instrumentationLibrary: { name: 'default', version: '0.0.1' },
+  droppedAttributesCount: 0,
+  droppedEventsCount: 0,
+  droppedLinksCount: 0,
 };
 
 export function ensureExportedEventsAreCorrect(events: IEvent[]) {

experimental/packages/otlp-transformer/src/trace/internal.ts

@@ -39,16 +39,16 @@ export function sdkSpanToOtlpSpan(span: ReadableSpan, useHex?: boolean): ISpan {
     startTimeUnixNano: hrTimeToNanoseconds(span.startTime),
     endTimeUnixNano: hrTimeToNanoseconds(span.endTime),
     attributes: toAttributes(span.attributes),
-    droppedAttributesCount: 0,
+    droppedAttributesCount: span.droppedAttributesCount,
     events: span.events.map(toOtlpSpanEvent),
-    droppedEventsCount: 0,
+    droppedEventsCount: span.droppedEventsCount,
     status: {
       // API and proto enums share the same values
       code: status.code as unknown as EStatusCode,
       message: status.message,
     },
     links: span.links.map(link => toOtlpLink(link, useHex)),
-    droppedLinksCount: 0,
+    droppedLinksCount: span.droppedLinksCount,
   };
 }
 
@@ -62,7 +62,7 @@ export function toOtlpLink(link: Link, useHex?: boolean): ILink {
       ? link.context.traceId
       : core.hexToBase64(link.context.traceId),
     traceState: link.context.traceState?.serialize(),
-    droppedAttributesCount: 0,
+    droppedAttributesCount: link.droppedAttributesCount || 0,
   };
 }
 
@@ -73,6 +73,6 @@ export function toOtlpSpanEvent(timedEvent: TimedEvent): IEvent {
       : [],
     name: timedEvent.name,
     timeUnixNano: hrTimeToNanoseconds(timedEvent.time),
-    droppedAttributesCount: 0,
+    droppedAttributesCount: timedEvent.droppedAttributesCount || 0,
   };
 }

experimental/packages/otlp-transformer/test/trace.test.ts

@@ -178,6 +178,9 @@ describe('Trace', () => {
         status: {
           code: SpanStatusCode.OK,
         },
+        droppedAttributesCount: 0,
+        droppedEventsCount: 0,
+        droppedLinksCount: 0,
       };
     });