Partilhar via

Configurar o Azure Monitor OpenTelemetry

  • Artigo

Este artigo aborda as definições de configuração para a distro OpenTelemetry do Azure Monitor.

Connection string

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

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

  • Adicione UseAzureMonitor() ao seu program.cs ficheiro:

    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 seu appsettings.json arquivo de configuração.

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

Nota

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

  1. Código
  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 suportados, a Distro OpenTelemetry do Azure Monitor deteta automaticamente o contexto do recurso e fornece valores padrão para as propriedades Nome da Função de Nuvem e Instância de Função de Nuvem do seu componente. No entanto, talvez você queira substituir os valores padrão por algo que faça sentido para 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 dos atributos de Recurso . O Nome da Função de Nuvem usa service.namespace e service.name atributa, embora caia para service.name se service.namespace não estiver definido. A Instância de Função de Nuvem usa o valor do service.instance.id atributo. Para obter informações sobre atributos padrão para recursos, consulte Convenções semânticas 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();

Ativar amostragem

Talvez você queira habilitar a amostragem para reduzir o volume de ingestão de dados, o que reduz o custo. O Azure Monitor fornece um amostrador de taxa fixa personalizado que preenche eventos com uma taxa de amostragem, que o Application Insights converte em ItemCount. O amostrador de taxa fixa garante experiências precisas e contagens de eventos. O amostrador foi projetado para preservar seus rastreamentos entre serviços e é interoperável com SDKs (Software Development Kits) mais antigos do Application Insights. Para obter mais informações, consulte Saiba mais sobre amostragem.

Nota

As métricas e os logs não são afetados pela amostragem.

O amostrador espera uma taxa de amostragem entre 0 e 1, inclusive. Uma taxa de 0,1 significa que aproximadamente 10% dos seus vestígios são enviados.

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

Gorjeta

Ao usar amostragem de taxa fixa/porcentagem e você não tiver certeza do que definir a taxa de amostragem, comece em 5% (ou seja, razão de amostragem de 0,05) e ajuste a taxa com base na precisão das operações mostradas nos painéis de falhas e desempenho. Uma taxa mais alta geralmente resulta em maior precisão. No entanto, QUALQUER amostragem afetará a precisão, por isso recomendamos alertar sobre as métricas OpenTelemetry que não são afetadas pela amostragem.

Métricas em tempo real

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

Importante

Veja Termos de Utilização Complementares da Pré-visualizações do Microsoft Azure para obter os termos legais que se aplicam às funcionalidades do Azure que estão na versão beta, na pré-visualização ou que ainda não foram lançadas para disponibilidade geral.

Esta caraterística está ativada por predefinição.

Os usuários podem desativar o 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 (anteriormente Azure AD)

Talvez você queira habilitar a autenticação do Microsoft Entra para uma conexão mais segura com o Azure, o que impede que a telemetria não autorizada seja ingerida em sua assinatura.

Damos suporte às classes de credenciais fornecidas pela Identidade do Azure.

  • Recomendamos para o DefaultAzureCredential desenvolvimento local.
  • Recomendamos ManagedIdentityCredential para identidades gerenciadas atribuídas pelo sistema e pelo usuário.
    • Para system-assigned, use o construtor padrão sem parâmetros.
    • Para o usuário atribuído, forneça o ID do cliente para o construtor.
  • Recomendamos ClientSecretCredential para entidades de serviço.
    • Forneça a ID do locatário, a ID do cliente e o segredo do cliente para o construtor.

  1. Instale o pacote Azure.Identity mais recente:

    dotnet add package Azure.Identity

  2. Forneça a classe de credencial desejada:

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

Armazenamento off-line e novas tentativas automáticas

Para melhorar a confiabilidade e a resiliência, as ofertas baseadas em OpenTelemetria do Azure Monitor gravam no armazenamento offline/local por padrão quando um aplicativo perde sua conexão com o Application Insights. Ele salva a telemetria do aplicativo no disco e periodicamente tenta enviá-lo novamente por até 48 horas. Em aplicações de alta carga, a telemetria é ocasionalmente descartada por dois motivos. Primeiro, quando o tempo permitido é excedido e, segundo, quando o tamanho máximo do arquivo é excedido ou o SDK não tem a oportunidade de limpar o arquivo. Se precisarmos escolher, o produto salva eventos mais recentes do que os antigos. Saiba mais

O pacote Distro inclui o AzureMonitorExporter, que por padrão usa um dos seguintes locais para armazenamento offline (listados 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 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();

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

Habilitar o Exportador OTLP

Talvez você queira habilitar o Exportador de Protocolo de Telemetria Aberta (OTLP) junto com o Exportador do Azure Monitor para enviar sua telemetria para dois locais.

Nota

O Exportador OTLP é mostrado apenas por conveniência. Não suportamos oficialmente o Exportador OTLP ou quaisquer componentes ou experiências de terceiros a jusante do mesmo.

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

    dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol

  2. Adicione o seguinte trecho de código. Este exemplo pressupõe que você tenha um OpenTelemetry Collector com um recetor OTLP em execução. Para obter detalhes, consulte o exemplo no 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 OpenTelemetry

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

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

Redact URL Query Strings

Para redigir cadeias de caracteres de consulta de URL, desative a coleção de cadeias de caracteres 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 estão incluídas. Nosso pacote de distribuição define a Edição de Cadeia de Caracteres de Consulta desativada por padrão.

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

  • ASP.NET Instrumentação principal: OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTION a Redação da Cadeia de Caracteres de Consulta está desativada por padrão. Para habilitar, defina essa variável de ambiente como "false".
  • Instrumentação de Cliente HTTP: OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTION A Edição de Cadeia de Caracteres de Consulta está desativada por padrão. Para habilitar, defina essa variável de ambiente como "false".