Condividi tramite


Configurare OpenTelemetry di Monitoraggio di Azure

Questa guida illustra come configurare OpenTelemetry (OTel) nel Monitoraggio di Azure Application Insights usando la distribuzione di OpenTelemetry di Monitoraggio di Azure. La configurazione corretta garantisce una raccolta coerente dei dati di telemetria tra applicazioni .NET, Java, Node.jse Python, consentendo un monitoraggio e una diagnostica più affidabili.

Note

Per le app per le funzioni di Azure, vedere Usare OpenTelemetry con Funzioni di Azure.

Stringa di connessione

Una stringa di connessione in Application Insights definisce la posizione di destinazione per l'invio dei dati di telemetria.

Adottare uno dei tre modi seguenti per configurare la stringa di connessione:

  • Aggiungere UseAzureMonitor() nel program.cs file.

        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();
    
  • Impostare una variabile di ambiente.

    APPLICATIONINSIGHTS_CONNECTION_STRING=<YOUR-CONNECTION-STRING>
    
  • Aggiungere la sezione seguente al file di configurazione appsettings.json.

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

Note

Se si imposta la stringa di connessione in più posizioni, viene osservato l'ordine di precedenza seguente:

  1. Codice
  2. Variabile di ambiente
  3. File di configurazione

Impostare il nome e l'istanza del ruolo cloud

Per le lingue supportate, la distribuzione OpenTelemetry di Monitoraggio di Azure rileva automaticamente il contesto delle risorse e fornisce i valori predefiniti per le proprietà Nome ruolo cloud e Istanza del ruolo cloud del componente. È tuttavia possibile sostituire i valori predefiniti con altri più pertinenti per il proprio team. Nella mappa delle applicazioni, il valore del nome del ruolo cloud corrisponde al nome visualizzato sotto un nodo.

Imposta il Cloud Role Name e il Cloud Role Instance tramite gli attributi Resource. Il nome del ruolo cloud usa gli attributi service.namespace e service.name ma, se service.name non è impostato, esegue il fallback a service.namespace. L'istanza del ruolo cloud usa il valore di attributo service.instance.id. Per informazioni sugli attributi standard per le risorse, vedere Convenzioni semantiche 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();

Abilitare il campionamento

Il campionamento riduce il volume e i costi di inserimento dei dati di telemetria. La distribuzione OpenTelemetry di Azure Monitor supporta due strategie di campionamento per le tracce e (facoltativamente) consente di allineare i log dell'applicazione alle decisioni di campionamento delle tracce. Il campionatore associa il rapporto di campionamento o la frequenza selezionati agli intervalli esportati in modo che Application Insights possa regolare i conteggi dell'esperienza in modo accurato. Per una panoramica concettuale, vedere Altre informazioni sul campionamento.

Importante

  • Le decisioni di campionamento si applicano alle tracce (intervalli).
  • Le metriche non vengono mai campionate.
  • I log non vengono campionati per impostazione predefinita. È possibile abilitare il campionamento basato su traccia per i log in modo che i log che appartengono a tracce non sottoposte a campionamento vengano eliminati. Per altri dettagli, configurare il campionamento basato su traccia per i log.

Note

Se vengono visualizzati addebiti imprevisti o costi elevati in Application Insights, le cause comuni includono volumi di telemetria elevati, picchi di inserimento dati e campionamento non configurato correttamente. Per iniziare la risoluzione dei problemi, vedere Risolvere i problemi relativi all'inserimento di dati elevati in Application Insights.

Configurare il campionamento usando le variabili di ambiente

Usare le variabili di ambiente OpenTelemetry standard per selezionare l'sampler e specificarne l'argomento:

  • OTEL_TRACES_SAMPLER — tipo di campionatore

    • microsoft.fixed.percentage - esegue il campionamento di una frazione di tracce.
    • microsoft.rate_limited - prevede un limite di tracce al secondo.
  • OTEL_TRACES_SAMPLER_ARG — argomento sampler

    • Per microsoft.fixed.percentage: valore in 0,0–1,0 (ad esempio, 0.1 = ~10%).
    • Per microsoft.rate_limited: numero massimo di tracce al secondo (ad esempio, 1.5).

