Konfigurowanie alertów o ruchu

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Używaj alertów o ruchu, aby wysyłać powiadomienie o zmianach natężenia ruchu w środowisku, serwerze proxy lub regionie o określoną wartość procentową w wybranym okresie.

Ustawiasz zakres czasu:

  • 1 godzina
  • 1 dzień
  • 7 dni
  • 15 dni (tylko interfejs API)
  • 30 dni (tylko interfejs API)

Działanie tego alertu polega na porównywaniu ruchu w bieżącym zakresie czasu z ruchem z poprzedniego zakresu czasu. Możesz na przykład określić zakres godzinowy. Następnie alert porównuje natężenie ruchu z ostatniej godziny z natężeniem ruchu w tym okresie z natężeniem ruchu w tym okresie:

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

Wartość dodatnia oznacza wzrost natężenia ruchu, a ujemna – jego spadek.

Następnie ustawiasz próg, który wywołuje alert o ruchu, jako procentowy wzrost lub spadek natężenia ruchu z interfejsu API w wybranym okresie.

Zanim ustawisz tę wartość procentową, upewnij się, że jest ona zgodna z normalnymi wzorcami ruchu. Jeśli np. ruch w interfejsie API zmienia się w ciągu dnia, a gwałtowne wzrosty ruchu sięgają nawet 100% w określonych godzinach, są one normalnym zjawiskiem i nie powinny wywoływać alertu. Jeśli jednak skonfigurujesz alert tak, aby był wyzwalany w przypadku każdego wzrostu ruchu godzinowego o 50%, będziesz otrzymywać niepotrzebne alerty dla zwykłego ruchu.

Więcej informacji o alertach znajdziesz w artykule Konfigurowanie alertów i powiadomień.

Dodawanie alertów o natężeniu ruchu i powiadomień o natężeniu ruchu

Aby dodać alerty o natężeniu ruchu i powiadomienia o natężeniu ruchu:
  1. Kliknij Analiza > Reguły alertów w interfejsie Edge.
  2. Kliknij +Alert.
  3. Wpisz te ogólne informacje o alercie:
    Pole Opis
    Nazwa alertu Nazwa alertu. Użyj nazwy, która opisuje regułę i będzie dla Ciebie zrozumiała. Nazwa nie może przekraczać 128 znaków.
    Opis Opis alertu.
    Typ alertu Kliknij Całkowity ruch. Więcej informacji znajdziesz w artykule Informacje o typach alertów.
    Środowisko Wybierz środowisko z listy.
    Stan Przełącz, aby włączyć lub wyłączyć alert.
  4. Określ próg i wymiar warunku, który będzie wyzwalał alert.
    Pole warunku Opis
    Próg

    Określ, czy alert ma być wywoływany, gdy natężenie ruchu wzrośnie o lub spadnie o określony procent w porównaniu z poprzednim interwałem czasu.

    Ustaw procent zwiększania o na wartość większą lub równą 0%. Ustaw wartość zmniejszoną o procentową na wartość większą lub równą 0% oraz mniejszą lub równą 100%.

    Możesz wybrać taki przedział czasu:

    • 1 godzina
    • 1 dzień
    • 1 tydzień
    Wymiar

    Kliknij +Dodaj wymiar i określ szczegóły wymiaru, dla których mają zostać zwrócone wyniki, w tym serwer proxy interfejsu API i region.

    Ustaw konkretny wymiar, aby:

    • Serwer proxy – ustaw określony serwer proxy lub opcję Wszystkie serwery proxy. Serwer proxy nie obsługuje wartości „Dowolna”. Zamiast tego możesz dodać osobny alert dla każdego serwera proxy, który Cię interesuje.
    • Region – ustaw konkretny region lub opcję Wszystkie regiony. Region nie obsługuje wartości „Dowolna”. Zamiast tego możesz dodać oddzielny alert dla każdego regionu, który Cię interesuje.
  5. Kliknij + Powiadomienie, aby dodać powiadomienie o alercie.
    Szczegóły powiadomienia Opis
    Kanał Wybierz kanał powiadomień, którego chcesz używać, i podaj miejsce docelowe: Email, Slack, PagerDuty lub Webhook.
    Miejsce docelowe Określ miejsce docelowe na podstawie wybranego typu kanału:
    • E-mail – adres e-mail, taki jak joe@company.com
    • Slack – adres URL kanału Slacka, np. https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty – kod PagerDuty, np. abcd1234efgh56789
    • Webhook – adres URL webhooka, np. https://apigee.com/test-webhook

      Uwaga: dla każdego powiadomienia możesz określić tylko jedno miejsce docelowe. Aby określić kilka miejsc docelowych dla tego samego typu kanału, dodaj więcej powiadomień.
  6. Aby dodać kolejne powiadomienia, powtórz poprzedni krok.
  7. Jeśli dodasz powiadomienie, skonfiguruj te pola:
    Pole Opis
    Poradnik (Opcjonalnie) Pole tekstowe zawierające krótki opis zalecanych działań związanych z rozwiązywaniem alertów po ich uruchomieniu. Możesz też podać link do wewnętrznej strony wiki lub strony społeczności, na której znajdziesz sprawdzone metody. Informacje z tego pola zostaną umieszczone w powiadomieniu. Zawartość tego pola nie może przekraczać 1500 znaków.
    Ograniczaj Częstotliwość wysyłania powiadomień. Wybierz wartość z listy.
  8. Kliknij Zapisz.

