Habilitar o Azure Monitor OpenTelemetry para aplicativos .NET, Node.js, Python e Java

Instale o pacote NuGet mais recente:Azure.Monitor.OpenTelemetry.AspNetCore

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore 

Instale o pacote NuGet mais recente:Azure.Monitor.OpenTelemetry.Exporter

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Transfira o ficheiro applicationinsights-agent-3.5.4.jar .

Para aplicações nativas do Spring Boot :

• Importe as listas de materiais (BOM) OpenTelemetry .
• Adicione a dependência do Spring Cloud Azure Starter Monitor .
• Siga estas instruções para os arquivos JAR (Java Archive) do SDK do Azure.

Para aplicações nativas do Quarkus :

• Adicione o Quarkus OpenTelemetry Exporter para dependência do Azure .

Instale o pacote mais recente do @azure/monitor-opentelemetry :

npm install @azure/monitor-opentelemetry

Os pacotes a seguir também são usados para alguns cenários específicos descritos posteriormente neste artigo:

• @opentelemetry/api
• @opentelemetry/sdk-metrics
• @opentelemetry/recursos
• @opentelemetry/convenções semânticas
• @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

Instale o pacote azure-monitor-opentelemetry PyPI mais recente:

pip install azure-monitor-opentelemetry

Importe o namespace, adicione OpenTelemetry e configure-o para usar o Azure.Monitor.OpenTelemetry.AspNetCore Azure Monitor em sua program.cs classe:

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

Adicione o Exportador do Azure Monitor a cada sinal OpenTelemetry na program.cs classe:

// 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(options =>
    {
        options.AddAzureMonitorLogExporter();
    });
});

A autoinstrumentação é ativada através de alterações de configuração. Não são necessárias alterações de código.

Aponte a máquina virtual Java (JVM) para o arquivo jar adicionando -javaagent:"path/to/applicationinsights-agent-3.5.4.jar" aos args da JVM do seu aplicativo.

A autoinstrumentação é ativada através de alterações de configuração. Não são necessárias alterações de código.

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

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

• Para obter detalhes sobre como adicionar e modificar o Azure Monitor OpenTelemetry, consulte Adicionar e modificar o Azure Monitor OpenTelemetry.
• Para configurar ainda mais a distro OpenTelemetry , consulte Configuração do Azure Monitor OpenTelemetry .
• Para revisar o código-fonte, consulte o repositório GitHub do Azure Monitor AspNetCore.
• Para instalar o pacote NuGet, verificar se há atualizações ou exibir notas de versão, consulte a página Pacote NuGet do Azure Monitor AspNetCore.
• Para se familiarizar com o Azure Monitor e o OpenTelemetry, consulte o Aplicativo de exemplo do Azure Monitor.
• Para saber mais sobre o OpenTelemetry e sua comunidade, consulte o repositório OpenTelemetry .NET GitHub.
• Para habilitar experiências de uso, habilite o monitoramento de usuários da Web ou do navegador.

• Para obter detalhes sobre como adicionar e modificar o Azure Monitor OpenTelemetry, consulte Adicionar e modificar o Azure Monitor OpenTelemetry.
• Para configurar ainda mais a distro OpenTelemetry , consulte Configuração do Azure Monitor OpenTelemetry .
• Para revisar o código-fonte, consulte o repositório GitHub do Exportador do Azure Monitor.
• Para instalar o pacote NuGet, verificar se há atualizações ou exibir notas de versão, consulte a página Pacote NuGet do Exportador do Azure Monitor.
• Para se familiarizar com o Azure Monitor e o OpenTelemetry, consulte o Aplicativo de exemplo do Azure Monitor.
• Para saber mais sobre o OpenTelemetry e sua comunidade, consulte o repositório OpenTelemetry .NET GitHub.
• Para habilitar experiências de uso, habilite o monitoramento de usuários da Web ou do navegador.

• Consulte Adicionar e modificar o Azure Monitor OpenTelemetry para obter detalhes sobre como adicionar e modificar o Azure Monitor OpenTelemetry.
• Analise as opções de configuração de autoinstrumentação Java.
• Analise o código-fonte no repositório GitHub de autoinstrumentação Java do Azure Monitor.
• Saiba mais sobre o OpenTelemetry e sua comunidade no repositório OpenTelemetry Java GitHub.
• Habilite as experiências de uso vendo Habilitar monitoramento de usuários da Web ou do navegador.
• Analise as notas de versão no GitHub.

