Ta strona została przetłumaczona przez Cloud Translation API.

Konfigurowanie alertów o ruchu

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. info

Użyj alertu o ruchu, aby wywołać powiadomienie, gdy ruch w środowisku, serwerze proxy lub regionie zmieni się o określony odsetek w danym przedziale czasu.

Ustawiasz zakres czasowy:

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

Alert działa na zasadzie porównania ruchu w bieżącym zakresie czasu z ruchem w poprzednim zakresie czasu. Na przykład określasz godzinny zakres czasowy. Następnie alert porównuje ruch w ostatniej godzinie z ruchem w poprzedniej godzinie, aby obliczyć procentową zmianę ruchu:

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

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

Następnie ustaw próg, który wywoła alert o ruchu, jako procentowy wzrost lub spadek ruchu w interfejsie API w określonym przedziale czasu.

Zanim ustawisz ten odsetek, upewnij się, że jest on zgodny z Twoimi normalnymi wzorcami ruchu. Jeśli na przykład natężenie ruchu w interfejsie API zwykle zmienia się w ciągu dnia, a w określonych godzinach szczytu wzrasta nawet o 100%, takie skoki są normalne i nie powinny wywoływać alertu. Jeśli jednak skonfigurujesz alert, który będzie się uruchamiał przy każdym 50-procentowym wzroście ruchu w ciągu godziny, będziesz otrzymywać 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:

W interfejsie Edge kliknij Analyze > Alert Rules (Analizuj > Reguły alertów).
Kliknij + Alert.

Podaj te ogólne informacje o alercie:

Pole	Opis
Nazwa alertu	Nazwa alertu. Użyj nazwy, która opisuje wyzwalacz i będzie dla Ciebie zrozumiała. Nazwa nie może mieć więcej niż 128 znaków.
Opis	Opis alertu.
Typ alertu	Kliknij Cały ruch. Więcej informacji znajdziesz w artykule Typy alertów.
Środowisko	Wybierz środowisko z menu.
Stan	Przełącz, aby włączyć lub wyłączyć alert.

Określ próg i wymiar warunku, który będzie aktywować alert.

Pole warunku	Opis
Próg	Określ, kiedy ma się pojawić alert: gdy ruch wzrośnie o lub zmaleje o określony procent w porównaniu z poprzednim przedziałem czasu. Ustaw wartość procentową zwiększoną o na wartość większą lub równą 0%. Ustaw wartość procentową zmniejszoną o na wartość większą lub równą 0% i mniejszą lub równą 100%. Możesz wybrać przedział czasu: 1 godzina 1 dzień 1 tydzień
Wymiar	Kliknij +Add Dimension (Dodaj wymiar) i określ szczegóły wymiaru, dla którego chcesz uzyskać wyniki, w tym serwer proxy interfejsu API i region. Ustaw określony wymiar na: Serwer proxy – ustaw konkretny serwer proxy lub wszystkie serwery proxy. Serwer proxy nie obsługuje wartości „Any”. Zamiast tego możesz dodać osobny alert dla każdego interesującego Cię serwera proxy. Region – ustaw konkretny region lub wszystkie regiony. Region nie obsługuje wartości „Any”. Zamiast tego możesz dodać osobny alert dla każdego regionu, który Cię interesuje.

Pole warunku

Opis

Próg

Określ, kiedy ma się pojawić alert: gdy ruch wzrośnie o lub zmaleje o określony procent w porównaniu z poprzednim przedziałem czasu.

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

Możesz wybrać przedział czasu:

1 godzina
1 dzień
1 tydzień

Wymiar

Kliknij +Add Dimension (Dodaj wymiar) i określ szczegóły wymiaru, dla którego chcesz uzyskać wyniki, w tym serwer proxy interfejsu API i region.

Ustaw określony wymiar na:

Serwer proxy – ustaw konkretny serwer proxy lub wszystkie serwery proxy. Serwer proxy nie obsługuje wartości „Any”. Zamiast tego możesz dodać osobny alert dla każdego interesującego Cię serwera proxy.
Region – ustaw konkretny region lub wszystkie regiony. Region nie obsługuje wartości „Any”. Zamiast tego możesz dodać osobny alert dla każdego regionu, który Cię interesuje.

Aby dodać powiadomienie o alercie, kliknij + Powiadomienie.

Szczegóły powiadomienia Opis

Kanał Wybierz kanał powiadomień, którego chcesz używać, i określ miejsce docelowe: e-mail, Slack, PagerDuty lub webhook.

Miejsce docelowe

Szczegóły powiadomienia	Opis
Kanał	Wybierz kanał powiadomień, którego chcesz używać, i określ miejsce docelowe: e-mail, Slack, PagerDuty lub webhook.
Miejsce docelowe	Określ miejsce docelowe na podstawie wybranego typu kanału: E-mail – adres e-mail, np. `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, np. `https://apigee.com/test-webhook` Uwaga: w przypadku każdego powiadomienia możesz określić tylko 1 miejsce docelowe. Aby określić wiele miejsc docelowych dla tego samego typu kanału, dodaj dodatkowe powiadomienia.

