Configurare avvisi e notifiche

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Le condizioni di avviso definiscono specifici codici di stato (ad esempio 404/502/2xx/4xx/5xx), latenza e codice di errore che, al superamento, attivano avvisi visivi nell'interfaccia utente e inviano notifiche tramite una serie di canali, ad esempio email, slack, pagerduty o webhook. Puoi configurare avvisi a livello di ambiente, proxy API, servizio di destinazione o regione. Quando viene attivato un avviso, riceverai una notifica utilizzando il metodo da te definito per l'aggiunta di avvisi e notifiche.

Ad esempio, potresti voler attivare un avviso e inviare una notifica al team Operations quando la percentuale di errori 5xx supera il 23% per un periodo di 5 minuti per il proxy API di produzione degli ordini di cui è stato eseguito il deployment nell'ambiente di produzione.

La figura seguente mostra come vengono visualizzati gli avvisi nell'interfaccia utente:

Di seguito è riportato un esempio di notifica via email che potresti ricevere quando viene attivato un avviso.

All'interno del corpo della notifica di avviso, fai clic sui seguenti link per ulteriori informazioni:

• Visualizza dettagli per visualizzare maggiori dettagli, tra cui le impostazioni degli avvisi e l'attività per ogni condizione nell'ultima ora.
• Definizione dell'avviso per visualizzarne la definizione.
• Cronologia avvisi per visualizzare ulteriori informazioni sull'avviso specifico.
• Visualizza il playbook per vedere le azioni consigliate, se disponibili.
• Visualizza il report Analisi delle API per visualizzare un report personalizzato relativo alla condizione dell'avviso.

Le seguenti sezioni descrivono come configurare e gestire avvisi e notifiche.

Informazioni sui tipi di avvisi

La versione iniziale di API Monitoring consente di creare regole basate su pattern che specificano quando generare un avviso in base a una serie di condizioni predefinite. Questi tipi di avvisi sono chiamati avvisi fissi ed erano l'unico tipo di avvisi supportato nella versione iniziale di API Monitoring.

Ad esempio, puoi generare un avviso corretto quando:

• [percentuale di errori 5xx] [è maggiore di] [10%] per [10 minuti] da [target mytarget1]
• [numero di errori 2xx] [è inferiore a] [50] per [5 minuti] in [regione us-east-1]
• [Latenza p90] [è maggiore di] [750ms] per [10 minuti] su [proxy myproxy1]

La release 19.11.13 Beta di Security Reporting aggiunge nuovi tipi di avvisi:

• Avvisi sul traffico totale (beta). Un tipo di avviso che consente di generare un avviso quando il traffico cambia di una percentuale specificata in un intervallo di tempo.
• Avvisi di anomalia (beta). Un tipo di avviso in cui Edge rileva problemi di traffico e prestazioni invece di doverli predeterminare autonomamente. Puoi quindi generare un avviso per queste anomalie.
• Avvisi di scadenza TLS (beta). Un tipo di avviso che ti consente di inviare una notifica quando un certificato TLS sta per scadere.

Poiché ora API Monitoring supporta più tipi di avvisi, nella finestra di dialogo Crea avviso viene ora visualizzata l'opzione per selezionare il tipo di avviso:

Visualizza impostazioni degli avvisi

Per visualizzare le impostazioni degli avvisi attualmente definite, fai clic su Analizza > Regole di avviso nell'interfaccia utente Edge.

Viene visualizzata la pagina Avviso, come illustrato nella figura seguente:

Come evidenziato nella figura, la pagina Avviso consente di:

• Visualizza un riepilogo delle impostazioni degli avvisi attualmente definite
• Visualizza la cronologia degli avvisi attivati.
• Aggiungere avvisi e notifiche
• Creare un report personalizzato da un avviso
• Attivare o disattivare un avviso
• Modificare un avviso
• Eliminare un avviso
• Cercare nell'elenco di avvisi per una stringa specifica

Visualizzare la cronologia degli avvisi attivati per l'organizzazione

Per visualizzare la cronologia degli avvisi attivati per la tua organizzazione nelle ultime 24 ore, fai clic su Analizza > Regole avviso nell'interfaccia utente Edge e fai clic sulla scheda Cronologia.

