入門指南
此導出程式包假定您的應用程式已使用 OpenTelemetry SDK 進行檢測 。 準備好匯出 OpenTelemetry 資料後,您可以將此匯出器添加到您的應用程式中。
安裝套件
npm install @azure/monitor-opentelemetry-exporter
目前支援的環境
如需詳細資訊,請參閱我們的支援原則。
警告: 此 SDK 僅適用於 Node.js 環境。 將 Application Insights JavaScript SDK 用於瀏覽器環境。
先決條件
分散式追蹤
將匯出器添加到現有的 OpenTelemetry Tracer Provider ()NodeTracerProvider / BasicTracerProvider
import { AzureMonitorTraceExporter } from "@azure/monitor-opentelemetry-exporter";
import { NodeTracerProvider, BatchSpanProcessor } from "@opentelemetry/sdk-trace-node";
import { resourceFromAttributes } 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: resourceFromAttributes({
[ATTR_SERVICE_NAME]: "basic-service",
}),
spanProcessors: [
new BatchSpanProcessor(exporter, {
exportTimeoutMillis: 15000,
maxQueueSize: 1000,
}),
],
});
// Register Tracer Provider as global
tracerProvider.register();
指標
將匯出器添加到現有的 OpenTelemetry Meter 提供程式 ()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);
日誌
將 Log Exporter 添加到現有的 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 { resourceFromAttributes } 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: resourceFromAttributes({
[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 註冊表。
如果您在註冊表中找不到您的庫,請隨時在 上 opentelemetry-js-contrib建議新的外掛程式請求。
貢獻
如果您想要參與此連結庫,請閱讀 參與指南,以深入瞭解如何建置和測試程序代碼。