Monitoraggio dell'API

Questa pagina descrive come monitorare lo stato delle API API Gateway utilizzando i log e le metriche gestiti automaticamente da API Gateway.

Quando crei un'API, API Gateway crea automaticamente un servizio gestito corrispondente. Il nome del servizio gestito creato è disponibile nell'output del seguente comando:

gcloud api-gateway apis describe API_ID

Il nome del servizio è il valore del campo managedService.

Quando gli utenti inviano richieste alla tua API, API Gateway registra informazioni sulle richieste e sulle risposte. API Gateway tiene traccia anche di 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

Per generare log e metriche da visualizzare, esegui il deployment di un'API e invia richieste. Se non hai ancora creato ed eseguito il deployment di un'API in un gateway, prova la guida rapida di API Gateway.

Panoramica dell'API

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

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

    Vai alle API

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

  3. Assicurati di essere nella scheda Panoramica.

Grafici

La pagina Panoramica fornisce una serie di grafici per alcune metriche, in modo da poter rilevare immediatamente eventuali picchi, cali o attività impreviste. Utilizzando i filtri nella parte superiore della pagina, puoi:

  • Utilizza l'elenco a discesa Seleziona grafici per visualizzare i grafici relativi alle metriche che ti interessano e rimuovere quelli che non vuoi visualizzare.
  • Modifica l'ambito dei grafici selezionando uno dei vari intervalli di tempo. In questo modo viene regolato l'intervallo di tempo dei valori visualizzati, il che modifica 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:

  • Nell'angolo in alto a sinistra della tabella, fai clic sull'icona Filtra tabella per selezionare le opzioni di query di filtro perfezionate dalla tabella a discesa. Aggiungi un OR tra ciascuna query di filtro per cercare più termini.
  • Nell'angolo in alto a destra della tabella, fai clic sull'icona Opzioni di visualizzazione delle colonne per visualizzare un elenco a discesa. Seleziona le metriche che ti interessano e deseleziona quelle che non vuoi visualizzare.
  • Nell'angolo in alto a destra della pagina 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, puoi utilizzare la 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, nell'angolo in basso a destra fai clic su Visualizza tutti i log.

  • Per trovare i log di API Gateway direttamente dalla pagina Esplora log:

    1. Nella console Google Cloud, vai alla pagina Esplora log:

      Vai a Esplora log

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

Consulta il riferimento ai log di API Gateway per informazioni dettagliate sulla struttura dei log in Esplora log.

Scopri cos'altro puoi fare con i log:

  • Inizia a utilizzare Esplora log.

    Utilizza il riquadro delle 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. 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

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 API Gateway > API per il tuo progetto.

    Vai alle API

  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.

Passaggi successivi