Включение Azure Monitor OpenTelemetry для приложений .NET, Node.js, Python и Java

Статья
2025-02-28

В этой статье описывается, как включить и настроить сбор данных на основе OpenTelemetry в Azure Monitor Application Insights. Дистрибутив OpenTelemetry для Azure Monitor:

Предоставляет распределение OpenTelemetry, которое включает поддержку функций, относящихся к Azure Monitor.
Включает автоматическую телеметрию, включая библиотеки инструментирования OpenTelemetry для сбора трассировок, метрик, журналов и исключений.
Позволяет собирать пользовательские данные телеметрии.
Поддерживает динамические метрики для мониторинга и сбора дополнительных данных телеметрии из динамических веб-приложений в рабочей среде.

Дополнительные сведения о преимуществах использования дистрибутива OpenTelemetry в Azure Monitor см. в статье "Почему следует использовать дистрибутив Azure Monitor OpenTelemetry".

Чтобы узнать больше о сборе данных с помощью OpenTelemetry, ознакомьтесь с основами сбора данных или часто задаваемыми вопросами о OpenTelemetry.

Состояние выпуска OpenTelemetry

Предложения OpenTelemetry доступны для приложений .NET, Node.js, Python и Java. Для получения сведений о состоянии выпуска каждой функции см. часто задаваемые вопросы.

Активировать OpenTelemetry с помощью Application Insights

Выполните действия, описанные в этом разделе, для инструментирования приложения с помощью OpenTelemetry. Выберите вкладку для инструкций на определённом языке.

Примечание.

.NET охватывает несколько сценариев, включая классические ASP.NET, консольные приложения, Windows Forms (WinForms) и многое другое.

Предварительные условия

Подписка Azure. Создание бесплатной подписки Azure.
Ресурс Application Insights. Создание ресурса Application Insights.

ASP.NET Core Application с помощью официально поддерживаемой версии .NET

Совет

Если вы переходите с классического API Application Insights, ознакомьтесь с нашей документацией по миграции.

Установка клиентской библиотеки

Установите последний Azure.Monitor.OpenTelemetry.AspNetCoreпакет NuGet:

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore

Установите последний Azure.Monitor.OpenTelemetry.Exporterпакет NuGet:

dotnet add package Azure.Monitor.OpenTelemetry.Exporter

Установите последний пакет @azure/monitor-opentelemetry :

npm install @azure/monitor-opentelemetry

Следующие пакеты также используются для некоторых конкретных сценариев, описанных далее в этой статье:

@opentelemetry/api
@opentelemetry/sdk-metrics
@opentelemetry/resources
@opentelemetry/semantic-conventions (семантические соглашения)
@opentelemetry/sdk-trace-base

npm install @opentelemetry/api
npm install @opentelemetry/sdk-metrics
npm install @opentelemetry/resources
npm install @opentelemetry/semantic-conventions
npm install @opentelemetry/sdk-trace-base

Установите последний пакет PyPI для azure-monitor-opentelemetry :

pip install azure-monitor-opentelemetry

Изменение приложения

Импортируйте пространство имен Azure.Monitor.OpenTelemetry.AspNetCore, добавьте OpenTelemetry и настройте для работы с Azure Monitor в классе program.cs.

// Import the Azure.Monitor.OpenTelemetry.AspNetCore namespace.
using Azure.Monitor.OpenTelemetry.AspNetCore;

var builder = WebApplication.CreateBuilder(args);

// Add OpenTelemetry and configure it to use Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

var app = builder.Build();

app.Run();

Добавьте экспортер Azure Monitor к каждому сигналу OpenTelemetry в program.cs классе:

// Create a new tracer provider builder and add an Azure Monitor trace exporter to the tracer provider builder.
// It is important to keep the TracerProvider instance active throughout the process lifetime.
// See https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace#tracerprovider-management
var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddAzureMonitorTraceExporter();

// Add an Azure Monitor metric exporter to the metrics provider builder.
// It is important to keep the MetricsProvider instance active throughout the process lifetime.
// See https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/metrics#meterprovider-management
var metricsProvider = Sdk.CreateMeterProviderBuilder()
    .AddAzureMonitorMetricExporter();

// Create a new logger factory.
// It is important to keep the LoggerFactory instance active throughout the process lifetime.
// See https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/logs#logger-management
var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddOpenTelemetry(logging =>
    {
        logging.AddAzureMonitorLogExporter();
    });
});

Примечание.

Дополнительные сведения см. в руководстве по началу работы с OpenTelemetry .NET

Автоинструментация включена с помощью изменений конфигурации. Никаких изменений кода не требуется.

Наведите виртуальную машину Java (JVM) на JAR-файл, добавив -javaagent:"path/to/applicationinsights-agent-3.7.1.jar" в аргументы JVM вашего приложения.

Примечание.

Выборка включена по умолчанию в размере 5 запросов в секунду, помогая в управлении затратами. Данные телеметрии могут быть отсутствуют в сценариях, превышающих эту скорость. Для получения дополнительной информации об изменении конфигурации выборки см. переопределение параметров выборки. Если вы видите непредвиденные расходы или высокие затраты в Application Insights, это руководство может помочь. В ней рассматриваются распространенные причины, такие как высокий объем телеметрии, пики приема данных и неправильно настроенная выборка. Особенно полезно, если вы устраняете проблемы, связанные с резким увеличением затрат, объемом телеметрии, неисправной выборкой, ограничениями данных, высокой нагрузкой на прием данных или неожиданными счетами. Чтобы начать, ознакомьтесь с материалом по устранению неполадок в случае высокого объёма поступающих данных в Application Insights.

