fix: otlp json encoding (#4220)

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

experimental/CHANGELOG.md

@@ -13,6 +13,9 @@ All notable changes to experimental packages in this project will be documented
 * fix(sdk-node): remove the explicit dependency on @opentelemetry/exporter-jaeger that was kept on the previous release
  * '@opentelemetry/exporter-jaeger' is no longer be a dependency of this package. To continue using '@opentelemetry/exporter-jaeger', please install it manually.
  * NOTE: `@opentelemetry/exporter-jaeger` is deprecated, consider switching to one of the alternatives described [here](https://www.npmjs.com/package/@opentelemetry/exporter-jaeger)
+* fix(otlp-transformer): OTLP json encoding [#4220](https:/open-telemetry/opentelemetry-js/pull/4220) @seemk
+ * Fixes a bug in the OTLP (http/json) exporters where timestamps were not encoded as strings, causing the export to
+ be rejected by OTLP endpoints
 
 ### :books: (Refine Doc)
 

experimental/packages/exporter-logs-otlp-http/src/platform/browser/OTLPLogExporter.ts

@@ -48,7 +48,10 @@ export class OTLPLogExporter
  }
 
  convert(logRecords: ReadableLogRecord[]): IExportLogsServiceRequest {
- return createExportLogsServiceRequest(logRecords, true);
+ return createExportLogsServiceRequest(logRecords, {
+ useHex: true,
+ useLongBits: false,
+ });
  }
 
  getDefaultUrl(config: OTLPExporterConfigBase): string {

experimental/packages/exporter-logs-otlp-http/src/platform/node/OTLPLogExporter.ts

@@ -48,7 +48,10 @@ export class OTLPLogExporter
  }
 
  convert(logRecords: ReadableLogRecord[]): IExportLogsServiceRequest {
- return createExportLogsServiceRequest(logRecords, true);
+ return createExportLogsServiceRequest(logRecords, {
+ useHex: true,
+ useLongBits: false,
+ });
  }
 
  getDefaultUrl(config: OTLPExporterNodeConfigBase): string {

experimental/packages/exporter-logs-otlp-http/test/logHelper.ts

@@ -20,7 +20,6 @@ import { Resource } from '@opentelemetry/resources';
 import * as assert from 'assert';
 import { VERSION } from '@opentelemetry/core';
 import {
- hrTimeToFixed64Nanos,
  IAnyValue,
  IExportLogsServiceRequest,
  IKeyValue,
@@ -77,22 +76,17 @@ export function ensureExportedBodyIsCorrect(body?: IAnyValue) {
  );
 }
 
-function hrTimeToFixed64(hrTime: HrTime) {
- const { low, high } = hrTimeToFixed64Nanos(hrTime);
- return { low, high };
-}
-
 export function ensureExportedLogRecordIsCorrect(logRecord: ILogRecord) {
  ensureExportedBodyIsCorrect(logRecord.body);
  ensureExportedAttributesAreCorrect(logRecord.attributes);
  assert.deepStrictEqual(
  logRecord.timeUnixNano,
- hrTimeToFixed64(mockedReadableLogRecord.hrTime),
+ '1680253513123241635',
  'timeUnixNano is wrong'
  );
  assert.deepStrictEqual(
  logRecord.observedTimeUnixNano,
- hrTimeToFixed64(mockedReadableLogRecord.hrTimeObserved),
+ '1680253513123241635',
  'observedTimeUnixNano is wrong'
  );
  assert.strictEqual(

experimental/packages/exporter-trace-otlp-http/src/platform/browser/OTLPTraceExporter.ts

@@ -47,7 +47,10 @@ export class OTLPTraceExporter
  );
  }
  convert(spans: ReadableSpan[]): IExportTraceServiceRequest {
- return createExportTraceServiceRequest(spans, true);
+ return createExportTraceServiceRequest(spans, {
+ useHex: true,
+ useLongBits: false,
+ });
  }
 
  getDefaultUrl(config: OTLPExporterConfigBase): string {

experimental/packages/exporter-trace-otlp-http/src/platform/node/OTLPTraceExporter.ts

@@ -53,7 +53,10 @@ export class OTLPTraceExporter
  }
 
  convert(spans: ReadableSpan[]): IExportTraceServiceRequest {
- return createExportTraceServiceRequest(spans, true);
+ return createExportTraceServiceRequest(spans, {
+ useHex: true,
+ useLongBits: false,
+ });
  }
 
  getDefaultUrl(config: OTLPExporterNodeConfigBase): string {

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

@@ -31,7 +31,6 @@ import {
  ILink,
  IResource,
  ISpan,
- UnsignedLong,
 } from '@opentelemetry/otlp-transformer';
 
 if (typeof Buffer === 'undefined') {
@@ -244,59 +243,54 @@ export const multiInstrumentationLibraryTrace: ReadableSpan[] = [
  },
 ];
 
-function fixed64FromString(str: string) {
- const { low, high } = UnsignedLong.fromString(str);
- return { low, high };
-}
-
 export function ensureEventsAreCorrect(events: IEvent[]) {
  assert.deepStrictEqual(
  events,
  [
  {
- timeUnixNano: fixed64FromString('1574120165429803070'),
+ timeUnixNano: '1574120165429803070',
  name: 'fetchStart',
  attributes: [],
  droppedAttributesCount: 0,
  },
  {
- timeUnixNano: fixed64FromString('1574120165429803070'),
+ timeUnixNano: '1574120165429803070',
  name: 'domainLookupStart',
  attributes: [],
  droppedAttributesCount: 0,
  },
  {
- timeUnixNano: fixed64FromString('1574120165429803070'),
+ timeUnixNano: '1574120165429803070',
  name: 'domainLookupEnd',
  attributes: [],
  droppedAttributesCount: 0,
  },
  {
- timeUnixNano: fixed64FromString('1574120165429803070'),
+ timeUnixNano: '1574120165429803070',
  name: 'connectStart',
  attributes: [],
  droppedAttributesCount: 0,
  },
  {
- timeUnixNano: fixed64FromString('1574120165429803070'),
+ timeUnixNano: '1574120165429803070',
  name: 'connectEnd',
  attributes: [],
  droppedAttributesCount: 0,
  },
  {
- timeUnixNano: fixed64FromString('1574120165435513070'),
+ timeUnixNano: '1574120165435513070',
  name: 'requestStart',
  attributes: [],
  droppedAttributesCount: 0,
  },
  {
- timeUnixNano: fixed64FromString('1574120165436923070'),
+ timeUnixNano: '1574120165436923070',
  name: 'responseStart',
  attributes: [],
  droppedAttributesCount: 0,
  },
  {
- timeUnixNano: fixed64FromString('1574120165438688070'),
+ timeUnixNano: '1574120165438688070',
  name: 'responseEnd',
  attributes: [],
  droppedAttributesCount: 0,
@@ -372,12 +366,12 @@ export function ensureSpanIsCorrect(span: ISpan, useHex = true) {
  assert.strictEqual(span.kind, ESpanKind.SPAN_KIND_INTERNAL, 'kind is wrong');
  assert.deepStrictEqual(
  span.startTimeUnixNano,
- fixed64FromString('1574120165429803070'),
+ '1574120165429803070',
  'startTimeUnixNano is wrong'
  );
  assert.deepStrictEqual(
  span.endTimeUnixNano,
- fixed64FromString('1574120165438688070'),
+ '1574120165438688070',
  'endTimeUnixNano is wrong'
  );
  assert.strictEqual(

experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/test/metricsHelper.ts

@@ -33,11 +33,10 @@ import {
  View,
 } from '@opentelemetry/sdk-metrics';
 import {
- hrTimeToFixed64Nanos,
+ encodeAsString,
  IKeyValue,
  IMetric,
  IResource,
- UnsignedLong,
 } from '@opentelemetry/otlp-transformer';
 
 class TestMetricReader extends MetricReader {
@@ -152,14 +151,8 @@ export function ensureExportedCounterIsCorrect(
  assert.strictEqual(dp.asInt, '1');
  assert.strictEqual(dp.flags, 0);
 
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.startTimeUnixNano as string),
- hrTimeToFixed64Nanos(startTime)
- );
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.timeUnixNano as string),
- hrTimeToFixed64Nanos(time)
- );
+ assert.deepStrictEqual(dp.startTimeUnixNano, encodeAsString(startTime));
+ assert.deepStrictEqual(dp.timeUnixNano as string, encodeAsString(time));
 }
 
 export function ensureExportedObservableGaugeIsCorrect(
@@ -179,14 +172,8 @@ export function ensureExportedObservableGaugeIsCorrect(
  assert.strictEqual(dp.asDouble, 6);
  assert.strictEqual(dp.flags, 0);
 
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.startTimeUnixNano as string),
- hrTimeToFixed64Nanos(startTime)
- );
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.timeUnixNano as string),
- hrTimeToFixed64Nanos(time)
- );
+ assert.deepStrictEqual(dp.startTimeUnixNano, encodeAsString(startTime));
+ assert.deepStrictEqual(dp.timeUnixNano, encodeAsString(time));
 }
 
 export function ensureExportedHistogramIsCorrect(
@@ -215,14 +202,8 @@ export function ensureExportedHistogramIsCorrect(
  assert.strictEqual(dp.min, 7);
  assert.strictEqual(dp.max, 14);
 
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.startTimeUnixNano as string),
- hrTimeToFixed64Nanos(startTime)
- );
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.timeUnixNano as string),
- hrTimeToFixed64Nanos(time)
- );
+ assert.deepStrictEqual(dp.startTimeUnixNano, encodeAsString(startTime));
+ assert.deepStrictEqual(dp.timeUnixNano, encodeAsString(time));
  assert.deepStrictEqual(dp.bucketCounts, bucketCounts);
  assert.deepStrictEqual(dp.explicitBounds, explicitBounds);
 }

experimental/packages/opentelemetry-exporter-metrics-otlp-http/src/platform/browser/OTLPMetricExporter.ts

@@ -62,7 +62,7 @@ class OTLPExporterBrowserProxy extends OTLPExporterBrowserBase<
  }
 
  convert(metrics: ResourceMetrics[]): IExportMetricsServiceRequest {
- return createExportMetricsServiceRequest(metrics);
+ return createExportMetricsServiceRequest(metrics, { useLongBits: false });
  }
 }
 

