Configurare gli avvisi sul traffico

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Utilizza un avviso sul traffico per sollevare una notifica quando il traffico per un ambiente, un proxy o una regione cambia di una percentuale specificata in un intervallo di tempo.

Imposti l'intervallo di tempo su:

  • 1 ora
  • 1 giorno
  • 7 giorni
  • 15 giorni (solo API)
  • 30 giorni (solo API)

L'avviso confronta il traffico relativo all'intervallo di tempo attuale con quello dell'intervallo di tempo precedente. Ad esempio, puoi specificare un intervallo di tempo di un'ora. L'avviso confronta quindi il traffico dell'ora più recente rispetto al traffico dell'ora precedente per calcolare la variazione percentuale del traffico:

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

Un valore positivo indica che il traffico è aumentato, mentre un valore negativo indica che il traffico è diminuito.

Puoi quindi impostare la soglia che attiva un avviso sul traffico come un aumento o una diminuzione percentuale del traffico dell'API. per il periodo di tempo specificato.

Prima di impostare questa percentuale, assicurati che sia in linea con il valore normale modelli di traffico. Ad esempio, se il traffico dell'API di solito fluttua durante il giorno con picchi di traffico orari fino al 100% in determinati momenti di picco, questi picchi sono normali e non dovrebbero attivare un avviso. Tuttavia, se devi configurare un avviso in modo che si attivi per qualsiasi aumento del 50% del traffico orario, riceverai avvisi non necessari per il traffico normale.

Per saperne di più sugli avvisi, vedi Configurare avvisi e notifiche.

Aggiungi avvisi e notifiche sul traffico

Per aggiungere avvisi e notifiche sul traffico:
  1. Fai clic su Analizza > Regole di avviso nella UI Edge.
  2. Fai clic su +Avviso.
  3. Inserisci le seguenti informazioni generali sull'avviso:
    Campo Descrizione
    Nome avviso Nome dell'avviso. Utilizza un nome che descriva l'attivatore e che sia significativo per te. Il nome non può contenere più di 128 caratteri.
    Descrizione Descrizione dell'avviso.
    Tipo di avviso: Seleziona Traffico totale. Consulta Per saperne di più, consulta Informazioni sui tipi di avvisi.
    Ambiente Seleziona l'ambiente dall'elenco a discesa.
    Stato Attiva/disattiva l'avviso per abilitare o disabilitare l'avviso.
  4. Definisci la soglia e la dimensione per la condizione che attiverà l'avviso.
    Campo condizione Descrizione
    Soglia

    Specifica di generare l'avviso quando il traffico è aumentato del o diminuito di una percentuale specifica rispetto a un intervallo di tempo precedente.

    Imposta la percentuale Aumentato di su un valore maggiore o uguale a 0%. Imposta la percentuale diminuita del su un valore maggiore o uguale a 0%, e inferiore o uguale al 100%.

    Puoi scegliere un intervallo di tempo di:

    • 1 ora
    • 1 giorno
    • 1 settimana
    Dimensione

    Fai clic su + Aggiungi dimensione e specifica i dettagli delle dimensioni per i quali restituire risultati, tra cui il proxy API e la regione.

    Imposta una dimensione specifica su:

    • Proxy: imposta su un proxy specifico o su Tutti. Proxy non supporta il valore "Any". Invece puoi aggiungere un avviso separato per ogni proxy che ti interessa.
    • Regione. Imposta una regione specifica o Tutte le regioni. Regione non supporta il valore "Any". Invece puoi aggiungere un avviso separato per ogni regione che ti interessa.
  5. 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

      Nota: puoi specificare una sola destinazione per notifica. Per specificare più destinazioni per lo stesso tipo di canale, aggiungi ulteriori notifiche.
  6. Per aggiungere altre notifiche, ripeti il passaggio precedente.
  7. 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 per risolvere gli avvisi quando vengono attivati. Puoi anche specificare un link al tuo wiki interno o pagina della community in cui fai riferimento alle best practice. Le informazioni di questo campo saranno incluso nella notifica. Il contenuto di questo campo non può superare i 1500 caratteri.
    Limitazione Frequenza di invio delle notifiche. Seleziona un valore dall'elenco a discesa.
  8. Fai clic su Salva.

Visualizza gli avvisi nella dashboard Eventi

