feat(sdk-logs): add droppedAttributesCount in ReadableLogRecord (open…

…-telemetry#3758)
HyunnoH · Oct 9, 2023 · f1898bf · f1898bf
1 parent c320c98
commit f1898bf
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 11 deletions.
diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md
@@ -18,6 +18,7 @@ All notable changes to experimental packages in this project will be documented
 
 * feat(exporter-metrics-otlp-proto): add esm build [#4099](https://github.com/open-telemetry/opentelemetry-js/pull/4099) @pichlermarc
 * feat(opencensus-shim): implement OpenCensus metric producer [#4066](https://github.com/open-telemetry/opentelemetry-js/pull/4066) @aabmass
+* feat(sdk-logs): add droppedAttributesCount in ReadableLogRecord [#3758](https://github.com/open-telemetry/opentelemetry-js/issues/3758) @hyunnoh
 
 ### :bug: (Bug Fix)
 

diff --git a/experimental/packages/exporter-logs-otlp-grpc/test/logsHelper.ts b/experimental/packages/exporter-logs-otlp-grpc/test/logsHelper.ts
@@ -57,6 +57,7 @@ export const mockedReadableLogRecord: ReadableLogRecord = {
     traceId: '1f1008dc8e270e85c40a0d7c3939b278',
     spanId: '5e107261f64fa53e',
   },
+  droppedAttributesCount: 0,
 };
 
 export function ensureExportedAttributesAreCorrect(attributes: IKeyValue[]) {

diff --git a/experimental/packages/exporter-logs-otlp-http/test/logHelper.ts b/experimental/packages/exporter-logs-otlp-http/test/logHelper.ts
@@ -53,6 +53,7 @@ export const mockedReadableLogRecord: ReadableLogRecord = {
     traceId: '1f1008dc8e270e85c40a0d7c3939b278',
     spanId: '5e107261f64fa53e',
   },
+  droppedAttributesCount: 0,
 };
 export function ensureExportedAttributesAreCorrect(attributes: IKeyValue[]) {
   assert.deepStrictEqual(

diff --git a/experimental/packages/exporter-logs-otlp-proto/test/logHelper.ts b/experimental/packages/exporter-logs-otlp-proto/test/logHelper.ts
@@ -53,6 +53,7 @@ export const mockedReadableLogRecord: ReadableLogRecord = {
     traceId: '1f1008dc8e270e85c40a0d7c3939b278',
     spanId: '5e107261f64fa53e',
   },
+  droppedAttributesCount: 0,
 };
 export function ensureExportedAttributesAreCorrect(attributes: IKeyValue[]) {
   assert.deepStrictEqual(

diff --git a/experimental/packages/otlp-transformer/test/logs.test.ts b/experimental/packages/otlp-transformer/test/logs.test.ts
@@ -116,13 +116,15 @@ describe('Logs', () => {
           traceFlags: TraceFlags.SAMPLED,
           traceId: '00000000000000000000000000000001',
         },
+        droppedAttributesCount: 0,
       };
       const log_fragment_2 = {
         hrTime: [1680253797, 687038506] as HrTime,
         hrTimeObserved: [1680253797, 687038506] as HrTime,
         attributes: {
           'another-attribute': 'another attribute value',
         },
+        droppedAttributesCount: 0,
       };
       log_1_1_1 = {
         ...log_fragment_1,

diff --git a/experimental/packages/sdk-logs/src/LogRecord.ts b/experimental/packages/sdk-logs/src/LogRecord.ts
@@ -39,6 +39,7 @@ export class LogRecord implements ReadableLogRecord {
   private _severityText?: string;
   private _severityNumber?: logsAPI.SeverityNumber;
   private _body?: string;
+  private _totalAttributesCount: number = 0;
 
   private _isReadonly: boolean = false;
   private readonly _logRecordLimits: Required<LogRecordLimits>;
@@ -73,6 +74,10 @@ export class LogRecord implements ReadableLogRecord {
     return this._body;
   }
 
+  get droppedAttributesCount() {
+    return this._totalAttributesCount - Object.keys(this.attributes).length;
+  }
+
   constructor(
     _sharedState: LoggerProviderSharedState,
     instrumentationScope: InstrumentationScope,
@@ -114,29 +119,34 @@ export class LogRecord implements ReadableLogRecord {
     if (value === null) {
       return this;
     }
-    if (
-      typeof value === 'object' &&
-      !Array.isArray(value) &&
-      Object.keys(value).length > 0
-    ) {
-      this.attributes[key] = value;
-    }
     if (key.length === 0) {
       api.diag.warn(`Invalid attribute key: ${key}`);
       return this;
     }
-    if (!isAttributeValue(value)) {
+    if (
+      !isAttributeValue(value) &&
+      !(
+        typeof value === 'object' &&
+        !Array.isArray(value) &&
+        Object.keys(value).length > 0
+      )
+    ) {
       api.diag.warn(`Invalid attribute value set for key: ${key}`);
       return this;
     }
+    this._totalAttributesCount += 1;
     if (
       Object.keys(this.attributes).length >=
         this._logRecordLimits.attributeCountLimit &&
       !Object.prototype.hasOwnProperty.call(this.attributes, key)
     ) {
       return this;
     }
-    this.attributes[key] = this._truncateToSize(value);
+    if (isAttributeValue(value)) {
+      this.attributes[key] = this._truncateToSize(value);
+    } else {
+      this.attributes[key] = value;
+    }
     return this;
   }
 

diff --git a/experimental/packages/sdk-logs/src/export/ReadableLogRecord.ts b/experimental/packages/sdk-logs/src/export/ReadableLogRecord.ts
@@ -29,4 +29,5 @@ export interface ReadableLogRecord {
   readonly resource: IResource;
   readonly instrumentationScope: InstrumentationScope;
   readonly attributes: LogAttributes;
+  readonly droppedAttributesCount: number;
 }
diff --git a/experimental/packages/sdk-logs/test/common/LogRecord.test.ts b/experimental/packages/sdk-logs/test/common/LogRecord.test.ts
@@ -179,14 +179,34 @@ describe('LogRecord', () => {
       describe('when "attributeCountLimit" option defined', () => {
         const { logRecord } = setup({ attributeCountLimit: 100 });
         for (let i = 0; i < 150; i++) {
-          logRecord.setAttribute(`foo${i}`, `bar${i}`);
+          let attributeValue;
+          switch (i % 3) {
+            case 0: {
+              attributeValue = `bar${i}`;
+              break;
+            }
+            case 1: {
+              attributeValue = [`bar${i}`];
+              break;
+            }
+            case 2: {
+              attributeValue = {
+                bar: `bar${i}`,
+              };
+              break;
+            }
+            default: {
+              attributeValue = `bar${i}`;
+            }
+          }
+          logRecord.setAttribute(`foo${i}`, attributeValue);
         }
 
         it('should remove / drop all remaining values after the number of values exceeds this limit', () => {
           const { attributes } = logRecord;
           assert.strictEqual(Object.keys(attributes).length, 100);
           assert.strictEqual(attributes.foo0, 'bar0');
-          assert.strictEqual(attributes.foo99, 'bar99');
+          assert.deepStrictEqual(attributes.foo98, { bar: 'bar98' });
           assert.strictEqual(attributes.foo149, undefined);
         });
       });