Merge branch 'main' into sbom-npm

CHANGELOG.md

@@ -13,6 +13,8 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 ### :bug: (Bug Fix)
 
+* fix(sdk-metrics): increase the depth of the output to the console such that objects in the metric are printed fully to the console [#4522](https://github.com/open-telemetry/opentelemetry-js/pull/4522) @JacksonWeber
+
 ### :books: (Refine Doc)
 
 ### :house: (Internal)

CONTRIBUTING.md

@@ -104,7 +104,7 @@ An entry into `CHANGELOG.md` or `experimental/CHANGELOG.md` is required for the
 - Changes to default settings
 - New components being added
 
-It is reasonable to omit an entry to the changelog under these circuimstances:
+It is reasonable to omit an entry to the changelog under these circumstances:
 
 - Updating test to remove flakiness or improve coverage
 - Updates to the CI/CD process

api/README.md

@@ -36,7 +36,7 @@ npm install @opentelemetry/api @opentelemetry/sdk-trace-base
 
 ### Trace Your Application
 
-In order to get started with tracing, you will need to first register an SDK. The SDK you are using may provide a convenience method which calls the registration methods for you, but if you would like to call them directly they are documented here: [sdk registration methods][docs-sdk-registration].
+In order to get started with tracing, you will need to first register an SDK. The SDK you are using may provide a convenience method which calls the registration methods for you, but if you would like to call them directly they are documented here: [SDK registration methods][docs-sdk-registration].
 
 Once you have registered an SDK, you can start and end spans. A simple example of basic SDK registration and tracing a simple operation is below. The example should export spans to the console once per second. For more information, see the [tracing documentation][docs-tracing].
 

api/test/common/metrics/Metric.test.ts

@@ -42,7 +42,7 @@ describe('Metric', () => {
       const counter: Counter<Attributes> = {
         add(_value: number, _attribute: Attributes) {},
       };
-      // @ts-expect-error Expacting the type of Attributes
+      // @ts-expect-error Expecting the type of Attributes
       counter.add(1, { 'another-attribute': 'value' });
     });
   });
@@ -72,7 +72,7 @@ describe('Metric', () => {
       const counter: UpDownCounter<Attributes> = {
         add(_value: number, _attribute: Attributes) {},
       };
-      // @ts-expect-error Expacting the type of Attributes
+      // @ts-expect-error Expecting the type of Attributes
       counter.add(1, { 'another-attribute': 'value' });
     });
   });
@@ -102,7 +102,7 @@ describe('Metric', () => {
       const counter: Histogram<Attributes> = {
         record(_value: number, _attribute: Attributes) {},
       };
-      // @ts-expect-error Expacting the type of Attributes
+      // @ts-expect-error Expecting the type of Attributes
       counter.record(1, { 'another-attribute': 'value' });
     });
   });

doc/upgrade-guide.md

@@ -107,7 +107,7 @@ Collector exporter packages and types are renamed:
 
 - All plugins have been removed in favor of instrumentations.
 
-- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header endcoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [readme][otel-propagator-b3] for full details and usage.
+- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header encoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [README][otel-propagator-b3] for full details and usage.
 
 - Sampling configuration via environment variable has changed. If you were using `OTEL_SAMPLING_PROBABILITY` then you should replace it with `OTEL_TRACES_SAMPLER=parentbased_traceidratio` and `OTEL_TRACES_SAMPLER_ARG=<number>` where `<number>` is a number in the [0..1] range, e.g. "0.25". Default is 1.0 if unset.
 
@@ -232,7 +232,7 @@ Some types exported from `"@opentelemetry/api"` have been changed to be more spe
 
 ## 0.15.0 to 0.16.0
 