Viene visualizzata la pagina Cronologia avvisi.

Fai clic sul nome dell'avviso per visualizzarne i dettagli nella dashboard di indagine. Puoi filtrare l'elenco eseguendo una ricerca in base al nome dell'avviso, tutto o in parte.

Aggiungi avvisi e notifiche

Per aggiungere avvisi e notifiche:

1. Fai clic su Analizza > Regole avviso nell'interfaccia utente Edge.
2. Fai clic su +Avviso.
3. Inserisci le seguenti informazioni generali sull'avviso:

   Campo	Descrizione
   Nome dell'avviso	Nome dell'avviso. Utilizza un nome che descriva l'attivatore e che sia significativo per te. Il nome non può superare i 128 caratteri.
   Tipo di avviso:	Seleziona Fisse. Per saperne di più sui tipi di avvisi, consulta Informazioni sui tipi di avvisi.
   Descrizione	Descrizione dell'avviso.
   Ambiente	Seleziona l'ambiente dall'elenco a discesa.
   Stato	Attiva/disattiva per abilitare o disabilitare l'avviso.

4. Definisci la metrica, la soglia e la dimensione per la prima condizione che attiverà l'avviso.

   Campo Condizione	Descrizione
   Metrica	Seleziona una delle seguenti metriche: Codice di stato. Seleziona un codice di stato dall'elenco, ad esempio HTTP 401, 404, 2xx, 4xx o 5xx. Nota: L'API consente di impostare una gamma più ampia di codici di stato. Utilizza l'API per specificare qualsiasi codice di stato compreso tra 200-299, 400-599 e i valori dei caratteri jolly 2xx, 4xx o 5xx. Vedi Crea avviso. Per gli avvisi sulla limitazione della frequenza (codice di stato HTTP 429), imposta la metrica su un codice di errore Picco di arresto. Puoi utilizzare il criterioAssignMessage per riscrivere il codice di risposta HTTP da un errore del proxy o da un errore target. API Monitoring ignora eventuali codici riscritti e registra i codici di risposta HTTP effettivi. Latenza: seleziona un valore di latenza dall'elenco a discesa. Nello specifico: p50 (50° percentile), p90 (90° percentile), p95 (95° percentile) o p99 (99° percentile). Ad esempio, seleziona p95 per configurare un avviso che viene attivato quando la latenza di risposta per il 95° percentile è maggiore della soglia impostata di seguito. Codice di errore: seleziona una categoria, una sottocategoria e un codice di errore dall'elenco. In alternativa, seleziona una delle seguenti opzioni all'interno di una categoria o sottocategoria: Tutti: il totale combinato di tutti i codici di errore di questa categoria/sottocategoria deve soddisfare i criteri delle metriche. Qualsiasi: il codice di un singolo errore in questa categoria/sottocategoria deve soddisfare i criteri della metrica. Consulta le informazioni sul codice di errore per ulteriori informazioni. Traffico totale (beta): seleziona l'aumento o la riduzione del traffico. Per saperne di più, consulta Avvisi sul traffico (beta).
   Soglia	Configura la soglia per la metrica selezionata: Codice di stato: imposta la soglia come tasso percentuale, conteggio o transazioni al secondo (TPS) nel tempo. Latenza: seleziona la soglia come durata totale o latenza target (ms) nel tempo. In questo caso, viene attivato un avviso se il percentile di latenza osservato specificato, che viene aggiornato ogni minuto in caso di traffico, supera la condizione di soglia per l'intervallo di tempo che copre la durata specificata. Ciò significa che la condizione di soglia non viene aggregata per l'intera durata. Codice di errore: imposta la soglia come tasso percentuale, conteggio o transazioni al secondo (TPS) nel tempo.
   Dimensione	Fai clic su + Aggiungi dimensione e specifica i dettagli della dimensione per cui restituire i risultati, tra cui proxy API, servizio di destinazione, app per sviluppatori e regione. Se imposti una dimensione specifica su: Tutte: tutte le entità nella dimensione devono soddisfare i criteri delle metriche. Non puoi selezionare Tutte per una metrica di tipo Latenza. Qualsiasi: applicabile solo alla regione. Un'entità della dimensione deve soddisfare i criteri delle metriche per ogni singola regione. Nota: per i proxy API o i servizi di destinazione, seleziona una raccolta che supporti qualsiasi funzionalità. Raccolte: seleziona una raccolta dall'elenco per specificare il set di proxy API o i servizi di destinazione. In questo caso, qualsiasi entità della raccolta deve soddisfare i criteri. Se imposti la dimensione su Target, puoi selezionare un servizio target o il servizio specificato da una norma sui callout di servizio. Il target di un criterio di callout di servizio viene visualizzato come valore preceduto da "sc://". Ad esempio, "sc://my.endpoint.net".