• Consulte Adicionar e modificar o Azure Monitor OpenTelemetry para obter detalhes sobre como adicionar e modificar o Azure Monitor OpenTelemetry.
• Analise o código-fonte na Distro OpenTelemetry do Azure Monitor na imagem nativa do Spring Boot, no aplicativo Java e no Quarkus OpenTelemetry Exporter for Azure.
• Saiba mais sobre o OpenTelemetry e sua comunidade no repositório OpenTelemetry Java GitHub.
• Saiba mais recursos para aplicativos de imagem nativos do Spring Boot no OpenTelemetry SpringBoot starter
• Saiba mais recursos para aplicativos nativos do Quarkus no Quarkus OpenTelemetry Exporter for Azure.
• Analise as notas de versão no GitHub.

• Para obter detalhes sobre como adicionar e modificar o Azure Monitor OpenTelemetry, consulte Adicionar e modificar o Azure Monitor OpenTelemetry.
• Para revisar o código-fonte, consulte o repositório GitHub do Azure Monitor OpenTelemetry .
• Para instalar o pacote npm e verificar se há atualizações, consulte a página Pacote npm.@azure/monitor-opentelemetry
• Para se familiarizar com o Azure Monitor Application Insights e o OpenTelemetry, consulte o Aplicativo de exemplo do Azure Monitor.
• Para saber mais sobre o OpenTelemetry e sua comunidade, consulte o repositório OpenTelemetry JavaScript GitHub.
• Para habilitar experiências de uso, habilite o monitoramento de usuários da Web ou do navegador.

• Consulte Adicionar e modificar o Azure Monitor OpenTelemetry para obter detalhes sobre como adicionar e modificar o Azure Monitor OpenTelemetry.
• Analise o código-fonte e a documentação extra no repositório GitHub do Azure Monitor Distro.
• Veja exemplos extras e casos de uso em exemplos de Distro do Azure Monitor.
• Revise o changelog no GitHub.
• Instale o pacote PyPI, verifique se há atualizações ou veja as notas de versão na página Pacote PyPI da Distro do Azure Monitor.
• Familiarize-se com o Azure Monitor Application Insights e o OpenTelemetry no Aplicativo de Exemplo do Azure Monitor.
• Saiba mais sobre o OpenTelemetry e sua comunidade no repositório OpenTelemetry Python GitHub.
• Consulte as instrumentações e componentes OpenTelemetry disponíveis no repositório Python GitHub do OpenTelemetry Contributor.
• Habilite experiências de uso habilitando o monitoramento de usuários da Web ou do navegador.

Etapa 1: Habilitar o log de diagnóstico

O Exportador do Azure Monitor usa EventSource para seu log interno. Os logs do exportador estão disponíveis para qualquer EventListener ao aceitar a fonte nomeada OpenTelemetry-AzureMonitor-Exporter. Para conhecer as etapas de solução de problemas, consulte Solução de problemas do OpenTelemetry no GitHub.

Etapa 2: Testar a conectividade entre o host do aplicativo e o serviço de ingestão

SDKs e agentes do Application Insights enviam telemetria para serem ingeridos como chamadas REST em nossos pontos de extremidade de ingestão. Para testar a conectividade do seu servidor Web ou computador host de aplicativo com os pontos de extremidade do serviço de ingestão, use comandos cURL ou solicitações REST brutas do PowerShell. Para obter mais informações, consulte Solucionar problemas de telemetria de aplicativo ausente no Azure Monitor Application Insights.

Problemas conhecidos

Os seguintes itens são problemas conhecidos para os Exportadores OpenTelemetry do Azure Monitor:

• O nome da operação está ausente da telemetria de dependência. O nome da operação ausente causa falhas e afeta negativamente a experiência da guia de desempenho.

• O modelo de dispositivo está ausente da telemetria de solicitação e dependência. O modelo de dispositivo ausente afeta negativamente a análise de coorte de dispositivos.

Etapa 1: Habilitar o log de diagnóstico

O Exportador do Azure Monitor usa EventSource para seu log interno. Os logs do exportador estão disponíveis para qualquer EventListener ao aceitar a fonte nomeada OpenTelemetry-AzureMonitor-Exporter. Para conhecer as etapas de solução de problemas, consulte Solução de problemas do OpenTelemetry no GitHub.

