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

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

Connection string

Строка подключения в приложении Аналитика определяет целевое расположение для отправки данных телеметрии, гарантируя, что он достигает соответствующего ресурса для мониторинга и анализа.

ASP.NET Core

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

• Добавьте UseAzureMonitor() в свой класс запуск program.cs приложения.

  // 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 => {
      options.ConnectionString = "<Your Connection String>";
  });
  
  // Build the ASP.NET Core web application.
  var app = builder.Build();
  
  // Start the ASP.NET Core web application.    
  app.Run();
  

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

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>
  

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

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

Примечание.

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

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

.NET

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

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

  // Create a new OpenTelemetry tracer provider.
  // It is important to keep the TracerProvider instance active throughout the process lifetime.
  var tracerProvider = Sdk.CreateTracerProviderBuilder()
  .AddAzureMonitorTraceExporter(options =>
  {
      options.ConnectionString = "<Your Connection String>";
  });
  
  // Create a new OpenTelemetry meter provider.
  // It is important to keep the MetricsProvider instance active throughout the process lifetime.
  var metricsProvider = Sdk.CreateMeterProviderBuilder()
      .AddAzureMonitorMetricExporter(options =>
      {
          options.ConnectionString = "<Your Connection String>";
      });
  
  // Create a new logger factory.
  // It is important to keep the LoggerFactory instance active throughout the process lifetime.
  var loggerFactory = LoggerFactory.Create(builder =>
  {
      builder.AddOpenTelemetry(options =>
      {
          options.AddAzureMonitorLogExporter(options =>
          {
              options.ConnectionString = "<Your Connection String>";
          });
      });
  });
  

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

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>
  

Примечание.

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

1. Код
2. Переменная среды

Java

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

Node.js

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

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

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>
  

• Используйте объект конфигурации.

  // Import the useAzureMonitor function and the AzureMonitorOpenTelemetryOptions class from the @azure/monitor-opentelemetry package.
  const { useAzureMonitor, AzureMonitorOpenTelemetryOptions } = require("@azure/monitor-opentelemetry");
  
  // Create a new AzureMonitorOpenTelemetryOptions object.
  const options: AzureMonitorOpenTelemetryOptions = {
    azureMonitorExporterOptions: {
      connectionString: "<your connection string>"
    }
  };
  
  // Enable Azure Monitor integration using the useAzureMonitor function and the AzureMonitorOpenTelemetryOptions object.
  useAzureMonitor(options);
  

Python

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

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

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>
  

• Использовать функцию configure_azure_monitor.

# 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 specified connection string.
# Replace `<your-connection-string>` with the connection string of your Azure Monitor Application Insights resource.
configure_azure_monitor(
    connection_string="<your-connection-string>",
)

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

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

ASP.NET Core

Задайте имя облачной роли и экземпляр облачной роли с помощью атрибутов ресурсов . Имя облачной роли использует атрибуты 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 OpenTelemetry tracer provider to add the resource attributes to all traces.
builder.Services.ConfigureOpenTelemetryTracerProvider((sp, builder) => 
    builder.ConfigureResource(resourceBuilder => 
        resourceBuilder.AddAttributes(resourceAttributes)));

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

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

.NET

Задайте имя облачной роли и экземпляр облачной роли с помощью атрибутов ресурсов . Имя облачной роли использует атрибуты 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 resource builder.
var resourceBuilder = ResourceBuilder.CreateDefault().AddAttributes(resourceAttributes);

// Create a new OpenTelemetry tracer provider and set the resource builder.
// It is important to keep the TracerProvider instance active throughout the process lifetime.
var tracerProvider = Sdk.CreateTracerProviderBuilder()
    // Set ResourceBuilder on the TracerProvider.
    .SetResourceBuilder(resourceBuilder)
    .AddAzureMonitorTraceExporter();

// Create a new OpenTelemetry meter provider and set the resource builder.
// It is important to keep the MetricsProvider instance active throughout the process lifetime.
var metricsProvider = Sdk.CreateMeterProviderBuilder()
    // Set ResourceBuilder on the MeterProvider.
    .SetResourceBuilder(resourceBuilder)
    .AddAzureMonitorMetricExporter();

