Monitoraggio dell'API

In questa pagina viene descritto come monitorare l'integrità delle API API Gateway utilizzando i log e le metriche che API Gateway gestisce automaticamente.

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

gcloud api-gateway apis describe API_ID

Il nome del servizio è il valore del campo managedService.

Quando gli utenti effettuano richieste alla tua API, API Gateway registra le informazioni su richieste e risposte. API Gateway monitora inoltre tre dei quattro segnali aurei del monitoraggio: latenza, traffico ed errori. Queste metriche su utilizzo e prestazioni consentono di monitorare l'API.

Prima di iniziare

Per generare log e metriche per la visualizzazione, esegui il deployment di un'API e inviale richieste. Se non hai ancora creato un'API e ne hai eseguito il deployment in un gateway, prova la guida rapida del gateway API.

Panoramica dell'API

Quando esegui il debug di un problema con il tuo servizio o vuoi semplicemente che tutto funzioni come previsto, vai alla panoramica dell'API:

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

    Vai alla pagina delle API

  2. Se disponi di più 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 individuare subito eventuali picchi, cali o attività impreviste. Utilizzando i filtri nella parte superiore della pagina, puoi:

  • Utilizza l'elenco a discesa Seleziona grafici per mostrare i grafici delle metriche di tuo interesse e rimuovere quelli che non vuoi visualizzare.
  • Modifica la portata dei grafici scegliendo tra i vari intervalli di tempo. Consente di regolare l'intervallo di tempo dei valori visualizzati e, di conseguenza, anche la granularità dei punti.

Tabella dei metodi

Quando è tutto pronto per approfondire, scorri sotto i grafici per visualizzare una tabella con le metriche per i singoli metodi nell'API. Puoi:

  • Nell'angolo in alto a sinistra della tabella, fai clic sull'icona Filtra tabella per selezionare le opzioni di query di filtro perfezionato dalla tabella a discesa. Aggiungi un OR tra ogni 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 scelto un intervallo di tempo sia per i grafici che per la tabella.

Log

Quando rilevi 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 dell'API, fai clic su Visualizza log nella tabella.

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

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

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

      Vai alla pagina Esplora log

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

Consulta il riferimento ai log del gateway API per i dettagli 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 ricevendo tutte le richieste con una latenza superiore a 300 millisecondi.

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

Filtra in base a un progetto consumer specifico

Per filtrare le metriche per un progetto specifico di un consumatore:

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

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

    Vai alla pagina delle API

  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 Filtra.

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

Passaggi successivi