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

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

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

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

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

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

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

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

Примечание.

Сведения о приложениях-функциях Azure см. в разделе Use OpenTelemetry с Функции Azure.

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

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

В следующей таблице перечислены пакеты и команды установки для каждого поддерживаемого языка:

Язык	Package	Команда установки
ASP.NET Core	Azure.Monitor.OpenTelemetry.AspNetCore	dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore
.NET	Azure.Monitor.OpenTelemetry.Exporter	dotnet add package Azure.Monitor.OpenTelemetry.Exporter
Java	applicationinsights-agent-3.7.8.jar	Скачать с GitHub
Node.js	@azure/monitor-opentelemetry	npm install @azure/monitor-opentelemetry
Python	azure-monitor-opentelemetry	pip install azure-monitor-opentelemetry

Примечание.

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

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

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

ASP.NET Core

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

Совет

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

.NET

• Приложение с поддерживаемой версией.NET или .NET Framework 4.6.2 и более поздних версий.

Совет

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

Java

• Приложение Java с помощью Java 8+

Java native

• Приложение Java с помощью GraalVM 17+

Node.js

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

Примечание.

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

Если вы используете любое из этих свойств, воспользуйтесь дистрибутивом OpenTelemetry для Azure Monitor.

Совет

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

Python

• приложение Python с помощью Python 3.8+

Совет

Если вы выполняете миграцию из OpenCensus, ознакомьтесь с нашей документацией по миграции.

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

ASP.NET Core

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

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore

.NET

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

dotnet add package Azure.Monitor.OpenTelemetry.Exporter

Java

Скачайте последний файл applicationinsights-agent-3.7.8.jar.

Предупреждение

Если вы обновляете более раннюю версию 3.x, то изменения в настройках по умолчанию или небольшие различия в собираемых данных могут вас затронуть. Дополнительные сведения см. в разделе о миграции в заметках о выпуске. 3.5.0, .4.03.3.0, 3.2.0 и 3.1.0

Java native

Для собственных приложений Spring Boot :

• Импорт счетов за материалы OpenTelemetry (BOM).
• Добавьте зависимость Spring Cloud Azure Starter Monitor.
• Следуйте этим инструкциям для файлов JAR Azure SDK (Архив Java).

Для собственных приложений Quarkus :

• Добавьте зависимость Quarkus OpenTelemetry Exporter for Azure.

Примечание.

Сообщество Quarkus поддерживает и обслуживает расширения Quarkus. Для получения справки используйте каналы поддержки сообщества Quarkus. Microsoft не предоставляет техническую поддержку этой интеграции.

Node.js

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

npm install @azure/monitor-opentelemetry

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

• @opentelemetry/api
• `@opentelemetry/sdk-metrics`
• @opentelemetry/ресурсы
• @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

Python

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

pip install azure-monitor-opentelemetry

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

ASP.NET Core

Импортируйте пространство имен 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();

.NET

Добавьте Azure Monitor Exporter к каждому сигналу 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();
    });
});

Примечание.

Для получения дополнительной информации см. учебное руководство "getting-started" для OpenTelemetry .NET

Java

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

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

Примечание.

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

Совет

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

Совет

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

Java native

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

Node.js

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

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

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

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

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

Метод	Поддерживаемые языки	Рекомендуется для
Переменная среды	Все	Производство
Файл конфигурации (applicationinsights.json)	Только Java	Промышленная среда (Java)
Код	ASP.NET Core, Node.js, Python	Только локальные разработки и тестирования

Внимание

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

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

• Задайте строку подключения Application Insights в качестве переменной среды (рекомендуется для продуктивной среды)

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

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Настройте строку подключения Application Insights в файле конфигурации - Только для Java

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

  {
    "connectionString": "<Your connection string>"
  }
  

  Замените <Your строка подключения> в предыдущем JSON на вашу уникальную строку подключения.

• Настройте строку подключения Application Insights в коде - Только для ASP.NET Core, Node.js и Python

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

Примечание.

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

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

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

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

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

Примечание.

В рамках инструментирования Application Insights мы собираем и отправляем диагностические данные в Microsoft. Эти данные помогают нам использовать и улучшать Application Insights. Дополнительные сведения см. в разделе "Вопросы и ответы о Application Insights".

Внимание

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

Устранение неполадок, обратная связь и поддержка

Совет

Во всех статьях о дистрибутивах OpenTelemetry доступны следующие разделы.

Troubleshooting

ASP.NET Core

Сведения об устранении неполадок см. в статье Устранение проблем с OpenTelemetry в .NET и Устранение неполадок с отсутствием данных телеметрии приложений в Azure Monitor Application Insights.

.NET

Сведения об устранении неполадок см. в статье Устранение проблем с OpenTelemetry в .NET и Устранение неполадок с отсутствием данных телеметрии приложений в Azure Monitor Application Insights.

Java

Сведения об устранении неполадок см. в разделе Устранение неполадок OpenTelemetry в Java и Устранение неполадок отсутствия данных телеметрии приложений в Azure Monitor Application Insights.

Java native

Сведения об устранении неполадок см. в разделе Устранение неполадок OpenTelemetry в приложениях Spring Boot с нативными образами и Устранение неполадок отсутствия данных телеметрии приложений в Azure Monitor Application Insights.

Node.js

Сведения об устранении неполадок см. в статьях Устранение неполадок OpenTelemetry в Node.js и Устранение отсутствия данных телеметрии приложений в Azure Monitor Application Insights.