// Create a new logger factory and add the OpenTelemetry logger provider with the resource builder.
// It is important to keep the LoggerFactory instance active throughout the process lifetime.
var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddOpenTelemetry(options =>
    {
        // Set ResourceBuilder on the Logging config.
        options.SetResourceBuilder(resourceBuilder);
        options.AddAzureMonitorLogExporter();
    });
});

Java

Чтобы задать имя облачной роли, см . имя облачной роли.

Сведения о настройке экземпляра облачной роли см. в разделе "Экземпляр облачной роли".

Node.js

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

// Import the useAzureMonitor function, the AzureMonitorOpenTelemetryOptions class, the Resource class, and the SemanticResourceAttributes class from the @azure/monitor-opentelemetry, @opentelemetry/resources, and @opentelemetry/semantic-conventions packages, respectively.
const { useAzureMonitor, AzureMonitorOpenTelemetryOptions } = require("@azure/monitor-opentelemetry");
const { Resource } = require("@opentelemetry/resources");
const { SemanticResourceAttributes } = require("@opentelemetry/semantic-conventions");

// Create a new Resource object with the following custom resource attributes:
//
// * service_name: my-service
// * service_namespace: my-namespace
// * service_instance_id: my-instance
const customResource = new Resource({
  [SemanticResourceAttributes.SERVICE_NAME]: "my-service",
  [SemanticResourceAttributes.SERVICE_NAMESPACE]: "my-namespace",
  [SemanticResourceAttributes.SERVICE_INSTANCE_ID]: "my-instance",
});

// Create a new AzureMonitorOpenTelemetryOptions object and set the resource property to the customResource object.
const options: AzureMonitorOpenTelemetryOptions = {
  resource: customResource
};

// Enable Azure Monitor integration using the useAzureMonitor function and the AzureMonitorOpenTelemetryOptions object.
useAzureMonitor(options);

Python

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

Задайте атрибуты ресурса с помощью OTEL_RESOURCE_ATTRIBUTES переменных среды и /или OTEL_SERVICE_NAME среды. OTEL_RESOURCE_ATTRIBUTES принимает ряд пар "ключ-значение", разделенных запятыми. Например, чтобы задать имя my-namespace.my-helloworld-service облачной роли и задать для my-instanceэкземпляра облачной роли значение, можно задать OTEL_RESOURCE_ATTRIBUTES и OTEL_SERVICE_NAME так:

export OTEL_RESOURCE_ATTRIBUTES="service.namespace=my-namespace,service.instance.id=my-instance"
export OTEL_SERVICE_NAME="my-helloworld-service"

Если атрибут resource не задан, можно также задать имя облачной service.namespace роли только с переменной среды OTEL_SERVICE_NAME или атрибутом service.name Resource. Например, чтобы задать имя my-helloworld-service облачной роли и задать для my-instanceэкземпляра облачной роли значение, можно задать OTEL_RESOURCE_ATTRIBUTES и OTEL_SERVICE_NAME так:

export OTEL_RESOURCE_ATTRIBUTES="service.instance.id=my-instance"
export OTEL_SERVICE_NAME="my-helloworld-service"

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

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

Примечание.

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

ASP.NET Core

Выборщик ожидает частоту выборки от 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(o =>
{
    // Set the sampling ratio to 10%. This means that 10% of all traces will be sampled and sent to Azure Monitor.
    o.SamplingRatio = 0.1F;
});

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

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

.NET

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

// Create a new OpenTelemetry tracer provider.
// It is important to keep the TracerProvider instance active throughout the process lifetime.
var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddAzureMonitorTraceExporter(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;
    });

Java

Начиная с версии 3.4.0 доступна ограниченная скорость выборки и теперь используется по умолчанию. Дополнительные сведения о выборке см. в статье "Выборка Java".

Node.js

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

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

