Monitoraggio dell'API

OpenAPI   |  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 sulle richieste e sulle risposte. Endpoints monitora anche tre dei quattro indicatori aurei del monitoraggio: latenza, traffico ed errori. Queste metriche di utilizzo e prestazioni ti aiutano a monitorare la tua API.

Prima di iniziare

Per generare log e metriche da visualizzare, devi eseguire il deployment dell'API e inviare richieste. Se non hai ancora configurato nulla, prova la guida rapida di Endpoints.

Panoramica dell'API

Quando esegui il debug di un problema con il tuo servizio o vuoi semplicemente assicurarti che tutto funzioni correttamente, vai alla panoramica della tua API:

1. Nella Google Cloud console, vai alla pagina Endpoints > Servizi del tuo progetto:

   Vai alla pagina Servizi Endpoints

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

3. Assicurati di trovarti nella scheda Panoramica.

Grafici

Nella parte superiore sono presenti i grafici di alcune metriche, in modo da poter individuare immediatamente eventuali picchi e cali. Puoi:

• Nell'angolo in alto a destra del primo grafico, utilizza l'elenco a discesa Seleziona grafici per mostrare i grafici delle 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 puntatore del mouse per visualizzare una descrizione della metrica visualizzata.

• Nell'angolo in alto a destra della panoramica, regola i grafici selezionando i vari intervalli di tempo. In questo modo, l'intervallo di tempo dei valori visualizzati in questi grafici viene modificato, così come la granularità dei punti.

Tabella dei metodi

Quando sei pronto per visualizzare in dettaglio, scorri sotto i grafici per visualizzare una tabella con le metriche per i singoli metodi della tua API. Puoi:

• Nell'angolo in alto a destra della tabella, utilizza l'elenco a discesa Seleziona colonne per mostrare le metriche che ti interessano e rimuovere quelle che non vuoi visualizzare. Anche le voci qui hanno il punto interrogativo su cui puoi passare il puntatore del mouse 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. In questo modo, viene selezionato un intervallo di tempo sia per i grafici sia per la tabella.

Log

Quando individui un problema nelle metriche, vai alla pagina Esplora log nella Google Cloud console 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 della tua 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. Nella 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 Endpoints.

Per informazioni dettagliate sulla struttura dei log in Esplora log, consulta il riferimento ai log di Endpoints.

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 ottenere tutte le richieste con una latenza superiore a 300 millisecondi.

• Configura e gestisci i sink per indirizzare i log verso le destinazioni supportate. In questo modo, puoi trasmettere i log in streaming a BigQuery per un'analisi più approfondita, salvare i log non elaborati in Cloud Storage o inviarli agli argomenti di messaggistica Pub/Sub.

Filtrare per un progetto consumer specifico

Alfa

Questa funzionalità è soggetta ai "Termini dell'offerta pre-GA" nella sezione dei Termini di servizio generali dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per ulteriori informazioni, 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 del consumatore dell'API Google Cloud . 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 di un progetto consumer specifico:

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

2. Nella Google Cloud console, vai alla pagina Endpoints > Servizi del tuo progetto.

   Vai alla pagina Servizi Endpoints

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

4. Fai clic su Filtra.

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

Avvisi

Beta

Questa funzionalità è soggetta ai "Termini dell'offerta pre-GA" nella sezione dei Termini di servizio generali dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per ulteriori informazioni, consulta le descrizioni della fase di lancio.

Le metriche raccolte da Endpoints sono disponibili anche in Cloud Monitoring. Puoi utilizzare Monitoring per configurare gli avvisi su latenza, traffico ed errori. L'unico indicatore aureo per cui non puoi configurare un avviso utilizzando le metriche di Endpoints è 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 sulla saturazione.

Per configurare gli avvisi:

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

   Vai alla Google Cloud console

2. Utilizza il riquadro di navigazione e seleziona Monitoraggio.

3. Crea una policy di avviso per configurare gli avvisi per gli indicatori aurei 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 del criterio di avviso non la offre come response-code-class.

Nota: se il vincolo critico per il tuo servizio è l'I/O di rete, potresti essere in grado di utilizzare una delle metriche di Endpoints per configurare un avviso. Tutti i log di Endpoints sono inclusi in Tipo di risorsa Produced API.

Passaggi successivi

• Log di Endpoints
• Metriche di Endpoints