Configurazione di avvisi e notifiche

Stai visualizzando la documentazione di Apigee X.
Visualizza la documentazione di Apigee Edge.

Uno degli scopi principali di API Monitoring è per informarti di eventi o pattern insoliti, come picchi di traffico o latenze. Per monitorare eventi come questi, puoi impostare avvisi che vengono attivati al verificarsi di un evento specifico. Un evento effettivo che attiva un avviso è chiamato incidente.

Puoi impostare regole specifiche per un avviso, ad esempio potrebbe essere attivato da un codice di risposta 500 (Errore interno di servizio) su un proxy. Quando si verifica un incidente per l'avviso, puoi visualizzarne i dettagli nel riquadro Eventi della dashboard per gli avvisi di Cloud Console.

Se vuoi ricevere una notifica quando viene attivato un determinato avviso, puoi configurare una notifica per l'avviso. Quando si verifica un incidente, Apigee ti invia una notifica con un riepilogo dell'evento, inclusi i link a Cloud Console e all'interfaccia utente di Apigee per ulteriori indagini.

In API Monitoring sono disponibili due tipi di avvisi:

Avvisi basati sulle metriche, attivati dalle modifiche alle metriche delle API.
Avvisi basati su log, basati sui dati API archiviati da Cloud Logging.

Avvisi basati su metriche

Gli avvisi basati su metriche vengono attivati quando una metrica per i dati API raggiunge un livello specificato o inizia a cambiare rapidamente. Puoi definire una regola di avviso utilizzando due proprietà principali:

La metrica: la quantità che attiva l'avviso, ad esempio il numero di richieste.
La soglia: il livello che la metrica deve raggiungere per attivare l'avviso.

Passaggi iniziali per la creazione di un avviso basato su metriche

Per creare un avviso basato sulle metriche, segui questa procedura.

Apri la dashboard Crea criterio di avviso in Google Cloud Console.

Nota: apri la dashboard dei criteri di avviso in una nuova scheda se vuoi seguire i passaggi riportati di seguito.
Fai clic su AGGIUNGI CONDIZIONE. Si apre una nuova finestra in cui puoi aggiungere la condizione di avviso.
(Facoltativo) Aggiungi un titolo per la condizione nel campo Condizione senza titolo. Per questo esempio la lasciamo vuota, nel qual caso alla condizione viene assegnato un titolo predefinito.
Copia e incolla quanto segue nel campo Trova tipo di risorsa e metrica:
```
Apigee proxy (v2)
```
Il riquadro Target ora viene mostrato come mostrato di seguito.

Il riquadro visualizza il campo Seleziona una metrica in cui puoi specificare la metrica, ad esempio traffico totale o percentile di latenza.

Nota: alcune metriche elencate in Selezionare una metrica non sono al momento disponibili per API Monitoring. Consulta la sezione Metriche per un elenco delle metriche disponibili.

Dopo aver completato i passaggi iniziali precedenti, puoi continuare selezionando una metrica e aggiungendo condizioni per l'avviso. La sezione successiva presenta un esempio che mostra come fare.

Avviso per codice di risposta 500 su un proxy

L'esempio successivo crea un avviso quando viene restituito un codice di risposta 500 (Errore interno del server). Puoi creare un avviso simile per qualsiasi codice di risposta.

Per eseguire l'esempio, devi prima eseguire i passaggi iniziali descritti nella sezione precedente. Quindi continua con i passaggi seguenti.

Target

Nel riquadro Target, segui questi passaggi:

Aggiungi la metrica response_count copiando il codice riportato di seguito e incollandolo nel campo Seleziona una metrica.
```
apigee.googleapis.com/proxyV2/response_count
```
Aggiungi un filtro per il conteggio delle risposte come segue:
1. Nel campo Filtro, fai clic su Aggiungi un filtro e seleziona response_code dal menu a discesa.
2. Nel campo successivo, seleziona =.
3. Nel campo Valore, seleziona 500.
4. Fai clic su APPLICA.

Puoi lasciare invariati i campi rimanenti nel riquadro Target, poiché non vengono utilizzati nell'esempio.

Configurazione

Nel riquadro Configurazione:

Nel campo Condizione, seleziona è superiore a.
Nel campo Soglia, inserisci 1.
Nel campo Per, seleziona il valore più recente.

Infine, fai clic su AGGIUNGI per creare l'avviso. Viene visualizzata la dashboard dei criteri di avviso, che mostra la nuova condizione, come mostrato di seguito.

Da qui puoi scegliere una di queste opzioni:

Fai clic su AGGIUNGI condizione per creare un'altra condizione per l'avviso oppure
Fai clic su AVANTI per andare al passaggio 2, dove avrai la possibilità di creare una notifica per l'avviso, come descritto nella sezione successiva.

Se non vuoi creare una notifica, fai clic due volte su AVANTI senza inserire nulla per ignorare i passaggi 2 e 3.

Fai clic su SALVA per salvare l'avviso.

Aggiunta di una condizione: avviso per il codice di risposta 500 per le richieste POST HTTP su un proxy

Puoi creare più condizioni per un avviso. Ad esempio, nell'avviso per il codice di risposta 500 su un proxy descritto nella sezione precedente, potresti aggiungere la condizione che attiva l'avviso solo per le richieste POST HTTP. Per farlo, è sufficiente seguire la stessa procedura dell'esempio precedente, ma dopo il passaggio 2 nella sezione Target, aggiungi un altro filtro come segue:

Fai clic su + Aggiungi un filtro e seleziona metodo nell'elenco a discesa.
Nel campo Valore, seleziona POST. Specifica una richiesta POST HTTP.
Fai clic su Applica.

Continua quindi con i passaggi indicati nella sezione Configurazione. Al termine, l'avviso verrà attivato quando il proxy riceverà un codice di risposta 500 da una richiesta POST HTTP.

Per un esempio correlato, consulta la pagina Avviso per combinazioni di codici di risposta e metodi HTTP.

Visualizzazione dei dettagli degli incidenti

Un evento API che attiva un avviso è chiamato incidente. Puoi visualizzare i dettagli degli incidenti recenti nella dashboard di avvisi di Cloud Console.

Metriche e filtri

Questa sezione descrive le metriche e i filtri che puoi utilizzare per creare avvisi basati su metriche.

Metriche

Una metrica è la quantità che attiva un avviso, ad esempio il numero di richieste. La tabella seguente mostra le metriche disponibili.

Metrica	Descrizione
`apigee.googleapis.com/proxyv2/request_count`	Numero totale di richieste ricevute dal proxy dell'API Apigee.
`apigee.googleapis.com/proxyv2/response_count`	Numero totale di risposte restituite dal proxy dell'API Apigee.
`apigee.googleapis.com/proxyv2/latencies_percentile`	Percentile di tutte le risposte proxy API a una richiesta.

Filtri

I filtri consentono di creare avvisi per sottoinsiemi di dati API. Un filtro specifica una condizione che definisce il sottoinsieme. Ad esempio, puoi creare un avviso basato sui dati di un singolo proxy.

Puoi scegliere tra i seguenti filtri:

Filtra	Descrizione	Metriche per cui è possibile applicare il filtro
`env`	Ambiente per i dati.	Tutti
`location`	Posizione dei dati.	Tutti
`proxy_name`	Proxy per i dati.	Tutti
`runtime_version`	La versione di runtime per i dati.	Tutti
`instance_id`	ID istanza per i dati.	Tutti
`method`	HTTP per i dati.	Tutti
`response_code`	Codice di risposta HTTP per i dati.	`apigee.googleapis.com/proxyv2/response_count`
`fault_code`	Codice di errore per i dati.	`apigee.googleapis.com/proxyv2/response_count`
`fault_source`	Origine con errori per i dati. Se vuoi rilevare errori generali che possono verificarsi in qualsiasi punto di una rete API, imposta `fault_source` su `proxy`.	`apigee.googleapis.com/proxyv2/response_count`
`percentile`	Il percentile delle risposte del proxy Apigee.	`apigee.googleapis.com/proxyv2/latencies_percentile`

Avvisi basati su log

Oltre agli avvisi basati su metriche descritti nella sezione precedente, puoi creare anche avvisi basati su log, che monitorano i dati API archiviati da Cloud Logging.

Configurazione di un avviso basato su log

