Konfigurowanie alertów o wygaśnięciu

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

Użyj alertu o wygaśnięciu TLS powiadomienie o zbliżającej się wygaśnięciu certyfikatu TLS w środowisku.

Informacje o certyfikatach TLS

Protokół TLS (Transport Layer Security) to standardowa technologia zabezpieczeń do ustanowienia zaszyfrowanego połączenia między serwerem WWW a klientem sieciowym, takim jak przeglądarka . Zaszyfrowane połączenie zapewnia, że wszystkie dane przesyłane między serwerem a klientem pozostają prywatne.

Certyfikat TLS to plik cyfrowy identyfikujący podmiot w transakcji TLS. Edge używa protokołu TLS certyfikat, aby skonfigurować TLS dla:

Certyfikat TLS ma datę ważności. Jeśli certyfikat TLS wygaśnie, połączenie TLS nie zostanie nawiązane do czasu zaktualizowania certyfikatu. Oznacza to, że wszystkie żądania wysyłane do interfejsu API będą kończyć się niepowodzeniem, dopóki nie zaktualizujesz certyfikatu.

Informacje o alertach dotyczących wygaśnięcia

Zamiast czekać, aż certyfikat wygaśnie, a żądania wysyłane do interfejsu API zakończą się niepowodzeniem, użyj wygaśnięcie: alert do zgłoszenia powiadomienie o zbliżającej się wygaśnięciu dowolnego certyfikatu TLS w środowisku. Po wywołaniu alertu możesz zaktualizować certyfikat, tak aby klienci nie nie występują żadne przerwy w działaniu usługi.

Podczas konfigurowania alertu nie określaj pojedynczego certyfikatu, tylko konkretnego środowiska. Alert jest wyzwalany po zaplanowaniu wdrożenia dowolnego certyfikatu wygasa w określonym przedziale czasu.

Możesz skonfigurować alert o wygaśnięciu:

  • 1 dzień przed wygaśnięciem dowolnego certyfikatu
  • 14 dni przed wygaśnięciem dowolnego certyfikatu.
  • 30 dni przed wygaśnięciem dowolnego certyfikatu.
. Więcej informacji o alertach znajdziesz w artykule Konfigurowanie alertów i powiadomień.

Dodawanie alertów i powiadomień o wygaśnięciu

Aby dodać alerty i powiadomienia o wygaśnięciu:
  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 Wygaśnięcie TLS. 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

    Skonfiguruj zakres czasu wygasających certyfikatów. Możesz przesłać alert o wygaśnięciu certyfikatu za:

    • 1 dzień
    • 14 dni
    • 30 dni
    Wymiar Wymiary są ustalone na wartość Dowolne certyfikaty TLS odpowiadające parametrowi dowolny certyfikat TLS w środowisku.
  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. Określanie wielu 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ń umożliwiających rozwiązanie problemu alerty po ich uruchomieniu. Możesz też podać link do swojej wewnętrznej strony wiki lub społeczności, odniesienia do sprawdzonych metod. Informacje podane w tym polu pojawią się 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 wygaśnięciu

Większość interfejsów API, których używasz do tworzenia alertów dotyczących wygaśnięcia i zarządzania nimi, jest taka sama jak te, których używasz z ustalonymi alertami. Te interfejsy API alertów działają w taki sam sposób w przypadku alertów o stanie i wygaśnięciu:

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 i aktualizowanie alertów o wygaśnięciu

Użyj tych samych interfejsów API do tworzenia lub zaktualizuj alert o wygaśnięciu, tak jak w przypadku konkretnego alertu. Treść wywołania interfejsu API mającego na celu utworzenie lub aktualizację alert o wygaśnięciu jest taki sam jak w przypadku konkretnego alertu, z tymi zmianami:

  • Aby określić, że alert jest alertem o wygaśnięciu, musisz dodać te nowe właściwości:

    "alertType": "cert"
"alertSubType": "certfixed"

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

    "alertType": "runtime"
"alertSubType": "fixed"

  • W tablicy conditions:

    • Właściwość metrics przyjmuje tylko wartości expiration.
    • Za pomocą właściwości gracePeriodSeconds możesz określić zakres czasu do wygaśnięcia certyfikatu (w sekundach) do maksymalnie 30 dni.
    • Właściwości threshold, durationSeconds i comparator nie są obsługiwane.
  • W elemencie dimensions tablicy conditions:
    • Wartość właściwości certificate należy ustawić na ANY.
    • Wartość właściwości proxy należy ustawić na ALL.
    • statusCode, developerApp, collection, faultCodeCategory, Właściwości faultCodeSubCategory i faultCodeName nie są obsługiwane.
  • Właściwość reportEnabled nie jest obsługiwana w przypadku alertów o wygaśnięciu.

Poniższe przykładowe wywołanie interfejsu API tworzy alert o wygaśnięciu, który jest aktywowany, gdy dowolny Cerki w środowisko produkcyjne wygaśnie w ciągu najbliższych 30 dni. Na podany adres e-mail zostanie wysłane powiadomienie po wywołaniu alertu:

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 Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

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.

Otrzymuj alerty o wygaśnięciu

Domyślnie interfejs API Get Alerts zwraca informacje o wszystkich zdefiniowanych alertach, zarówno stałych, jak i wygasających. 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 jest nieskonfigurowana. czyli zwracają wszystkie podtypy alertów. Aby zwracać alerty o wygaśnięciu, określ certfixed.

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 wygaśnięciu, zarówno włączone, jak i wyłączone:

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

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.