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

Настройка Azure Monitor OpenTelemetry

  • Статья

В этой статье рассматриваются параметры конфигурации для дистрибутива OpenTelemetry в Azure Monitor.

Connection string

Строка подключения в Application Insights определяет целевое расположение для отправки данных телеметрии.

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

  • Добавьте UseAzureMonitor() в program.cs файл:

    var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options => {
    options.ConnectionString = "<Your Connection String>";
});

var app = builder.Build();

app.Run();

  • Задайте переменную среды.

    APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>

  • Добавьте следующий раздел в appsettings.json файл конфигурации.

    {
  "AzureMonitor": {
      "ConnectionString": "<Your Connection String>"
  }
}

Примечание.

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

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

Настройка имени облачной роли и экземпляра облачной роли

Для поддерживаемых языков дистрибутив Azure Monitor OpenTelemetry автоматически обнаруживает контекст ресурса и предоставляет значения по умолчанию для свойств облачного имени роли и экземпляра облачной роли компонента. Однако может потребоваться переопределить значения по умолчанию на то, что имеет смысл для вашей команды. Значение имени облачной роли отображается на карте приложения в качестве имени под узлом.

Задайте имя облачной роли и экземпляр облачной роли с помощью атрибутов ресурсов . Имя облачной роли использует атрибуты service.namespace и service.name, хотя и возвращается к service.name, если service.namespace не задано. Экземпляр облачной роли использует значение атрибута service.instance.id. Сведения о стандартных атрибутах ресурсов см. в разделе "Семантические соглашения OpenTelemetry".

// Setting role name and role instance

// Create a dictionary of resource attributes.
var resourceAttributes = new Dictionary<string, object> {
    { "service.name", "my-service" },
    { "service.namespace", "my-namespace" },
    { "service.instance.id", "my-instance" }};

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry()
    .UseAzureMonitor()
    // Configure the ResourceBuilder to add the custom resource attributes to all signals.
    // Custom resource attributes should be added AFTER AzureMonitor to override the default ResourceDetectors.
    .ConfigureResource(resourceBuilder => resourceBuilder.AddAttributes(_testResourceAttributes));

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Включение выборки

Вы можете включить выборку, чтобы уменьшить объем приема данных, что снижает затраты. Azure Monitor предоставляет настраиваемый выборщик фиксированной частоты , заполняющий события коэффициентом выборки, в который Application Insights преобразуется ItemCount. Выборщик фиксированной частоты обеспечивает точные возможности и количество событий. Пример предназначен для сохранения трассировок между службами и взаимодействия с более старыми пакетами средств разработки программного обеспечения Application Insights (SDK). Дополнительные сведения см. в разделе "Дополнительные сведения о выборке".

Примечание.

Метрики и журналы не влияют на выборку.

Выборщик ожидает частоту выборки от 0 до 1 включительно. Скорость 0,1 означает, что отправляется примерно 10% ваших трассировок.

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options =>
{
    // Set the sampling ratio to 10%. This means that 10% of all traces will be sampled and sent to Azure Monitor.
    options.SamplingRatio = 0.1F;
});

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Совет

При использовании фиксированной скорости и процентной выборки и вы не уверены, что задать частоту выборки как, начните с 5 % (т. е. 0,05 коэффициент выборки) и настройте частоту на основе точности операций, показанных в сбоях и панелях производительности. Более высокая скорость обычно приводит к повышению точности. Однако любая выборка влияет на точность, поэтому мы рекомендуем оповещать о метриках OpenTelemetry, которые не влияют на выборку.

Динамические метрики

Динамические метрики предоставляют панель мониторинга аналитики в режиме реального времени для анализа активности приложений и производительности.

Внимание

Юридические условия, применимые к функциям Azure, которые находятся в состоянии бета-версии, предварительной версии или иным образом еще не выпущены в общедоступной версии, см. на странице Дополнительные условия использования предварительных версий в Microsoft Azure.

По умолчанию эта функция включена.

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

builder.Services.AddOpenTelemetry().UseAzureMonitor(options => {
	// Disable the Live Metrics feature.
    options.EnableLiveMetrics = false;
});

Включение проверки подлинности Microsoft Entra ID (прежнее название — Azure AD)

Возможно, потребуется включить проверку подлинности Microsoft Entra для более безопасного подключения к Azure, что предотвращает прием неавторизованных данных телеметрии в подписку.

