适用于 JavaScript 的 Azure Monitor OpenTelemetry Exporter 客户端库 - 版本 1.0.0-beta.33

入门指南

此导出程序包假定您的应用程序已使用 OpenTelemetry SDK 进行检测 。 准备好导出 OpenTelemetry 数据后，您可以将此导出器添加到您的应用程序中。

安装软件包

npm install @azure/monitor-opentelemetry-exporter

当前支持的环境

• LTS 版本的 Node.js

有关详细信息，请参阅我们的 支持策略。

警告： 此 SDK 仅适用于 Node.js 环境。 将 Application Insights JavaScript SDK 用于浏览器环境。

先决条件

• 一个 Azure 订阅
• Application Insights 工作区

分布式跟踪

将导出器添加到现有的 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建议新的插件请求。

贡献

若要参与此库，请阅读 贡献指南 了解有关如何生成和测试代码的详细信息。