// Create a new AzureMonitorOpenTelemetryOptions object and set the samplingRatio property to 0.1.
const options: AzureMonitorOpenTelemetryOptions = {
  samplingRatio: 0.1
};

// Enable Azure Monitor integration using the useAzureMonitor function and the AzureMonitorOpenTelemetryOptions object.
useAzureMonitor(options);

Python

Функция configure_azure_monitor() автоматически использует Application Аналитика Sampler для совместимости с пакетами SDK для приложений Аналитика и выборки данных телеметрии. Переменная OTEL_TRACES_SAMPLER_ARG среды может использоваться для указания частоты выборки с допустимым диапазоном от 0 до 1, где 0 — 0% и 1 — 100 %. Например, значение 0,1 означает, что 10 % трассировки отправляются.

export OTEL_TRACES_SAMPLER_ARG=0.1

Совет

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

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

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

ASP.NET Core

Мы поддерживаем классы учетных данных, предоставляемые удостоверением 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();
   

.NET

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

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

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

   dotnet add package Azure.Identity
   

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

   // Create a DefaultAzureCredential.
   var credential = new DefaultAzureCredential();
   
   // Create a new OpenTelemetry tracer provider and set the credential.
   // It is important to keep the TracerProvider instance active throughout the process lifetime.
   var tracerProvider = Sdk.CreateTracerProviderBuilder()
       .AddAzureMonitorTraceExporter(options =>
       {
           options.Credential = credential;
       });
   
   // Create a new OpenTelemetry meter provider and set the credential.
   // It is important to keep the MetricsProvider instance active throughout the process lifetime.
   var metricsProvider = Sdk.CreateMeterProviderBuilder()
       .AddAzureMonitorMetricExporter(options =>
       {
           options.Credential = credential;
       });
   
   // Create a new logger factory and add the OpenTelemetry logger provider with the credential.
   // It is important to keep the LoggerFactory instance active throughout the process lifetime.
   var loggerFactory = LoggerFactory.Create(builder =>
   {
       builder.AddOpenTelemetry(options =>
       {
           options.AddAzureMonitorLogExporter(options =>
           {
               options.Credential = credential;
           });
       });
   });
   

Java

Дополнительные сведения о Java см. в дополнительной документации по Java.

Node.js

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

// Import the useAzureMonitor function, the AzureMonitorOpenTelemetryOptions class, and the ManagedIdentityCredential class from the @azure/monitor-opentelemetry and @azure/identity packages, respectively.
const { useAzureMonitor, AzureMonitorOpenTelemetryOptions } = require("@azure/monitor-opentelemetry");
const { ManagedIdentityCredential } = require("@azure/identity");

// Create a new ManagedIdentityCredential object.
const credential = new ManagedIdentityCredential();

// Create a new AzureMonitorOpenTelemetryOptions object and set the credential property to the credential object.
const options: AzureMonitorOpenTelemetryOptions = {
    azureMonitorExporterOptions: {
        credential: credential
    }
};

// Enable Azure Monitor integration using the useAzureMonitor function and the AzureMonitorOpenTelemetryOptions object.
useAzureMonitor(options);

Python

# Import the `ManagedIdentityCredential` class from the `azure.identity` package.
from azure.identity import ManagedIdentityCredential
# 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 a managed identity credential.
# This will allow OpenTelemetry to authenticate to Azure Monitor without requiring you to provide a connection string.
configure_azure_monitor(
    credential=ManagedIdentityCredential(),
)

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

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

ASP.NET Core

Пакет дистрибутива включает 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

.NET

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

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

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

// Create a new OpenTelemetry tracer provider and set the storage directory.
// It is important to keep the TracerProvider instance active throughout the process lifetime.
var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddAzureMonitorTraceExporter(options =>
    {
        // Set the Azure Monitor storage directory to "C:\\SomeDirectory".
        // This is the directory where the OpenTelemetry SDK will store any trace data that cannot be sent to Azure Monitor immediately.
        options.StorageDirectory = "C:\\SomeDirectory";
    });