Określ miejsce docelowe na podstawie wybranego typu kanału:

E-mail – adres e-mail, np. 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, np. https://apigee.com/test-webhook
Uwaga: w przypadku każdego powiadomienia możesz określić tylko 1 miejsce docelowe. Aby określić wiele miejsc docelowych dla tego samego typu kanału, dodaj dodatkowe powiadomienia.

Aby dodać kolejne powiadomienia, powtórz poprzedni krok.

Jeśli dodasz powiadomienie, ustaw te pola:

Pole	Opis
Scenariusz	(Opcjonalnie) Pole tekstowe do podania krótkiego opisu zalecanych działań, które należy podjąć, gdy pojawią się alerty. Możesz też podać link do wewnętrznej wiki lub strony społeczności, na której znajdziesz sprawdzone metody. Informacje w tym polu zostaną uwzględnione w powiadomieniu. Tekst w tym polu nie może przekraczać 1500 znaków.
Ograniczenie	Częstotliwość wysyłania powiadomień. Wybierz wartość z listy.

Kliknij Zapisz.

Wyświetlanie alertów w panelu Zdarzenia

Gdy Edge wykryje warunek alertu, automatycznie rejestruje go w panelu Events w interfejsie Edge. Lista zdarzeń wyświetlana na panelu Zdarzenia obejmuje wszystkie alerty, zarówno stałe, jak i dotyczące certyfikatów.

Aby wyświetlić alert:

W interfejsie Edge kliknij Analiza > Zdarzenia. Pojawi się nowy panel Zdarzenia:
Filtruj panel Zdarzenia według:
- Środowisko
- Region
- Przedział czasu
Wybierz wiersz w panelu Zdarzenia, aby wyświetlić magazyn kluczy zawierający wygasający certyfikat i dokładniej zbadać alert. Na stronie Keystore możesz przesłać nowy certyfikat i usunąć wygasający certyfikat.

Korzystanie z interfejsów API alertów z alertami o korkach

Większość interfejsów API, których używasz do tworzenia alertów o ruchu i zarządzania nimi, jest taka sama jak w przypadku innych typów alertów:

Pobierz alert – pobierz definicję alertu o stałej wartości lub anomalii.
Pobierz historię alertów – pobierz dane dotyczące historii alertów.
Usuwanie alertu – usuwanie definicji alertu o stałej wartości lub alertu o anomalii.
Pobierz instancję alertu – pobierz informacje o wywołanym alercie.
Pobierz liczbę alertów – pobierz łączną liczbę alertów.

Niektóre interfejsy API mają jednak dodatkowe właściwości, które służą do obsługi alertów o anomaliach, m.in.:

Otrzymuj alerty – wyświetla listę wszystkich alertów, w tym alertów o naprawionych problemach i anomaliach.
Utwórz alert – utwórz alert stały lub alert o anomalii.
Aktualizowanie alertu – aktualizowanie definicji alertu o stałej wartości lub alertu o anomalii.

Tworzenie i aktualizowanie alertu o natężeniu ruchu

Używaj tych samych interfejsów API do tworzenia lub aktualizowania alertów o ruchu, których używasz obecnie w przypadku innych typów alertów. Treść wywołania interfejsu API do utworzenia lub zaktualizowania alertu o ruchu jest taka sama jak w przypadku innych alertów, z tymi zmianami:

Aby określić, że alert jest alertem o ruchu, dodaj te nowe właściwości:
```
"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 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.
- Wartość właściwości traffic musi być ustawiona 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ą określającą procentowy wzrost lub spadek natężenia ruchu, przy czym 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 mieć jedną z tych wartości: 3600 (1 godzina), 86400 (1 dzień), 604800 (7 dni), 1296000 (15 dni), 2592000 (30 dni) .
W przypadku alertów o ruchu drogowym usługa reportEnabled nie jest obsługiwana.

Poniższy przykład pokazuje, jak skonfigurować alert, który będzie się włączać, gdy ruch w przypadku organizacji i środowiska wzrośnie o 50% w ciągu godziny. Gdy alert zostanie uruchomiony, na podany kod PagerDuty zostanie wysłane 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 $ACCESS_TOKEN na 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 Korzystanie z cURL.

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

Otrzymywanie alertów o korkach

Domyślnie interfejs API Get Alerts zwraca informacje o wszystkich zdefiniowanych alertach. Ten interfejs API przyjmuje teraz parametry zapytania, które umożliwiają filtrowanie wyników:

enabled – jeśli parametr true określa, że mają być zwracane tylko włączone alerty. Wartością domyślną jest false.
alertType – określa typ alertu do zwrócenia. Dozwolone wartości to runtime (wartość domyślna) i cert.
alertSubType – określa podtyp alertu do zwrócenia. Wartość domyślna jest nieokreślona, co oznacza, że zwracane są wszystkie podtypy alertów.

Aby na przykład zwrócić tylko włączone alerty dotyczące organizacji o nazwie myorg, użyj tego wywołania interfejsu API:

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

Poniższe wywołanie zwraca tylko alerty o 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 na 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 Korzystanie z cURL.