Konfigurowanie alertów o ruchu

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Użyj alertu o korkach, by zwiększyć powiadomienie, gdy ruch w środowisku, serwerze proxy lub regionie zmieni się o określony procent w czasie.

Ustawiasz zakres czasowy na:

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

Alert porównuje ruch w bieżącym zakresie z natężeniem ruchu w poprzednim przedziale czasu. Możesz na przykład określić jednogodzinny zakres czasu. Następnie alert porównuje ruch w ostatniej godzinie w porównaniu z ruchem z poprzedniej godziny, aby obliczyć procentową zmianę natężenia ruchu:

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

Wartość dodatnia oznacza wzrost ruchu, a wartość ujemna oznacza spadek ruchu.

Następnie ustawiasz próg, który powoduje alert o ruchu, jako procentowe zwiększenie lub spadek natężenia ruchu przez interfejs API. w określonym przedziale czasu.

Zanim ustawisz tę wartość, upewnij się, że odpowiada ona Twoim wzorców ruchu. Jeśli na przykład ruch w interfejsie API zmienia się w ciągu dnia z godzinowymi wzrostami ruchu sięgającymi maksymalnie 100% w określonych porach szczytu te skoki są normalne i nie powinny wyzwalać alertu. Jeśli jednak skonfigurujesz alert, aby aktywować alert w przypadku 50-procentowego wzrostu natężenia ruchu w ciągu godziny, otrzymasz niepotrzebne alerty dotyczące normalnego ruchu.

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

Dodawanie alertów i powiadomień o korkach

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

    Określ, czy alert ma być sygnalizowany wzrostem natężenia ruchu o lub zmniejszyła się o konkretną wartość procentową w porównaniu z poprzednim przedziałem czasu.

    Ustaw wartość procentową zwiększone o na wartość większą lub równą 0%. Ustaw zmniejszony o procent na wartość większą lub równą 0%, ale nie więcej niż 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 chcesz zwracać wyniki obejmujące określ region i serwer proxy interfejsu API.

    Ustaw konkretny wymiar, aby:

    • Serwer proxy – ustaw określony serwer proxy lub 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 Wszystkie regiony. Region nie obsługuje wartości "Any". Zamiast tego możesz dodać osobne alerty 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żyć, i określ 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 na Slacku, np. https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty – kod PagerDuty, np. abcd1234efgh56789
    • Webhook – adres URL webhooka, na przykład https://apigee.com/test-webhook

      Uwaga: dla każdego powiadomienia możesz określić tylko jedno miejsce docelowe. Aby określić wiele miejsc docelowych dla tego samego typu kanału, dodaj więcej powiadomień.
  6. Aby dodać więcej powiadomień, powtórz poprzedni krok.
  7. Po dodaniu powiadomienia skonfiguruj te pola:
    Pole Opis
    Poradnik (Opcjonalnie) Pole tekstowe z krótkim opisem zalecanych działań dla w celu rozwiązania alertów po ich uruchomieniu. Możesz też podać link do swojej wewnętrznej strony wiki lub strony społeczności, na której znajdziesz informacje o sprawdzonych metodach. Informacje w tym polu zostaną ujęte w powiadomieniu. Zawartość tego pola nie może przekraczać 1500 znaków.
    Ograniczenie Częstotliwość wysyłania powiadomień. Wybierz wartość z listy.
  8. Kliknij Zapisz.

Wyświetl alerty w panelu Zdarzenia

Gdy Edge wykryje warunek tworzenia alertów, automatycznie zapisuje go w Panel Zdarzenia w interfejsie Edge. Lista zdarzeń wyświetlana w panelu Zdarzenia Obejmuje wszystkie alerty, zarówno stałe, jak i mające certyfikat.

Aby wyświetlić alert:

  1. Kliknij Analizuj > Zdarzenia w interfejsie Edge. Pojawi się nowy panel Zdarzenia:

  2. Filtruj panel Zdarzenia według tych kryteriów:

    • Środowisko
    • Region
    • Przedział czasu
  3. Wybierz wiersz w panelu zdarzeń, aby wyświetlić magazyn kluczy zawierający wygasający certyfikat dokładniej zbadać alert. Na stronie magazynu kluczy możesz przesłać nowy certyfikat i usunąć certyfikat wygasający certyfikat.

Korzystanie z interfejsów API alertów z alertami o natężeniu ruchu

Większość interfejsów API, których używasz do tworzenia alertów dotyczących ruchu i zarządzania nimi, to te same, których używasz z innymi typami alertów:

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

  • Otrzymuj alerty – pokazuje wszystkie alerty, w tym alerty o naprawionych i anomalii.
  • Utwórz alert – utwórz alert naprawiony lub dotyczący anomalii.
  • Zaktualizuj alert – zaktualizuj definicję alertu o poprawionej lub anomalii.

Tworzenie lub aktualizowanie alertów o natężeniu ruchu

Użyj tych samych interfejsów API do tworzenia lub zaktualizuj alert o ruchu, podobnie jak w przypadku innych typów alertów. Treść wywołania interfejsu API służącego do utworzenia lub zaktualizowania alertu o ruchu jest taka sama jak w przypadku inne alerty z tymi zmianami:

  • Dodaj te nowe właściwości, aby określić, że alert jest alertem dotyczącym ruchu:

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

    Domyślne wartości tych właściwości to:

    "alertType": "runtime"
"alertSubType": "fixed"
  • W elemencie dimensions tablicy conditions:
    • Musisz ustawić wartości tych parametrów: org, env, proxy, i usług region. Obsługiwane są tylko te właściwości. Dla opcji proxy i region możesz ustawić wartość ALL.
    • Wartość właściwości traffic należy ustawić na total.

  • 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ą, która określa procentowy wzrost lub spadek natężenia ruchu gdzie wartość 1.0 odpowiada 100%. Wartość w polu increasedBy nie może być mniejszy niż 0,0 (0%). W przypadku decreasedBy wartość musi wynosić większe lub równe 0,0 (0%) i mniejsze lub równe 1,0 (100%).
    • Właściwość durationSeconds musi mieć 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 korkach.
. Z przykładu poniżej dowiesz się, jak skonfigurować alert, który jest wywoływany, gdy ruch związany z organizacja i środowisko wzrasta o 50% w ciągu godziny. Po uruchomieniu alertu wysyłane jest powiadomienie do określonego kodu PagerDuty. 
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 $ACCESS_TOKEN jako token dostępu OAuth 2.0 zgodnie z opisem w Uzyskiwanie tokena dostępu OAuth 2.0 Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w sekcji Używanie cURL.

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

Otrzymywanie alertów o natężeniu ruchu

Domyślnie interfejs API Get Alerts zwraca informacje o wszystkich zdefiniowanych alertach. Ten interfejs API przyjmuje teraz parametry zapytania, aby umożliwić 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 do zwrócenia. Dozwolone wartości to runtime, domyślna i cert.
  • alertSubType – określa podtyp alertu do zwrócenia. Wartość domyślna nie jest skonfigurowana, co oznacza, że zwracają wszystkie podtypy alertów.

Na przykład to wywołanie interfejsu API zwróci tylko włączone alerty dla organizacji o nazwie myorg:

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

To wywołanie zwraca tylko alerty o natężeniu ruchu, 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 $ACCESS_TOKEN jako token dostępu OAuth 2.0 w sposób opisany w artykule Uzyskiwanie tokena dostępu OAuth 2.0. Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w sekcji Używanie cURL.