// Create a new OpenTelemetry meter provider and set the storage directory.
// It is important to keep the MetricsProvider instance active throughout the process lifetime.
var metricsProvider = Sdk.CreateMeterProviderBuilder()
    .AddAzureMonitorMetricExporter(options =>
    {
        // Set the Azure Monitor storage directory to "C:\\SomeDirectory".
        // This is the directory where the OpenTelemetry SDK will store any metric data that cannot be sent to Azure Monitor immediately.
        options.StorageDirectory = "C:\\SomeDirectory";
    });

// Create a new logger factory and add the OpenTelemetry logger provider with the storage directory.
// It is important to keep the LoggerFactory instance active throughout the process lifetime.
var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddOpenTelemetry(options =>
    {
        options.AddAzureMonitorLogExporter(options =>
        {
            // Set the Azure Monitor storage directory to "C:\\SomeDirectory".
            // This is the directory where the OpenTelemetry SDK will store any log data that cannot be sent to Azure Monitor immediately.
            options.StorageDirectory = "C:\\SomeDirectory";
        });
    });
});

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

Java

Настройка автономных служба хранилища и автоматических повторных попыток недоступна в Java.

Полный список доступных конфигураций см. в разделе "Параметры конфигурации".

Node.js

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

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

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

Например:

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

// Create a new AzureMonitorOpenTelemetryOptions object and set the azureMonitorExporterOptions property to an object with the following properties:
//
// * connectionString: The connection string for your Azure Monitor Application Insights resource.
// * storageDirectory: The directory where the Azure Monitor OpenTelemetry exporter will store telemetry data when it is offline.
// * disableOfflineStorage: A boolean value that specifies whether to disable offline storage.
const options: AzureMonitorOpenTelemetryOptions = {
  azureMonitorExporterOptions: {
    connectionString: "<Your Connection String>",
    storageDirectory: "C:\\SomeDirectory",
    disableOfflineStorage: false
  }
};

// Enable Azure Monitor integration using the useAzureMonitor function and the AzureMonitorOpenTelemetryOptions object.
useAzureMonitor(options);

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

Python

По умолчанию экспортеры Azure Monitor используют следующий путь:

<tempfile.gettempdir()>/Microsoft/AzureMonitor/opentelemetry-python-<your-instrumentation-key>

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

Например:

...
# Configure OpenTelemetry to use Azure Monitor with the specified connection string and storage directory.
# Replace `your-connection-string` with the connection string to your Azure Monitor Application Insights resource.
# Replace `C:\\SomeDirectory` with the directory where you want to store the telemetry data before it is sent to Azure Monitor.
configure_azure_monitor(
    connection_string="your-connection-string",
    storage_directory="C:\\SomeDirectory",
)
...

Чтобы отключить эту функцию, необходимо задать значение disable_offline_storageTrue. По умолчанию — False.

Например:

...
# Configure OpenTelemetry to use Azure Monitor with the specified connection string and disable offline storage.
# Replace `your-connection-string` with the connection string to your Azure Monitor Application Insights resource.
configure_azure_monitor(
    connection_string="your-connection-string",
    disable_offline_storage=True,
)
...

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

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

Примечание.

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

ASP.NET Core

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

.NET

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

   dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
   

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

   // Create a new OpenTelemetry tracer provider and add the Azure Monitor trace exporter and the OTLP trace exporter.
   // It is important to keep the TracerProvider instance active throughout the process lifetime.
   var tracerProvider = Sdk.CreateTracerProviderBuilder()
       .AddAzureMonitorTraceExporter()
       .AddOtlpExporter();
   
   // Create a new OpenTelemetry meter provider and add the Azure Monitor metric exporter and the OTLP metric exporter.
   // It is important to keep the MetricsProvider instance active throughout the process lifetime.
   var metricsProvider = Sdk.CreateMeterProviderBuilder()
       .AddAzureMonitorMetricExporter()
       .AddOtlpExporter();
   

Java

Дополнительные сведения о Java см. в дополнительной документации по Java.

Node.js