Quando Edge rileva una condizione di avviso, la registra automaticamente nel Dashboard Eventi nella UI Edge. L'elenco di eventi visualizzati nella dashboard Eventi include tutti gli avvisi, sia fissi che di certificazione.

Per visualizzare un avviso:

  1. Fai clic su Analizza > Eventi nell'UI di Edge. Viene visualizzata la nuova dashboard Eventi:

  2. Filtra la dashboard Eventi per:

    • Ambiente
    • Regione
    • Periodo di tempo
  3. Seleziona una riga nella dashboard Eventi per visualizzare l'archivio chiavi contenente il certificato in scadenza indagare ulteriormente sull'avviso. Dalla pagina Archivio chiavi puoi caricare un nuovo certificato ed eliminare certificato in scadenza.

Utilizzare le API degli avvisi con gli avvisi sul traffico

La maggior parte delle API che utilizzi per creare e gestire gli avvisi sul traffico sono le stesse che utilizzi con altri tipi di avvisi:

Tuttavia, alcune API dispongono di proprietà aggiuntive utilizzate per supportare gli avvisi relativi alle anomalie, tra cui:

Creare o aggiornare un avviso sul traffico

Utilizza le stesse API per creare o aggiorna un avviso sul traffico, come fai attualmente per gli altri tipi di avvisi. Il corpo della chiamata API per creare o aggiornare un avviso sul traffico è lo stesso utilizzato per altri avvisi, con le seguenti modifiche:

  • Aggiungi le nuove proprietà seguenti per specificare che l'avviso è un avviso sul traffico:

    "alertType": "runtime"
"alertSubType": "trafficfixed"

    I valori predefiniti di queste proprietà sono:

    "alertType": "runtime"
"alertSubType": "fixed"
  • Nell'elemento dimensions dell'array conditions:
      .
    • Devi impostare i valori di org, env, proxy, e region. Sono supportate solo queste proprietà. Puoi impostare proxy e region su ALL.
    • Devi impostare il valore della proprietà traffic su total.

  • Nell'array conditions:

    • La proprietà metrics deve avere il valore trafficChange.
    • La proprietà comparator deve essere impostata su increasedBy o decreasedBy.
    • La proprietà threshold contiene un valore positivo che specifica una percentuale di aumento o diminuzione del traffico dove il valore 1.0 corrisponde al 100%. Per increasedBy il valore deve essere maggiore o uguale a 0,0 (0%). Per decreasedBy, il valore deve essere maggiore o uguale a 0,0 (0%) e minore o uguale a 1,0 (100%).
    • La proprietà durationSeconds deve essere impostata su uno dei seguenti valori: 3600 (1 ora), 86400 (1 giorno), 604800 (7 giorni), 1296000 (15 giorni), 2592000 (30 giorni) .
  • La proprietà reportEnabled non è supportata per gli avvisi sul traffico.
di Gemini Advanced. L'esempio seguente mostra come configurare un avviso che viene attivato quando il traffico per un'organizzazione e un ambiente aumentano del 50% nell'arco di un'ora. Quando viene attivato l'avviso, viene inviata una notifica al codice PagerDuty specificato. 
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

Imposta $ACCESS_TOKEN sul tuo token di accesso OAuth 2.0, come descritto in Ottieni un token di accesso OAuth 2.0. Per informazioni sulle opzioni cURL utilizzate in questo esempio, consulta Utilizzare cURL.

Per saperne di più sull'utilizzo di questa API, consulta la sezione Visualizzazione degli eventi.

Ricevi avvisi sul traffico

Per impostazione predefinita, l'API Get Alerts restituisce informazioni su tutti gli avvisi definiti. Questa API ora utilizza i parametri di query per consentirti di filtrare i risultati:

  • enabled: se true specifica di restituire solo avvisi abilitati. Il valore predefinito è false.
  • alertType - Specifica il tipo di avviso da restituire. I valori consentiti sono runtime, il valore predefinito e cert.
  • alertSubType - Specifica il sottotipo di avviso da restituire. Il valore predefinito non è impostato, il che significa che restituisce tutti i sottotipi di avvisi.

Ad esempio, utilizza la seguente chiamata API per attivare solo gli avvisi per l'organizzazione denominata myorg:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

La seguente chiamata restituisce solo avvisi sul traffico, sia abilitati che disabilitati:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'

Imposta $ACCESS_TOKEN sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni cURL utilizzate in questo esempio, consulta Utilizzare cURL.