Мы поддерживаем классы учетных данных, предоставляемые удостоверением Azure.

  • Рекомендуется DefaultAzureCredential для локальной разработки.
  • Рекомендуется ManagedIdentityCredential использовать управляемые удостоверения, назначенные системой и назначаемые пользователем.
    • Для удостоверений, назначаемых системой, используйте конструктор по умолчанию без параметров.
    • Для назначаемого пользователем укажите идентификатор клиента конструктору.
  • Рекомендуется ClientSecretCredential использовать субъекты-службы.
    • Укажите идентификатор клиента, идентификатор клиента и секрет клиента конструктору.

  1. Установите последний пакет Azure.Identity :

    dotnet add package Azure.Identity

  2. Укажите нужный класс учетных данных:

    // Create a new ASP.NET Core web application builder.    
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options => {
    // Set the Azure Monitor credential to the DefaultAzureCredential.
    // This credential will use the Azure identity of the current user or
    // the service principal that the application is running as to authenticate
    // to Azure Monitor.
    options.Credential = new DefaultAzureCredential();
});

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Автономное хранилище и автоматические повторные попытки

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

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

  • Windows
    • %LOCALAPPDATA%\Microsoft\AzureMonitor
    • %TEMP%\Microsoft\AzureMonitor
  • Не в Windows
    • %TMPDIR%/Microsoft/AzureMonitor
    • /var/tmp/Microsoft/AzureMonitor
    • /tmp/Microsoft/AzureMonitor

Чтобы переопределить каталог по умолчанию, необходимо задать.AzureMonitorOptions.StorageDirectory

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options =>
{
    // Set the Azure Monitor storage directory to "C:\\SomeDirectory".
    // This is the directory where the OpenTelemetry SDK will store any telemetry data that cannot be sent to Azure Monitor immediately.
    options.StorageDirectory = "C:\\SomeDirectory";
});

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Чтобы отключить эту функцию, следует задать.AzureMonitorOptions.DisableOfflineStorage = true

Включение средства экспорта OTLP

Возможно, вы хотите включить экспортер OpenTelemetry Protocol (OTLP) вместе с экспортером Azure Monitor, чтобы отправить данные телеметрии в два расположения.

Примечание.

Средство экспорта OTLP отображается только для удобства. Корпорация Майкрософт официально не поддерживает средство экспорта OTLP, а также все подчиненные компоненты и сторонние средства.

  1. Установите пакет OpenTelemetry.Exporter.OpenTelemetryProtocol в проекте.

    dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol

  2. Добавьте приведенный ниже фрагмент кода. В этом примере предполагается, что у вас есть сборщик OpenTelemetry с работающим приемником OTLP. Дополнительные сведения см. в примере на GitHub.

    // Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Add the OpenTelemetry OTLP exporter to the application.
// This exporter will send telemetry data to an OTLP receiver, such as Prometheus
builder.Services.AddOpenTelemetry().WithTracing(builder => builder.AddOtlpExporter());
builder.Services.AddOpenTelemetry().WithMetrics(builder => builder.AddOtlpExporter());

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Конфигурации OpenTelemetry

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

Переменная среды Description
APPLICATIONINSIGHTS_CONNECTION_STRING Задайте для ресурса Application Insights строка подключения.
APPLICATIONINSIGHTS_STATSBEAT_DISABLED Задайте для него true возможность отказаться от внутренней коллекции метрик.
OTEL_RESOURCE_ATTRIBUTES Пары "ключ-значение", используемые в качестве атрибутов ресурсов. Дополнительные сведения об атрибутах ресурсов см. в спецификации пакета SDK для ресурсов.
OTEL_SERVICE_NAME Задает значение атрибута service.name ресурса. Если service.name он также указан OTEL_RESOURCE_ATTRIBUTES, OTEL_SERVICE_NAME то имеет приоритет.

Строки запроса URL-адреса Redact

Чтобы изменить строки запроса URL-адреса, отключите коллекцию строк запроса. Этот параметр рекомендуется использовать при вызове хранилища Azure с помощью маркера SAS.

При использовании пакета дистрибутива Azure.Monitor.OpenTelemetry.AspNetCore включены библиотеки инструментирования ASP.NET Core и HttpClient. По умолчанию пакет дистрибутива задает redaction строки запроса.

Чтобы изменить это поведение, необходимо задать для переменной среды значение true или false.

  • ASP.NET основное инструментирование. OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTION По умолчанию параметр "Редактация строки запроса" отключен. Чтобы включить, задайте для этой переменной среды значение false.
  • Инструментирование клиента Http. OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTION По умолчанию параметр "Редактация строки запроса" отключен. Чтобы включить, задайте для этой переменной среды значение false.