Negli esempi seguenti viene illustrato come configurare il campionamento usando le variabili di ambiente.

Campionamento a percentuale fissa (~10%)

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

Campionamento a frequenza limitata (~1,5 tracce/sec)

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

Configurare il campionamento nel codice

Note

Quando vengono configurate entrambe le opzioni a livello di codice e le variabili di ambiente, le variabili di ambiente hanno la precedenza. Il comportamento predefinito del campionatore può differire in base alla lingua. Vedere le schede seguenti.

Campionamento percentuale fisso

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

Campionamento con frequenza limitata

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

Note

Se non si imposta un campionatore nel codice o tramite variabili di ambiente, Monitoraggio di Azure usa ApplicationInsightsSampler per impostazione predefinita.

Suggerimento

Quando si usa il campionamento a percentuale fissa e non si è certi di cosa impostare la frequenza di campionamento, iniziare da 5% (0.05). Modificare la frequenza in base all'accuratezza delle operazioni visualizzate nei riquadri errori e prestazioni. Qualsiasi campionamento riduce l'accuratezza, quindi è consigliabile inviare avvisi sulle metriche OpenTelemetry, che non sono interessate dal campionamento.

Configurare il campionamento basato su traccia per i log

Se questa opzione è abilitata, i record di log che appartengono a tracce non campionate vengono eliminati in modo che i log rimangano allineati al campionamento delle tracce.

  • Un record di log viene considerato parte di una traccia quando ha un oggetto valido SpanId.
  • Se la traccia TraceFlags associata indica non campionata, il record di log viene eliminato.
  • I record di log senza alcun contesto di traccia non sono interessati.
  • La funzionalità è disabilitata per impostazione predefinita. L'abilitazione riguarda la comunicazione, consultare le schede seguenti.

Usare l'impostazione seguente nella configurazione per abilitare il campionamento dei log basato su traccia:

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

Metriche attive

Le metriche in tempo reale forniscono un dashboard di analisi in tempo reale per informazioni dettagliate sulle attività e sulle prestazioni dell'applicazione.

Importante

Vedere le Condizioni per l'utilizzo supplementari per le anteprime di Microsoft Azure per le condizioni legali applicabili alle funzionalità di Azure in versione beta, in anteprima o non ancora rilasciate nella disponibilità generale.

Questa funzionalità è abilitata per impostazione predefinita.

Gli utenti possono disabilitare le metriche in tempo reale durante la configurazione della distribuzione.

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

Abilitare l'autenticazione di Microsoft Entra ID (in precedenza Azure AD)

Per una connessione più sicura ad Azure è possibile abilitare l'autenticazione di Microsoft Entra, che impedisce l'inserimento di dati di telemetria non autorizzati nella sottoscrizione.

Per altre informazioni, vedere la pagina dedicata relativa all'autenticazione di Microsoft Entra collegata per ogni lingua supportata.

Per informazioni sulla configurazione dell'autenticazione di Entra ID, vedere Autenticazione di Microsoft Entra per Application Insights

Archiviazione offline e retry automatici

Le offerte basate su OpenTelemetry di Monitor di Azure memorizzano nella cache i dati di telemetria per un massimo di 48 ore, quando un'applicazione si disconnette da Application Insights e ritenta l'invio. Per le raccomandazioni sulla gestione dei dati, vedere Esportare ed eliminare dati privati. Le applicazioni ad alto carico rilasciano occasionalmente i dati di telemetria per due motivi: il superamento del tempo consentito o il superamento delle dimensioni massime del file. Quando necessario, il prodotto assegna priorità agli eventi recenti rispetto a quelli precedenti.

Il pacchetto di distribuzione include AzureMonitorExporter, che per impostazione predefinita usa uno dei percorsi seguenti per la risorsa di archiviazione offline (elencati in ordine di precedenza):

  • Windows

    • %LOCALAPPDATA%\Microsoft\AzureMonitor
    • %TEMP%\Microsoft\AzureMonitor
  • Non-Windows

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

