Monitoraggio dell'utilizzo delle API

Questa pagina descrive come utilizzare le metriche API per monitorare e comprendere l'utilizzo delle API di Google e Google Cloud.

Le API di Google generano metriche di utilizzo dettagliate che possono aiutarti a:

  • Monitora e comprendi il tuo utilizzo delle API di Google.
  • Monitora le prestazioni delle tue applicazioni e delle API di Google.
  • Scopri i problemi tra le tue applicazioni e le API di Google.

Può accelerare notevolmente i tempi di risoluzione quando risolvi problemi o hai bisogno di assistenza tecnica da parte di Google.

Le metriche prodotte dalle API di Google sono gli indicatori standard che gli Site Reliability Engineer di Google utilizzano per valutare l'integrità di un servizio. Queste metriche coprono i conteggi delle richieste, i tassi di errore, le latenze totali, le latenze di backend, le dimensioni delle richieste e le dimensioni delle risposte. Per le definizioni delle metriche API, consulta la documentazione di Cloud Monitoring.

Puoi visualizzare le metriche API in due posizioni: dashboard delle API e Cloud Monitoring. Le metriche che vedi sono specifiche per il tuo progetto e non riflettono lo stato generale del servizio.

Utilizzo della dashboard API

Il modo più semplice per visualizzare le metriche API è utilizzare la dashboard API di Google Cloud Console. Puoi visualizzare una panoramica di tutto l'utilizzo delle API oppure puoi esaminare in dettaglio l'utilizzo di un'API specifica.

Per visualizzare una panoramica dell'utilizzo dell'API:

  1. Visita la sezione API e servizi di Cloud Console. Per impostazione predefinita viene visualizzata la dashboard API principale. In questa pagina puoi visualizzare tutte le API attualmente abilitate per il tuo progetto, nonché i grafici di panoramica per le seguenti metriche:

    • Traffico: il numero di richieste al secondo effettuate dal tuo progetto o relative al tuo progetto alle API abilitate
    • Errori: la percentuale di richieste alle API abilitate che hanno generato errori
    • Latenza mediana: la latenza mediana per le richieste alle API abilitate, se disponibile.

Per visualizzare i dettagli di utilizzo di un'API specifica:

  1. Seleziona l'API che vuoi visualizzare nell'elenco principale delle API della dashboard delle API. La pagina Panoramica dell'API mostra un grafico del traffico più dettagliato con una suddivisione per codice di risposta.

  2. Per informazioni sull'utilizzo ancora più dettagliate, seleziona Visualizza metriche. Per impostazione predefinita, vengono visualizzati i seguenti grafici predefiniti, anche se ne sono disponibili altri:

    • Traffico per codice di risposta
    • Errori per metodo API
    • Latenza complessiva al 50°, 95° e 99° percentile
    • Latenza per metodo API (mediana)

  3. Se vuoi aggiungere altri grafici, puoi selezionarne altri predefiniti dal menu a discesa Seleziona grafici.

Utilizzo di Cloud Monitoring

Se utilizzi Cloud Monitoring, puoi analizzare più in dettaglio i dati delle metriche disponibili utilizzando Metrics Explorer per ottenere maggiori insight sull'utilizzo dell'API. Cloud Monitoring supporta un'ampia gamma di metriche, che possono essere combinate con filtri e aggregazioni per ottenere punti di vista nuovi e significativi sul rendimento delle applicazioni. Ad esempio, puoi combinare una metrica di conteggio delle richieste con un filtro sulla classe del codice di risposta HTTP per creare un dashboard che mostri i tassi di errore nel tempo oppure puoi esaminare la latenza del 95° percentile delle richieste all'API Cloud Pub/Sub.

Per visualizzare le metriche API in Metrics Explorer, seleziona API utilizzata come tipo di risorsa, quindi seleziona una delle metriche serviceruntime. Quindi utilizza le opzioni di filtro e aggregazione per perfezionare i dati. Dopo aver trovato le informazioni sull'utilizzo dell'API, puoi utilizzare Cloud Monitoring per creare dashboard e avvisi personalizzati che ti aiuteranno a continuare a monitorare e gestire un'applicazione solida. Le istruzioni per questa operazione sono disponibili alle pagine seguenti:

Per saperne di più, consulta Esplora metriche.

Risoluzione dei problemi con le metriche API

