Abilitare OpenTelemetry di Monitoraggio di Azure per applicazioni .NET, Node.js, Python e Java

Articolo
10/14/2024

Questo articolo descrive come abilitare e configurare la raccolta dati basata su OpenTelemetry in Application Insights. La distribuzione OpenTelemetry di Monitoraggio di Azure:

Fornisce una distribuzione OpenTelemetry che include il supporto per le funzionalità specifiche di Monitoraggio di Azure,
Abilita la telemetria automatica includendo librerie di strumentazione OpenTelemetry per raccogliere tracce, metriche, log ed eccezioni.
Consente di raccogliere dati di telemetria personalizzati.
Supporta metriche attive per monitorare e raccogliere altri dati di telemetria dalle applicazioni Web in produzione attive.

Per altre informazioni sui vantaggi dell'uso della distribuzione OpenTelemetry di Monitoraggio di Azure, vedere Perché usare la distribuzione di OpenTelemetry di Monitoraggio di Azure.

Per altre informazioni sulla raccolta di dati con OpenTelemetry, vedere Informazioni di base sulla raccolta dati o Domande frequenti su OpenTelemetry.

Stato versione OpenTelemetry

Le offerte OpenTelemetry sono disponibili per le applicazioni .NET, Node.js, Python e Java. Per uno stato di release funzionalità per funzionalità, vedere le domande frequenti.

Abilitare OpenTelemetry con Application Insights

Seguire la procedura descritta in questa sezione per instrumentare l'applicazione con OpenTelemetry. Selezionare una scheda per istruzioni specifiche del linguaggio.

Nota

.NET include più scenari, tra cui ASP.NET classiche, app console, Windows Form (WinForms) e altro ancora.

Prerequisiti

Sottoscrizione di Azure - Creare una sottoscrizione di Azure gratuita
Risorsa di Application Insights: creare una risorsa di Application Insights

Applicazione ASP.NET Core usando una versione ufficialmente supportata di .NET

Suggerimento

Se si esegue la migrazione dall'API classica di Application Insights, vedere la documentazione sulla migrazione.

Installare la libreria client

Installare il pacchetto NuGet Azure.Monitor.OpenTelemetry.AspNetCore più recente:

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore

Installare il pacchetto NuGet Azure.Monitor.OpenTelemetry.Exporter più recente:

dotnet add package Azure.Monitor.OpenTelemetry.Exporter

Installare la versione più recente del pacchetto @azure/monitor-opentelemetry:

npm install @azure/monitor-opentelemetry

I pacchetti seguenti vengono usati anche per alcuni scenari specifici descritti più avanti in questo articolo:

npm install @opentelemetry/api
npm install @opentelemetry/sdk-metrics
npm install @opentelemetry/resources
npm install @opentelemetry/semantic-conventions
npm install @opentelemetry/sdk-trace-base

Installare la versione più recente del pacchetto azure-monitor-opentelemetry PyPI:

pip install azure-monitor-opentelemetry

Modificare l'applicazione

Importare lo spazio dei nomi Azure.Monitor.OpenTelemetry.AspNetCore, aggiungere OpenTelemetry e configurarlo per l'uso di Monitoraggio di Azure nella classe program.cs:

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

Aggiungere l'utilità di esportazione di Monitoraggio di Azure a ogni segnale OpenTelemetry nella classe program.cs:

// 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

Per altre informazioni, vedere l'esercitazione introduttiva per OpenTelemetry .NET

La strumentazione automatica viene abilitata tramite le modifiche alla configurazione. Non sono necessarie modifiche al codice.

Puntare la macchina virtuale Java (JVM) al file JAR aggiungendo -javaagent:"path/to/applicationinsights-agent-3.6.2.jar" agli argomenti JVM dell'applicazione.

Nota

Il campionamento è abilitato per impostazione predefinita a una velocità di 5 richieste al secondo, che facilita la gestione dei costi. I dati di telemetria potrebbero non essere presenti negli scenari che superano questa frequenza. Per altre informazioni sulla modifica della configurazione di campionamento, vedere Override del campionamento.

Suggerimento

Per indicazioni specifiche per gli scenari, vedere Introduzione (supplementare).

Suggerimento

Se si sviluppa un'applicazione Spring Boot, è possibile sostituire facoltativamente l'argomento JVM con una configurazione a livello di codice. Per altre informazioni, vedere Uso di Application Insights di Monitoraggio di Azure con Spring Boot.

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

Copiare la stringa di connessione dalla risorsa di Application Insights

La stringa di connessione è univoca e specifica dove la distribuzione OpenTelemetry di Monitoraggio di Azure invia i dati di telemetria raccolti.

Suggerimento

Se non si ha già una risorsa di Application Insights, crearne una seguendo questa guida. È consigliabile creare una nuova risorsa anziché usarne una esistente.

Per copiare la stringa di connessione:

Passare al riquadro Panoramica della risorsa di Application Insights.
Trovare la stringa di connessione.
Passare il puntatore del mouse sulla stringa di connessione e selezionare l'icona Copia negli Appunti.

Incollare la stringa di connessione nell'ambiente

Per incollare la stringa di connessione, selezionare una delle opzioni seguenti:

Importante

