Monitoraggio dell'API

OpenAPI   |  gRPC

In questa pagina viene descritto come monitorare l'integrità delle API di tua proprietà utilizzando i log e le metriche che Cloud Endpoints gestisce automaticamente per te. Quando gli utenti inviano richieste alla tua API, gli endpoint registrano le informazioni relative alle richieste e alle risposte. Gli endpoint monitorano inoltre tre dei quattro indicatori 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, devi eseguire il deployment dell'API e inviarle richieste. Se non hai ancora configurato nulla, prova la guida rapida di Endpoint.

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 dell'API:

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

   Vai alla pagina di Endpoints Services

2. Se disponi di più API, fai clic su quella che vuoi monitorare.

3. Assicurati di essere nella scheda Panoramica.

Grafici

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

• In alto a destra nel primo grafico, utilizza l'elenco a discesa Seleziona grafici per mostrare i grafici relativi alle metriche di tuo interesse e rimuovi quelli che non vuoi visualizzare. Ogni voce nell'elenco a discesa contiene un punto interrogativo su cui puoi tenere premuto il puntatore del mouse per visualizzare una descrizione della metrica visualizzata.

• Nell'angolo in alto a destra della panoramica, regola i grafici scegliendo tra i vari intervalli di tempo. Questo regola l'intervallo di tempo dei valori visualizzati in questi grafici, alterando 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:

• In alto a destra nella tabella, utilizza l'elenco a discesa Seleziona colonne per mostrare le metriche che ti interessano e rimuovere quelle che non vuoi visualizzare. Le voci qui inserite contengono anche un punto interrogativo su cui puoi tenere 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. Viene scelto un intervallo di tempo sia per i grafici che per la tabella.

Log

Quando rilevi un problema nelle metriche, vai alla 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 Endpoints direttamente dalla pagina Esplora log:

  1. Nella console Google Cloud, vai alla pagina Stackdriver > Logging:

     Vai alla pagina Esplora log

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

Consulta il riferimento ai log degli endpoint per i dettagli sulla struttura dei log in Esplora log.

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 indirizzare 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 ad argomenti della messaggistica Pub/Sub.

Filtra in base a un progetto consumer specifico

Alpha

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

Per visualizzare le metriche per un progetto consumer specifico, i consumatori 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 Google Cloud del consumer dell'API. Per scoprire come limitare l'accesso alla tua API utilizzando una chiave API, consulta Limitazione dell'accesso alle API con le chiavi API.

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 Endpoint > Servizi relativa al tuo progetto.

   Vai alla pagina di Endpoints Services

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.

Avvisi

Beta

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

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

Per configurare gli avvisi:

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

   Vai alla console Google Cloud

2. Utilizzando il riquadro di navigazione, seleziona Monitoring.

3. Crea un criterio di avviso per configurare avvisi per i segnali dorati 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 la classe codice di risposta, 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 classe di codice di risposta.

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

Passaggi successivi

• Log degli endpoint
• Metriche relative agli endpoint