-[PR-1863](https://github.com/open-telemetry/opentelemetry-js/pull/1863) removed public attributes `keepAlive` and `httpAgentOptions` from nodejs `CollectorTraceExporter` and `CollectorMetricExporter`
+[PR-1863](https://github.com/open-telemetry/opentelemetry-js/pull/1863) removed public attributes `keepAlive` and `httpAgentOptions` from Node.js `CollectorTraceExporter` and `CollectorMetricExporter`
 
 ## 0.14.0 to 0.15.0
 

experimental/CHANGELOG.md

@@ -10,6 +10,9 @@ All notable changes to experimental packages in this project will be documented
 
 ### :bug: (Bug Fix)
 
+* fix(exporter-*-otlp-*): use parseHeaders() to ensure header-values are not 'undefined' #4540
+  * Fixes a bug where passing `undefined` as a header value would crash the end-user app after the export timeout elapsed.
+
 ### :books: (Refine Doc)
 
 ### :house: (Internal)
@@ -59,6 +62,19 @@ All notable changes to experimental packages in this project will be documented
   * This breaking change only affects users that are using the *experimental* `@opentelemetry/instrumentation/hook.mjs` loader hook AND Node.js 18.19 or later:
     * This reverts back to an older version of `import-in-the-middle` due to <https://github.com/DataDog/import-in-the-middle/issues/57>
     * This version does not support Node.js 18.19 or later
+* fix(exporter-*-otlp-grpc)!: lazy load gRPC to improve compatibility with `@opentelemetry/instrumenation-grpc` [#4432](https://github.com/open-telemetry/opentelemetry-js/pull/4432) @pichlermarc
+  * Fixes a bug where requiring up the gRPC exporter before enabling the instrumentation from `@opentelemetry/instrumentation-grpc` would lead to missing telemetry
+  * Breaking changes, removes several functions and properties that were used internally and were not intended for end-users
+    * `getServiceClientType()`
+      * this returned a static enum value that would denote the export type (`SPAN`, `METRICS`, `LOGS`)
+    * `getServiceProtoPath()`
+      * this returned a static enum value that would correspond to the gRPC service path
+    * `metadata`
+      * was used internally to access metadata, but as a side effect allowed end-users to modify metadata on runtime.
+    * `serviceClient`
+      * was used internally to keep track of the service client used by the exporter, as a side effect it allowed end-users to modify the gRPC service client that was used
+    * `compression`
+      * was used internally to keep track of the compression to use but was unintentionally exposed to the users. It allowed to read and write the value, writing, however, would have no effect.
 
 ### :bug: (Bug Fix)
 

experimental/packages/exporter-logs-otlp-grpc/src/OTLPLogExporter.ts

@@ -16,17 +16,17 @@
 
 import { LogRecordExporter, ReadableLogRecord } from '@opentelemetry/sdk-logs';
 import { baggageUtils, getEnv } from '@opentelemetry/core';
-import { Metadata } from '@grpc/grpc-js';
 import {
   OTLPGRPCExporterConfigNode,
   OTLPGRPCExporterNodeBase,
-  ServiceClientType,
   validateAndNormalizeUrl,
   DEFAULT_COLLECTOR_URL,
+  LogsSerializer,
 } from '@opentelemetry/otlp-grpc-exporter-base';
 import {
   createExportLogsServiceRequest,
   IExportLogsServiceRequest,
+  IExportLogsServiceResponse,
 } from '@opentelemetry/otlp-transformer';
 import { VERSION } from './version';
 
@@ -38,21 +38,27 @@ const USER_AGENT = {
  * OTLP Logs Exporter for Node
  */
 export class OTLPLogExporter
-  extends OTLPGRPCExporterNodeBase<ReadableLogRecord, IExportLogsServiceRequest>
+  extends OTLPGRPCExporterNodeBase<
+    ReadableLogRecord,
+    IExportLogsServiceRequest,
+    IExportLogsServiceResponse
+  >
   implements LogRecordExporter
 {
   constructor(config: OTLPGRPCExporterConfigNode = {}) {
-    super(config);
-    const headers = {
+    const signalSpecificMetadata = {
       ...USER_AGENT,
       ...baggageUtils.parseKeyPairsIntoRecord(
         getEnv().OTEL_EXPORTER_OTLP_LOGS_HEADERS
       ),
     };
-    this.metadata ||= new Metadata();
-    for (const [k, v] of Object.entries(headers)) {
-      this.metadata.set(k, v);
-    }
+    super(
+      config,
+      signalSpecificMetadata,
+      'LogsExportService',
+      '/opentelemetry.proto.collector.logs.v1.LogsService/Export',
+      LogsSerializer
+    );
   }
 
   convert(logRecords: ReadableLogRecord[]): IExportLogsServiceRequest {
@@ -63,14 +69,6 @@ export class OTLPLogExporter
     return validateAndNormalizeUrl(this.getUrlFromConfig(config));
   }
 
-  getServiceClientType() {
-    return ServiceClientType.LOGS;
-  }
-
-  getServiceProtoPath(): string {
-    return 'opentelemetry/proto/collector/logs/v1/logs_service.proto';
-  }
-
   getUrlFromConfig(config: OTLPGRPCExporterConfigNode): string {
     if (typeof config.url === 'string') {
       return config.url;

experimental/packages/exporter-logs-otlp-grpc/test/OTLPLogExporter.test.ts

@@ -32,7 +32,6 @@ import {
 } from './logsHelper';
 import * as core from '@opentelemetry/core';
 import { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base';
-import { GrpcCompressionAlgorithm } from '@opentelemetry/otlp-grpc-exporter-base';
 import {
   IExportLogsServiceRequest,
   IResourceLogs,
@@ -292,7 +291,7 @@ const testCollectorExporter = (params: TestParams) => {
         });
         assert.strictEqual(
           collectorExporter.compression,
-          GrpcCompressionAlgorithm.GZIP
+          CompressionAlgorithm.GZIP
         );
         delete envSource.OTEL_EXPORTER_OTLP_COMPRESSION;
       });
@@ -320,44 +319,54 @@ describe('OTLPLogExporter - node (getDefaultUrl)', () => {
 
 describe('when configuring via environment', () => {
   const envSource = process.env;
+
+  afterEach(function () {
+    // Ensure we don't pollute other tests if assertions fail
+    delete envSource.OTEL_EXPORTER_OTLP_ENDPOINT;
+    delete envSource.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT;
+    delete envSource.OTEL_EXPORTER_OTLP_HEADERS;
+    delete envSource.OTEL_EXPORTER_OTLP_LOGS_HEADERS;
+    sinon.restore();
+  });
+
   it('should use url defined in env', () => {
     envSource.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://foo.bar';
     const collectorExporter = new OTLPLogExporter();
     assert.strictEqual(collectorExporter.url, 'foo.bar');
-    envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
   });
   it('should override global exporter url with signal url defined in env', () => {
     envSource.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://foo.bar';
     envSource.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = 'http://foo.logs';
     const collectorExporter = new OTLPLogExporter();
     assert.strictEqual(collectorExporter.url, 'foo.logs');
-    envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
-    envSource.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = '';
   });
   it('should include user-agent header by default', () => {
     const collectorExporter = new OTLPLogExporter();
-    assert.deepStrictEqual(collectorExporter.metadata?.get('User-Agent'), [
+    const actualMetadata =
+      collectorExporter['_transport']['_parameters'].metadata();
+    assert.deepStrictEqual(actualMetadata.get('User-Agent'), [
       `OTel-OTLP-Exporter-JavaScript/${VERSION}`,
     ]);
   });
   it('should use headers defined via env', () => {
     envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=bar';
     const collectorExporter = new OTLPLogExporter();
-    assert.deepStrictEqual(collectorExporter.metadata?.get('foo'), ['bar']);
-    envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
+    const actualMetadata =
+      collectorExporter['_transport']['_parameters'].metadata();
+    assert.deepStrictEqual(actualMetadata.get('foo'), ['bar']);
   });
-  it('should override global headers config with signal headers defined via env', () => {
+  it('should not override hard-coded headers config with headers defined via env', () => {
     const metadata = new grpc.Metadata();
     metadata.set('foo', 'bar');
     metadata.set('goo', 'lol');
     envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=jar,bar=foo';
     envSource.OTEL_EXPORTER_OTLP_LOGS_HEADERS = 'foo=boo';
     const collectorExporter = new OTLPLogExporter({ metadata });
-    assert.deepStrictEqual(collectorExporter.metadata?.get('foo'), ['boo']);
-    assert.deepStrictEqual(collectorExporter.metadata?.get('bar'), ['foo']);
-    assert.deepStrictEqual(collectorExporter.metadata?.get('goo'), ['lol']);
-    envSource.OTEL_EXPORTER_OTLP_LOGS_HEADERS = '';
-    envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
+    const actualMetadata =
+      collectorExporter['_transport']['_parameters'].metadata();
+    assert.deepStrictEqual(actualMetadata.get('foo'), ['bar']);
+    assert.deepStrictEqual(actualMetadata.get('goo'), ['lol']);
+    assert.deepStrictEqual(actualMetadata.get('bar'), ['foo']);
   });
 });
 

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

@@ -21,7 +21,10 @@ import type {
 import type { OTLPExporterNodeConfigBase } from '@opentelemetry/otlp-exporter-base';
 import type { IExportLogsServiceRequest } from '@opentelemetry/otlp-transformer';
 import { getEnv, baggageUtils } from '@opentelemetry/core';
-import { OTLPExporterNodeBase } from '@opentelemetry/otlp-exporter-base';
+import {
+  OTLPExporterNodeBase,
+  parseHeaders,
+} from '@opentelemetry/otlp-exporter-base';
 import { createExportLogsServiceRequest } from '@opentelemetry/otlp-transformer';
 
 import { getDefaultUrl } from '../config';
@@ -50,7 +53,7 @@ export class OTLPLogExporter
       ...baggageUtils.parseKeyPairsIntoRecord(
         getEnv().OTEL_EXPORTER_OTLP_LOGS_HEADERS
       ),
-      ...config.headers,
+      ...parseHeaders(config?.headers),
     };
   }
 

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

@@ -19,6 +19,7 @@ import {
   OTLPExporterConfigBase,
   appendResourcePathToUrl,
   appendRootPathToUrlIfNeeded,
+  parseHeaders,
 } from '@opentelemetry/otlp-exporter-base';
 import {
   OTLPProtoExporterNodeBase,
@@ -57,7 +58,7 @@ export class OTLPLogExporter
       ...baggageUtils.parseKeyPairsIntoRecord(
         getEnv().OTEL_EXPORTER_OTLP_LOGS_HEADERS
       ),
-      ...config.headers,
+      ...parseHeaders(config?.headers),
     };
   }
   convert(logs: ReadableLogRecord[]): IExportLogsServiceRequest {

experimental/packages/exporter-trace-otlp-grpc/src/OTLPTraceExporter.ts

@@ -16,17 +16,17 @@
 
 import { ReadableSpan, SpanExporter } from '@opentelemetry/sdk-trace-base';
 import { baggageUtils, getEnv } from '@opentelemetry/core';
-import { Metadata } from '@grpc/grpc-js';
 import {
   OTLPGRPCExporterConfigNode,
   OTLPGRPCExporterNodeBase,
-  ServiceClientType,
   validateAndNormalizeUrl,
   DEFAULT_COLLECTOR_URL,
+  TraceSerializer,
 } from '@opentelemetry/otlp-grpc-exporter-base';
 import {
   createExportTraceServiceRequest,
   IExportTraceServiceRequest,
+  IExportTraceServiceResponse,
 } from '@opentelemetry/otlp-transformer';
 import { VERSION } from './version';
 
@@ -38,21 +38,27 @@ const USER_AGENT = {
  * OTLP Trace Exporter for Node
  */
 export class OTLPTraceExporter
-  extends OTLPGRPCExporterNodeBase<ReadableSpan, IExportTraceServiceRequest>
+  extends OTLPGRPCExporterNodeBase<
+    ReadableSpan,
+    IExportTraceServiceRequest,
+    IExportTraceServiceResponse
+  >
   implements SpanExporter
 {
   constructor(config: OTLPGRPCExporterConfigNode = {}) {
-    super(config);
-    const headers = {
+    const signalSpecificMetadata = {
       ...USER_AGENT,
       ...baggageUtils.parseKeyPairsIntoRecord(
         getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
       ),
     };
-    this.metadata ||= new Metadata();
-    for (const [k, v] of Object.entries(headers)) {
-      this.metadata.set(k, v);
-    }
+    super(
+      config,
+      signalSpecificMetadata,
+      'TraceExportService',
+      '/opentelemetry.proto.collector.trace.v1.TraceService/Export',
+      TraceSerializer
+    );
   }
 
   convert(spans: ReadableSpan[]): IExportTraceServiceRequest {
@@ -63,14 +69,6 @@ export class OTLPTraceExporter
     return validateAndNormalizeUrl(this.getUrlFromConfig(config));
   }
 
-  getServiceClientType() {
-    return ServiceClientType.SPANS;
-  }
-
-  getServiceProtoPath(): string {
-    return 'opentelemetry/proto/collector/trace/v1/trace_service.proto';
-  }
-
   getUrlFromConfig(config: OTLPGRPCExporterConfigNode): string {
     if (typeof config.url === 'string') {
       return config.url;