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

Este artigo descreve como habilitar e configurar a coleta de dados baseada em OpenTelemetry no Application Insights. A Distro OpenTelemetry do Azure Monitor:

• Fornece uma distribuição OpenTelemetry que inclui suporte para recursos específicos do Azure Monitor.
• Permite a telemetria automática incluindo bibliotecas de instrumentação OpenTelemetry para coletar rastreamentos, métricas, logs e exceções.
• Permite coletar telemetria personalizada .
• Suporta métricas em tempo real para monitorar e coletar mais telemetria de aplicativos Web em tempo real em produção.

Para obter mais informações sobre as vantagens de usar a Distro OpenTelemetry do Azure Monitor, consulte Por que devo usar a Distro OpenTelemetry do Azure Monitor.

Para saber mais sobre como coletar dados usando OpenTelemetry, confira Noções básicas de coleta de dados ou as Perguntas frequentes sobre OpenTelemetria.

Status da versão do OpenTelemetry

As ofertas OpenTelemetry estão disponíveis para aplicativos .NET, Node.js, Python e Java. Para obter um status de versão recurso por recurso, consulte as Perguntas frequentes.

Habilite o OpenTelemetry com o Application Insights

Siga as etapas nesta seção para instrumentar seu aplicativo com OpenTelemetry. Selecione uma guia para instruções específicas do idioma.

Nota

O .NET abrange vários cenários, incluindo ASP.NET clássico, aplicativos de console, Windows Forms (WinForms) e muito mais.

Pré-requisitos

• Subscrição do Azure: crie uma subscrição do Azure gratuitamente
• Recurso do Application Insights: Criar um recurso do Application Insights

ASP.NET Core

• ASP.NET Core Application usando uma versão oficialmente suportada do .NET

Gorjeta

Se você estiver migrando da API do Application Insights Classic, consulte nossa documentação de migração.

.NET

• Aplicação utilizando uma versão suportada do .NET ou .NET Framework 4.6.2 e posterior.

Gorjeta

Se você estiver migrando da API do Application Insights Classic, consulte nossa documentação de migração.

Java

• Uma aplicação Java usando Java 8+

Java nativo

• Uma aplicação Java usando GraalVM 17+

Node.js

• Aplicação que utiliza uma versão oficialmente suportada do Node.js tempo de execução:
  • Tempos de execução suportados pelo OpenTelemetry
  • Runtimes suportados pelo Azure Monitor OpenTelemetry Exporter

Nota

Se você não depender de nenhuma propriedade listada na tabela sem suporte, o shim do ApplicationInsights será o caminho mais fácil depois de sair da versão beta.

Se você confiar em qualquer uma dessas propriedades, continue com a Distro OpenTelemetry do Azure Monitor. Forneceremos um guia de migração em breve.

Gorjeta

Se você estiver migrando da API do Application Insights Classic, consulte nossa documentação de migração.

Python

• Aplicação Python usando Python 3.8+

Gorjeta

Se você estiver migrando do OpenCensus, consulte nossa documentação de migração.

Instalar a biblioteca de cliente

ASP.NET Core

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

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore 

.NET

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

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Java

Transfira o ficheiro applicationinsights-agent-3.6.0.jar .

Aviso

Se você estiver atualizando de uma versão 3.x anterior, poderá ser afetado pela alteração de padrões ou pequenas diferenças nos dados que coletamos. Para obter mais informações, consulte a seção de migração nas notas de versão. 3.5.0, 3.4.0, 3.3.0, 3.2.0 e 3.1.0

Java nativo

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 .

Node.js

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

Python

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

pip install azure-monitor-opentelemetry

Modificar a sua candidatura

ASP.NET Core

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

.NET

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

Nota

Para obter mais informações, consulte o tutorial de introdução para OpenTelemetry .NET

Java

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.6.0.jar" aos args da JVM do seu aplicativo.

Nota

A amostragem é ativada por padrão a uma taxa de 5 solicitações por segundo, ajudando no gerenciamento de custos. Os dados de telemetria podem estar ausentes em cenários que excedem essa taxa. Para obter mais informações sobre como modificar a configuração de amostragem, consulte substituições de amostragem.

Gorjeta

Para obter orientações específicas do cenário, consulte Introdução (suplementar).

Gorjeta

Se você desenvolver um aplicativo Spring Boot, poderá opcionalmente substituir o argumento JVM por uma configuração programática. Para obter mais informações, consulte Usando o Azure Monitor Application Insights com o Spring Boot.

Java nativo

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

Node.js

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

Python

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

