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

Статья
28.01.2025

В этой статье описывается, как включить и настроить сбор данных на основе OpenTelemetry в 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. Выберите вкладку для инструкций для langauge.

Примечание

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

Необходимые компоненты

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

Приложение, использующее официально поддерживаемую версию среды выполнения Node.js:
• Поддерживаемые среды выполнения OpenTelemetry
• Поддерживаемые среды выполнения в Azure Monitor OpenTelemetry

Примечание

Если вы не полагаетесь на какие-либо свойства, перечисленные в не поддерживаемой таблице, оболочка ApplicationInsights будет вашим простым путем вперед один раз из бета-версии.

Если вы используете все эти свойства, перейдите к дистрибутиву OpenTelemetry в Azure Monitor. В ближайшее время мы предоставим руководство по миграции.

Совет

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

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

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

Интерфейс командной строки.NET

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore

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

Интерфейс командной строки.NET

dotnet add package Azure.Monitor.OpenTelemetry.Exporter

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

npm install @azure/monitor-opentelemetry

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

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.0.jar" их в args приложения JVM.

Примечание

Выборка включена по умолчанию в размере 5 запросов в секунду, помогая в управлении затратами. Данные телеметрии могут быть отсутствуют в сценариях, превышающих эту скорость. Дополнительные сведения об изменении конфигурации выборки см . в переопределении выборки.

Совет

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

Совет

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

TypeScript

// 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();

Python

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, создайте его в этом руководстве. Рекомендуется создать новый ресурс, а не использовать существующий.

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

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

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

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

Важно!

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

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

Настройка с помощью рекомендуемой переменной - среды

Замените <Your connection string> в следующей команде строка подключения.

Консоль
```
APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
```
Настройка только с помощью файла - конфигурации Java

Создайте файл конфигурации с именем applicationinsights.jsonи поместите его в тот же каталог, что applicationinsights-agent-3.7.0.jar и в следующем содержимом:

JSON
```
{
  "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".
Чтобы просмотреть исходный код, ознакомьтесь с репозиторием GitHub в Azure Monitor OpenTelemetry.
Чтобы установить пакет npm и проверить наличие обновлений, см @azure/monitor-opentelemetry . страницу пакета npm.
Дополнительные сведения об Azure Monitor Application Insights и OpenTelemetry см. на странице примеров приложений для Azure Monitor.
Чтобы получить дополнительные сведения об OpenTelemetry и соответствующем сообществе, ознакомьтесь с репозиторием JavaScript для OpenTelemetry на GitHub.
Чтобы включить функции использования, ознакомьтесь со статьей о включении наблюдения за пользователями в Интернете или браузере.
Чтобы просмотреть часто задаваемые вопросы, действия по устранению неполадок, варианты поддержки или предоставить отзыв о OpenTelemetry, ознакомьтесь со справкой, поддержкой и отзывом по Azure Monitor Application Insights.

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

Обучение

Модуль

Реализация наблюдаемости в облачном приложении .NET с помощью OpenTelemetry - Training

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

Сертификация

Microsoft Certified: Azure Developer Associate (Сертификация Майкрософт. Помощник Разработчика Azure) - Certifications

Создавайте комплексные решения в Microsoft Azure для создания Функции Azure, реализации веб-приложений и управления ими, разработке решений, использующих службу хранилища Azure, и т. д.

События

Создание приложений и агентов ИИ

17 мар., 21 - 21 мар., 10

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

Зарегистрироваться

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

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

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

Включение OpenTelemetry с помощью Application Insights

Необходимые компоненты

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

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

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

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

Подтверждение передачи данных

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

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

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

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