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

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

ASP.NET Core

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

Совет

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

.NET

• Приложение, использующее поддерживаемую версию .NET или платформа .NET Framework 4.6.2 и более поздних версий.

Совет

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

Java

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

Java native

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

Node.js

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

Примечание.

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

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

Совет

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

Python

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

Совет

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

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

ASP.NET Core

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

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore 

.NET

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

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Java

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

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

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

Java native

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

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

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

• Добавьте экспортер Кваркуса OpenTelemetry для зависимостей Azure.

Node.js

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

npm install @azure/monitor-opentelemetry

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

• @opentelemetry/api
• @opentelemetry/sdk-метрики
• @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

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 к каждому сигналу 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

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

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

Примечание.

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

Совет

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

Совет

При разработке приложения Spring Boot можно при необходимости заменить аргумент JVM программными конфигурациями. Дополнительные сведения см. в статье Об использовании Azure Monitor Application Insights с 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 the `configure_azure_monitor()` function from the
# `azure.monitor.opentelemetry` package.
from azure.monitor.opentelemetry import configure_azure_monitor

# Import the tracing api from the `opentelemetry` package.
from opentelemetry import trace

# Configure OpenTelemetry to use Azure Monitor with the 
# APPLICATIONINSIGHTS_CONNECTION_STRING environment variable.
configure_azure_monitor()

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

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

Совет

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

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

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

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

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

Внимание

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

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

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

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

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Настройка только с помощью файла - конфигурации Java

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

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

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

• Настройка только с помощью кода - ASP.NET Core, Node.js и Python

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

Примечание.

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

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

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

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

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

Внимание

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

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

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

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

• пример приложения ASP.NET Core
• Пример приложения NET
• Примеры приложений Java
• Примеры приложений Java GraalVM
• пример приложения Node.js
• Примеры приложений Python

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

ASP.NET Core

• Дополнительные сведения о добавлении и изменении 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.

.NET

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

Java

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

Java native

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

Node.js

• Дополнительные сведения о добавлении и изменении 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.

Python

• Дополнительные сведения о добавлении и изменении Azure Monitor OpenTelemetry см. в статье "Добавление и изменение Azure Monitor OpenTelemetry ".
• Просмотрите исходный код и дополнительную документацию в репозитории GitHub дистрибутива Azure Monitor.
• Дополнительные примеры и варианты использования см. в примерах дистрибутивов Azure Monitor.
• Просмотрите журнал изменений на сайте GitHub.
• Установите пакет PyPI, проверьте наличие обновлений или просмотрите заметки о выпуске на странице пакета PyPI дистрибутива Azure Monitor.
• Узнайте больше о Azure Monitor Application Insights и OpenTelemetry в примере приложения Azure Monitor.
• Дополнительные сведения о OpenTelemetry и его сообществе см. в репозитории GitHub OpenTelemetry Python.
• См. доступные инструментирования и компоненты OpenTelemetry в репозитории GitHub участника OpenTelemetry.
• Включите возможности использования, включив мониторинг пользователей в интернете или браузере.
• Чтобы просмотреть часто задаваемые вопросы, действия по устранению неполадок, варианты поддержки или предоставить отзыв о OpenTelemetry, ознакомьтесь со справкой, поддержкой и отзывом по Azure Monitor Application Insights.