Monitoraggio dell'API

Questa pagina descrive come monitorare l'integrità delle API di tua proprietà utilizzando i log e le metriche che Cloud Endpoints gestisce automaticamente per tuo conto. Quando gli utenti effettuano richieste all'API, Endpoints registra informazioni su richieste e risposte. Gli endpoint monitorano inoltre 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 per gli endpoint.

Panoramica dell'API

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

  1. In Google Cloud Console, vai alla pagina Endpoint > Servizi relativa al tuo progetto:

    Vai alla pagina Servizi di endpoint

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

  3. Assicurati di essere nella scheda Panoramica.

Grafici

Nella parte superiore sono riportati grafici relativi ad alcune metriche, che ti consentono di individuare immediatamente picchi e cali. Puoi:

  • In alto a destra nel 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. A ogni voce nell'elenco a discesa è presente un punto interrogativo in cui puoi tenere premuto 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. Regola l'intervallo di tempo dei valori visualizzati in questi grafici, che a sua volta modifica la granularità dei punti.

Tabella dei metodi

Quando vuoi analizzare in dettaglio ulteriormente, scorri sotto i grafici per una tabella con le metriche per i singoli metodi nella tua 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 rimuovere quelle che non vuoi mostrare. In queste voci è presente anche il punto interrogativo in cui puoi tenere il puntatore per vedere 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 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 relativi a singoli metodi dell'API, nella tabella fai clic su Visualizza log.

  • 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 Endpoints direttamente dalla pagina Esplora log:

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

      Vai alla pagina Esplora log

    2. Seleziona Produced API, SERVICE_NAME, dove SERVICE_NAME è il nome del servizio Endpoints.

Per maggiori dettagli sulla struttura dei log in Esplora log, consulta il riferimento dei 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 ricevendo tutte le richieste con una latenza superiore a 300 millisecondi.

  • Configura e gestisci i sink per instradare i 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 agli argomenti di messaggistica Pub/Sub.

Filtra per un progetto consumer specifico

Per visualizzare le metriche per un progetto consumer specifico, i consumer 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 di chiamata, la chiave API deve essere stata creata nel progetto Cloud consumer di API. Per informazioni su come limitare l'accesso all'API utilizzando una chiave API, consulta Limitazione dell'accesso all'API con le chiavi API.

Per filtrare le metriche relative a un progetto consumatore specifico:

  1. Recupera il numero di progetto del progetto consumer dell'API. Se non hai l'autorizzazione ad accedere al progetto dell'API consumer, chiedi a qualcuno che dispone dell'autorizzazione di richiederne il numero.

  2. In Google Cloud Console, vai alla pagina Endpoint > Servizi relativa al tuo progetto.

    Vai alla pagina Servizi di endpoint

  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 solo il traffico proveniente dal progetto specificato.

Avvisi

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

Per configurare gli avvisi:

  1. In Google Cloud Console, seleziona il progetto cloud con l'API Monitoring di endpoint associata all'account.

    Vai a Google Cloud Console

  2. Utilizzando il riquadro di navigazione, seleziona Monitoraggio.

  3. Crea un criterio di avviso per configurare gli avvisi per i segnali d'oro 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 la quale 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 la quale 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 la classe del codice di risposta, inserisci 5xx.
      5. Inserisci la soglia per la quale vuoi ricevere avvisi e segui il resto della guida agli avvisi.

Passaggi successivi