experimental/packages/opentelemetry-exporter-metrics-otlp-http/src/platform/node/OTLPMetricExporter.ts

@@ -52,7 +52,7 @@ class OTLPExporterNodeProxy extends OTLPExporterNodeBase<
  }
 
  convert(metrics: ResourceMetrics[]): IExportMetricsServiceRequest {
- return createExportMetricsServiceRequest(metrics);
+ return createExportMetricsServiceRequest(metrics, { useLongBits: false });
  }
 
  getDefaultUrl(config: OTLPExporterNodeConfigBase): string {

experimental/packages/opentelemetry-exporter-metrics-otlp-http/test/metricsHelper.ts

@@ -34,7 +34,7 @@ import {
  View,
 } from '@opentelemetry/sdk-metrics';
 import {
- hrTimeToFixed64Nanos,
+ encodeAsString,
  IExportMetricsServiceRequest,
  IKeyValue,
  IMetric,
@@ -207,11 +207,6 @@ export function ensureWebResourceIsCorrect(resource: IResource) {
  assert.strictEqual(resource.droppedAttributesCount, 0);
 }
 
-function hrTimeToFixed64(hrTime: HrTime) {
- const { low, high } = hrTimeToFixed64Nanos(hrTime);
- return { low, high };
-}
-
 export function ensureCounterIsCorrect(
  metric: IMetric,
  time: HrTime,
@@ -228,8 +223,8 @@ export function ensureCounterIsCorrect(
 
  assert.deepStrictEqual(dp.attributes, []);
  assert.strictEqual(dp.asInt, 1);
- assert.deepStrictEqual(dp.startTimeUnixNano, hrTimeToFixed64(startTime));
- assert.deepStrictEqual(dp.timeUnixNano, hrTimeToFixed64(time));
+ assert.deepStrictEqual(dp.startTimeUnixNano, encodeAsString(startTime));
+ assert.deepStrictEqual(dp.timeUnixNano, encodeAsString(time));
 }
 
 export function ensureDoubleCounterIsCorrect(
@@ -273,8 +268,8 @@ export function ensureObservableGaugeIsCorrect(
  assert.deepStrictEqual(dp.attributes, []);
  assert.strictEqual(dp.asDouble, value);
 
- assert.deepStrictEqual(dp.startTimeUnixNano, hrTimeToFixed64(startTime));
- assert.deepStrictEqual(dp.timeUnixNano, hrTimeToFixed64(time));
+ assert.deepStrictEqual(dp.startTimeUnixNano, encodeAsString(startTime));
+ assert.deepStrictEqual(dp.timeUnixNano, encodeAsString(time));
 }
 
 export function ensureHistogramIsCorrect(
@@ -300,8 +295,8 @@ export function ensureHistogramIsCorrect(
  assert.deepStrictEqual(dp.bucketCounts, bucketCounts);
  assert.deepStrictEqual(dp.explicitBounds, explicitBounds);
 
- assert.deepStrictEqual(dp.startTimeUnixNano, hrTimeToFixed64(startTime));
- assert.deepStrictEqual(dp.timeUnixNano, hrTimeToFixed64(time));
+ assert.deepStrictEqual(dp.startTimeUnixNano, encodeAsString(startTime));
+ assert.deepStrictEqual(dp.timeUnixNano, encodeAsString(time));
 }
 
 export function ensureExportMetricsServiceRequestIsSet(

experimental/packages/opentelemetry-exporter-metrics-otlp-proto/test/metricsHelper.ts

@@ -31,11 +31,10 @@ import {
  View,
 } from '@opentelemetry/sdk-metrics';
 import {
- hrTimeToFixed64Nanos,
+ encodeAsString,
  IExportMetricsServiceRequest,
  IKeyValue,
  IMetric,
- UnsignedLong,
 } from '@opentelemetry/otlp-transformer';
 import { Stream } from 'stream';
 
@@ -147,14 +146,8 @@ export function ensureExportedCounterIsCorrect(
 
  const [dp] = metric.sum.dataPoints;
  assert.strictEqual(dp.asInt, '1');
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.startTimeUnixNano as string),
- hrTimeToFixed64Nanos(startTime)
- );
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.timeUnixNano as string),
- hrTimeToFixed64Nanos(time)
- );
+ assert.deepStrictEqual(dp.startTimeUnixNano, encodeAsString(startTime));
+ assert.deepStrictEqual(dp.timeUnixNano, encodeAsString(time));
 }
 
 export function ensureExportedObservableGaugeIsCorrect(
@@ -169,14 +162,8 @@ export function ensureExportedObservableGaugeIsCorrect(
 
  const [dp] = metric.gauge.dataPoints;
  assert.strictEqual(dp.asDouble, 6);
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.startTimeUnixNano as string),
- hrTimeToFixed64Nanos(startTime)
- );
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.timeUnixNano as string),
- hrTimeToFixed64Nanos(time)
- );
+ assert.deepStrictEqual(dp.startTimeUnixNano, encodeAsString(startTime));
+ assert.deepStrictEqual(dp.timeUnixNano, encodeAsString(time));
 }
 
 export function ensureExportedHistogramIsCorrect(
@@ -204,14 +191,8 @@ export function ensureExportedHistogramIsCorrect(
  assert.strictEqual(dp.max, 14);
  assert.deepStrictEqual(dp.explicitBounds, explicitBounds);
  assert.deepStrictEqual(dp.bucketCounts, bucketCounts);
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.startTimeUnixNano as string),
- hrTimeToFixed64Nanos(startTime)
- );
- assert.deepStrictEqual(
- UnsignedLong.fromString(dp.timeUnixNano as string),
- hrTimeToFixed64Nanos(time)
- );
+ assert.deepStrictEqual(dp.startTimeUnixNano, encodeAsString(startTime));
+ assert.deepStrictEqual(dp.timeUnixNano, encodeAsString(time));
 }
 
 export function ensureExportMetricsServiceRequestIsSet(