Клиентская библиотека Экспортера OpenTelemetry в Azure Monitor для JavaScript версии 1.0.0-beta.29

Статья
03/06/2025

Начало работы

Этот пакет экспортера предполагает, что приложение уже инструментировано с помощью пакета SDK OpenTelemetry. После того как вы будете готовы экспортировать данные OpenTelemetry, вы можете добавить этого экспортера в приложение.

Установка пакета

npm install @azure/monitor-opentelemetry-exporter

Поддерживаемые в настоящее время среды

версии LTS Node.js

Дополнительные сведения см. в политике поддержки .

предупреждение: этот пакет SDK работает только для сред Node.js. Используйте пакета SDK JavaScript для Application Insights для браузеров.

Необходимые условия

подписки Azure
рабочей области Application Insights

Распределенная трассировка

Добавьте экспортера в существующий поставщик трассировки 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 (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/loger.

Дальнейшие действия

Этот экспортер используется с OpenTelemetry JS.

Реестр подключаемых модулей

Чтобы узнать, был ли подключаемый модуль уже создан для используемой библиотеки, ознакомьтесь с реестром OpenTelemetry.

Если вы не можете использовать библиотеку в реестре, вы можете предложить новый запрос подключаемого модуля по opentelemetry-js-contrib.

Способствует

Если вы хотите внести свой вклад в эту библиотеку, ознакомьтесь с руководством по вкладу, чтобы узнать больше о том, как создавать и тестировать код.

Поделиться через