Monitoraggio dell'API

API Open | gRPC

Questa pagina descrive come monitorare lo stato delle API di tua proprietà utilizzando i log e le metriche che Cloud Endpoints gestisce automaticamente per te. Quando gli utenti effettuano richieste alla tua API, Endpoints registra informazioni su richieste e risposte. Gli endpoint monitorano anche tre dei quattro segnali aurei del monitoraggio: latenza, traffico ed errori. Queste metriche di utilizzo e prestazioni ti consentono di monitorare la tua API.

Prima di iniziare

Devi eseguire il deployment dell'API e inviare richieste al fine di generare log e metriche per la visualizzazione. Se non hai ancora configurato nulla, prova la guida rapida agli endpoint.

Panoramica dell'API

Se stai eseguendo il debug di un problema relativo al tuo servizio o vuoi assicurarti che tutto funzioni correttamente, vai alla panoramica dell'API:

1. In Google Cloud Console, 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 da monitorare.

3. Assicurati di essere nella scheda Panoramica.

Grafici

Nella parte superiore ci sono grafici per alcune metriche, in modo da individuare immediatamente eventuali picchi e cali. Puoi:

• Nella parte superiore destra del primo grafico, utilizza l'elenco a discesa Seleziona grafici per visualizzare i grafici relativi alle metriche di tuo interesse e rimuovi quelli che non vuoi visualizzare. Ogni voce dell'elenco a discesa contiene un punto interrogativo su cui puoi posizionare il puntatore del mouse per visualizzare una descrizione della metrica visualizzata.

• Nell'angolo in alto a destra della panoramica, modifica i grafici selezionando i vari intervalli di tempo. Consente di modificare l'intervallo di tempo dei valori visualizzati in questi grafici, il che influisce anche sulla granularità dei punti.

Tabella dei metodi

Quando vuoi esaminare ulteriormente i dettagli, scorri sotto i grafici per una tabella con le metriche per singoli metodi nell'API. Puoi:

• Nell'angolo in alto a destra della tabella, utilizza l'elenco a discesa Seleziona colonne per visualizzare le metriche che ti interessano e rimuovi quelle che non vuoi mostrare. Le voci qui hanno anche un punto interrogativo che puoi tenere premuto sul puntatore del mouse per visualizzare una descrizione.

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

Log

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

• Per visualizzare i log per singoli metodi dell'API, nella tabella fai clic su Visualizza log.

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

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

  1. In Google Cloud Console, vai alla pagina Stackdriver > Logging:

     Vai alla pagina Esplora log

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

Per informazioni dettagliate sulla struttura dei log in Esplora log, consulta il riferimento sui 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 per ricevere tutte le richieste con una latenza superiore a 300 millisecondi.

• Configura e gestisci sink per instradare i tuoi log a destinazioni supportate In questo modo puoi trasmettere i log a BigQuery per ulteriori analisi, salvare i log non elaborati in Cloud Storage o inviarli ad argomenti di messaggistica Pub/Sub.

Filtra per un progetto consumer specifico

alpha

Questa funzionalità è regolata dai Termini delle offerte pre-GA dei Termini di servizio di Google Cloud. Le funzionalità pre-GA potrebbero avere supporto limitato e le modifiche a queste funzionalità potrebbero non essere compatibili con altre versioni pre-GA. Per ulteriori informazioni, consulta le descrizioni della fase di lancio.

Per visualizzare le metriche relative a un progetto consumer specifico, i consumer delle API devono inviare una chiave API quando effettuano una richiesta. Poiché gli endpoint utilizzano la chiave API per identificare il progetto a cui è associata l'applicazione di chiamata, la chiave API deve essere stata creata nel progetto Cloud del consumer dell'API. Per scoprire come limitare l'accesso alla tua API utilizzando una chiave API, consulta l'articolo su come limitare l'accesso alle API con le chiavi API.

Per filtrare le metriche in base a un progetto consumer specifico:

1. Recupera il numero di progetto del progetto consumer dell'API. Se non hai l'autorizzazione per accedere al progetto del consumer dell'API, chiedi a qualcuno che abbia l'autorizzazione di ottenere per te il numero del progetto.

2. In Google Cloud Console, 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 di progetto.

4. Fai clic su Filtro.

Le metriche sulla pagina vengono aggiornate in modo da riflettere il traffico solo dal progetto specificato.

Avvisi

beta

Questa funzionalità è regolata dai Termini delle offerte pre-GA dei Termini di servizio di Google Cloud. Le funzionalità pre-GA potrebbero avere supporto limitato e le modifiche a queste funzionalità potrebbero non essere compatibili con altre versioni pre-GA. Per ulteriori informazioni, consulta le descrizioni della fase di lancio.

Le metriche raccolte dagli endpoint sono disponibili anche in Cloud Monitoring. Puoi utilizzare Monitoring per configurare avvisi su latenza, traffico ed errori. L'unico indicatore dorato per cui non è possibile configurare un avviso per l'utilizzo delle metriche endpoint è la saturazione. Le metriche che devi monitorare per la saturazione dipendono dalla tua applicazione. Consulta l'elenco delle metriche disponibili in Cloud Monitoring per le metriche che puoi utilizzare per configurare gli avvisi di saturazione.

Per configurare gli avvisi:

1. In Google Cloud Console, seleziona il progetto Cloud con la tua API Monitoring collegata, associata all'account.

   Vai a Google Cloud Console

2. Utilizzando il riquadro di navigazione, seleziona Monitoring.

3. Crea un criterio di avviso per configurare gli avvisi per i segnali d'oro utilizzando:

   • 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 avvisi 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 avvisi 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 class-code-response, inserisci 5xx.
     5. Inserisci la soglia per cui vuoi ricevere avvisi e segui il resto della guida agli avvisi.

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

Nota: se il vincolo critico per il tuo servizio è IO 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 di Produced API.

Passaggi successivi

• Log degli endpoint
• Metriche degli endpoint