Per eseguire l'override della directory predefinita, impostare 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();

Per disabilitare questa funzionalità, impostare AzureMonitorOptions.DisableOfflineStorage = true.

Abilitare l'utilità di esportazione di OTLP

Per salvare i dati di telemetria su due percorsi diversi, è possibile abilitare l'utilità di esportazione OTLP (OpenTelemetry Protocol) contestualmente all'utilità di esportazione di Monitoraggio di Azure.

Note

L'utilità di esportazione OTLP viene mostrata qui solo per praticità. Non viene infatti fornito il supporto ufficiale dell'utilità di esportazione OTLP, né di alcun componente o esperienza di terze parti a valle.

  1. Installare il pacchetto OpenTelemetry.Exporter.OpenTelemetryProtocol nel progetto.

    dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
    
  2. Aggiungere il frammento di codice seguente. In questo esempio si presuppone che sia presente un agente di raccolta OpenTelemetry con un ricevitore OTLP in esecuzione. Per informazioni dettagliate, vedere l'esempio in 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();
    

Configurazioni di OpenTelemetry

Per accedere alle configurazioni di OpenTelemetry seguenti, è necessario applicare specifiche variabili di ambiente durante l'uso delle distribuzioni OpenTelemetry di Monitoraggio di Azure.

Variabile di ambiente Descrizione
APPLICATIONINSIGHTS_CONNECTION_STRING Impostarla sulla stringa di connessione per la risorsa di Application Insights.
APPLICATIONINSIGHTS_STATSBEAT_DISABLED Impostarla su true per rifiutare esplicitamente la raccolta di metriche interne.
OTEL_RESOURCE_ATTRIBUTES Coppie chiave-valore da usare come attributi di risorsa. Per altre informazioni sugli attributi delle risorse, vedere la specifica di Resource SDK.
OTEL_SERVICE_NAME Impostare il valore dell'attributo di risorsa service.name. Se service.name viene specificato anche in OTEL_RESOURCE_ATTRIBUTES, viene assegnata la precedenza a OTEL_SERVICE_NAME.

Redigere stringhe di query URL

Per redigere le stringhe di query dell’URL, disattivare la raccolta di stringhe di query. È consigliabile usare questa impostazione se si chiama Archiviazione di Azure usando un token di firma di accesso condiviso.

Quando si usa il pacchetto di distribuzione Azure.Monitor.OpenTelemetry.AspNetCore , sono incluse entrambe le librerie di strumentazione Core e HttpClient ASP.NET. Il pacchetto di distribuzione disattiva la redazione delle stringhe di query per impostazione predefinita.

Per modificare questo comportamento, è necessario impostare una variabile di ambiente su true o false.

  • Strumentazione ASP.NET Core: la redazione delle stringhe di query OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTION è disabilitata per impostazione predefinita. Per abilitarla, impostare questa variabile di ambiente su false.

  • Strumentazione client HTTP: la redazione delle stringhe di query OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTION è disabilitata per impostazione predefinita. Per abilitarla, impostare questa variabile di ambiente su false.

Intervallo di esportazione delle metriche

È possibile configurare l'intervallo di esportazione delle metriche usando la OTEL_METRIC_EXPORT_INTERVAL variabile di ambiente.

OTEL_METRIC_EXPORT_INTERVAL=60000

Il valore predefinito è 60000 millisecondi (60 secondi). Questa impostazione controlla la frequenza con cui OpenTelemetry SDK esporta le metriche.

Suggerimento

Le metriche di Monitoraggio di Azure e l'area di lavoro di Monitoraggio di Azure inseriscono metriche personalizzate a intervalli di 60 secondi fissi. Le metriche inviate più frequentemente vengono memorizzate nel buffer ed elaborate una volta ogni 60 secondi. Log Analytics registra le metriche nell'intervallo in cui vengono inviati, il che può aumentare i costi a intervalli più brevi e ritardare la visibilità nel caso di intervalli più lunghi.

Per informazioni di riferimento, vedere le specifiche OpenTelemetry seguenti: