
关于
为 Node.js 应用自动注入分布式追踪、指标和日志。
name: azure-monitor-opentelemetry-ts description: "为 Node.js 应用程序自动注入分布式追踪、指标和日志。" risk: unknown source: community date_added: "2026-02-27"
Azure Monitor OpenTelemetry SDK(TypeScript 版)
为 Node.js 应用程序自动注入分布式追踪、指标和日志。
安装
# Distro(推荐 - 自动注入)
npm install @azure/monitor-opentelemetry
# 底层导出器(自定义 OpenTelemetry 设置)
npm install @azure/monitor-opentelemetry-exporter
# 自定义日志摄取
npm install @azure/monitor-ingestion
环境变量
APPLICATIONINSIGHTS_CONNECTION_STRING=InstrumentationKey=...;IngestionEndpoint=...
快速开始(自动注入)
重要: 在导入其他模块之前调用 useAzureMonitor()。
import { useAzureMonitor } from "@azure/monitor-opentelemetry";
useAzureMonitor({
azureMonitorExporterOptions: {
connectionString: process.env.APPLICATIONINSIGHTS_CONNECTION_STRING
}
});
// Now import your application
import express from "express";
const app = express();
ESM 支持(Node.js 18.19+)
node --import @azure/monitor-opentelemetry/loader ./dist/index.js
package.json:
{
"scripts": {
"start": "node --import @azure/monitor-opentelemetry/loader ./dist/index.js"
}
}
完整配置
import { useAzureMonitor, AzureMonitorOpenTelemetryOptions } from "@azure/monitor-opentelemetry";
import { resourceFromAttributes } from "@opentelemetry/resources";
const options: AzureMonitorOpenTelemetryOptions = {
azureMonitorExporterOptions: {
connectionString: process.env.APPLICATIONINSIGHTS_CONNECTION_STRING,
storageDirectory: "/path/to/offline/storage",
disableOfflineStorage: false
},
// 采样
samplingRatio: 1.0, // 0-1, percentage of traces
// 功能
enableLiveMetrics: true,
enableStandardMetrics: true,
enablePerformanceCounters: true,
// 注入库
instrumentationOptions: {
azureSdk: { enabled: true },
http: { enabled: true },
mongoDb: { enabled: true },
mySql: { enabled: true },
postgreSql: { enabled: true },
redis: { enabled: true },
bunyan: { enabled: false },
winston: { enabled: false }
},
// 自定义资源
resource: resourceFromAttributes({ "service.name": "my-service" })
};
useAzureMonitor(options);
自定义追踪
import { trace } from "@opentelemetry/api";
const tracer = trace.getTracer("my-tracer");
const span = tracer.startSpan("doWork");
try {
span.setAttribute("component", "worker");
span.setAttribute("operation.id", "42");
span.addEvent("processing started");
// Your work here
} catch (error) {
span.recordException(error as Error);
span.setStatus({ code: 2, message: (error as Error).message });
} finally {
span.end();
}
自定义指标
import { metrics } from "@opentelemetry/api";
const meter = metrics.getMeter("my-meter");
// 计数器
const counter = meter.createCounter("requests_total");
counter.add(1, { route: "/api/users", method: "GET" });
// 直方图
const histogram = meter.createHistogram("request_duration_ms");
histogram.record(150, { route: "/api/users" });
// 可观测仪表
const gauge = meter.createObservableGauge("active_connections");
gauge.addCallback((result) => {
result.observe(getActiveConnections(), { pool: "main" });
});
手动导出器设置
追踪导出器
import { AzureMonitorTraceExporter } from "@azure/monitor-opentelemetry-exporter";
import { NodeTracerProvider, BatchSpanProcessor } from "@opentelemetry/sdk-trace-node";
const exporter = new AzureMonitorTraceExporter({
connectionString: process.env.APPLICATIONINSIGHTS_CONNECTION_STRING
});
const provider = new NodeTracerProvider({
spanProcessors: [new BatchSpanProcessor(exporter)]
});
provider.register();
指标导出器
import { AzureMonitorMetricExporter } from "@azure/monitor-opentelemetry-exporter";
import { PeriodicExportingMetricReader, MeterProvider } from "@opentelemetry/sdk-metrics";
import { metrics } from "@opentelemetry/api";
const exporter = new AzureMonitorMetricExporter({
connectionString: process.env.APPLICATIONINSIGHTS_CONNECTION_STRING
});
const meterProvider = new MeterProvider({
readers: [new PeriodicExportingMetricReader({ exporter })]
});
metrics.setGlobalMeterProvider(meterProvider);
日志导出器
import { AzureMonitorLogExporter } from "@azure/monitor-opentelemetry-exporter";
import { BatchLogRecordProcessor, LoggerProvider } from "@opentelemetry/sdk-logs";
import { logs } from "@opentelemetry/api-logs";
const exporter = new AzureMonitorLogExporter({
connectionString: process.env.APPLICATIONINSIGHTS_CONNECTION_STRING
});
const loggerProvider = new LoggerProvider();
loggerProvider.addLogRecordProcessor(new BatchLogReco
兼容工具
Claude CodeCursor
标签
后端开发