Etapa 2: Testar a conectividade entre o host do aplicativo e o serviço de ingestão

SDKs e agentes do Application Insights enviam telemetria para serem ingeridos como chamadas REST em nossos pontos de extremidade de ingestão. Para testar a conectividade do seu servidor Web ou computador host de aplicativo com os pontos de extremidade do serviço de ingestão, use comandos cURL ou solicitações REST brutas do PowerShell. Para obter mais informações, consulte Solucionar problemas de telemetria de aplicativo ausente no Azure Monitor Application Insights.

Problemas conhecidos

Os seguintes itens são problemas conhecidos para os Exportadores OpenTelemetry do Azure Monitor:

• O nome da operação está ausente da telemetria de dependência. O nome da operação ausente causa falhas e afeta negativamente a experiência da guia de desempenho.

• O modelo de dispositivo está ausente da telemetria de solicitação e dependência. O modelo de dispositivo ausente afeta negativamente a análise de coorte de dispositivos.

Etapa 1: Habilitar o log de diagnóstico

Por padrão, o log de diagnóstico é habilitado no Azure Monitor Application Insights. Para obter mais informações, consulte Guia de solução de problemas: Azure Monitor Application Insights for Java.

Etapa 2: Testar a conectividade entre o host do aplicativo e o serviço de ingestão

SDKs e agentes do Application Insights enviam telemetria para serem ingeridos como chamadas REST em nossos pontos de extremidade de ingestão. Para testar a conectividade do seu servidor Web ou computador host de aplicativo com os pontos de extremidade do serviço de ingestão, use comandos cURL ou solicitações REST brutas do PowerShell. Para obter mais informações, consulte Solucionar problemas de telemetria de aplicativo ausente no Azure Monitor Application Insights.

Problemas conhecidos

• Se você baixar a biblioteca de cliente do Application Insights para instalação a partir de um navegador, às vezes o arquivo JAR baixado está corrompido e tem cerca de metade do tamanho do arquivo de origem. Se você enfrentar esse problema, baixe o arquivo JAR executando o comando curl ou wget , conforme mostrado nas seguintes chamadas de comando de exemplo:

  curl --location --output applicationinsights-agent-3.4.11.jar https://github.com/microsoft/ApplicationInsights-Java/releases/download/3.4.11/applicationinsights-agent-3.4.11.jar
  

  wget --output-document=applicationinsights-agent-3.4.11.jar https://github.com/microsoft/ApplicationInsights-Java/releases/download/3.4.11/applicationinsights-agent-3.4.11.jar
  

  Nota

  As chamadas de comando de exemplo aplicam-se ao Application Insights for Java versão 3.4.11. Para encontrar o número da versão e o endereço URL da versão atual do Application Insights for Java, consulte https://github.com/microsoft/ApplicationInsights-Java/releases.

As etapas a seguir são aplicáveis a aplicativos nativos do Spring Boot.

Etapa 1: Verificar a versão do OpenTelemetry

Você pode notar a seguinte mensagem durante a inicialização do aplicativo:

WARN  c.a.m.a.s.OpenTelemetryVersionCheckRunner - The OpenTelemetry version is not compatible with the spring-cloud-azure-starter-monitor dependency.
The OpenTelemetry version should be <version>

Nesse caso, você precisa importar as listas de materiais do OpenTelemetry seguindo a documentação do OpenTelemetry no iniciador do Spring Boot.

Etapa 2: Habilitar o autodiagnóstico

Se algo não funcionar como esperado, você pode habilitar o DEBUG autodiagnóstico no nível para obter alguns insights. Para fazer isso, defina o nível de autodiagnóstico como ERROR, WARN, INFO, DEBUG, ou TRACE usando a APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_LEVEL variável de ambiente.

Para habilitar o autodiagnóstico no nível ao DEBUG executar um contêiner do docker, execute o seguinte comando:

docker run -e APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_LEVEL=DEBUG <image-name>

Exclusão de responsabilidade de informações de terceiros

Os produtos de terceiros referidos neste artigo são fabricados por empresas independentes da Microsoft. A Microsoft não concede qualquer garantia, implícita ou de outra natureza, relativamente ao desempenho ou à fiabilidade destes produtos.