1. Установите экспортер трассировки трассировки сборщика OpenTelemetry и другие пакеты OpenTelemetry в проекте.

       npm install @opentelemetry/api
       npm install @opentelemetry/exporter-trace-otlp-http
       npm install @opentelemetry/sdk-trace-base
       npm install @opentelemetry/sdk-trace-node
   

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

   // Import the useAzureMonitor function, the AzureMonitorOpenTelemetryOptions class, the trace module, the ProxyTracerProvider class, the BatchSpanProcessor class, the NodeTracerProvider class, and the OTLPTraceExporter class from the @azure/monitor-opentelemetry, @opentelemetry/api, @opentelemetry/sdk-trace-base, @opentelemetry/sdk-trace-node, and @opentelemetry/exporter-trace-otlp-http packages, respectively.
   const { useAzureMonitor, AzureMonitorOpenTelemetryOptions } = require("@azure/monitor-opentelemetry");
   const { BatchSpanProcessor } = require('@opentelemetry/sdk-trace-base');
   const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
   
   // Create a new OTLPTraceExporter object.
   const otlpExporter = new OTLPTraceExporter();
   
   // Enable Azure Monitor integration.
   const options: AzureMonitorOpenTelemetryOptions = {
       // Add the SpanEnrichingProcessor
       spanProcessors: [new BatchSpanProcessor(otlpExporter)] 
   }
   useAzureMonitor(options);
   

Python

1. Установите пакет opentelemetry-exporter-otlp.

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

   # Import the `configure_azure_monitor()`, `trace`, `OTLPSpanExporter`, and `BatchSpanProcessor` classes from the appropriate packages.    
   from azure.monitor.opentelemetry import configure_azure_monitor
   from opentelemetry import trace
   from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
   from opentelemetry.sdk.trace.export import BatchSpanProcessor
   
   # Configure OpenTelemetry to use Azure Monitor with the specified connection string.
   # Replace `<your-connection-string>` with the connection string to your Azure Monitor Application Insights resource.
   configure_azure_monitor(
       connection_string="<your-connection-string>",
   )
   
   # Get the tracer for the current module.
   tracer = trace.get_tracer(__name__) 
   
   # Create an OTLP span exporter that sends spans to the specified endpoint.
   # Replace `http://localhost:4317` with the endpoint of your OTLP collector.
   otlp_exporter = OTLPSpanExporter(endpoint="http://localhost:4317")
   
   # Create a batch span processor that uses the OTLP span exporter.
   span_processor = BatchSpanProcessor(otlp_exporter)
   
   # Add the batch span processor to the tracer provider.
   trace.get_tracer_provider().add_span_processor(span_processor)
   
   # Start a new span with the name "test".
   with tracer.start_as_current_span("test"):
       print("Hello world!")
   

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

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

ASP.NET Core

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

.NET

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

Java

Дополнительные сведения о Java см. в дополнительной документации по Java.

Node.js

Дополнительные сведения о конфигурации пакета SDK Для OpenTelemetry см. в документации по OpenTelemetry.

Python

Дополнительные сведения о конфигурации пакета SDK Для OpenTelemetry см. в документации по OpenTelemetry и использовании дистрибутива Azure Monitor.

Часто задаваемые вопросы

В этом разделы приводятся ответы на часто задаваемые вопросы.

Что такое OpenTelemetry?

Это новый стандарт с открытым исходным кодом для наблюдения. Дополнительные сведения см. в openTelemetry.

Почему Microsoft Azure Monitor инвестирует в OpenTelemetry?

Корпорация Майкрософт — один из крупнейших инвесторов OpenTelemetry.

Ключевыми ценными особенностями OpenTelemetry являются независимость от поставщика и согласованность интерфейсов API и пакетов SDK для различных языков.

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

Наконец, OpenTelemetry соответствует стратегии корпорации Майкрософт по работе с открытым исходным кодом.

Что такое состояние OpenTelemetry?

См. сведения о состоянии OpenTelemetry.

Что такое дистрибутив Azure Monitor OpenTelemetry?

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

