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

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

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

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

npm install @azure/monitor-opentelemetry-exporter

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

• Версии Node.js LTS

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

Предупреждение: Этот 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 { 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 (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 { 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/loger.

Дальнейшие шаги

Этот экспортер предназначен для использования с OpenTelemetry JS.

Реестр плагинов

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

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

Вклад

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