È consigliabile impostare la stringa di connessione tramite codice solo in ambienti di sviluppo e test locali.

Per la produzione, usare una variabile di ambiente o un file di configurazione (solo Java).

Impostare tramite variabile di ambiente - scelta consigliata

Sostituire <Your connection string> nel comando seguente con la stringa di connessione univoca.
```
APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
```
Impostare tramite il file di configurazione - Solo Java

Creare un file di configurazione denominato applicationinsights.json e inserirlo nella stessa directory di applicationinsights-agent-3.6.2.jar con il contenuto seguente:
```
{
  "connectionString": "<Your connection string>"
}
```
Sostituire <Your connection string> nel codice JSON precedente con la stringa di connessione univoca.
Impostare tramite codice - Solo ASP.NET Core, Node.js e Python

Per un esempio di impostazione della stringa di connessione tramite codice, vedere Configurazione della stringa di connessione.

Nota

Se si imposta la stringa di connessione in più posizioni, la variabile di ambiente verrà assegnata in ordine di priorità nell'ordine seguente:

Codice
Variabile di ambiente
File di configurazione

Verificare che i dati vengano trasmessi

Eseguire l'applicazione, quindi aprire Application Insights nel portale di Azure. La visualizzazione dei dati potrebbe richiedere alcuni minuti.

Screenshot della scheda Panoramica di Application Insights con le richieste del server e il tempo di risposta del server evidenziato.

Application Insights è ora abilitato per l'applicazione. I passaggi seguenti sono facoltativi e consentono ulteriori personalizzazioni.

Importante

Se si dispone di due o più servizi che generano dati di telemetria nella stessa risorsa di Application Insights, è necessario impostare i nomi dei ruoli cloud per rappresentarli correttamente nella mappa delle applicazioni.

Nell'ambito dell'uso della strumentazione di Application Insights, vengono raccolti e inviati dati di diagnostica a Microsoft. Questi dati consentono di eseguire e migliorare Application Insights. Per altre informazioni, vedere Statsbeat in Azure Application Insights.

Applicazioni di esempio

Le applicazioni di esempio OpenTelemetry di Monitoraggio di Azure sono disponibili per tutte le lingue supportate:

Passaggi successivi

Per informazioni dettagliate sull'aggiunta e la modifica di OpenTelemetry di Monitoraggio di Azure, vedere Aggiungere e modificare OpenTelemetry di Monitoraggio di Azure.
Per configurare ulteriormente la distribuzione di OpenTelemetry, vedere Configurazione di OpenTelemetry di Monitoraggio di Azure.
Per esaminare il codice sorgente, vedere il repository GitHub AspNetCore di Monitoraggio di Azure.
Per installare il pacchetto NuGet, verificare la disponibilità di aggiornamenti o visualizzare le note sulla versione, vedere la pagina Pacchetto NuGet AspNetCore di Monitoraggio di Azure.
Per acquisire familiarità con Monitoraggio di Azure e OpenTelemetry, vedere l'applicazione di esempio di Monitoraggio di Azure.
Per altre informazioni su OpenTelemetry e sulla relativa community, vedere il repository GitHub .NET OpenTelemetry.
Per abilitare le esperienze di utilizzo, abilitare il monitoraggio degli utenti Web o browser.
Per esaminare le domande frequenti, i passaggi per la risoluzione dei problemi, le opzioni di supporto o per fornire commenti e suggerimenti su OpenTelemetry, vedere La Guida, il supporto e il feedback di OpenTelemetry per Application Insights di Monitoraggio di Azure.

Per informazioni dettagliate sull'aggiunta e la modifica di OpenTelemetry di Monitoraggio di Azure, vedere Aggiungere e modificare OpenTelemetry di Monitoraggio di Azure.
Per esaminare il codice sorgente, vedere il repository GitHub OpenTelemetry di Monitoraggio di Azure.
Per installare il pacchetto npm e verificare la disponibilità di aggiornamenti, vedere la pagina @azure/monitor-opentelemetry pacchetto npm.
Per acquisire familiarità con Monitoraggio di Azure, Application Insights e OpenTelemetry, vedere l'applicazione di esempio di Monitoraggio di Azure.
Per altre informazioni su OpenTelemetry e sulla relativa community, vedere il repository GitHub JavaScript OpenTelemetry.
Per abilitare le esperienze di utilizzo, abilitare il monitoraggio degli utenti Web o browser.
Per esaminare le domande frequenti, i passaggi per la risoluzione dei problemi, le opzioni di supporto o per fornire commenti e suggerimenti su OpenTelemetry, vedere La Guida, il supporto e il feedback di OpenTelemetry per Application Insights di Monitoraggio di Azure.

Condividi tramite

Abilitare OpenTelemetry di Monitoraggio di Azure per applicazioni .NET, Node.js, Python e Java

Stato versione OpenTelemetry

Abilitare OpenTelemetry con Application Insights

Prerequisiti

Installare la libreria client

Modificare l'applicazione

Copiare la stringa di connessione dalla risorsa di Application Insights

Incollare la stringa di connessione nell'ambiente

Verificare che i dati vengano trasmessi

Applicazioni di esempio

Passaggi successivi

Commenti e suggerimenti

Risorse aggiuntive