Почему следует использовать дистрибутив Azure Monitor OpenTelemetry?

Существует несколько преимуществ использования дистрибутива OpenTelemetry в Azure Monitor по сравнению с собственной платформой OpenTelemetry из сообщества:

• Сокращение усилий по включению
• Поддерживается корпорацией Майкрософт
• Включает такие функции Azure, как:
  • Выборка, совместимая с классическими пакетами SDK Аналитика приложений
  • Проверка подлинности Microsoft Entra
  • Автономные служба хранилища и автоматические повторные попытки
  • Statsbeat
  • Стандартные метрики приложения Аналитика
  • Обнаружение метаданных ресурсов для автоматического заполнения имени облачной роли и экземпляра облачной роли в различных средах Azure
  • Интерактивные метрики

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

• Экспортер протокола OpenTelemetry (OTLP) и отправка в другое место одновременно
• Другие библиотеки инструментирования, не включенные в дистрибутив

Так как дистрибутив предоставляет распределение OpenTelemetry, дистрибутив поддерживает все, что поддерживается OpenTelemetry. Например, можно добавить дополнительные процессоры телеметрии, экспортеры или библиотеки инструментирования, если OpenTelemetry поддерживает их.

Примечание.

Дистрибутив задает образец для пользовательского с фиксированной скоростью выборки для приложения Аналитика. Это можно изменить на другой образец, но это может отключить некоторые из включенных возможностей дистрибутива. Дополнительные сведения о поддерживаемом образце см. в разделе "Включение выборки " в разделе "Настройка Azure Monitor OpenTelemetry".

Для языков без поддерживаемого автономного экспортера OpenTelemetry дистрибутив Azure Monitor OpenTelemetry является единственным поддерживаемым в настоящее время способом использования OpenTelemetry с Azure Monitor. Для языков с поддерживаемым автономным экспортером OpenTelemetry вы можете использовать дистрибутив Azure Monitor OpenTelemetry или соответствующий автономный экспортер OpenTelemetry в зависимости от сценария телеметрии. Дополнительные сведения см. в статье "Когда следует использовать экспортер OpenTelemetry Azure Monitor?".

Как протестировать дистрибутив OpenTelemetry в Azure Monitor?

Ознакомьтесь с нашими документами по включению для .NET, Java, JavaScript (Node.js) и Python.

Следует ли использовать OpenTelemetry или пакет SDK для приложений Аналитика?

Мы рекомендуем использовать дистрибутив OpenTelemetry, если вам не требуется функция, доступная только с официальной поддержкой в пакете SDK для приложений Аналитика.

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

Когда следует использовать экспортер OpenTelemetry в Azure Monitor?

Для ASP.NET Core, Java, Node.js и Python рекомендуется использовать дистрибутив OpenTelemetry в Azure Monitor. Это одна строка кода для начала работы.

Для всех других сценариев .NET, включая классические ASP.NET, консольные приложения и т. д., мы рекомендуем использовать экспортер OpenTelemetry .NET в Azure Monitor: Azure.Monitor.OpenTelemetry.Exporter

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

Что такое текущее состояние выпуска функций в дистрибутиве OpenTelemetry в Azure Monitor?

На следующей диаграмме описана поддержка функций OpenTelemetry для каждого языка.

Функция	.NET	Node.js	Python	Java
Распределенная трассировка	✅	✅	✅	✅
Пользовательские метрики	✅	✅	✅	✅
Стандартные метрики (точность в настоящее время влияет на выборку)	✅	✅	✅	✅
Выборка с фиксированной частотой	✅	✅	✅	✅
Автономное хранилище и автоматические повторные попытки	✅	✅	✅	✅
Отчеты об исключениях	✅	✅	✅	✅
Коллекция журналов	✅	⚠️	✅	✅
Пользовательские события	⚠️	⚠️	⚠️	✅
Проверка подлинности Microsoft Entra	✅	✅	✅	✅
Динамические метрики	❌	❌	❌	✅
Определение контекста ресурсов для vm/VMSS и Служба приложений	✅	❌	✅	✅
Определение контекста ресурсов для AKS и функций	❌	❌	❌	✅
Фильтрация диапазона тестирования доступности	❌	❌	❌	✅
Автоматическое заполнение идентификатора пользователя, идентификатора пользователя с проверкой подлинности и IP-адреса пользователя	❌	❌	❌	✅
Переопределение или задание имени операции вручную, идентификатора пользователя или идентификатора пользователя с проверкой подлинности	❌	❌	❌	✅
Адаптивная выборка	❌	❌	❌	✅
Profiler	❌	❌	❌	⚠️
Отладчик моментальных снимков	❌	❌	❌	❌