Etapa 1: Habilitar o log de diagnóstico

O Azure Monitor Exporter usa o logger da API OpenTelemetry para logs internos. Para habilitar o registrador, execute o seguinte trecho de código:

const { diag, DiagConsoleLogger, DiagLogLevel } = require("@opentelemetry/api");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");

const provider = new NodeTracerProvider();
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ALL);
provider.register();

Etapa 2: Testar a conectividade entre o host do aplicativo e o serviço de ingestão

SDKs e agentes do Application Insights enviam telemetria para serem ingeridos como chamadas REST em nossos pontos de extremidade de ingestão. Para testar a conectividade do seu servidor Web ou computador host de aplicativo com os pontos de extremidade do serviço de ingestão, use comandos cURL ou solicitações REST brutas do PowerShell. Para obter mais informações, consulte Solucionar problemas de telemetria de aplicativo ausente no Azure Monitor Application Insights.

Problemas conhecidos

Os seguintes itens são problemas conhecidos para os Exportadores OpenTelemetry do Azure Monitor:

• O nome da operação está ausente da telemetria de dependência. O nome da operação ausente causa falhas e afeta negativamente a experiência da guia de desempenho.

• O modelo de dispositivo está ausente da telemetria de solicitação e dependência. O modelo de dispositivo ausente afeta negativamente a análise de coorte de dispositivos.

• O nome do servidor de banco de dados está ausente do nome da dependência. Como o nome do servidor de banco de dados não está incluído, os Exportadores OpenTelemetry agregam incorretamente tabelas que têm o mesmo nome em servidores diferentes.

Etapa 1: Habilitar o log de diagnóstico

O Microsoft Azure Monitor Exporter usa a biblioteca de log padrão Python para seu log interno. A API OpenTelemetry e os logs do Exportador do Azure Monitor recebem um nível de gravidade de WARNING ou ERROR para atividade irregular. O INFO nível de gravidade é usado para atividade regular ou bem-sucedida.

Por padrão, a biblioteca de log Python define o nível de gravidade como WARNING. Portanto, você deve alterar o nível de gravidade para ver os logs sob essa configuração de gravidade. O código de exemplo a seguir mostra como exportar logs de todos os níveis de gravidade para o console e um arquivo:

...
import logging

logging.basicConfig(format = "%(asctime)s:%(levelname)s:%(message)s", level = logging.DEBUG)

logger = logging.getLogger(__name__)
file = logging.FileHandler("example.log")
stream = logging.StreamHandler()
logger.addHandler(file)
logger.addHandler(stream)
...

Etapa 2: Testar a conectividade entre o host do aplicativo e o serviço de ingestão

SDKs e agentes do Application Insights enviam telemetria para serem ingeridos como chamadas REST em nossos pontos de extremidade de ingestão. Para testar a conectividade do seu servidor Web ou computador host de aplicativo com os pontos de extremidade do serviço de ingestão, use comandos cURL ou solicitações REST brutas do PowerShell. Para obter mais informações, consulte Solucionar problemas de telemetria de aplicativo ausente no Azure Monitor Application Insights.

Etapa 3: Evitar telemetria duplicada

A telemetria duplicada geralmente é causada se você criar várias instâncias de processadores ou exportadores. Certifique-se de executar apenas um exportador e processador de cada vez para cada pilar de telemetria (logs, métricas e rastreamento distribuído).

As seções a seguir descrevem cenários que podem causar telemetria duplicada.

Duplicar logs de rastreamento no Azure Functions

Se você vir um par de entradas para cada log de rastreamento no Application Insights, provavelmente habilitou os seguintes tipos de instrumentação de log:

• A instrumentação de log nativa no Azure Functions
• A azure-monitor-opentelemetry instrumentação de registro na distribuição

Para evitar duplicação, você pode desabilitar o log da distribuição, mas deixar a instrumentação de log nativa no Azure Functions habilitada. Para fazer isso, defina a OTEL_LOGS_EXPORTER variável de ambiente como None.

Telemetria duplicada no Azure Functions "Always On"

Se a configuração Always On no Azure Functions estiver definida como Ativado, o Azure Functions manterá alguns processos em execução em segundo plano após a conclusão de cada execução. Por exemplo, suponha que você tenha uma função de temporizador de cinco minutos que chama configure_azure_monitor cada vez. Após 20 minutos, você pode ter quatro exportadores de métricas em execução ao mesmo tempo. Essa situação pode ser a origem da telemetria de métricas duplicadas.

