Questa pagina è stata tradotta dall'API Cloud Translation.

Configurazione di avvisi e notifiche

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Uno degli scopi principali del monitoraggio delle API è informarti su eventi o pattern insoliti, come picchi di traffico o latenze. Per monitorare eventi come questi, puoi configurare gli avvisi, che vengono attivati quando si verifica un evento specifico. Un evento effettivo che attiva un avviso è chiamato incidente.

Puoi impostare regole specifiche per un avviso. Ad esempio, questo potrebbe essere attivato da un codice di risposta 500 (errore di servizio interno) su un proxy. Quando si verifica un incidente per l'avviso, puoi visualizzarne i dettagli nel riquadro Incidenti della pagina Avvisi della console Google Cloud.

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

In API Monitoring sono disponibili due tipi di avvisi:

Avvisi basati su metriche, che vengono attivati da modifiche alle metriche dell'API.
Allerte basate su log, che si basano sui dati dell'API archiviati da Cloud Logging.

Avvisi basati su metriche

Gli avvisi basati su metriche vengono attivati quando una metrica per i dati dell'API raggiunge un livello specificato o inizia a cambiare rapidamente. Una regola di avviso viene definita 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.

Le seguenti sezioni forniscono esempi di avvisi basati su metriche.

Avviso per il codice di risposta 500 su un proxy

L'esempio seguente 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 creare l'avviso, segui questi passaggi:

Apri la pagina Crea criterio di avviso nella console Google Cloud.
Fai clic su Seleziona una metrica.
Deseleziona il pulsante Attivo.
Nota:se nella tua organizzazione non sono disponibili dati recenti sul traffico API, la metrica nel passaggio successivo non verrà visualizzata, a meno che questa opzione non sia deselezionata.
Seleziona una metrica come segue:
1. Se utilizzi Apigee Hybrid v1.12, copia e incolla quanto segue nel campo Seleziona una metrica:
```
apigee.googleapis.com/proxy/response_count
```
  Nota: se utilizzi Apigee hybrid v1.10 o v1.11, utilizza la seguente metrica:
```
apigee.googleapis.com/proxyv2/response_count
```
2. Seleziona Proxy Apigee.
3. Nel riquadro che si apre a destra, seleziona Proxy.
4. Nel riquadro successivo a destra, seleziona Conteggio risposte proxy Apigee.
5. Fai clic su Applica.
Aggiungi un filtro per il codice di risposta come segue:
1. Fai clic su Aggiungi filtro.
2. Fai clic nel campo Filtro e seleziona response_code dal menu a discesa.
3. In Comparatore, seleziona =.
4. Nel campo Valore, digita 500.
5. Fai clic su Fine.

Configura l'attivatore di avvisi

Per configurare l'evento che attiva l'avviso, fai clic su Configura attivatore nel riquadro a sinistra. Poi segui questi passaggi:

In Tipo di condizione, seleziona Soglia.
Nel campo Attivatore di avvisi, seleziona Qualsiasi violazione della serie temporale.
Nel campo Posizione soglia, seleziona Sopra la soglia.
Nel campo Valore soglia, inserisci 1.

Con queste impostazioni, verrà attivato un avviso ogni volta che viene restituita una risposta con codice 500.

Fai clic su Avanti per aprire il riquadro Configurare le notifiche e finalizzare l'avviso.

Configura una notifica per l'avviso

Nel riquadro Configura le notifiche e finalizza l'avviso, puoi impostare una notifica che verrà inviata quando viene attivato un avviso. Ecco come fare:

Fai clic nel campo Canali di notifica. Se hai già creato un canale per la notifica, come un indirizzo email o un numero SMS, puoi selezionarlo in Canali di notifica.

In caso contrario, devi aggiungere un canale selezionando Gestisci canali di notifica. Si aprirà il riquadro Canali di notifica, in cui puoi aggiungere uno o più canali. Per saperne di più, consulta la pagina relativa alla gestione dei canali di notifica. Al termine, torna al riquadro Configura le notifiche e finalizza l'avviso.
Nota: per visualizzare un nuovo canale dopo averlo creato, potresti dover fare clic sul pulsante di aggiornamento accanto a Gestisci canali di notifica.
Dopo aver selezionato uno o più canali di notifica, fai clic su OK.
Nel campo Documentazione, puoi aggiungere un messaggio che verrà inviato con la notifica. Ad esempio, il messaggio potrebbe descrivere il motivo dell'avviso e contenere link alla documentazione che spiega come rispondere.
Fai clic su Avanti per esaminare i dettagli dell'avviso. Se sono soddisfatti, fai clic su Crea criterio per creare il criterio di 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'alert per il codice di risposta 500 su un proxy descritto nella sezione precedente, potresti aggiungere la condizione che l'avviso venga attivato solo per le richieste POST HTTP. Per farlo, segui semplicemente gli stessa procedura dell'esempio precedente, ma dopo il passaggio 8, aggiungi un altro filtro come segue:

Fai clic su Aggiungi filtro.
Fai clic nel campo Filtro e seleziona metodo metodo HTTP nell'elenco a discesa.
Nel campo Comparatore, seleziona =.
Nel campo Valore, inserisci POST.
Fai clic su Fine.

Quindi, continua con i passaggi descritti in Configurare l'attivatore di avvisi. Al termine, l'avviso verrà attivato quando il proxy riceve un codice di risposta 500 da una richiesta HTTP POST.

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

Visualizzazione dei dettagli dell'incidente

Un evento API che attiva un avviso è chiamato incidente. Puoi visualizzare i dettagli degli incidenti recenti nella console Google Cloud, nella pagina Avvisi.

