feat/logattributes support map type (#3821)

Co-authored-by: Marc Pichler <[email protected]>

Author: Abinet18

experimental/CHANGELOG.md

@@ -13,6 +13,7 @@ All notable changes to experimental packages in this project will be documented
 
 ### :rocket: (Enhancement)
 
+* feat(api-logs): support map in log attributes. [#3821](https://github.com/open-telemetry/opentelemetry-js/pull/3821) @Abinet18
 * feat(instrumentation): add ESM support for instrumentation. [#3698](https://github.com/open-telemetry/opentelemetry-js/pull/3698) @JamieDanielson, @pkanal, @vmarchaud, @lizthegrey, @bengl
 * feat(exporter-logs-otlp-http): otlp-http exporter for logs. [#3764](https://github.com/open-telemetry/opentelemetry-js/pull/3764/) @fuaiyi
 * feat(otlp-trace-exporters): Add User-Agent header to OTLP trace exporters. [#3790](https://github.com/open-telemetry/opentelemetry-js/pull/3790) @JamieDanielson

experimental/packages/api-logs/src/types/LogRecord.ts

@@ -14,7 +14,12 @@
  * limitations under the License.
  */
 
-import { Attributes, Context } from '@opentelemetry/api';
+import { AttributeValue, Context } from '@opentelemetry/api';
+
+export type LogAttributeValue = AttributeValue | LogAttributes;
+export interface LogAttributes {
+  [attributeKey: string]: LogAttributeValue | undefined;
+}
 
 export enum SeverityNumber {
   UNSPECIFIED = 0,
@@ -73,7 +78,7 @@ export interface LogRecord {
   /**
    * Attributes that define the log record.
    */
-  attributes?: Attributes;
+  attributes?: LogAttributes;
 
   /**
    * The Context associated with the LogRecord.

experimental/packages/api-logs/src/types/LoggerOptions.ts

@@ -13,9 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 import { Attributes } from '@opentelemetry/api';
-
 export interface LoggerOptions {
   /**
    * The schemaUrl of the tracer or instrumentation library

experimental/packages/otlp-transformer/package.json

@@ -57,6 +57,7 @@
   "devDependencies": {
     "@opentelemetry/api": "1.4.1",
     "@opentelemetry/api-logs": "0.39.1",
+    "@opentelemetry/sdk-logs": "0.39.1",
     "@types/mocha": "10.0.0",
     "@types/webpack-env": "1.16.3",
     "codecov": "3.8.3",

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

@@ -13,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { Attributes } from '@opentelemetry/api';
 import type { IAnyValue, IKeyValue } from './types';
+import { Attributes } from '@opentelemetry/api';
 
 export function toAttributes(attributes: Attributes): IKeyValue[] {
   return Object.keys(attributes).map(key => toKeyValue(key, attributes[key]));

experimental/packages/otlp-transformer/src/logs/index.ts

@@ -22,9 +22,11 @@ import {
   IResourceLogs,
 } from './types';
 import { IResource } from '@opentelemetry/resources';
-import { toAnyValue, toAttributes } from '../common/internal';
+import { toAnyValue, toAttributes, toKeyValue } from '../common/internal';
 import { hexToBase64, hrTimeToNanoseconds } from '@opentelemetry/core';
 import { SeverityNumber } from '@opentelemetry/api-logs';
+import { IKeyValue } from '../common/types';
+import { LogAttributes } from '@opentelemetry/api-logs';
 
 export function createExportLogsServiceRequest(
   logRecords: ReadableLogRecord[],
@@ -97,7 +99,7 @@ function toLogRecord(log: ReadableLogRecord, useHex?: boolean): ILogRecord {
     severityNumber: toSeverityNumber(log.severityNumber),
     severityText: log.severityText,
     body: toAnyValue(log.body),
-    attributes: toAttributes(log.attributes),
+    attributes: toLogAttributes(log.attributes),
     droppedAttributesCount: 0,
     flags: log.spanContext?.traceFlags,
     traceId: useHex
@@ -119,3 +121,7 @@ function optionalHexToBase64(str: string | undefined): string | undefined {
   if (str === undefined) return undefined;
   return hexToBase64(str);
 }
+
+export function toLogAttributes(attributes: LogAttributes): IKeyValue[] {
+  return Object.keys(attributes).map(key => toKeyValue(key, attributes[key]));
+}

experimental/packages/sdk-logs/package.json

@@ -69,7 +69,7 @@
   "sideEffects": false,
   "peerDependencies": {
     "@opentelemetry/api": ">=1.4.0 <1.5.0",
-    "@opentelemetry/api-logs": ">=0.38.0"
+    "@opentelemetry/api-logs": ">=0.39.1"
   },
   "devDependencies": {
     "@opentelemetry/api": ">=1.4.0 <1.5.0",

experimental/packages/sdk-logs/src/LogRecord.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Attributes, AttributeValue, diag } from '@opentelemetry/api';
+import { AttributeValue, diag } from '@opentelemetry/api';
 import type * as logsAPI from '@opentelemetry/api-logs';
 import * as api from '@opentelemetry/api';
 import {
@@ -27,14 +27,15 @@ import type { IResource } from '@opentelemetry/resources';
 import type { ReadableLogRecord } from './export/ReadableLogRecord';
 import type { LogRecordLimits } from './types';
 import { Logger } from './Logger';
+import { LogAttributes } from '@opentelemetry/api-logs';
 
 export class LogRecord implements ReadableLogRecord {
   readonly hrTime: api.HrTime;
   readonly hrTimeObserved: api.HrTime;
   readonly spanContext?: api.SpanContext;
   readonly resource: IResource;
   readonly instrumentationScope: InstrumentationScope;
-  readonly attributes: Attributes = {};
+  readonly attributes: logsAPI.LogAttributes = {};
   private _severityText?: string;
   private _severityNumber?: logsAPI.SeverityNumber;
   private _body?: string;
@@ -102,13 +103,20 @@ export class LogRecord implements ReadableLogRecord {
     this.setAttributes(attributes);
   }
 
-  public setAttribute(key: string, value?: AttributeValue) {
+  public setAttribute(key: string, value?: LogAttributes | AttributeValue) {
     if (this._isLogRecordReadonly()) {
       return this;
     }
     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;
@@ -128,7 +136,7 @@ export class LogRecord implements ReadableLogRecord {
     return this;
   }
 
-  public setAttributes(attributes: Attributes) {
+  public setAttributes(attributes: LogAttributes) {
     for (const [k, v] of Object.entries(attributes)) {
       this.setAttribute(k, v);
     }

experimental/packages/sdk-logs/src/export/ReadableLogRecord.ts

@@ -15,9 +15,9 @@
  */
 
 import type { IResource } from '@opentelemetry/resources';
-import type { Attributes, HrTime, SpanContext } from '@opentelemetry/api';
+import type { HrTime, SpanContext } from '@opentelemetry/api';
 import type { InstrumentationScope } from '@opentelemetry/core';
-import type { SeverityNumber } from '@opentelemetry/api-logs';
+import type { LogAttributes, SeverityNumber } from '@opentelemetry/api-logs';
 
 export interface ReadableLogRecord {
   readonly hrTime: HrTime;
@@ -28,5 +28,5 @@ export interface ReadableLogRecord {
   readonly body?: string;
   readonly resource: IResource;
   readonly instrumentationScope: InstrumentationScope;
-  readonly attributes: Attributes;
+  readonly attributes: LogAttributes;
 }

experimental/packages/sdk-logs/test/common/utils.ts

@@ -21,11 +21,12 @@ export const validAttributes = {
   'array<string>': ['str1', 'str2'],
   'array<number>': [1, 2],
   'array<bool>': [true, false],
+  object: { bar: 'foo' },
 };
 
 export const invalidAttributes = {
-  // invalid attribute type object
-  object: { foo: 'bar' },
+  // invalid attribute empty object
+  object: {},
   // invalid attribute inhomogeneous array
   'non-homogeneous-array': [0, ''],
   // This empty length attribute should not be set