L'esempio seguente mostra come configurare un avviso basato su log.

Apri Google Cloud Console nel browser.
Nell'angolo in alto a sinistra della console, apri il menu di navigazione e seleziona Logging > Esplora log.
Nel riquadro Query, inserisci una query come nell'esempio riportato di seguito.
```
resource.type="apigee.googleapis.com/Environment"
logName="projects/<project_id>/logs/apigee.googleapis.com%2Fanomaly_event"
```
Nota: / prima del giorno anomaly_event ([LOG_ID]) deve essere codificato nell'URL come %2F. Consulta la pagina di riferimento LogEntry.

Per ulteriori informazioni, vedi Creare un avviso basato su log (Esplora log).
Fai clic su Esegui query. I risultati vengono visualizzati nella sezione Verifica che la query restituisca le voci di log per le quali vuoi ricevere avvisi.
Fai clic su Crea avviso sotto il riquadro Query.
Specifica un nome e una descrizione dell'avviso. Tieni presente che il campo Descrizione avviso supporta la formattazione Markdown. Dopo aver compilato i campi, seleziona Avanti per continuare.
Nel riquadro Scegli i log da includere nel riquadro di avviso, verifica che le voci riportate di seguito Definisci le voci di log in cui ricevere gli avvisi corrispondano alla query inserita nel passaggio 3.

Seleziona Avanti per continuare.
Specifica la durata minima del periodo di tempo che deve trascorrere tra gli avvisi per questo criterio. Ad esempio, nel criterio di esempio riportato di seguito, se due voci di log corrispondenti al filtro vengono scritte entro un periodo di dieci minuti, riceverai un avviso per la prima voce di log scritta, ma non per la seconda.

Nota: esiste un limite di cinque avvisi per criterio ogni cinque minuti. Quando il quinto avviso viene inviato, riceverai una notifica che indica che le norme sono in fase di limitazione.
Infine, se vuoi ricevere una notifica quando si verifica un avviso, specifica un destinatario nel campo Canali di notifica, quindi fai clic su Salva.

Creare una notifica per un avviso

Se vuoi ricevere una notifica immediata quando si verifica un incidente, puoi creare una notifica. Quando viene attivato l'avviso, Apigee ti invia una notifica. Puoi scegliere uno dei seguenti canali per ricevere la notifica:

Email
PagerDuty
Slack
Webhook

Per creare una notifica per un avviso:

Se hai appena creato l'avviso (come mostrato nell'esempio precedente) e stai visualizzando la dashboard Crea criterio di avviso, vai al passaggio successivo.

Altrimenti, apri il riquadro Criteri nella dashboard degli avvisi di Cloud Console e, nella riga dell'avviso che hai creato, fai clic sull'icona con tre puntini alla fine della riga e seleziona Modifica.

Viene visualizzata la dashboard Modifica criterio di avviso:
Nella sezione Che cosa vuoi monitorare?, fai clic su AVANTI.
Nella sezione Chi dovrebbe ricevere le notifiche, seleziona Canali di notifica, dove puoi scegliere tra i canali esistenti per cui ricevere le notifiche.

Se vuoi creare un nuovo canale di notifica, seleziona GESTISCI CANALI DI NOTIFICA. Viene visualizzata la dashboard Canali di notifica in Cloud Console, dove puoi aggiungere canali. Per maggiori dettagli, consulta Gestione dei canali di notifica.
Fai clic su AVANTI. Qui sono visualizzate le opzioni descritte di seguito.
Nel campo Nome avviso, inserisci un nome per l'avviso.
Nel campo Documentazione, inserisci l'URL di una pagina web che fornisce informazioni su come risolvere il problema che ha causato l'avviso. L'URL sarà incluso nella notifica.
Fai clic su Salva per creare l'avviso.

Quando viene attivato un avviso, riceverai una notifica con un riepilogo dell'incidente e della data in cui si è verificato. La notifica contiene anche due link per aiutarti a esaminare l'incidente:

VISUALIZZA INCIDENTE: visualizza l'incidente in Cloud Console.
VISUALIZZA IN APIGEE: visualizza un grafico cronologico del traffico API e delle tabelle di dati correlati nella dashboard delle indagini di API Monitoring.