Upgrade to otel sdk v2 (#1789)

* Upgrade @opentelemetry/resources

* Upgrade @opentelemetry/core

* Use new environment variable utilities

* Determine version of otel js sdk using npm list, as the VERSION variable is no longer exported in version 2.0.0

* Set span processors through TracerProvider constructor instead of deprecated addSpanProcessor method, remove support for configureTracerProvider global method

* Use node tracer provider instead of custom implementation

* Set trace exporters based on OTEL_TRACES_EXPORTER env var

* Upgrade remaining packages to v2 versions

* Update minimum node version

* Raise compilation target to ES2022

* Remove redundant lockfile

* Remove zipkin exporter from default supported exporters through env vars

* Allow exporters set through env vars to overwrite the config from the configureTracer global func

* Reassign exporterName with lowercased and trimmed value

Author: wpessers

.github/workflows/release-layer-nodejs.yml

@@ -40,7 +40,7 @@ jobs:
       - name: Save Node SDK Version
         id: save-node-sdk-version
         run: |
-          SDK_VERSION=$(node version.js)
+          SDK_VERSION=$(npm list @opentelemetry/core --depth=0 | grep @opentelemetry/core | sed 's/^.*@//')
           echo "SDK_VERSION=$SDK_VERSION" >> $GITHUB_OUTPUT
         working-directory: nodejs/packages/layer/scripts
 

README.md

@@ -102,7 +102,7 @@ The table below captures the state of various features and their levels of suppo
 
 The following are runtimes which are no longer or not yet supported by this repository:
 
-* Node.js 12 - not [officially supported](https://github.com/open-telemetry/opentelemetry-js#supported-runtimes) by OpenTelemetry JS
+* Node.js 12, Node.js 16 - not [officially supported](https://github.com/open-telemetry/opentelemetry-js#supported-runtimes) by OpenTelemetry JS
 
 [1]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/faas-spans.md#general-attributes
 [2]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/faas-spans.md#incoming-invocations

nodejs/package-lock.json

@@ -33,56 +33,56 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=18.19.0"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/api-logs": "^0.57.2",
-    "@opentelemetry/context-async-hooks": "^1.30.1",
-    "@opentelemetry/core": "^1.30.0",
-    "@opentelemetry/exporter-logs-otlp-http": "^0.57.2",
-    "@opentelemetry/exporter-metrics-otlp-http": "^0.57.2",
-    "@opentelemetry/exporter-trace-otlp-http": "^0.57.2",
-    "@opentelemetry/instrumentation": "^0.57.2",
-    "@opentelemetry/instrumentation-amqplib": "^0.46.1",
-    "@opentelemetry/instrumentation-aws-lambda": "^0.50.3",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.49.1",
-    "@opentelemetry/instrumentation-bunyan": "^0.45.1",
-    "@opentelemetry/instrumentation-cassandra-driver": "^0.45.1",
-    "@opentelemetry/instrumentation-connect": "^0.43.1",
-    "@opentelemetry/instrumentation-dataloader": "^0.16.1",
-    "@opentelemetry/instrumentation-dns": "^0.43.1",
-    "@opentelemetry/instrumentation-express": "^0.47.1",
-    "@opentelemetry/instrumentation-fs": "^0.19.1",
-    "@opentelemetry/instrumentation-graphql": "^0.47.1",
-    "@opentelemetry/instrumentation-grpc": "^0.57.2",
-    "@opentelemetry/instrumentation-hapi": "^0.45.2",
-    "@opentelemetry/instrumentation-http": "^0.57.2",
-    "@opentelemetry/instrumentation-ioredis": "^0.47.1",
-    "@opentelemetry/instrumentation-kafkajs": "^0.7.1",
-    "@opentelemetry/instrumentation-knex": "^0.44.1",
-    "@opentelemetry/instrumentation-koa": "^0.47.1",
-    "@opentelemetry/instrumentation-memcached": "^0.43.1",
-    "@opentelemetry/instrumentation-mongodb": "^0.52.0",
-    "@opentelemetry/instrumentation-mongoose": "^0.46.1",
-    "@opentelemetry/instrumentation-mysql": "^0.45.1",
-    "@opentelemetry/instrumentation-mysql2": "^0.45.2",
-    "@opentelemetry/instrumentation-nestjs-core": "^0.44.1",
-    "@opentelemetry/instrumentation-net": "^0.43.1",
-    "@opentelemetry/instrumentation-pg": "^0.51.1",
-    "@opentelemetry/instrumentation-pino": "^0.46.1",
-    "@opentelemetry/instrumentation-redis": "^0.46.1",
-    "@opentelemetry/instrumentation-restify": "^0.45.1",
-    "@opentelemetry/instrumentation-socket.io": "^0.46.1",
-    "@opentelemetry/instrumentation-undici": "^0.10.1",
-    "@opentelemetry/instrumentation-winston": "^0.44.1",
-    "@opentelemetry/propagator-aws-xray": "^1.26.2",
-    "@opentelemetry/propagator-aws-xray-lambda": "^0.53.2",
-    "@opentelemetry/resource-detector-aws": "^1.12.0",
-    "@opentelemetry/resources": "^1.30.0",
-    "@opentelemetry/sdk-logs": "^0.57.0",
-    "@opentelemetry/sdk-metrics": "^1.30.0",
-    "@opentelemetry/sdk-trace-base": "^1.30.0"
+    "@opentelemetry/api-logs": "^0.200.0",
+    "@opentelemetry/context-async-hooks": "^2.0.0",
+    "@opentelemetry/core": "^2.0.0",
+    "@opentelemetry/exporter-logs-otlp-http": "^0.200.0",
+    "@opentelemetry/exporter-metrics-otlp-http": "^0.200.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.200.0",
+    "@opentelemetry/instrumentation": "^0.200.0",
+    "@opentelemetry/instrumentation-amqplib": "^0.47.0",
+    "@opentelemetry/instrumentation-aws-lambda": "^0.51.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.51.0",
+    "@opentelemetry/instrumentation-bunyan": "^0.46.0",
+    "@opentelemetry/instrumentation-cassandra-driver": "^0.46.0",
+    "@opentelemetry/instrumentation-connect": "^0.44.0",
+    "@opentelemetry/instrumentation-dataloader": "^0.17.0",
+    "@opentelemetry/instrumentation-dns": "^0.44.0",
+    "@opentelemetry/instrumentation-express": "^0.48.1",
+    "@opentelemetry/instrumentation-fs": "^0.20.0",
+    "@opentelemetry/instrumentation-graphql": "^0.48.0",
+    "@opentelemetry/instrumentation-grpc": "^0.200.0",
+    "@opentelemetry/instrumentation-hapi": "^0.46.0",
+    "@opentelemetry/instrumentation-http": "^0.200.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.48.0",
+    "@opentelemetry/instrumentation-kafkajs": "^0.9.1",
+    "@opentelemetry/instrumentation-knex": "^0.45.0",
+    "@opentelemetry/instrumentation-koa": "^0.48.0",
+    "@opentelemetry/instrumentation-memcached": "^0.44.0",
+    "@opentelemetry/instrumentation-mongodb": "^0.53.0",
+    "@opentelemetry/instrumentation-mongoose": "^0.47.0",
+    "@opentelemetry/instrumentation-mysql": "^0.46.0",
+    "@opentelemetry/instrumentation-mysql2": "^0.46.0",
+    "@opentelemetry/instrumentation-nestjs-core": "^0.46.0",
+    "@opentelemetry/instrumentation-net": "^0.44.0",
+    "@opentelemetry/instrumentation-pg": "^0.52.0",
+    "@opentelemetry/instrumentation-pino": "^0.47.0",
+    "@opentelemetry/instrumentation-redis": "^0.47.0",
+    "@opentelemetry/instrumentation-restify": "^0.46.0",
+    "@opentelemetry/instrumentation-socket.io": "^0.47.0",
+    "@opentelemetry/instrumentation-undici": "^0.11.0",
+    "@opentelemetry/instrumentation-winston": "^0.45.0",
+    "@opentelemetry/propagator-aws-xray": "^2.0.0",
+    "@opentelemetry/propagator-aws-xray-lambda": "^0.54.0",
+    "@opentelemetry/resource-detector-aws": "^2.0.0",
+    "@opentelemetry/resources": "^2.0.0",
+    "@opentelemetry/sdk-logs": "^0.200.0",
+    "@opentelemetry/sdk-metrics": "^2.0.0",
+    "@opentelemetry/sdk-trace-node": "^2.0.0"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.9",

nodejs/packages/layer/package-lock.json

@@ -10,22 +10,24 @@ import {
 } from '@opentelemetry/api';
 import {
   CompositePropagator,
-  getEnv,
+  diagLogLevelFromString,
+  getStringFromEnv,
   W3CBaggagePropagator,
   W3CTraceContextPropagator,
 } from '@opentelemetry/core';
 import {
-  BasicTracerProvider,
   BatchSpanProcessor,
   ConsoleSpanExporter,
+  NodeTracerProvider,
   SDKRegistrationConfig,
   SimpleSpanProcessor,
+  SpanExporter,
   TracerConfig,
-} from '@opentelemetry/sdk-trace-base';
+} from '@opentelemetry/sdk-trace-node';
 import {
-  detectResourcesSync,
+  detectResources,
   envDetector,
-  IResource,
+  Resource,
   processDetector,
 } from '@opentelemetry/resources';
 import { awsLambdaDetector } from '@opentelemetry/resource-detector-aws';
@@ -45,8 +47,6 @@ import {
 import { AWSXRayPropagator } from '@opentelemetry/propagator-aws-xray';
 import { AWSXRayLambdaPropagator } from '@opentelemetry/propagator-aws-xray-lambda';
 
-import { LambdaTracerProvider } from './LambdaTracerProvider';
-
 const defaultInstrumentationList = [
   'dns',
   'express',
@@ -83,10 +83,6 @@ declare global {
     defaultSdkRegistration: SDKRegistrationConfig,
   ): SDKRegistrationConfig;
   function configureTracer(defaultConfig: TracerConfig): TracerConfig;
-  /**
-   * @deprecated please use {@link configureTracer} instead.
-   */
-  function configureTracerProvider(tracerProvider: BasicTracerProvider): void;
 
   // No explicit metric type here, but "unknown" type.
   // Because metric packages are important dynamically.
@@ -359,32 +355,79 @@ function getPropagator(): TextMapPropagator {
   return new CompositePropagator({ propagators });
 }
 
+function getExportersFromEnv(): SpanExporter[] | null {
+  if (
+    process.env.OTEL_TRACES_EXPORTER == null ||
+    process.env.OTEL_TRACES_EXPORTER.trim() === ''
+  ) {
+    return [];
+  }
+  if (process.env.OTEL_TRACES_EXPORTER.includes('none')) {
+    return null;
+  }
+
+  const stringToExporter = new Map<string, () => SpanExporter>([
+    ['otlp', () => new OTLPTraceExporter()],
+    ['console', () => new ConsoleSpanExporter()],
+  ]);
+  const exporters: SpanExporter[] = [];
+  process.env.OTEL_TRACES_EXPORTER.split(',').map(exporterName => {
+    exporterName = exporterName.toLowerCase().trim();
+    const exporter = stringToExporter.get(exporterName);
+    if (exporter) {
+      exporters.push(exporter());
+    } else {
+      diag.warn(
+        `Invalid exporter "${exporterName}" specified in the environment variable OTEL_TRACES_EXPORTER`,
+      );
+    }
+  });
+  return exporters;
+}
+
 async function initializeTracerProvider(
-  resource: IResource,
-): Promise<TracerProvider> {
+  resource: Resource,
+): Promise<TracerProvider | undefined> {
   let config: TracerConfig = {
     resource,
+    spanProcessors: [],
   };
+
+  const exporters = getExportersFromEnv();
+  if (!exporters) {
+    return;
+  }
+
   if (typeof configureTracer === 'function') {
     config = configureTracer(config);
   }
 
-  const tracerProvider = new LambdaTracerProvider(config);
-  if (typeof configureTracerProvider === 'function') {
-    configureTracerProvider(tracerProvider);
-  } else {
-    // Defaults
-    tracerProvider.addSpanProcessor(
-      new BatchSpanProcessor(new OTLPTraceExporter()),
-    );
+  if (exporters.length) {
+    config.spanProcessors = [];
+    exporters.map(exporter => {
+      if (exporter instanceof ConsoleSpanExporter) {
+        config.spanProcessors?.push(new SimpleSpanProcessor(exporter));
+      } else {
+        config.spanProcessors?.push(new BatchSpanProcessor(exporter));
+      }
+    });
+  }
+
+  config.spanProcessors = config.spanProcessors || [];
+  if (config.spanProcessors.length === 0) {
+    // Default
+    config.spanProcessors.push(new BatchSpanProcessor(new OTLPTraceExporter()));
   }
+
   // Logging for debug
   if (logLevel === DiagLogLevel.DEBUG) {
-    tracerProvider.addSpanProcessor(
+    config.spanProcessors.push(
       new SimpleSpanProcessor(new ConsoleSpanExporter()),
     );
   }
 
+  const tracerProvider = new NodeTracerProvider(config);
+
   let sdkRegistrationConfig: SDKRegistrationConfig = {};
   if (typeof configureSdkRegistration === 'function') {
     sdkRegistrationConfig = configureSdkRegistration(sdkRegistrationConfig);
@@ -399,7 +442,7 @@ async function initializeTracerProvider(
 }
 
 async function initializeMeterProvider(
-  resource: IResource,
+  resource: Resource,
 ): Promise<unknown | undefined> {
   if (process.env.OTEL_METRICS_EXPORTER === 'none') {
     return;
@@ -442,7 +485,7 @@ async function initializeMeterProvider(
 }
 
 async function initializeLoggerProvider(
-  resource: IResource,
+  resource: Resource,
 ): Promise<unknown | undefined> {
   if (process.env.OTEL_LOGS_EXPORTER === 'none') {
     return;
@@ -488,11 +531,11 @@ async function initializeLoggerProvider(
 }
 
 async function initializeProvider() {
-  const resource = detectResourcesSync({
+  const resource = detectResources({
     detectors: [awsLambdaDetector, envDetector, processDetector],
   });
 
-  const tracerProvider: TracerProvider =
+  const tracerProvider: TracerProvider | undefined =
     await initializeTracerProvider(resource);
   const meterProvider: unknown | undefined =
     await initializeMeterProvider(resource);
@@ -576,5 +619,5 @@ let metricsDisableFunction: () => void;
 let logsDisableFunction: () => void;
 
 // Configure lambda logging
-const logLevel = getEnv().OTEL_LOG_LEVEL;
+const logLevel = diagLogLevelFromString(getStringFromEnv('OTEL_LOG_LEVEL'));
 diag.setLogger(new DiagConsoleLogger(), logLevel);

nodejs/packages/layer/package.json

@@ -10,7 +10,7 @@ import {
 import {
   BatchSpanProcessor,
   InMemorySpanExporter
-} from '@opentelemetry/sdk-trace-base';
+} from '@opentelemetry/sdk-trace-node';
 
 import { registerLoader } from '../src/loader.mjs';
 import { init, wrap, unwrap } from '../build/src/wrapper.js';

nodejs/packages/layer/scripts/version.js

@@ -7,7 +7,7 @@ import {
   BatchSpanProcessor,
   InMemorySpanExporter,
   ReadableSpan,
-} from '@opentelemetry/sdk-trace-base';
+} from '@opentelemetry/sdk-trace-node';
 import { Context } from 'aws-lambda';
 
 import { init, wrap, unwrap } from '../src/wrapper';