Le metriche API possono essere particolarmente utili se devi contattare Google quando qualcosa va storto e possono persino mostrarti che non devi contattare l'assistenza. Ad esempio:

  • Se tutte le chiamate a un servizio non vanno a buon fine per un singolo ID credenziale, ma non per altri, è probabile che ci sia qualcosa di sbagliato in quell'account che puoi facilmente risolvere autonomamente senza aprire un ticket.
  • Stai risolvendo un problema con la tua app e noti una correlazione tra le prestazioni limitate della tua applicazione e un prolungato aumento della latenza del 50° percentile di un servizio GCP critico. Chiamaci e indicaci questi dati in modo che possiamo iniziare a lavorare sul problema il più rapidamente possibile.
  • Le latenze per un servizio GCP riportano un aspetto positivo e invariato rispetto a prima, ma le metriche in-app segnalano che la latenza delle chiamate al servizio è eccessivamente alta. Questo indica che si è verificato un problema di rete. Contatta il tuo operatore di rete (in alcuni casi, Google) per avviare il processo di debug.

Best practice

Sebbene le metriche API siano uno strumento estremamente utile, devi considerare alcuni problemi per assicurarti che forniscano informazioni utili, in particolare quando configuri avvisi basati sui valori delle metriche. Le seguenti best practice ti aiuteranno a ottenere il massimo dai dati delle metriche API.

La latenza sta causando problemi?

Mentre alcuni servizi sono piuttosto sensibili alla latenza, per altri la scalabilità e l'affidabilità sono più importanti. Alcune API, ad esempio Cloud Storage o BigQuery, possono avere una latenza elevata di un paio di secondi senza che i clienti se ne accorgano. Con i dati delle metriche API, puoi scoprire di cosa hanno bisogno i tuoi utenti da un determinato servizio.

Cercare variazioni rispetto alla norma

Prima di decidere di generare un avviso per un determinato valore della metrica, considera cosa conta effettivamente come comportamento insolito. L'analisi delle metriche API può mostrare che i risultati di latenza per la maggior parte dei servizi rientrano in una distribuzione normale: un grande picco al centro e valori anomali su entrambi i lati. Le metriche ti aiuteranno a comprendere la distribuzione normale, in modo da progettare la tua app in modo che funzioni bene all'interno della curva di distribuzione. Le metriche possono anche aiutarti a correlare le modifiche alla distribuzione con i periodi in cui la tua app non funziona come previsto, per aiutarti a trovare la causa principale di un problema. Prevediamo che il 99° percentile sia molto diverso dalla mediana, ma non ci aspettiamo cambiamenti drastici in questi percentili nel tempo.

Inoltre, potresti notare che alcuni tipi di richieste richiedono più tempo rispetto ad altri. Se le dimensioni medie di una foto caricata su Google Foto sono 4 MB, ma di solito carichi file RAW da 20 MB, il tempo medio per caricare 20 foto sarà probabilmente molto peggiore di quello della maggior parte degli utenti, ma è comunque il tuo comportamento normale.

Tutto ciò significa che non è particolarmente utile inviare un avviso la prima volta che viene rilevata una chiamata RPC di un secondo o una chiamata HTTP 5xx. Quando esamini un servizio Google come possibile causa di un problema riscontrato dalla tua applicazione, confronta i codici restituiti e i tassi di latenza nel tempo e cerca cambiamenti sostenuti rispetto alla norma che sono correlati ai problemi osservati nella tua applicazione.

Tasso di traffico

Le metriche API sono più utili quando hai un volume elevato di traffico diretto all'API. Se chiami un servizio solo a intermittenza, le metriche API non saranno statisticamente valide e non ti forniranno informazioni di triage significative.

Ad esempio, se vuoi monitorare la latenza del 99,5° percentile per un servizio ed esegui solo 100 chiamate all'ora, osservare la misurazione per un periodo di due ore ti darebbe solo un punto dati per rappresentare il 99,5° percentile, che non ti direbbe molto sul comportamento normale dell'API o della tua applicazione. Assicurati che il tasso di traffico, il percentile che stai monitorando e la finestra temporale che stai considerando generino molti punti dati di interesse, altrimenti i dati di monitoraggio non ti saranno utili.

API supportate

Tutte le API Google e Google Cloud, nonché le API create in base a Cloud Endpoints e API Gateway, supportano le metriche API. Se sei un consumer di API, puoi visualizzare le metriche delle API utilizzate nella dashboard delle API. Se sei un produttore di API, puoi visualizzare le metriche delle API prodotte nella dashboard di Endpoints.