Ключ

• ✅ Эта функция доступна всем клиентам с официальной поддержкой.
• ⚠️ Эта функция доступна как общедоступная предварительная версия. Дополнительные условия использования для предварительных версий Microsoft Azure.
• ❌ Эта функция недоступна или не применима.

Можно ли использовать OpenTelemetry для веб-браузеров?

Да, но мы не рекомендуем его, и Azure не поддерживает его. JavaScript OpenTelemetry оптимизирован для Node.js. Вместо этого рекомендуется использовать пакет SDK javaScript для приложений Аналитика.

Когда можно ожидать, что пакет SDK OpenTelemetry будет доступен для использования в веб-браузерах?

Веб-пакет SDK OpenTelemetry не имеет определенной доступности временная шкала. Скорее всего, несколько лет от пакета SDK для браузера, который является жизнеспособной альтернативой пакету SDK JavaScript для приложений Аналитика.

Можно ли протестировать OpenTelemetry в веб-браузере сегодня?

Веб-песочница OpenTelemetry — это вилка, предназначенная для работы OpenTelemetry в браузере. Пока невозможно отправить данные телеметрии в приложение Аналитика. Пакет SDK не определяет общие события клиента.

Поддерживается ли приложение Аналитика вместе с агентами конкурентов, такими как AppDynamics, DataDog и NewRelic?

№ Эта практика не является тем, что мы планируем протестировать или поддерживать, хотя наши дистрибутивы позволяют экспортировать в конечную точку OTLP вместе с Azure Monitor одновременно.

Можно ли использовать предварительные версии функций в рабочих средах?

Это не рекомендуемый вариант. Дополнительные условия использования для предварительных версий Microsoft Azure.

Какова разница между ручной и автоматической инструментированием?

Ознакомьтесь с обзором OpenTelemetry.

Можно ли использовать сборщик OpenTelemetry?

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

Чем отличается OpenCensus от OpenTelemetry?

OpenCensus — это предшественник OpenTelemetry. Корпорация Майкрософт способствовала объединению OpenTracing с OpenCensus для создания OpenTelemetry, единого в мире стандарта наблюдаемости. Текущий рабочий пакет SDK для Python для Azure Monitor основан на OpenCensus. Корпорация Майкрософт стремится сделать Azure Monitor на основе OpenTelemetry.

Устранение неполадок

ASP.NET Core

Не работает? Ознакомьтесь со страницей устранения неполадок для ASP.NET Core.

.NET

Не работает? Ознакомьтесь со страницей устранения неполадок для .NET.

Java

Не работает? Ознакомьтесь со страницей устранения неполадок для Java.

Node.js

Не работает? Ознакомьтесь со страницей устранения неполадок для Node.js.

Python

Не работает? Ознакомьтесь со страницей устранения неполадок для Python.

Поддержка

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

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.
• Список открытых проблем, связанных с автоинструментацией Java Для Azure Monitor, см. на странице проблем GitHub.

Node.js

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

Python

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

Отзывы по OpenTelemetry

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

• Пройдите опрос для сбора отзывов клиентов в сообществе OpenTelemetry.
• Сообщите корпорации Майкрософт о себе, присоединившись к нашему сообществу ранних последователей OpenTelemetry.
• Общайтесь с другими пользователями Azure Monitor в Microsoft Tech Community.
• Выполните запрос функции на форуме отзывов Azure.