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 <deb2001-github@yahoo.de> * Update packages/opentelemetry-sdk-trace-base/src/Span.ts Co-authored-by: Gerhard Stöbich <deb2001-github@yahoo.de> * 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 <dyladan@users.noreply.github.com> Co-authored-by: Gerhard Stöbich <deb2001-github@yahoo.de>
open-telemetry · Mar 8, 2023 · 48ecf22 · 48ecf22
1 parent 95bf6fc
commit 48ecf22
Show file tree

Hide file tree

Showing 25 changed files with 295 additions and 62 deletions.
diff --git a/CHANGELOG.md b/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)
 

diff --git a/api/CHANGELOG.md b/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)
 

diff --git a/api/src/trace/link.ts b/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;
 }
diff --git a/experimental/CHANGELOG.md b/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)
 

diff --git a/experimental/packages/exporter-trace-otlp-grpc/test/traceHelper.ts b/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[]) {

diff --git a/experimental/packages/exporter-trace-otlp-http/test/traceHelper.ts b/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,
   },
 ];
 

diff --git a/experimental/packages/exporter-trace-otlp-proto/test/traceHelper.ts b/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[]) {

diff --git a/experimental/packages/otlp-grpc-exporter-base/test/traceHelper.ts b/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[]) {

diff --git a/experimental/packages/otlp-transformer/src/trace/internal.ts b/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,
   };
 }
diff --git a/experimental/packages/otlp-transformer/test/trace.test.ts b/experimental/packages/otlp-transformer/test/trace.test.ts
@@ -178,6 +178,9 @@ describe('Trace', () => {
         status: {
           code: SpanStatusCode.OK,
         },
+        droppedAttributesCount: 0,
+        droppedEventsCount: 0,
+        droppedLinksCount: 0,
       };
     });
 

diff --git a/packages/opentelemetry-core/src/utils/environment.ts b/packages/opentelemetry-core/src/utils/environment.ts
@@ -47,6 +47,8 @@ const ENVIRONMENT_NUMBERS_KEYS = [
   'OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT',
   'OTEL_SPAN_EVENT_COUNT_LIMIT',
   'OTEL_SPAN_LINK_COUNT_LIMIT',
+  'OTEL_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT',
+  'OTEL_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT',
   'OTEL_EXPORTER_OTLP_TIMEOUT',
   'OTEL_EXPORTER_OTLP_TRACES_TIMEOUT',
   'OTEL_EXPORTER_OTLP_METRICS_TIMEOUT',
@@ -131,6 +133,9 @@ export const DEFAULT_ATTRIBUTE_VALUE_LENGTH_LIMIT = Infinity;
 
 export const DEFAULT_ATTRIBUTE_COUNT_LIMIT = 128;
 
+export const DEFAULT_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT = 128;
+export const DEFAULT_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT = 128;
+
 /**
  * Default environment variables
  */
@@ -172,6 +177,10 @@ export const DEFAULT_ENVIRONMENT: Required<ENVIRONMENT> = {
   OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT: DEFAULT_ATTRIBUTE_COUNT_LIMIT,
   OTEL_SPAN_EVENT_COUNT_LIMIT: 128,
   OTEL_SPAN_LINK_COUNT_LIMIT: 128,
+  OTEL_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT:
+    DEFAULT_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT,
+  OTEL_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT:
+    DEFAULT_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT,
   OTEL_TRACES_EXPORTER: '',
   OTEL_TRACES_SAMPLER: TracesSamplerValues.ParentBasedAlwaysOn,
   OTEL_TRACES_SAMPLER_ARG: '',

diff --git a/packages/opentelemetry-exporter-jaeger/src/transform.ts b/packages/opentelemetry-exporter-jaeger/src/transform.ts
@@ -86,6 +86,30 @@ export function spanToThrift(span: ReadableSpan): ThriftSpan {
     });
   }
 
+  /* Add droppedAttributesCount as a tag */
+  if (span.droppedAttributesCount) {
+    tags.push({
+      key: 'otel.dropped_attributes_count',
+      value: toTagValue(span.droppedAttributesCount),
+    });
+  }
+
+  /* Add droppedEventsCount as a tag */
+  if (span.droppedEventsCount) {
+    tags.push({
+      key: 'otel.dropped_events_count',
+      value: toTagValue(span.droppedEventsCount),
+    });
+  }
+
+  /* Add droppedLinksCount as a tag */
+  if (span.droppedLinksCount) {
+    tags.push({
+      key: 'otel.dropped_links_count',
+      value: toTagValue(span.droppedLinksCount),
+    });
+  }
+
   const spanTags: ThriftTag[] = ThriftUtils.getThriftTags(tags);
 
   const logs = span.events.map((event): Log => {
@@ -96,6 +120,12 @@ export function spanToThrift(span: ReadableSpan): ThriftSpan {
         fields.push({ key: attr, value: toTagValue(attrs[attr]) })
       );
     }
+    if (event.droppedAttributesCount) {
+      fields.push({
+        key: 'otel.event.dropped_attributes_count',
+        value: event.droppedAttributesCount,
+      });
+    }
     return { timestamp: hrTimeToMilliseconds(event.time), fields };
   });
   const spanLogs: ThriftLog[] = ThriftUtils.getThriftLogs(logs);

diff --git a/packages/opentelemetry-exporter-jaeger/test/jaeger.test.ts b/packages/opentelemetry-exporter-jaeger/test/jaeger.test.ts
@@ -53,6 +53,9 @@ describe('JaegerExporter', () => {
       name: 'default',
       version: '0.0.1',
     },
+    droppedAttributesCount: 0,
+    droppedEventsCount: 0,
+    droppedLinksCount: 0,
   };
   describe('constructor', () => {
     afterEach(() => {