Copie a cadeia de conexão do recurso do Application Insights

A cadeia de conexão é exclusiva e especifica para onde a Distro OpenTelemetry do Azure Monitor envia a telemetria coletada.

Gorjeta

Se você ainda não tiver um recurso do Application Insights, crie um seguindo este guia. Recomendamos que você crie um novo recurso em vez de usar um existente.

Para copiar a cadeia de conexão:

1. Vá para o painel Visão geral do recurso do Application Insights.
2. Encontre sua cadeia de conexão.
3. Passe o cursor sobre a cadeia de conexão e selecione o ícone Copiar para a área de transferência.

Cole a cadeia de conexão em seu ambiente

Para colar a cadeia de conexão, selecione uma das seguintes opções:

Importante

Recomendamos definir a cadeia de conexão através do código somente em ambientes locais de desenvolvimento e teste.

Para produção, use uma variável de ambiente ou arquivo de configuração (somente Java).

• Definir através da variável - de ambiente recomendada

  Substitua <Your connection string> no comando a seguir pela cadeia de conexão.

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• Definir apenas através do ficheiro de - configuração Java

  Crie um arquivo de configuração chamado applicationinsights.json, e coloque-o no mesmo diretório que applicationinsights-agent-3.6.0.jar com o seguinte conteúdo:

  {
    "connectionString": "<Your connection string>"
  }
  

  Substitua <Your connection string> o JSON anterior por sua cadeia de conexão exclusiva.

• Definir apenas por código - ASP.NET Core, Node.js e Python

  Consulte Configuração da cadeia de conexão para obter um exemplo de configuração da cadeia de conexão via código.

Nota

Se você definir a cadeia de conexão em vários locais, a variável de ambiente será priorizada na seguinte ordem:

1. Código
2. Variável de ambiente
3. Arquivo de configuração

Confirmar que os dados estão fluindo

Execute seu aplicativo e abra o Application Insights no portal do Azure. Pode levar alguns minutos para que os dados apareçam.

O Application Insights agora está habilitado para seu aplicativo. As etapas a seguir são opcionais e permitem mais personalização.

Importante

Se você tiver dois ou mais serviços que emitem telemetria para o mesmo recurso do Application Insights, será necessário definir Nomes de Função na Nuvem para representá-los corretamente no Mapa do Aplicativo.

Como parte do uso da instrumentação do Application Insights, coletamos e enviamos dados de diagnóstico para a Microsoft. Esses dados nos ajudam a executar e melhorar o Application Insights. Para saber mais, consulte Statsbeat no Azure Application Insights.

Exemplos de aplicações

Os aplicativos de exemplo do Azure Monitor OpenTelemetry estão disponíveis para todos os idiomas suportados:

• Aplicativo de exemplo do ASP.NET Core
• NET aplicativo de exemplo
• Aplicativos de exemplo Java
• Aplicativos de exemplo nativos do Java GraalVM
• Node.js aplicativo de exemplo
• Aplicativos de exemplo Python

Próximos passos

ASP.NET Core

• 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 revisar perguntas frequentes, etapas de solução de problemas, opções de suporte ou fornecer comentários sobre o OpenTelemetria, consulte Ajuda, suporte e comentários do OpenTelemetry para o Azure Monitor Application Insights.

.NET

• 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.
• Para revisar perguntas frequentes, etapas de solução de problemas, opções de suporte ou fornecer comentários sobre o OpenTelemetria, consulte Ajuda, suporte e comentários do OpenTelemetry para o Azure Monitor Application Insights.

Java

• 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.
• Para revisar perguntas frequentes, etapas de solução de problemas, opções de suporte ou fornecer comentários sobre o OpenTelemetria, consulte Ajuda, suporte e comentários do OpenTelemetry para o Azure Monitor Application Insights.

Java nativo

• 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 revisar perguntas frequentes, etapas de solução de problemas, opções de suporte ou fornecer comentários sobre o OpenTelemetria, consulte Ajuda, suporte e comentários do OpenTelemetry para o Azure Monitor Application Insights.

Node.js

• 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.
• Para revisar perguntas frequentes, etapas de solução de problemas, opções de suporte ou fornecer comentários sobre o OpenTelemetria, consulte Ajuda, suporte e comentários do OpenTelemetry para o Azure Monitor Application Insights.

Python

• 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.
• Para revisar perguntas frequentes, etapas de solução de problemas, opções de suporte ou fornecer comentários sobre o OpenTelemetria, consulte Ajuda, suporte e comentários do OpenTelemetry para o Azure Monitor Application Insights.