Wyświetlanie alertów w panelu Zdarzenia

Gdy Edge wykryje warunek alertu, automatycznie zarejestruje go w panelu Zdarzenia w interfejsie Edge. Lista zdarzeń wyświetlana w panelu Zdarzenia zawiera wszystkie alerty, zarówno stałe, jak i certyfikowane.

Aby wyświetlić alert:

  1. W interfejsie użytkownika Edge kliknij Analyze > Zdarzenia. Pojawi się nowy panel Zdarzenia:

  2. Filtruj panel Zdarzenia według:

    • Środowisko
    • Region
    • Przedział czasu
  3. Wybierz wiersz w panelu zdarzeń, aby wyświetlić magazyn kluczy zawierający wygasający certyfikat w celu dokładniejszego zbadania alertu. Na stronie Magazyn kluczy możesz przesłać nowy certyfikat i usunąć wygasły.

Korzystanie z interfejsów API alertów razem z alertami o ruchu

Większość interfejsów API, których używasz do tworzenia alertów o ruchu i zarządzania nimi, jest taka sama jak te używane z innymi typami alertów:

Niektóre interfejsy API mają jednak dodatkowe właściwości używane do obsługi alertów o anomalii, np.:

  • Otrzymuj alerty – wyświetla wszystkie alerty, w tym alerty o problemach naprawionych i anomalii.
  • Utwórz alert – utwórz alert o stałej wartości lub o anomalii.
  • Aktualizowanie alertu – aktualizowanie definicji alertu o naprawionej lub anomalii.

Tworzenie lub aktualizowanie alertu o natężeniu ruchu

Do tworzenia i aktualizowania alertów o ruchu używaj tych samych interfejsów API, co w przypadku innych typów alertów. Treść wywołania interfejsu API służącego do tworzenia lub aktualizowania alertu o ruchu jest taka sama jak w innych alertach, z tymi zmianami:

  • Aby określić, że alert jest alertem o ruchu drogowym, dodaj te nowe właściwości:

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

    Wartości domyślne tych właściwości to:

    "alertType": "runtime"
"alertSubType": "fixed"
  • W elemencie dimensions tablicy conditions:
    • Musisz ustawić wartości właściwości org, env, proxy i region. Obsługiwane są tylko te właściwości. Możesz ustawić proxy i region na ALL.
    • Musisz ustawić wartość total właściwości traffic.

  • W tablicy conditions:

    • Właściwość metrics musi mieć wartość trafficChange.
    • Właściwość comparator musi mieć wartość increasedBy lub decreasedBy.
    • Właściwość threshold zawiera wartość dodatnią określającą procentowy wzrost lub spadek natężenia ruchu, gdzie wartość 1.0 odpowiada 100%. W przypadku increasedBy wartość musi być większa lub równa 0,0 (0%). W przypadku decreasedBy wartość musi być większa lub równa 0,0 (0%) i mniejsza lub równa 1,0 (100%).
    • Właściwość durationSeconds musi być ustawiona na jedną z tych wartości: 3600 (1 godzina), 86400 (1 dzień), 604800 (7 dni), 1296000 (15 dni), 2592000 (30 dni) .
  • Właściwość reportEnabled nie jest obsługiwana w przypadku alertów o natężeniu ruchu.
Z przykładu poniżej dowiesz się, jak skonfigurować alert wyzwalany, gdy natężenie ruchu w organizacji i środowisku wzrośnie o 50% w ciągu jednej godziny. Po uruchomieniu alertu na określony kod PagerDuty wysyłane jest powiadomienie. 
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
}'

Ustaw w $ACCESS_TOKEN token dostępu OAuth 2.0 zgodnie z opisem w sekcji Uzyskiwanie tokena dostępu OAuth 2.0. Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Użycie cURL.

Więcej informacji o korzystaniu z tego interfejsu API znajdziesz w artykule Wyświetlanie zdarzeń.

Otrzymuj powiadomienia o natężeniu ruchu

Domyślnie interfejs API pobierania alertów zwraca informacje o wszystkich zdefiniowanych alertach. Ten interfejs API pobiera teraz parametry zapytania, aby umożliwić Ci filtrowanie wyników:

  • enabled – jeśli true określa, że mają zwracać tylko włączone alerty. Wartością domyślną jest false.
  • alertType – określa typ alertu, który ma być zwracany. Dozwolone wartości to runtime, wartość domyślna i cert.
  • alertSubType – określa podtyp alertu, który ma być zwracany. Wartość domyślna jest nieskonfigurowana, co oznacza, że zwraca wszystkie podtypy alertów.

Na przykład to wywołanie interfejsu API spowoduje zwrócenie włączenia alertów tylko dla organizacji o nazwie myorg:

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

To połączenie zwróci tylko alerty o ruchu drogowym, zarówno włączone, jak i wyłączone:

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

Ustaw w $ACCESS_TOKEN token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0. Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Użycie cURL.