5. Fai clic su Mostra dati condizione per visualizzare i dati recenti relativi alla condizione nell'ultima ora.
   La percentuale di errori nel grafico mostra il colore rosso quando supera la soglia della condizione di avviso.
   

   Fai clic su Nascondi dati condizione per nascondere i dati.

6. Fai clic su + Aggiungi condizione per aggiungere altre condizioni e ripeti i passaggi 4 e 5.

   Nota: se specifichi più condizioni, l'avviso viene attivato quando tutte le condizioni sono soddisfatte.

7. Fai clic su Crea report di analisi delle API basati sulle condizioni di avviso se vuoi creare un report personalizzato basato sulle condizioni di avviso che hai configurato. Questa opzione è visualizzata in grigio se non sei un amministratore dell'organizzazione.

   Per saperne di più, consulta Creare un report personalizzato da un avviso.

   Nota: puoi modificare il report personalizzato dopo aver salvato l'avviso, come descritto in Gestione dei report personalizzati.

8. Fai clic su + Notifica per aggiungere una notifica di avviso.

   Dettagli notifica	Descrizione
   Canale	Seleziona il canale di notifica che vuoi utilizzare e specifica la destinazione: Email, Slack, PagerDuty o webhook.
   Destinazione	Specifica la destinazione in base al tipo di canale selezionato: Email - Indirizzo email, ad esempio joe@company.com Slack - URL del canale Slack, ad esempio https://hooks.slack.com/services/T00000000/B00000000/XXXXX PagerDuty - Codice PagerDuty, ad esempio abcd1234efgh56789 Webhook: URL webhook, ad esempio https://apigee.com/test-webhook. Consulta Formato oggetto webhook per una descrizione dell'oggetto inviato all'URL. Passa le informazioni sulle credenziali nell'URL del webhook. Ad esempio: https://apigee.com/test-webhook?auth_token=1234_abcd. Puoi specificare l'URL di un endpoint in grado di analizzare l'oggetto webhook per modificarlo o elaborarlo. Ad esempio, puoi specificare l'URL per un'API, come un'API Edge, o per qualsiasi altro endpoint in grado di elaborare l'oggetto. Nota: puoi specificare una sola destinazione per notifica. Per specificare più destinazioni per lo stesso tipo di canale, aggiungi altre notifiche.

9. Per aggiungere altre notifiche, ripeti il passaggio 8.
10. Se hai aggiunto una notifica, imposta i seguenti campi:

    Campo	Descrizione
    Playbook	(Facoltativo) Campo di testo in formato libero per fornire una breve descrizione delle azioni consigliate per risolvere gli avvisi quando vengono attivati. Puoi anche specificare un link al tuo wiki interno o alla pagina della community in cui fai riferimento alle best practice. Le informazioni in questo campo verranno incluse nella notifica. Il contenuto di questo campo non può superare i 1500 caratteri.
    Limitazione	Frequenza con cui inviare notifiche. Seleziona un valore dall'elenco a discesa. I valori validi sono: 15 minuti, 30 minuti e 1 ora.

11. Fai clic su Salva.

Formato oggetto webhook

{
  "alertInstanceId": "event-id",
  "alertName": "name",
  "org": "org-name",
  "description": "alert-description",
  "alertId": "alert-id",
  "alertTime": "alert-timestamp",
  "thresholdViolations":{"Count0": "Duration=threshold-duration Region=region Status Code=2xx Proxy=proxy Violation=violation-description"
  },
  "thresholdViolationsFormatted": [
    {
      "metric": "count",
      "duration": "threshold-duration",
      "proxy": "proxy",
      "region": "region",
      "statusCode": "2xx",
      "violation": "violation-description"
    }
  ],
  "playbook": "playbook-link"
}

