NestJS集成OpenTelemetry遇TS错误：metricExporter参数配置问题

问题核心原因 #

你遇到的类型错误是因为 OpenTelemetry SDK 的指标系统配置方式在较新版本中发生了变更：

• @opentelemetry/sdk-node@0.35.1 已采用新的Metric Reader管线，废弃了旧版的 metricExporter 和 metricInterval 配置项；
• nestjs-otel 的 README 文档可能未及时更新，仍沿用了旧版 SDK 的配置语法。

修正后的配置方案 #

需要使用 PeriodicExportingMetricReader 包装指标导出器，并通过 metricReader 字段配置到 NodeSDK 中，替代原来的 metricExporter 和 metricInterval：

完整配置代码 #

import { NodeSDK } from '@opentelemetry/sdk-node';
import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
import { CompositePropagator, JaegerPropagator, W3CTraceContextPropagator, W3CBaggagePropagator, B3Propagator, B3InjectEncoding } from '@opentelemetry/core';
import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
import { JaegerExporter } from '@opentelemetry/exporter-jaeger';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
import { PrometheusExporter } from '@opentelemetry/exporter-prometheus';
import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';

// 初始化 Prometheus 导出器
const prometheusExporter = new PrometheusExporter({
  // 可根据需求配置端口、endpoint 等参数，例如：
  // port: 9464,
  // endpoint: '/metrics',
});

const otelSDK = new NodeSDK({
  // 替换原 metricExporter 和 metricInterval
  metricReader: new PeriodicExportingMetricReader({
    exporter: prometheusExporter,
    exportIntervalMillis: 1000, // 对应原来的 metricInterval
  }),
  traceExporter: new JaegerExporter(),
  spanProcessor: new BatchSpanProcessor(new JaegerExporter()),
  contextManager: new AsyncLocalStorageContextManager(),
  textMapPropagator: new CompositePropagator({
    propagators: [
      new JaegerPropagator(),
      new W3CTraceContextPropagator(),
      new W3CBaggagePropagator(),
      new B3Propagator(),
      new B3Propagator({
        injectEncoding: B3InjectEncoding.MULTI_HEADER,
      }),
    ],
  }),
  instrumentations: [getNodeAutoInstrumentations()],
});

依赖兼容性说明 #

当前你的依赖组合是支持的：

• nestjs-otel@5.0.0 兼容 @opentelemetry/sdk-node@0.35.x 版本；
• 只需将指标配置从旧版的 metricExporter/metricInterval 切换为新版的 metricReader 即可正常工作。

内容的提问来源于stack exchange，提问作者Laurence Fass