Nessa situação, defina a configuração Always On como Desativado ou tente desligar manualmente os provedores entre cada configure_azure_monitor chamada. Para desligar cada provedor, execute chamadas de desligamento para cada provedor de medidor, rastreador e registrador atual, conforme mostrado no código a seguir:

get_meter_provider().shutdown()
get_tracer_provider().shutdown()
get_logger_provider().shutdown()

Pastas de trabalho do Azure e blocos de anotações do Jupyter

As Pastas de Trabalho do Azure e os Blocos de Anotações do Jupyter podem manter os processos de exportação em execução em segundo plano. Para evitar telemetria duplicada, limpe o cache antes de fazer mais chamadas para configure_azure_monitoro .

Passo 4: Certifique-se de que os dados de solicitação do Flask são coletados

Se você implementar um aplicativo Flask, poderá descobrir que não pode coletar dados da tabela de Solicitações do Application Insights enquanto usa a biblioteca de cliente do Azure Monitor OpenTelemetry Distro para Python. Esse problema pode ocorrer se você não estruturar suas import declarações corretamente. Você pode estar importando a estrutura da flask.Flask aplicação Web antes de chamar a configure_azure_monitor função para instrumentar a biblioteca Flask. Por exemplo, o código a seguir não instrumenta com êxito o aplicativo Flask:

from azure.monitor.opentelemetry import configure_azure_monitor
from flask import Flask

configure_azure_monitor()

app = Flask(__name__)

Em vez disso, recomendamos que você importe o módulo como um todo e, em seguida, chame configure_azure_monitor para configurar o OpenTelemetry para usar o flask Azure Monitor antes de acessarflask.Flask:

from azure.monitor.opentelemetry import configure_azure_monitor
import flask

configure_azure_monitor()

app = flask.Flask(__name__)

Como alternativa, você pode ligar configure_azure_monitor antes de importar flask.Flask:

from azure.monitor.opentelemetry import configure_azure_monitor

configure_azure_monitor()

from flask import Flask

app = Flask(__name__)

• Para problemas de suporte do Azure, abra um tíquete de suporte do Azure.
• Para problemas de OpenTelemetria, entre em contato diretamente com a comunidade OpenTelemetry .NET.
• Para obter uma lista de problemas em aberto relacionados ao Azure Monitor Exporter, consulte a página Problemas do GitHub.

• Para problemas de suporte do Azure, abra um tíquete de suporte do Azure.
• Para problemas de OpenTelemetria, entre em contato diretamente com a comunidade OpenTelemetry .NET.
• Para obter uma lista de problemas em aberto relacionados ao Azure Monitor Exporter, consulte a página Problemas do GitHub.

• Para problemas de suporte do Azure, abra um tíquete de suporte do Azure.
• Para obter ajuda com a solução de problemas, revise as etapas de solução de problemas.
• Para problemas de OpenTelemetria, entre em contato diretamente com a comunidade OpenTelemetria.
• Para obter uma lista de problemas em aberto relacionados à Autoinstrumentação Java do Azure Monitor, consulte a página Problemas do GitHub.

• Para problemas de suporte do Azure, abra um tíquete de suporte do Azure.
• Para problemas de OpenTelemetria, entre em contato diretamente com a comunidade OpenTelemetria.
• Para obter uma lista de problemas abertos com aplicativos nativos do Spring Boot, consulte a página Problemas do GitHub.
• Para obter uma lista de problemas abertos com aplicativos nativos do Quarkus, consulte a página Problemas do GitHub.

• Para problemas de suporte do Azure, abra um tíquete de suporte do Azure.
• Para problemas com OpenTelemetry , entre em contato diretamente com a comunidade OpenTelemetry JavaScript.
• Para obter uma lista de problemas em aberto relacionados ao Azure Monitor Exporter, consulte a página Problemas do GitHub.

• Para problemas de suporte do Azure, abra um tíquete de suporte do Azure.
• Para problemas de OpenTelemetria, entre em contato diretamente com a comunidade OpenTelemetry Python.
• Para obter uma lista de problemas em aberto relacionados ao Azure Monitor Distro, consulte a página Problemas do GitHub.