Le proprietà thresholdViolations e thresholdViolationsFormatted contengono dettagli sull'avviso. La proprietà thresholdViolations contiene una singola stringa con i dettagli, mentre thresholdViolationsFormatted contiene un oggetto che descrive l'avviso. In genere utilizzi la proprietà thresholdViolationsFormatted perché è più semplice da decodificare.

L'esempio riportato sopra mostra i contenuti di queste proprietà per un avviso fisso quando configuri la metrica dell'avviso in modo che si attivi in base al codice di stato HTTP 2xx, come indicato dalla proprietà statusCode.

I contenuti di queste proprietà dipendono dal tipo di avviso, ad esempio fisso o anomalo, e dalla configurazione specifica dell'avviso. Ad esempio, se crei un avviso corretto basato su un codice di errore, la proprietà thresholdViolationsFormatted contiene una proprietà faultCode anziché una proprietà statusCode.

La seguente tabella mostra tutte le possibili proprietà della proprietà thresholdViolationsFormatted per diversi tipi di avviso:

metric, proxy, target, developerApp,
region, statusCode, faultCodeCategory, faultCodeSubCategory,
faultCode, percentile, comparisonType, thresholdValue,
triggerValue, duration, violation

metric, proxy, target, developerApp,
region, comparisonType, thresholdValue, triggerValue,
duration, violation

metric, proxy, target, region,
statusCode, faultCode, percentile, sensitivity,
violation

envName, certificateName, thresholdValue, violation

Creare un report personalizzato da un avviso

Per creare un report personalizzato da un avviso:

1. Quando crei un avviso, fai clic su Crea un report di analisi delle API in base alle condizioni di avviso, come descritto in Aggiungere avvisi e notifiche.

   Dopo aver salvato l'avviso, la UI mostra il seguente messaggio:

   Alert alertName saved successfully. To customize the report generated, click here.

   Fai clic sul messaggio per aprire il report in una nuova scheda con i campi pertinenti precompilati. Per impostazione predefinita, il report personalizzato è denominato: API Monitoring Generated alertName

2. Modifica il report personalizzato come preferisci e fai clic su Salva.
3. Fai clic sul nome del report nell'elenco ed esegui il report personalizzato.

Per gestire il report personalizzato creato in base alle condizioni di avviso:

1. Fai clic su Analizza > Regole avviso nell'interfaccia utente Edge.
2. Fai clic sulla scheda Impostazioni.
3. Nella colonna Report, fai clic sul report personalizzato associato all'avviso da gestire.

   La pagina del report personalizzato viene visualizzata in una nuova scheda. Se la colonna Report è vuota, significa che non è stato ancora creato alcun report personalizzato. Se vuoi, puoi modificare l'avviso per aggiungere un report personalizzato.

4. Modifica il report personalizzato come preferisci e fai clic su Salva.
5. Fai clic sul nome del report nell'elenco ed esegui il report personalizzato.

Attivare o disattivare un avviso

Per attivare o disattivare un avviso:

1. Fai clic su Analizza > Regole avviso nell'interfaccia utente Edge.
2. Fai clic sul pulsante di attivazione/disattivazione nella colonna Stato associato all'avviso che desideri abilitare o disabilitare.
   

Modificare un avviso

Per modificare un avviso:

1. Fai clic su Analizza > Regole avviso nell'interfaccia utente Edge.
2. Fai clic sul nome dell'avviso da modificare.
3. Modifica l'avviso come richiesto.
4. Fai clic su Salva.

Eliminare un avviso

Per eliminare un avviso:

1. Fai clic su Analizza > Regole avviso nell'interfaccia utente Edge.
2. Posiziona il cursore sull'avviso da eliminare e fai clic su nel menu delle azioni.

Avvisi suggeriti

