適用於 JavaScript 的 Azure 監視器 OpenTelemetry 匯出工具用戶端連結庫 - 1.0.0-beta.29 版

發行項
03/06/2025

開始

此匯出工具套件假設您的應用程式已使用 OpenTelemetry SDK 來檢測。準備好匯出 OpenTelemetry 資料之後，您可以將此匯出工具新增至您的應用程式。

安裝套件

npm install @azure/monitor-opentelemetry-exporter

目前支持的環境

LTS 版本的 Node.js

如需詳細資訊，請參閱我們的支持原則。

警告： 此 SDK 僅適用於 Node.js 環境。針對瀏覽器環境使用 Application Insights JavaScript SDK。

先決條件

分散式追蹤

將匯出工具新增至您現有的 OpenTelemetry 追蹤提供者（NodeTracerProvider / BasicTracerProvider）

import { AzureMonitorTraceExporter } from "@azure/monitor-opentelemetry-exporter";
import { NodeTracerProvider, BatchSpanProcessor } from "@opentelemetry/sdk-trace-node";
import { Resource } from "@opentelemetry/resources";
import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions";

// Create an exporter instance
const exporter = new AzureMonitorTraceExporter({
  connectionString: "<connection string>",
});

// Create and configure the Node Tracer provider
const tracerProvider = new NodeTracerProvider({
  resource: new Resource({
    [ATTR_SERVICE_NAME]: "basic-service",
  }),
  spanProcessors: [
    new BatchSpanProcessor(exporter, {
      exportTimeoutMillis: 15000,
      maxQueueSize: 1000,
    }),
  ],
});

// Register Tracer Provider as global
tracerProvider.register();

指標

將匯出工具新增至您現有的 OpenTelemetry 計量提供者（MeterProvider）

import { AzureMonitorMetricExporter } from "@azure/monitor-opentelemetry-exporter";
import { PeriodicExportingMetricReader, MeterProvider } from "@opentelemetry/sdk-metrics";
import { metrics } from "@opentelemetry/api";

// Add the exporter into the MetricReader and register it with the MeterProvider
const exporter = new AzureMonitorMetricExporter({
  connectionString: "<connection string>",
});

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

// Register Meter Provider as global
metrics.setGlobalMeterProvider(meterProvider);

原木

將記錄匯出工具新增至您現有的 OpenTelemetry Logger 提供者（LoggerProvider）

import { AzureMonitorLogExporter } from "@azure/monitor-opentelemetry-exporter";
import { BatchLogRecordProcessor, LoggerProvider } from "@opentelemetry/sdk-logs";
import { logs } from "@opentelemetry/api-logs";

// Add the Log exporter into the logRecordProcessor and register it with the LoggerProvider
const exporter = new AzureMonitorLogExporter({
  connectionString: "<connection string>",
});

const logRecordProcessor = new BatchLogRecordProcessor(exporter);
const loggerProvider = new LoggerProvider();
loggerProvider.addLogRecordProcessor(logRecordProcessor);

// Register logger Provider as global
logs.setGlobalLoggerProvider(loggerProvider);

採樣

您可以啟用取樣來限制您收到的遙測記錄數量。若要在 Application Insights 中啟用正確的取樣，請使用 ApplicationInsightsSampler，如下所示。

import { ApplicationInsightsSampler } from "@azure/monitor-opentelemetry-exporter";
import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { Resource } from "@opentelemetry/resources";
import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions";

// Sampler expects a sample rate of between 0 and 1 inclusive
// A rate of 0.75 means approximately 75 % of your traces will be sent
const aiSampler = new ApplicationInsightsSampler(0.75);
const provider = new NodeTracerProvider({
  sampler: aiSampler,
  resource: new Resource({
    [ATTR_SERVICE_NAME]: "basic-service",
  }),
});

provider.register();

例子

如需幾個冠軍案例的完整範例，請參閱 samples/ 資料夾。

重要概念

如需 OpenTelemetry 專案的詳細資訊，請檢閱 OpenTelemetry 規格。

故障排除

啟用偵錯記錄

您可以變更提供者的記錄層級來啟用偵錯記錄。

import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";

const provider = new NodeTracerProvider();
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ALL);
provider.register();

伐木

啟用 Azure 記錄也有助於找出有關失敗的實用資訊。若要查看 HTTP 要求和回應的記錄，請將 AZURE_LOG_LEVEL 環境變數設定為 info。或者，您可以在運行時間啟用記錄，方法是在 setLogLevel中呼叫 @azure/logger：

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

如需如何啟用記錄的詳細指示，請參閱@azure/記錄器套件檔。

後續步驟

此導出工具會與 OpenTelemetry JS搭配使用。

外掛程式登錄

若要查看您正在使用的連結庫是否已建立外掛程式，請參閱 OpenTelemetry Registry。

如果您無法在登錄中連結庫，請放心地在 opentelemetry-js-contrib建議新的外掛程式要求。

貢獻

如果您想要參與此連結庫，請閱讀參與指南，以深入瞭解如何建置和測試程序代碼。

共用方式為