feat(api-logs): add ObservedTimestamp to LogRecord

open-telemetry · May 8, 2023 · 2d47386 · 2d47386
1 parent 7255da9
commit 2d47386
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 5 deletions.
diff --git a/experimental/packages/api-logs/src/types/LogRecord.ts b/experimental/packages/api-logs/src/types/LogRecord.ts
@@ -50,6 +50,11 @@ export interface LogRecord {
    */
   timestamp?: number;
 
+  /**
+   * Time when the event was observed by the collection system.
+   */
+  observedTimestamp?: number;
+
   /**
    * Numerical value of the severity.
    */

diff --git a/experimental/packages/exporter-logs-otlp-grpc/test/logsHelper.ts b/experimental/packages/exporter-logs-otlp-grpc/test/logsHelper.ts
@@ -45,6 +45,7 @@ export const mockedReadableLogRecord: ReadableLogRecord = {
     schemaUrl: 'http://url.to.schema',
   },
   hrTime: [1680253513, 123241635] as HrTime,
+  hrTimeObserved: [1683526948, 965142784] as HrTime,
   attributes: {
     'some-attribute': 'some attribute value',
   },
@@ -92,7 +93,7 @@ export function ensureExportedLogRecordIsCorrect(logRecord: ILogRecord) {
   );
   assert.strictEqual(
     logRecord.observedTimeUnixNano,
-    '1680253513123241728',
+    '1683526948965142784',
     'observedTimeUnixNano is wrong'
   );
   assert.strictEqual(

diff --git a/experimental/packages/otlp-transformer/src/logs/index.ts b/experimental/packages/otlp-transformer/src/logs/index.ts
@@ -93,7 +93,7 @@ function logRecordsToResourceLogs(
 function toLogRecord(log: ReadableLogRecord, useHex?: boolean): ILogRecord {
   return {
     timeUnixNano: hrTimeToNanoseconds(log.hrTime),
-    observedTimeUnixNano: hrTimeToNanoseconds(log.hrTime),
+    observedTimeUnixNano: hrTimeToNanoseconds(log.hrTimeObserved),
     severityNumber: toSeverityNumber(log.severityNumber),
     severityText: log.severityText,
     body: toAnyValue(log.body),

diff --git a/experimental/packages/otlp-transformer/test/logs.test.ts b/experimental/packages/otlp-transformer/test/logs.test.ts
@@ -52,7 +52,7 @@ function createExpectedLogJson(useHex: boolean): IExportLogsServiceRequest {
                 // eslint-disable-next-line @typescript-eslint/no-loss-of-precision
                 timeUnixNano: 1680253513123241635,
                 // eslint-disable-next-line @typescript-eslint/no-loss-of-precision
-                observedTimeUnixNano: 1680253513123241635,
+                observedTimeUnixNano: 1683526948965142784,
                 severityNumber: ESeverityNumber.SEVERITY_NUMBER_ERROR,
                 severityText: 'error',
                 body: { stringValue: 'some_log_body' },
@@ -105,6 +105,7 @@ describe('Logs', () => {
       };
       const log_fragment_1 = {
         hrTime: [1680253513, 123241635] as HrTime,
+        hrTimeObserved: [1683526948, 965142784] as HrTime,
         attributes: {
           'some-attribute': 'some attribute value',
         },
@@ -119,6 +120,7 @@ describe('Logs', () => {
       };
       const log_fragment_2 = {
         hrTime: [1680253797, 687038506] as HrTime,
+        hrTimeObserved: [1680253797, 687038506] as HrTime,
         attributes: {
           'another-attribute': 'another attribute value',
         },

diff --git a/experimental/packages/sdk-logs/src/LogRecord.ts b/experimental/packages/sdk-logs/src/LogRecord.ts
@@ -21,6 +21,7 @@ import {
   timeInputToHrTime,
   isAttributeValue,
   InstrumentationScope,
+  hrTime,
 } from '@opentelemetry/core';
 import type { IResource } from '@opentelemetry/resources';
 
@@ -30,6 +31,7 @@ import { Logger } from './Logger';
 
 export class LogRecord implements ReadableLogRecord {
   readonly hrTime: api.HrTime;
+  readonly hrTimeObserved: api.HrTime;
   readonly spanContext?: api.SpanContext;
   readonly resource: IResource;
   readonly instrumentationScope: InstrumentationScope;
@@ -73,15 +75,26 @@ export class LogRecord implements ReadableLogRecord {
 
   constructor(logger: Logger, logRecord: logsAPI.LogRecord) {
     const {
-      timestamp = Date.now(),
+      timestamp,
+      observedTimestamp,
       severityNumber,
       severityText,
       body,
       attributes = {},
       context,
     } = logRecord;
 
-    this.hrTime = timeInputToHrTime(timestamp);
+    if (timestamp && observedTimestamp) {
+      this.hrTime = timeInputToHrTime(timestamp);
+      this.hrTimeObserved = timeInputToHrTime(observedTimestamp);
+    } else {
+      const now = hrTime();
+      this.hrTime = timestamp ? timeInputToHrTime(timestamp) : now;
+      this.hrTimeObserved = observedTimestamp
+        ? timeInputToHrTime(observedTimestamp)
+        : now;
+    }
+
     if (context) {
       const spanContext = api.trace.getSpanContext(context);
       if (spanContext && api.isSpanContextValid(spanContext)) {

diff --git a/experimental/packages/sdk-logs/src/export/ReadableLogRecord.ts b/experimental/packages/sdk-logs/src/export/ReadableLogRecord.ts
@@ -21,6 +21,7 @@ import type { SeverityNumber } from '@opentelemetry/api-logs';
 
 export interface ReadableLogRecord {
   readonly hrTime: HrTime;
+  readonly hrTimeObserved: HrTime;
   readonly spanContext?: SpanContext;
   readonly severityText?: string;
   readonly severityNumber?: SeverityNumber;