Apigee ti consiglia di configurare i seguenti avvisi per ricevere notifiche sui problemi comuni. Alcuni di questi avvisi sono specifici per l'implementazione delle API e sono utili solo in determinate situazioni. Ad esempio, diversi avvisi mostrati di seguito sono applicabili solo se utilizzi le norme di ServiceCallout o i criteri di JavaCallout.

Configura un avviso con codice di stato 5xx per un proxy API

Di seguito è riportato un esempio di come configurare un avviso utilizzando l'interfaccia utente che viene attivata quando le transazioni al secondo (TPS) di codici di stato 5xx per il proxy dell'API degli hotel superano 100 per 10 minuti per qualsiasi regione. Per ulteriori informazioni, vedi Aggiungere avvisi e notifiche.

Per informazioni sull'utilizzo dell'API, vedi Configurare un avviso relativo al codice di stato 5xx per un proxy che utilizza l'API.

Configurazione di un avviso di latenza P95 per un proxy API

Di seguito è riportato un esempio di come configurare un avviso utilizzando l'interfaccia utente che viene attivato quando la latenza totale di risposta per il 95° percentile è superiore a 100 ms per 5 minuti per il proxy dell'API degli hotel per qualsiasi regione. Per ulteriori informazioni, vedi Aggiungere avvisi e notifiche.

Per informazioni sull'utilizzo dell'API, consulta Configurare un avviso di latenza P95 per un proxy API utilizzando l'API

Configura un avviso 404 (Applicazione non trovata) per tutti i proxy API

Di seguito è riportato un esempio di come configurare un avviso utilizzando l'interfaccia utente che viene attivata quando la percentuale di codici di stato 404 per tutti i proxy API supera il 5% per 5 minuti per qualsiasi regione. Per ulteriori informazioni, vedi Aggiungere avvisi e notifiche.

Per informazioni sull'utilizzo dell'API, vedi Configurare un avviso 404 (Applicazione non trovata) per tutti i proxy API che utilizzano l'API.

Configura un avviso di conteggio proxy API per le API

Di seguito è riportato un esempio di come configurare un avviso utilizzando l'interfaccia utente che viene attivata quando il numero di codice 5xx delle API supera 200 per 5 minuti per qualsiasi regione. In questo esempio, le API vengono acquisite nella raccolta dei proxy API critici. Per ulteriori informazioni, vedi:

• Aggiungere avvisi e notifiche
• Gestire le raccolte

Per informazioni sull'utilizzo dell'API, vedi Configurare un avviso di conteggio proxy API per le API che utilizzano l'API.

Configura un avviso relativo alla percentuale di errori per i servizi di destinazione

Di seguito è riportato un esempio di come configurare un avviso utilizzando la UI che viene attivata quando la tariffa del codice 500 per i servizi di destinazione supera il 10% per 1 ora per qualsiasi regione. In questo esempio, i servizi di destinazione vengono acquisiti nella raccolta Target critici. Per ulteriori informazioni, vedi:

• Aggiungere avvisi e notifiche
• Gestire le raccolte

Per informazioni sull'utilizzo dell'API, consulta Configurare un avviso relativo al tasso di errore per i servizi target utilizzando l'API.

Configura un avviso relativo alla percentuale di errori per il criterio ServiceCallout

Di seguito è riportato un esempio di come configurare un avviso utilizzando l'interfaccia utente che viene attivata quando la tariffa del codice 500 per il servizio specificato dal criterio ServiceCallout supera il 10% per 1 ora per qualsiasi regione. Per ulteriori informazioni, vedi:

• Aggiungere avvisi e notifiche

Per informazioni sull'utilizzo dell'API, consulta Configurare un avviso relativo alla percentuale di errore per il criterio Callout di servizio utilizzando l'API.

Configura un avviso relativo al codice di errore del criterio

Di seguito è riportato un esempio di come configurare un avviso utilizzando la UI che viene attivata quando il conteggio dei codici di errore JWT AlgorithmMismatch per il criterio VerificationJWT è maggiore di 5 per 10 minuti per tutte le API. Per ulteriori informazioni, vedi:

• Aggiungere avvisi e notifiche
• Gestire le raccolte

Per informazioni sull'utilizzo dell'API, vedi Configurare un avviso relativo al codice di errore per il codice di errore dei criteri utilizzando l'API.