Monitoraggio dell'API

OpenAPI   |  gRPC

Questa pagina descrive come monitorare lo stato delle API di tua proprietà utilizzando i log e le metriche gestiti automaticamente da Cloud Endpoints. Quando gli utenti inviano richieste alla tua API, Endpoints registra informazioni sulle richieste e sulle risposte. Endpoints monitora anche tre dei quattro indicatori principali del monitoraggio: latenza, traffico ed errori. Queste metriche di utilizzo e prestazioni ti aiutano a monitorare la tua API.

Prima di iniziare

Devi eseguire il deployment dell'API e inviare richieste per generare log e metriche da visualizzare. Se non hai ancora configurato nulla, prova la guida introduttiva agli endpoint.

Panoramica dell'API

Quando stai cercando di risolvere un problema con il tuo servizio o vuoi solo assicurarti che tutto funzioni correttamente, vai alla panoramica dell'API:

1. Nella console Google Cloud, vai alla pagina Endpoint > Servizi per il tuo progetto:

   Vai alla pagina Servizi endpoint

2. Se hai più di un'API, fai clic su quella che vuoi monitorare.

3. Assicurati di essere nella scheda Panoramica.

Grafici

In alto sono presenti i grafici di alcune metriche, in modo da poter rilevare immediatamente eventuali picchi e cali. Puoi:

• In alto a destra del primo grafico, utilizza l'elenco a discesa Seleziona grafici per visualizzare i grafici relativi alle metriche che ti interessano e rimuovere quelli che non vuoi visualizzare. Ogni voce dell'elenco a discesa ha un punto interrogativo su cui puoi passare il mouse per visualizzare una descrizione della metrica visualizzata.

• Nell'angolo in alto a destra della panoramica, modifica i grafici selezionando uno dei vari intervalli di tempo. In questo modo viene modificato l'intervallo di tempo dei valori visualizzati in questi grafici, il che altera anche la granularità dei punti.

Tabella dei metodi

Quando vuoi visualizzare ulteriori dettagli, scorri sotto i grafici per visualizzare una tabella con le metriche per i singoli metodi dell'API. Puoi:

• In alto a destra nella tabella, utilizza l'elenco a discesa Seleziona colonne per visualizzare le metriche che ti interessano e rimuovere quelle che non vuoi visualizzare. Le voci qui hanno anche il punto interrogativo su cui puoi tenere premuto il cursore per visualizzare una descrizione.

• Nell'angolo in alto a destra della panoramica, seleziona un intervallo di tempo per i valori delle metriche nella tabella utilizzando il selettore dell'intervallo di tempo. Viene selezionato un intervallo di tempo sia per i grafici sia per la tabella.

Log

Quando riscontri un problema nelle metriche, vai alla pagina Esplora log nella console Google Cloud per visualizzare i log delle richieste e delle risposte per la tua API.

• Per visualizzare i log dei singoli metodi della tua API, fai clic su Visualizza log nella tabella.

• Per visualizzare i log di tutti i metodi dell'API, fai clic su Visualizza tutti i log nell'angolo in basso a destra.

• Per trovare i log di Endpoints direttamente dalla pagina Esplora log:

  1. Nella console Google Cloud, vai alla pagina Stackdriver > Logging:

     Vai alla pagina Esplora log

  2. Seleziona API prodotta, SERVICE_NAME, dove SERVICE_NAME è il nome del servizio Endpoints.

Per maggiori dettagli sulla struttura dei log in Esplora log, consulta il riferimento ai log degli endpoint.

Scopri cos'altro puoi fare con i log:

• Inizia a utilizzare Esplora log.

  Crea query per specificare l'insieme di voci di log che vuoi visualizzare, ad esempio tutte le richieste con una latenza superiore a 300 millisecondi.

• Configura e gestisci i sink per indirizzare i log alle destinazioni supportate. In questo modo puoi eseguire lo streaming dei log in BigQuery per ulteriori analisi, salvare i log non elaborati in Cloud Storage o inviarli agli argomenti di messaggistica Pub/Sub.

Filtrare per un progetto consumer specifico

Alpha

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

Per visualizzare le metriche di un progetto consumer specifico, i consumatori dell'API devono inviare una chiave API quando effettuano una richiesta. Poiché Endpoints utilizza la chiave API per identificare il progetto a cui è associata l'applicazione chiamante, la chiave API deve essere stata creata nel progetto Google Cloud del consumatore dell'API. Per scoprire come limitare l'accesso alla tua API utilizzando una chiave API, consulta Limitare l'accesso alle API con le chiavi API.

Per filtrare le metriche per un progetto consumer specifico:

1. Recupera il numero del progetto del progetto del consumatore dell'API. Se non disponi dell'autorizzazione per accedere al progetto del consumatore dell'API, chiedi a qualcuno che dispone dell'autorizzazione di recuperare il numero del progetto per te.

2. Nella console Google Cloud, vai alla pagina Endpoint > Servizi per il tuo progetto.

   Vai alla pagina Servizi endpoint

3. Nell'angolo in alto a sinistra della pagina Panoramica, inserisci il numero del progetto nel campo Filtra per numero progetto.

4. Fai clic su Filtra.

Le metriche nella pagina vengono aggiornate in modo da riflettere il traffico solo del progetto specificato.

Avvisi

Beta

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

Le metriche raccolte da Endpoints sono disponibili anche in Cloud Monitoring. Puoi utilizzare Monitoring per configurare avvisi su latenza, traffico ed errori. L'unico indicatore per cui non puoi configurare un avviso utilizzando le metriche di Endpoints è la saturazione. Le metriche da monitorare per la saturazione dipendono dall'applicazione. Consulta l'elenco delle metriche disponibili in Cloud Monitoring per individuare quelle che puoi utilizzare per configurare gli avvisi in caso di saturazione.

Per configurare gli avvisi:

1. Nella console Google Cloud, seleziona il progetto Google Cloud con l'API monitorata di Endpoints associata all'account.

   Vai alla console Google Cloud

2. Utilizzando il riquadro di navigazione, seleziona Monitoraggio.

3. Crea un criterio di avviso per configurare gli avvisi per i indicatori ideali utilizzando quanto segue:

   • Latenza

     1. In Tipo di condizione, inserisci Metric Threshold.
     2. In Tipo di risorsa, inserisci Produced API.
     3. Per la metrica, inserisci Request latencies.
     4. Inserisci la soglia per cui vuoi ricevere un avviso e segui il resto della guida agli avvisi.

   • Traffico

     1. In Tipo di condizione, inserisci Metric Threshold.
     2. In Tipo di risorsa, inserisci Produced API.
     3. Per la metrica, inserisci Request count.
     4. Inserisci la soglia per cui vuoi ricevere un avviso e segui il resto della guida agli avvisi.

   • Errori

     1. In Tipo di condizione, inserisci Metric Threshold.
     2. In Tipo di risorsa, inserisci Produced API.
     3. Per la metrica, inserisci Request count.
     4. Per response-code-class, inserisci 5xx.
     5. Inserisci la soglia per cui vuoi ricevere un avviso e segui il resto della guida agli avvisi.

Nota: se la tua API non ha ancora registrato una risposta 5xx, il modulo criterio di avviso non la offre come classe di codice di risposta.

Nota: se il vincolo critico per il tuo servizio è l'I/O di rete, potresti essere in grado di utilizzare una delle metriche degli endpoint per configurare un avviso. Tutti i log degli endpoint si trovano nel tipo di risorsa Produced API.

Passaggi successivi

• Log di Endpoints
• Metriche degli endpoint