Monitoraggio dell'API

Questa pagina descrive 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 è 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 monitora anche tre dei quattro segnali d'oro del monitoraggio: latenza, traffico ed errori. Queste metriche di utilizzo e rendimento 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 su un gateway, prova la guida rapida di API Gateway.

Panoramica dell'API

Quando esegui il debug di un problema con il tuo servizio o vuoi semplicemente assicurarti che tutto funzioni come previsto, vai alla panoramica della tua 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 individuare immediatamente 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 che ti interessano e rimuovere quelli che non vuoi visualizzare.
  • Regola 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 esaminare i dati 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 sinistra della tabella, fai clic sull'icona Filtra tabella per selezionare le opzioni di query di filtro perfezionate dalla tabella a discesa. Aggiungi un operatore 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 periodo di tempo per i valori delle metriche nella tabella utilizzando il selettore del periodo di tempo. In questo modo viene selezionato un intervallo di tempo sia per i grafici sia per la tabella.

Log

Quando rilevi un problema nelle metriche, puoi utilizzare la pagina Esplora log nella consoleGoogle 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 di tutti i metodi dell'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 a Esplora log

    2. Fai clic su Tutte le risorse.

    3. Seleziona API Gateway, LOCATION e GATEWAY_ID. Dove LOCATION è la regione in cui è stato eseguito il deployment dell'istanza API Gateway e GATEWAY_ID è il nome dell'istanza API Gateway.

    4. Fai clic su Applica.

Per informazioni dettagliate sulla struttura dei log in Esplora log, consulta il Riferimento ai log di API Gateway.

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 trasmettere i log in streaming a BigQuery per un'ulteriore analisi, salvare i log non elaborati in Cloud Storage o inviarli agli argomenti di messaggistica Pub/Sub.

Filtrare in base a un progetto consumer specifico

Per filtrare le metriche per un progetto consumer specifico:

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

  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 di progetto nel campo Filtra per numero di progetto.

  4. Fai clic su Filtro.

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

Passaggi successivi