Metriche e filtri

Una metrica è la quantità che attiva un avviso, ad esempio il numero di richieste. Questa sezione descrive le metriche e i filtri che puoi utilizzare per creare avvisi basati su metriche. Esistono due tipi di metriche:

Nuove metriche: nuove versioni delle metriche Apigee con prestazioni e affidabilità migliorate. Queste metriche sono attualmente disponibili per Apigee e Apigee hybrid v1.12 e versioni successive. Ti consigliamo di utilizzare le nuove metriche se possibile.
Metriche originali: le metriche originali sono ancora supportate per l'utilizzo con Apigee hybrid 1.10 e 1.11.

Nuove metriche

Nella tabella seguente sono elencate le nuove metriche.

Metrica	Descrizione
`apigee.googleapis.com/proxy/details`	Dettagli pertinenti al proxy di cui viene eseguito il deployment in un ambiente Apigee.
`apigee.googleapis.com/proxy/request_count`	Numero di richieste al proxy Apigee dall'ultimo campione registrato.
`apigee.googleapis.com/proxy/response_count`	Numero di risposte inviate dal proxy API Apigee.
`apigee.googleapis.com/proxy/latencies`	Distribuzione delle latenze, calcolate dal momento in cui la richiesta è stata ricevuta dal proxy Apigee al momento in cui la risposta è stata inviata dal proxy Apigee al client.
`apigee.googleapis.com/target/request_count`	Numero di richieste inviate al target Apigee dall'ultimo campionamento registrato.
`apigee.googleapis.com/target/response_count`	Numero di risposte ricevute dal target Apigee dall'ultimo campionamento registrato.
`apigee.googleapis.com/target/latencies`	Distribuzione delle latenze, calcolate dal momento in cui la richiesta è stata inviata al target Apigee al momento in cui la risposta è stata ricevuta dal proxy Apigee. Il tempo non include il sovraccarico del proxy API Apigee.

Metriche originali

Di seguito è riportato un elenco delle versioni originali delle metriche mostrate nella tabella precedente, che sono ancora supportate per l'utilizzo solo con Apigee Hybrid v1.10 e v1.11.

Metrica	Descrizione
`apigee.googleapis.com/proxyv2/details`	Dettagli pertinenti al proxy di cui viene eseguito il deployment in un ambiente Apigee.
`apigee.googleapis.com/proxyv2/request_count`	Numero totale di richieste ricevute dal proxy API Apigee.
`apigee.googleapis.com/proxyv2/response_count`	Numero totale di risposte restituite dal proxy API Apigee.
`apigee.googleapis.com/proxyv2/latencies_percentile`	Percentile di tutte le risposte del proxy API a una richiesta.
`apigee.googleapis.com/targetv2/request_count`	Numero totale di richieste ricevute dalla destinazione dell'API Apigee.
`apigee.googleapis.com/targetv2/response_count`	Numero totale di risposte restituite dal target dell'API Apigee.
`apigee.googleapis.com/targetv2/latencies_percentile`	Percentile di tutte le risposte target dell'API a una richiesta.

Filtri

I filtri ti consentono di creare avvisi per sottoinsiemi di dati dell'API. Un filtro specifica una condizione che definisce il sottoinsieme. Ad esempio, puoi creare un avviso in base ai dati di un singolo proxy.

Puoi scegliere tra i seguenti filtri:

Filtro	Descrizione	Metriche per le quali è possibile applicare un filtro
`env`	Ambiente per i dati.	Tutti
`location`	Posizione dei dati.	Tutti
`proxy_name`	Proxy per i dati.	Tutti
`proxy_deployment_type`	Tipo di deployment del proxy Apigee	`apigee.googleapis.com/proxy/details` `apigee.googleapis.com/proxyv2/details`
`runtime_version`	Versione del runtime per i dati.	Metriche originali
`instance_id`	ID istanza per i dati.	Metriche originali
`method`	Metodo HTTP per i dati.	Tutti
`response_code`	Codice di risposta HTTP per i dati.	`apigee.googleapis.com/proxy/response_count` `apigee.googleapis.com/proxyv2/response_count`
`fault_code`	Codice di errore per i dati.	`apigee.googleapis.com/proxy/response_count` `apigee.googleapis.com/proxyv2/response_count`
`fault_source`	Origine dell'errore per i dati. Se vuoi rilevare gli errori generali che possono verificarsi in qualsiasi punto di una rete API, imposta `fault_source` su `proxy`.	`apigee.googleapis.com/proxy/response_count` `apigee.googleapis.com/proxyv2/response_count`
`percentile`	Percentile delle latenze di risposta del proxy Apigee.	`apigee.googleapis.com/proxyv2/latencies_percentile`

Avvisi basati su log

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

Configurare un avviso basato su log

L'esempio seguente mostra come configurare un avviso basato su log. Per ulteriori informazioni, consulta Creare query in Esplora log.

Apri Esplora log nella Google Cloud Console.
Seleziona Mostra query sul lato destro di 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: il valore / prima di anomaly_event (l'attributo [LOG_ID]) deve essere codificato come URL come %2F. Consulta la pagina di riferimento di LogEntry.
Fai clic su Esegui query. I risultati vengono visualizzati in Verifica che la query restituisca le voci di log per cui vuoi ricevere avvisi.
Fai clic su Crea avviso sotto il riquadro Query.
Per creare l'avviso, segui la procedura nella finestra di dialogo Crea criterio di avviso basato su log. Per informazioni dettagliate, vedi Configurare gli avvisi basati su log.