Osservabilità in Gestione API di Azure

SI APPLICA A: Tutti i livelli di Gestione API

L'osservabilità è la capacità di comprendere lo stato interno di un sistema dai dati prodotti e la possibilità di esplorare tali dati per rispondere a domande su cosa è successo e perché.

Gestione API di Azure consente alle organizzazioni di centralizzare la gestione di tutte le API. Poiché funge da singolo punto di ingresso di tutto il traffico api, è un luogo ideale per osservare le API.

Panoramica

Gestione API di Azure consente di scegliere di usare il gateway gestito o il gateway self-hosted, distribuito automaticamente o tramite un'estensione di Azure Arc.

La tabella seguente riepiloga tutte le funzionalità di osservabilità supportate da Gestione API per gestire le API e i modelli di distribuzione supportati. Gli autori di API e altri con autorizzazioni per operare o gestire l'istanza di Gestione API possono usare queste funzionalità.

Nota

Per gli utenti API che utilizzano il portale per sviluppatori, è disponibile un report API integrato. Fornisce solo informazioni sull'utilizzo delle singole API nei 90 giorni precedenti. Attualmente, il report predefinito dell'API non è disponibile nel portale per sviluppatori per i livelli di servizio v2.

Strumento Utile per Ritardo dei dati4 Conservazione Campionamento Tipo di dati Modelli di distribuzione supportati
Traccia delle richieste (Controllo API) Test e debug Istantaneo Le ultime 100 tracce Attivato per richiesta Tracce delle richieste Gestito, ospitato localmente, Azure Arc, Area di lavoro
Analisi integrate Monitoraggio e creazione di report Minuti Durata 100% Report e log Gestito
Metriche di Monitoraggio di Azure Monitoraggio e creazione di report Minuti 90 giorni (aggiornamento per estendere) 100% Metriche Gestito, ospitato autonomamente2, Azure Arc
Log di Monitoraggio di Azure Creazione di report, monitoraggio e debug Minuti 31 giorni/5 GB (aggiornamento per estendere) 100% (regolabile) Log Gestito1, ospitato autonomamente3, Azure Arc3
applicazione Azure Insights Creazione di report, monitoraggio e debug Secondi 90 giorni/5 GB (aggiornamento per estendere) Personalizzazione Registri, metriche Gestito1, Ospitato autonomamente1, Azure Arc1, Area di lavoro1
Registrazione tramite Hub eventi di Azure Scenari personalizzati Secondi Gestiti dall'utente Personalizzazione Personalizzazione Gestito1, ospitato autonomamente1, Azure Arc1
OpenTelemetry Monitoraggio Minuti Gestiti dall'utente 100% Metriche Con hosting autonomo2

1 Facoltativo, a seconda della configurazione della funzionalità in Gestione API di Azure.
2 Facoltativo, a seconda della configurazione del gateway.
3 Il gateway self-hosted attualmente non invia i log di diagnostica ad Monitoraggio di Azure. Tuttavia, è possibile configurare e rendere persistenti i log in locale in cui viene distribuito il gateway self-hosted. Per altre informazioni, vedi come configurare metriche e log locali per il gateway self-hosted.
4 Ad eccezione della traccia delle richieste, tutte le registrazioni in Gestione API vengono eseguite in modo asincrono.

Procedure consigliate

Le procedure seguenti possono migliorare l'osservabilità dell'API:

  • Monitoraggio granulare: abilitare le metriche per metodo per ottenere informazioni dettagliate sui tempi di risposta e sulle percentuali di errore.
  • Monitoraggio della latenza di coda: configurare avvisi specifici per metodo per la latenza di coda (ad esempio, 90°, 95° o 99° percentile), poiché la latenza media può essere fuorviante. Per implementare questa funzionalità, usare KQL (Kusto Query Language) per inoltrare i log a un'area di lavoro Log Analytics.
  • Avvisi proattivi: stabilire avvisi per metodo per le percentuali di errore e tassi di esito positivo bassi, usare i tassi anziché i conteggi per garantire l'accuratezza.
  • Traccia distribuita: abilitare la traccia per identificare i colli di bottiglia delle prestazioni e risolvere i problemi.
  • Assegnazione di tag alle risorse: applicare tag alle API per tenere traccia dei costi e allocazioni accurati.