Compartilhar via


Configurar o OpenTelemetry do Azure Monitor

Este guia explica como configurar o OpenTelemetry (OTel) no Azure Monitor Application Insights usando a distribuição OpenTelemetry do Azure Monitor. A configuração adequada garante a coleta de dados de telemetria consistente em aplicativos .NET, Java, Node.jse Python, permitindo um monitoramento e diagnóstico mais confiáveis.

Observação

Para aplicativos de funções do Azure, consulte Usar OpenTelemetry com o Azure Functions.

Cadeia de conexão

Uma cadeia de conexão no Application Insights define o local de destino para enviar dados de telemetria.

Use uma das três maneiras a seguir para configurar a cadeia de conexão:

  • Adicione UseAzureMonitor() ao arquivo 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();
    
  • Defina uma variável de ambiente.

    APPLICATIONINSIGHTS_CONNECTION_STRING=<YOUR-CONNECTION-STRING>
    
  • Adicione a seção a seguir ao arquivo de configuração appsettings.json.

      {
        "AzureMonitor": {
            "ConnectionString": "<YOUR-CONNECTION-STRING>"
        }
      }
    

Observação

Se você definir a cadeia de conexão em mais de um local, seguiremos a seguinte precedência:

  1. Code
  2. Variável de ambiente
  3. Arquivo de configuração

Definir o Nome da Função de Nuvem e a Instância de Função de Nuvem

Para idiomas com suporte, a distribuição OpenTelemetry do Azure Monitor detecta automaticamente o contexto do recurso e fornece valores padrão para o Nome da função de nuvem e as propriedades da Instância da função de nuvem do componente. No entanto, talvez você queira substituir os valores padrão para algo que faça sentido para a sua equipe. O valor do nome da função de nuvem aparece no mapa do aplicativo como o nome abaixo de um nó.

Defina o Nome da Função de Nuvem e a Instância de Função de Nuvem por meio de atributos de Recurso. O Nome da Função de Nuvem usa os atributos service.namespace e service.name, embora ele volte para service.name se service.namespace não estiver definido. A Instância de Função de Nuvem usa o valor do atributo service.instance.id. Para obter informações sobre atributos padrão para recursos, confira Convenções semânticas do 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(resourceAttributes));

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

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

Habilitar amostragem

A amostragem reduz o volume e o custo da ingestão de telemetria. A distribuição OpenTelemetry do Azure Monitor oferece suporte a duas estratégias de amostragem para rastreamentos e (opcionalmente) permite alinhar os logs de aplicativos às suas decisões de amostragem de rastreamento. O amostrador anexa a taxa de amostragem selecionada aos intervalos exportados para que o Application Insights possa ajustar as contagens de experiência com precisão. Para obter uma visão geral conceitual, consulte Saiba mais sobre a amostragem.

Importante

  • As decisões de amostragem aplicam-se a rastreamentos (intervalos).
  • As métricas nunca são amostradas.
  • Os logs não são amostrados por padrão. Você pode habilitar a amostragem baseada em rastreamento para logs, de modo que os logs pertencentes a rastreamentos não amostrados sejam descartados. Para obter mais detalhes, configure a amostragem baseada em rastreamento para os logs.

Observação

Se você estiver vendo encargos inesperados ou custos altos no Application Insights, as causas comuns incluem alto volume de telemetria, picos de ingestão de dados e amostragem configurada incorretamente. Para começar a solucionar problemas, consulte Soluções para alta ingestão de dados no Application Insights.

Configurar a amostragem usando variáveis de ambiente

Use variáveis de ambiente OpenTelemetry padrão para selecionar o sampler e fornecer seu argumento:

  • OTEL_TRACES_SAMPLER — tipo de amostrador

    • microsoft.fixed.percentage — amostrar uma fração dos traços.
    • microsoft.rate_limited — limite de rastreamentos por segundo.
  • OTEL_TRACES_SAMPLER_ARG — argumento de amostrador

    • Para microsoft.fixed.percentage: valor em 0,0–1,0 (por exemplo, 0.1 = ~10%).
    • Para microsoft.rate_limited: máximo de rastreamentos por segundo (por exemplo, 1.5).

Os exemplos a seguir mostram como configurar a amostragem usando variáveis de ambiente.

Amostragem de porcentagem fixa (aproximadamente 10%)

export OTEL_TRACES_SAMPLER="microsoft.fixed.percentage"
export OTEL_TRACES_SAMPLER_ARG=0.1

Amostragem com limitação de taxa (~1,5 traços/s)

export OTEL_TRACES_SAMPLER="microsoft.rate_limited"
export OTEL_TRACES_SAMPLER_ARG=1.5

Configurar amostragem no código

Observação

Quando as opções de nível de código e as variáveis de ambiente são configuradas, as variáveis de ambiente têm precedência. O comportamento padrão do sampler pode ser diferente por idioma, veja as abas a seguir.

Amostragem de porcentagem fixa

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddOpenTelemetry().UseAzureMonitor(o =>
{
    o.SamplingRatio = 0.1F; // ~10%
});
var app = builder.Build();
app.Run();

Amostragem limitada por taxa

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddOpenTelemetry().UseAzureMonitor(o =>
{
    o.TracesPerSecond = 1.5; // ~1.5 traces/sec
});
var app = builder.Build();
app.Run();

Observação

Se você não definir um sampler no código ou por meio de variáveis de ambiente, o Azure Monitor usará ApplicationInsightsSampler por padrão.

Dica

Ao usar a amostragem de porcentagem fixa e você não tem certeza do que definir a taxa de amostragem como, comece em 5% (0.05). Ajuste a taxa com base na precisão das operações mostradas nos painéis de desempenho e falhas. Qualquer amostragem reduz a precisão, portanto, recomendamos alertar sobre as métricas OpenTelemetry, que não são afetadas pela amostragem.

Configurar amostragem baseada em rastreamento para logs

Quando ativada, essa opção descarta os registros de log pertencentes a rastreamentos não amostrados, garantindo que os seus logs permaneçam alinhados com a amostragem de rastreamento.

  • Um registro de log é considerado parte de um rastreamento quando possui um valor válido de SpanId.
  • Se o TraceFlags do rastreamento associado indicar que a amostra não foi coletada, o registro de log será descartado.
  • Registros sem qualquer contexto de rastreamento não são afetados.
  • O recurso está desabilitado por padrão. Habilitação é linguagem, consulte as guias a seguir.

Use a seguinte configuração no seu sistema para habilitar a amostragem de log baseada em rastreamento:

builder.Services.AddOpenTelemetry().UseAzureMonitor(o =>
{
    o.EnableTraceBasedLogsSampler = true;
});

Métricas em Tempo Real

Métricas ao vivo fornecem um painel de análise em tempo real para obter informações sobre a atividade e o desempenho do aplicativo.

Importante

Veja os Termos de Uso Complementares para Versões Prévias do Microsoft Azure para obter termos legais que se aplicam aos recursos do Azure que estão em versão beta, versão prévia ou que, de outra forma, ainda não foram lançados em disponibilidade geral.

Esse recurso está habilitado por padrão.

Os usuários podem desabilitar Live Metrics ao configurar a Distro.

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

Habilitar a autenticação do Microsoft Entra ID (antigo Azure AD)

Talvez você queira habilitar a autenticação do Microsoft Entra para ter uma conexão mais segura com o Azure, o que impede que dados telemétricos não autorizados sejam ingeridos em sua assinatura.

Para obter mais informações, consulte nossa página de autenticação dedicada do Microsoft Entra vinculada para cada idioma com suporte.

Para saber mais informações sobre a configuração de autenticação do Microsoft Entra ID, consulte Autenticação do Microsoft Entra para Application Insights

Armazenamento offline e novas tentativas automáticas

As ofertas baseadas em OpenTelemetry do Azure Monitor armazenam em cache a telemetria quando um aplicativo se desconecta do Application Insights e tenta enviar novamente por até 48 horas. Para obter recomendações de tratamento de dados, consulte Exportar e excluir dados privados. Aplicativos de alta carga ocasionalmente descartam a telemetria por dois motivos: excedendo o tempo permitido ou excedendo o tamanho máximo do arquivo. Quando necessário, o produto prioriza eventos recentes em relação aos antigos.

O pacote Distro inclui o AzureMonitorExporter que, por padrão, usa um dos seguintes locais para armazenamento offline (listado em ordem de precedência):

  • Windows

    • %LOCALAPPDATA%\Microsoft\AzureMonitor
    • %TEMP%\Microsoft\AzureMonitor
  • Não Windows

    • %TMPDIR%/Microsoft/AzureMonitor
    • /var/tmp/Microsoft/AzureMonitor
    • /tmp/Microsoft/AzureMonitor

Para substituir o diretório padrão, você deve definir 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 can't 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();

Para desabilitar esse recurso, você deve definir AzureMonitorOptions.DisableOfflineStorage = true.

Habilitar o Exportador OTLP

Talvez você queira habilitar o exportador do protocolo OpenTelemetry (OTLP) junto com o exportador do Azure Monitor para enviar os seus dados telemétricos para dois locais.

Observação

O Exportador OTLP é mostrado apenas para fins de conveniência. Nós não damos suporte oficialmente ao Exportador OTLP nem a qualquer componente ou experiência de terceiros downstream.

  1. Instale o pacote OpenTelemetry.Exporter.OpenTelemetryProtocol no seu projeto.

    dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
    
  2. Adicione o trecho de código a seguir. Este exemplo pressupõe que você tenha um coletor de OpenTelemetry com um receptor OTLP em execução. Para obter detalhes, confira o exemplo do 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();
    

Configurações do OpenTelemetry

As seguintes configurações do OpenTelemetry podem ser acessadas por meio de variáveis de ambiente ao usar as Distros do OpenTelemetry do Azure Monitor.

Variável de ambiente Descrição
APPLICATIONINSIGHTS_CONNECTION_STRING Defina isso como a string de conexão do seu recurso do Application Insights.
APPLICATIONINSIGHTS_STATSBEAT_DISABLED Defina como true para recusar a coleta de métricas internas.
OTEL_RESOURCE_ATTRIBUTES Pares de chave-valor usados como atributos de recursos. Para obter mais informações sobre atributos de recurso, consulte a especificação do SDK de Recurso.
OTEL_SERVICE_NAME Defina o valor do atributo de recurso service.name. Se service.name também for fornecido em OTEL_RESOURCE_ATTRIBUTES, então OTEL_SERVICE_NAME terá precedência.

Redigir sequências de consulta de URL

Para redigir sequências de consulta de URL, desative a coleta de sequências de consulta. Recomendamos essa configuração se você chamar o armazenamento do Azure usando um token SAS.

Ao usar o pacote de distribuição Azure.Monitor.OpenTelemetry.AspNetCore, as bibliotecas de instrumentação ASP.NET Core e HttpClient são incluídas. Nosso pacote de distribuição desativa a Redação de Cadeia de Consulta por padrão.

Para alterar esse comportamento, você deve definir uma variável de ambiente como true ou false.

  • Instrumentação do ASP.NET Core: OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTION A redação da cadeia de caracteres de consulta está desabilitada por padrão. Para habilitar, defina essa variável de ambiente como false.

  • Instrumentação do cliente HTTP: OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTION A redação da cadeia de caracteres de consulta está desabilitada por padrão. Para habilitar, defina essa variável de ambiente como false.

Intervalo de exportação de métrica

Você pode configurar o intervalo de exportação de métrica usando a variável de OTEL_METRIC_EXPORT_INTERVAL ambiente.

OTEL_METRIC_EXPORT_INTERVAL=60000

O valor padrão é 60000 milissegundos (60 segundos). Essa configuração controla a frequência com que o SDK do OpenTelemetry exporta métricas.

Dica

As Métricas do Azure Monitor e o Workspace do Azure Monitor ingerem métricas personalizadas em um intervalo fixo de 60 segundos. As métricas enviadas com mais frequência são armazenadas em buffer e processadas uma vez a cada 60 segundos. O Log Analytics registra as métricas no intervalo em que são enviadas, o que pode aumentar o custo em intervalos mais curtos e atrasar a visibilidade em mais longos.

Para obter referência, consulte as seguintes especificações do OpenTelemetry: