feat(otlp): Update to latest OpenTelemetry SDKs (#18)

* Update to latest OpenTelemetry SDKs

* add a comment

* remove unnecessary dependencies

Author: djMax

__tests__/fake-serv.test.ts

@@ -1,18 +1,16 @@
 import http from 'http';
 import path from 'path';
 
-import { afterAll, beforeAll, describe, expect, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 import request from 'supertest';
 
 import {
   listen,
   ServiceStartOptions,
-  shutdownGlobalTelemetry,
   startApp,
-  startGlobalTelemetry,
 } from '../src/index';
 
-import { FakeServLocals, service } from './fake-serv/src/index';
+import { type FakeServLocals, service } from './fake-serv/src/index';
 
 function httpRequest(options: http.RequestOptions) {
   return new Promise((resolve, reject) => {
@@ -33,14 +31,6 @@ function httpRequest(options: http.RequestOptions) {
 }
 
 describe('fake-serv', () => {
-  beforeAll(() => {
-    startGlobalTelemetry('fake-serv');
-  });
-
-  afterAll(async () => {
-    await shutdownGlobalTelemetry();
-  });
-
   test('basic service functionality', async () => {
     const options: ServiceStartOptions<FakeServLocals> = {
       service,
@@ -101,7 +91,6 @@ describe('fake-serv', () => {
       .get('/metrics')
       .expect(200)
       .expect((res) => {
-        // console.error(`---\n${res.text}\n---`);
         expect(res.text).toMatch(/nodejs_version_info{version/);
         expect(res.text).toMatch(/# UNIT http_server_duration ms/);
         expect(res.text).toMatch(/world_requests_total{method="get"} 1/);

__tests__/vitest.test-setup.ts

@@ -0,0 +1,15 @@
+import { afterAll, beforeAll } from 'vitest';
+
+import { shutdownGlobalTelemetry, startGlobalTelemetry } from '../src/telemetry';
+
+// Even in testing, this needs to run first so that the instrumentation
+// is loaded BEFORE express is loaded.
+const startPromise = startGlobalTelemetry('fake-serv');
+
+beforeAll(async () => {
+  await startPromise;
+});
+
+afterAll(async () => {
+  await shutdownGlobalTelemetry();
+});

package.json

@@ -59,26 +59,22 @@
   "homepage": "https://github.com/openapi-typescript-infra/service#readme",
   "dependencies": {
     "@godaddy/terminus": "^4.12.1",
-    "@opentelemetry/api": "^1.7.0",
-    "@opentelemetry/exporter-prometheus": "^0.43.0",
-    "@opentelemetry/exporter-trace-otlp-proto": "^0.43.0",
-    "@opentelemetry/instrumentation": "^0.43.0",
-    "@opentelemetry/instrumentation-dns": "^0.32.4",
-    "@opentelemetry/instrumentation-express": "^0.33.3",
-    "@opentelemetry/instrumentation-generic-pool": "^0.32.4",
-    "@opentelemetry/instrumentation-graphql": "^0.35.2",
-    "@opentelemetry/instrumentation-http": "^0.43.0",
-    "@opentelemetry/instrumentation-ioredis": "^0.35.3",
-    "@opentelemetry/instrumentation-net": "^0.32.4",
-    "@opentelemetry/instrumentation-pg": "^0.36.2",
-    "@opentelemetry/instrumentation-pino": "^0.34.4",
-    "@opentelemetry/resource-detector-container": "^0.3.4",
-    "@opentelemetry/resource-detector-gcp": "^0.29.4",
-    "@opentelemetry/resources": "^1.18.1",
-    "@opentelemetry/sdk-metrics": "^1.18.1",
-    "@opentelemetry/sdk-node": "^0.43.0",
-    "@opentelemetry/sdk-trace-base": "^1.18.1",
-    "@opentelemetry/semantic-conventions": "^1.18.1",
+    "@opentelemetry/api": "^1.8.0",
+    "@opentelemetry/exporter-prometheus": "^0.51.0",
+    "@opentelemetry/instrumentation-dns": "^0.36.0",
+    "@opentelemetry/instrumentation-express": "^0.38.0",
+    "@opentelemetry/instrumentation-generic-pool": "^0.36.0",
+    "@opentelemetry/instrumentation-graphql": "^0.40.0",
+    "@opentelemetry/instrumentation-http": "^0.51.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.40.0",
+    "@opentelemetry/instrumentation-net": "^0.36.0",
+    "@opentelemetry/instrumentation-pg": "^0.41.0",
+    "@opentelemetry/instrumentation-pino": "^0.38.0",
+    "@opentelemetry/instrumentation-undici": "^0.2.0",
+    "@opentelemetry/resource-detector-container": "^0.3.9",
+    "@opentelemetry/resource-detector-gcp": "^0.29.9",
+    "@opentelemetry/sdk-node": "^0.51.0",
+    "@opentelemetry/semantic-conventions": "^1.24.0",
     "@sesamecare-oss/confit": "^2.2.1",
     "@sesamecare-oss/opentelemetry-node-metrics": "^1.0.1",
     "ajv": "^8.12.0",
@@ -89,15 +85,14 @@
     "glob": "^8.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.8",
-    "opentelemetry-instrumentation-fetch-node": "^1.2.0",
     "pino": "^8.21.0",
     "read-pkg-up": "^7.0.1",
     "request-ip": "^3.3.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.3.0",
     "@commitlint/config-conventional": "^19.2.2",
-    "@openapi-typescript-infra/coconfig": "^4.3.0",
+    "@openapi-typescript-infra/coconfig": "^4.4.0",
     "@semantic-release/commit-analyzer": "^12.0.0",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/github": "^10.0.3",

src/telemetry/index.ts

@@ -1,4 +1,3 @@
-import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api';
 import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto';
 import * as opentelemetry from '@opentelemetry/sdk-node';
 import { PrometheusExporter } from '@opentelemetry/exporter-prometheus';
@@ -13,11 +12,11 @@ import type {
 import type { ListenFn, StartAppFn } from '../express-app/index';
 import type { ConfigurationSchema } from '../config/schema';
 
-import { getAutoInstrumentations, getResourceDetectors } from './instrumentations';
+import { getAutoInstrumentations, getResource } from './instrumentations';
 import { DummySpanExporter } from './DummyExporter';
 
 // For troubleshooting, set the log level to DiagLogLevel.DEBUG
-diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO);
+opentelemetry.api.diag.setLogger(new (opentelemetry.api.DiagConsoleLogger)(), opentelemetry.api.DiagLogLevel.INFO);
 
 function getExporter() {
   if (
@@ -46,16 +45,17 @@ let telemetrySdk: opentelemetry.NodeSDK | undefined;
  * In addition, since we have to load it right away before configuration
  * is available, we can't use configuration to decide anything.
  */
-export function startGlobalTelemetry(serviceName: string) {
+export async function startGlobalTelemetry(serviceName: string) {
   if (!prometheusExporter) {
     prometheusExporter = new PrometheusExporter({ preventServerStart: true });
+    const instrumentations = getAutoInstrumentations();
     telemetrySdk = new opentelemetry.NodeSDK({
       serviceName,
-      autoDetectResources: true,
+      autoDetectResources: false,
       traceExporter: getExporter(),
-      resourceDetectors: getResourceDetectors(),
+      resource: await getResource(),
       metricReader: prometheusExporter,
-      instrumentations: [getAutoInstrumentations()],
+      instrumentations,
       views: [
         new opentelemetry.metrics.View({
           instrumentName: 'http_request_duration_seconds',
@@ -76,7 +76,6 @@ export function getGlobalPrometheusExporter() {
 }
 
 export async function shutdownGlobalTelemetry() {
-  await prometheusExporter?.shutdown();
   await telemetrySdk?.shutdown();
   telemetrySdk = undefined;
   prometheusExporter = undefined;
@@ -86,7 +85,7 @@ export async function startWithTelemetry<
   SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>,
   RLocals extends RequestLocals = RequestLocals,
 >(options: DelayLoadServiceStartOptions) {
-  startGlobalTelemetry(options.name);
+  await startGlobalTelemetry(options.name);
 
   // eslint-disable-next-line import/no-unresolved, @typescript-eslint/no-var-requires
   const { startApp, listen } = require('../express-app/app.js') as {

src/telemetry/instrumentations.ts

@@ -1,7 +1,7 @@
 import type { Instrumentation } from '@opentelemetry/instrumentation';
 import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';
 import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
-import { FetchInstrumentation } from 'opentelemetry-instrumentation-fetch-node';
+import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici';
 import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
 import { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis';
@@ -11,8 +11,9 @@ import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino';
 import { containerDetector } from '@opentelemetry/resource-detector-container';
 import { gcpDetector } from '@opentelemetry/resource-detector-gcp';
 import {
-  Detector,
-  DetectorSync,
+  Resource,
+  detectResources,
+  detectResourcesSync,
   envDetectorSync,
   hostDetectorSync,
   osDetectorSync,
@@ -23,7 +24,7 @@ const InstrumentationMap = {
   '@opentelemetry/instrumentation-http': HttpInstrumentation,
   '@opentelemetry/instrumentation-dns': DnsInstrumentation,
   '@opentelemetry/instrumentation-express': ExpressInstrumentation,
-  'opentelemetry-instrumentation-fetch-node': FetchInstrumentation,
+  '@opentelemetry/instrumentation-undici': UndiciInstrumentation,
   '@opentelemetry/instrumentation-generic-pool': GenericPoolInstrumentation,
   '@opentelemetry/instrumentation-ioredis': IORedisInstrumentation,
   '@opentelemetry/instrumentation-net': NetInstrumentation,
@@ -58,13 +59,22 @@ export function getAutoInstrumentations(
     .filter((i) => !!i) as Instrumentation[];
 }
 
-export function getResourceDetectors(): (Detector | DetectorSync)[] {
-  return [
-    containerDetector,
+// Async function to get combined resources
+export async function getResource(): Promise<Resource> {
+  const syncDetectors = [
     envDetectorSync,
     hostDetectorSync,
     osDetectorSync,
     processDetectorSync,
+  ];
+  const asyncDetectors = [
+    containerDetector,
     gcpDetector,
   ];
+
+  const asyncResources = await detectResources({ detectors: asyncDetectors });
+  const syncResources = detectResourcesSync({ detectors: syncDetectors });
+
+  // Combine async and sync resources
+  return syncResources.merge(asyncResources);
 }