OpenTelemetry JS 中同步指标导出问题的分析与解决

问题背景

在使用 OpenTelemetry JS SDK 进行指标收集时，开发者可能会遇到一个常见问题：当应用程序快速执行并立即关闭时，同步类型的指标（如 Gauge）可能无法正确导出。这个问题在 OpenTelemetry JS 1.29.0 及更早版本中存在，但在 1.30.0 版本中得到了修复。

问题重现

让我们通过两个典型的代码示例来重现这个问题：

// 示例1：使用NodeSDK
import { PeriodicExportingMetricReader, ConsoleMetricExporter } from "@opentelemetry/sdk-metrics";
import { NodeSDK } from "@opentelemetry/sdk-node";
import { metrics, ValueType } from "@opentelemetry/api";

const metricReader = new PeriodicExportingMetricReader({
  exporter: new ConsoleMetricExporter(),
});
const sdk = new NodeSDK({ metricReader });
sdk.start();

const meter = metrics.getMeter("default");
const gauge = meter.createGauge("test_metric", {
  description: "Gauge",
  valueType: ValueType.DOUBLE,
});
gauge.record(14.4, { env: "test" });

sdk.shutdown().then(() => {
  console.log("SDK shut down");
});

// 示例2：直接使用MeterProvider
import { metrics, ValueType } from "@opentelemetry/api";
import { MeterProvider, PeriodicExportingMetricReader, ConsoleMetricExporter } from "@opentelemetry/sdk-metrics";

const meterProvider = new MeterProvider({
  readers: [new PeriodicExportingMetricReader({
    exporter: new ConsoleMetricExporter(),
  })],
});

metrics.setGlobalMeterProvider(meterProvider);

const meter = metrics.getMeter("default");
const gauge = meter.createGauge("test_metric", {
  description: "Gauge",
  valueType: ValueType.DOUBLE,
});
gauge.record(14.4, { env: "test" });

meterProvider.shutdown().then(() => {
  console.log("Meter provider shut down");
});

在这两种情况下，开发者期望看到控制台输出指标数据，但实际上指标并未被导出。

问题原因

这个问题的根本原因在于 OpenTelemetry JS SDK 1.29.0 及更早版本中，shutdown 方法没有正确处理同步指标的导出流程。具体来说：

1. 指标收集机制：OpenTelemetry 的指标收集分为同步和异步两种方式。Gauge 属于同步指标，它的值是在记录时确定的。

2. 导出周期：PeriodicExportingMetricReader 会定期收集并导出指标，但在应用程序快速关闭的情况下，可能没有足够的时间完成一个完整的收集-导出周期。

3. shutdown 行为：在旧版本中，shutdown 方法没有确保所有待处理的同步指标被正确收集和导出。

解决方案

这个问题在 OpenTelemetry JS SDK 1.30.0 版本中得到了修复。升级到 1.30.0 或更高版本可以解决这个问题。

对于无法立即升级的用户，可以考虑以下临时解决方案：

1. 添加延迟：在记录指标和调用 shutdown 之间添加短暂延迟，确保指标有足够时间被处理。

gauge.record(14.4, { env: "test" });

setTimeout(() => {
  sdk.shutdown().then(() => {
    console.log("SDK shut down");
  });
}, 1000); // 1秒延迟

2. 手动触发收集：在 shutdown 前手动触发一次指标收集。

gauge.record(14.4, { env: "test" });

metricReader.forceFlush().then(() => {
  return sdk.shutdown();
}).then(() => {
  console.log("SDK shut down");
});

最佳实践

为了避免类似问题，建议开发者：

1. 保持 SDK 更新：定期检查并更新 OpenTelemetry SDK 到最新稳定版本。

2. 合理设计应用生命周期：对于短期运行的应用程序，考虑添加适当的延迟或手动触发指标导出。

3. 监控指标导出：实现日志或监控机制，确保指标按预期导出。

4. 理解指标类型特性：同步指标和异步指标有不同的收集机制，设计指标时应考虑这些差异。

总结

OpenTelemetry JS SDK 在 1.30.0 版本修复了同步指标在快速关闭场景下的导出问题。开发者应当了解不同指标类型的行为差异，并根据应用场景选择合适的指标类型和导出策略。对于关键业务指标，建议实现额外的验证机制，确保数据可靠性。