Python

Сведения об устранении неполадок см. в статьях Устранение проблем с OpenTelemetry в Python и Устранение проблем отсутствия телеметрии приложений в Azure Monitor Application Insights.

Отзывы о OpenTelemetry

Чтобы оставить отзыв, сделайте следующее:

• Заполните опрос отзывов клиентов сообщества OpenTelemetry.
• Расскажите Microsoft о себе, присоединившись к OpenTelemetry Early Adopter Community.
• Взаимодействуйте с другими пользователями Azure Monitor в Microsoft Tech Community.
• Отправьте запрос на функцию на форуме отзывов Azure.

Поддержка

Выберите вкладку для выбранного языка, чтобы узнать параметры поддержки.

ASP.NET Core

• Для вопросов технической поддержки Azure откройте заявку в поддержку Azure.
• По вопросам, связанным с OpenTelemetry, обратитесь непосредственно к сообществу OpenTelemetry .NET.
• Список открытых вопросов, связанных с экспортером Azure Monitor, можно найти на странице с проблемами на GitHub.

.NET

• Для вопросов технической поддержки Azure откройте заявку в поддержку Azure.
• По вопросам, связанным с OpenTelemetry, обратитесь непосредственно к сообществу OpenTelemetry .NET.
• Список открытых вопросов, связанных с экспортером Azure Monitor, можно найти на странице с проблемами на GitHub.

Java

• Для вопросов технической поддержки Azure откройте заявку в поддержку Azure.
• Сведения об устранении неполадок см. в шагах по устранению неполадок.
• Для проблем с OpenTelemetry обратитесь непосредственно к сообществу OpenTelemetry .
• Список открытых проблем, связанных с автоинструментированием Azure Monitor Java, смотрите на странице с проблемами GitHub.

Java native

• Для вопросов технической поддержки Azure откройте заявку в поддержку Azure.
• Для проблем с OpenTelemetry обратитесь непосредственно к сообществу OpenTelemetry .
• Список открытых проблем с собственными приложениями Spring Boot см. на странице GitHub Issues Page.
• Для получения списка открытых вопросов с нативными приложениями Quarkus см. на странице GitHub Issues.

Примечание.

Сообщество Quarkus поддерживает и обслуживает расширения Quarkus. Для получения справки используйте каналы поддержки сообщества Quarkus. Microsoft не предоставляет техническую поддержку этой интеграции.

Node.js

• Для вопросов технической поддержки Azure откройте заявку в поддержку Azure.
• Для проблем с OpenTelemetry обратитесь непосредственно к сообществу JavaScript OpenTelemetry .
• Список открытых вопросов, связанных с экспортером Azure Monitor, можно найти на странице с проблемами на GitHub.

Python

• Для вопросов технической поддержки Azure откройте заявку в поддержку Azure.
• Если у вас возникли проблемы с OpenTelemetry, обратитесь непосредственно к сообществу OpenTelemetry Python.
• Для получения списка открытых проблем, связанных с дистрибутивом Azure Monitor, см. страницу GitHub Issues.

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

ASP.NET Core

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

.NET

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

Java

• Сведения о параметрах конфигурации см. в разделе Параметры конфигурации автоматической Java-инструментализации.
• Чтобы просмотреть исходный код, см. репозиторий GitHub Azure Monitor для автоинструментации Java.
• Сведения о примерах приложений см. в статье Application Insights Java Samples.
• Просмотрите заметки release на GitHub.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории OpenTelemetry Java GitHub.
• Чтобы включить возможности использования, ознакомьтесь со сведениями о включении мониторинга пользователей в Интернете или браузере.

Java native

• Чтобы просмотреть исходный код, см. статью Azure Monitor дистрибутив OpenTelemetry для собственного образа приложения Java на Spring Boot и Quarkus OpenTelemetry Exporter для Azure.
• Чтобы просмотреть пример приложения, см. Telemetry для нативных образов GraalVM.
• Просмотрите заметки release на GitHub.
• Узнайте больше о возможностях для приложений на основе образов Spring Boot с помощью стартер OpenTelemetry SpringBoot
• Дополнительные возможности для собственных приложений Quarkus см. в Quarkus OpenTelemetry Exporter для Azure.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории OpenTelemetry Java GitHub.

Node.js

• Чтобы просмотреть исходный код, см. репозиторий Azure Monitor OpenTelemetry for JavaScript.
• Чтобы просмотреть пример приложения, см. раздел Azure Monitor OpenTelemetry для Node.js.
• Чтобы установить пакет npm и проверить наличие обновлений, см. страницу @azure/monitor-opentelemetrynpm Package.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории OpenTelemetry JavaScript GitHub.
• Чтобы обеспечить пользовательский опыт, включите мониторинг пользователей в Интернете или браузере.

Python

• Дополнительные сведения о исходном коде и дополнительной документации см. в репозитории Azure Monitor Python GitHub.
• Сведения о примерах приложений см. в разделе Azure Monitor OpenTelemetry для Python.
• Чтобы установить пакет PyPI и проверить наличие обновлений, см. страницу Azure Monitor Distro PyPI Package.
• Просмотрите заметки release на GitHub.
• Сведения о доступных инструментах и компонентах OpenTelemetry см. в репозитории OpenTelemetry Contributor Python GitHub.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории OpenTelemetry Python GitHub.
• Чтобы обеспечить пользовательский опыт, включите мониторинг пользователей в Интернете или браузере.