Совет

Инструкции по сценарию см. в разделе "Начало работы" (дополнительное приложение).

Совет

При разработке приложения Spring Boot можно при необходимости заменить аргумент JVM программными конфигурациями. Дополнительные сведения см. в статье Об использовании Azure Monitor Application Insights с Spring Boot.

// Import the `useAzureMonitor()` function from the `@azure/monitor-opentelemetry` package.
const { useAzureMonitor } = require("@azure/monitor-opentelemetry");

// Call the `useAzureMonitor()` function to configure OpenTelemetry to use Azure Monitor.
useAzureMonitor();

import logging
# Import the `configure_azure_monitor()` function from the
# `azure.monitor.opentelemetry` package.
from azure.monitor.opentelemetry import configure_azure_monitor

# Configure OpenTelemetry to use Azure Monitor with the 
# APPLICATIONINSIGHTS_CONNECTION_STRING environment variable.
configure_azure_monitor(
    logger_name="<your_logger_namespace>",  # Set the namespace for the logger in which you would like to collect telemetry for if you are collecting logging telemetry. This is imperative so you do not collect logging telemetry from the SDK itself.
)
logger = logging.getLogger("<your_logger_namespace>")  # Logging telemetry will be collected from logging calls made with this logger and all of it's children loggers.

Скопируйте строку подключения из ресурса Application Insights.

Строка подключения уникальна и указывает, куда версия OpenTelemetry Azure Monitor отправляет собираемую телеметрию.

Совет

Если у вас еще нет ресурса Application Insights, следуйте этому руководству чтобы создать его. Рекомендуется создать новый ресурс, а не использовать существующий.

Чтобы скопировать строка подключения, выполните следующие действия.

Перейдите в панель Overview ресурса Application Insights.
Найдите строка подключения.
Наведите указатель мыши на строку подключения и выберите значок 'Копировать в буфер обмена'.

Вставьте строку подключения в вашу среду

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

Внимание

Рекомендуется задавать строку подключения с помощью кода в локальных средах разработки и тестирования.

Для рабочей среды используйте переменную среды или файл конфигурации (только Java).

Установлено через переменную окружения - рекомендуется

Замените <Your connection string> в следующей команде вашей строкой подключения.
```
APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
```
Установлено через файл конфигурации - Только Java

Создайте файл конфигурации с именем applicationinsights.jsonи поместите его в тот же каталог, что applicationinsights-agent-3.7.1.jar и в следующем содержимом:
```
{
  "connectionString": "<Your connection string>"
}
```
Замените <Your connection string> в предыдущем JSON на вашей уникальной строкой подключения.
Настройка только с помощью кода - ASP.NET Core, Node.js и Python

См. пример настройки конфигурации строки подключения с помощью кода.

Примечание.

Если установить строку подключения в нескольких местах, переменная среды будет в приоритете в следующем порядке:

Код
Переменная среды
Файл конфигурации

Подтвердите, что данные поступают

Запустите приложение, а затем откройте Application Insights в портал Azure. Для отображения данных может потребоваться несколько минут.

Снимок экрана вкладки

Application Insights теперь включен для приложения. Следующие шаги являются необязательными и позволяют дополнительно настраивать.

Внимание

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

В рамках использования инструментирования Application Insights мы собираем диагностические данные и отправляем их в корпорацию Майкрософт. Эти данные помогают нам использовать и улучшать Application Insights. Дополнительные сведения см. в разделе Statsbeat в Azure Application Insights.

Примеры приложений

Примеры приложений OpenTelemetry Azure Monitor доступны для всех поддерживаемых языков:

Следующие шаги

Дополнительные сведения о добавлении и изменении Azure Monitor OpenTelemetry см. в статье "Добавление и изменение Azure Monitor OpenTelemetry".
Чтобы дополнительно настроить дистрибутив OpenTelemetry, см. конфигурацию OpenTelemetry в Azure Monitor.
Чтобы просмотреть исходный код, посетите репозиторий GitHub Azure Monitor AspNetCore.
Чтобы установить пакет NuGet, проверить наличие обновлений или просмотреть заметки о выпуске, см. страницу пакета NuGet Azure Monitor AspNetCore.
Дополнительные сведения об Azure Monitor и OpenTelemetry см. в примере приложения Azure Monitor.
Чтобы получить дополнительные сведения об OpenTelemetry и соответствующем сообществе, ознакомьтесь с репозиторием .NET для OpenTelemetry на GitHub.
Чтобы включить возможности использования, включите мониторинг пользователей в Интернете или браузере.
Чтобы просмотреть часто задаваемые вопросы, действия по устранению неполадок, варианты поддержки или предоставить отзыв о OpenTelemetry, ознакомьтесь со справкой, поддержкой и отзывом по Azure Monitor Application Insights.

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

Включение Azure Monitor OpenTelemetry для приложений .NET, Node.js, Python и Java

Состояние выпуска OpenTelemetry

Активировать OpenTelemetry с помощью Application Insights

Предварительные условия

Установка клиентской библиотеки

Изменение приложения

Скопируйте строку подключения из ресурса Application Insights.

Вставьте строку подключения в вашу среду

Подтвердите, что данные поступают

Примеры приложений

Следующие шаги

Обратная связь

Дополнительные ресурсы