Konfigurowanie alertów o wygaśnięciu

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Użyj alertu o wygaśnięciu TLS, aby wysłać powiadomienie, gdy certyfikat TLS w środowisku wkrótce wygaśnie.

Informacje o certyfikatach TLS

TLS (Transport Layer Security) to standardowa technologia zabezpieczeń służąca do tworzenia zaszyfrowanego połączenia między serwerem WWW a klientem internetowym, takim jak przeglądarka lub aplikacja. Zaszyfrowane połączenie zapewnia, że wszystkie dane przesyłane między serwerem a klientem pozostaną prywatne.

Certyfikat TLS to plik cyfrowy, który identyfikuje podmiot w transakcji TLS. Edge używa certyfikatu TLS do konfigurowania TLS w tych przypadkach:

Certyfikat TLS zawiera datę ważności. Jeśli certyfikat TLS wygaśnie, połączenie TLS nie będzie działać, dopóki nie zaktualizujesz certyfikatu. Oznacza to, że wszystkie żądania do interfejsu API będą kończyć się niepowodzeniem, dopóki nie zaktualizujesz certyfikatu.

Informacje o alertach o wygaśnięciu

Zamiast czekać na wygaśnięcie certyfikatu i niepowodzenie żądań do interfejsu API, użyj alertu o wygaśnięciu, aby wysłać powiadomienie, gdy certyfikat TLS w środowisku wkrótce wygaśnie. Po wywołaniu alertu możesz zaktualizować certyfikat, aby Twoi klienci nie odczuli żadnych przerw w działaniu usługi.

Podczas konfigurowania alertu nie określaj pojedynczego certyfikatu, ale konkretne środowisko. Alert jest wywoływany, gdy jakikolwiek wdrożony certyfikat ma wygasnąć w określonym przedziale czasu.

Możesz ustawić alert o wygaśnięciu, aby był wywoływany:

  • 1 dzień przed wygaśnięciem certyfikatu.
  • 14 dni przed wygaśnięciem certyfikatu.
  • 30 dni przed wygaśnięciem 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. W interfejsie Edge kliknij Analiza > Reguły alertów.
  2. Kliknij +Alert.
  3. Wpisz 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 przekraczać 128 znaków.
    Opis Opis alertu.
    Typ alertu Wybierz Wygaśnięcie TLS. 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 wywoływać alert.
    Pole warunku Opis
    Próg

    Skonfiguruj zakres czasu dla wygasających certyfikatów. Możesz ustawić alert, który będzie wywoływany, gdy certyfikat wygaśnie za:

    • 1 dzień
    • 14 dni
    • 30 dni
    Wymiar Wymiar jest ustawiony na wartość Dowolne certyfikaty TLS odpowiadającą dowolnemu certyfikatowi TLS w środowisku.
  5. 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 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ć kilka miejsc docelowych dla tego samego typu kanału, dodaj dodatkowe powiadomienia.
  6. Aby dodać kolejne powiadomienia, powtórz poprzedni krok.
  7. Jeśli dodasz powiadomienie, ustaw te pola:
    Pole Opis
    Scenariusz (Opcjonalnie) Pole tekstowe, w którym możesz podać krótki opis zalecanych działań w celu rozwiązania problemów, gdy alerty zostaną wywołane. Możesz też podać link do wewnętrznej strony wiki lub strony społeczności, na której znajdziesz sprawdzone metody. Informacje w tym polu zostaną uwzględnione 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świetlanie alertów w panelu Zdarzenia

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

Aby wyświetlić alert:

  1. W interfejsie Edge kliknij Analiza > Zdarzenia. Pojawi się nowy panel Zdarzenia:

  2. Filtruj panel Zdarzenia według:

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

Używanie interfejsów API alertów z alertami o wygaśnięciu

Większość interfejsów API, których używasz do tworzenia alertów o wygaśnięciu i zarządzania nimi, jest taka sama jak w przypadku alertów stałych. Te interfejsy API alertów działają tak samo w przypadku alertów stałych i alertów o wygaśnięciu:

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

Tworzenie lub aktualizowanie alertu o wygaśnięciu

Do tworzenia lub aktualizowania alertu o wygaśnięciu używaj tych samych interfejsów API co w przypadku alertu stałego. Treść wywołania interfejsu API służącego do tworzenia lub aktualizowania alertu o wygaśnięciu jest taka sama jak w przypadku alertu stałego, 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.
    • Użyj właściwości gracePeriodSeconds, aby określić zakres czasu wygaśnięcia certyfikatu w sekundach, maksymalnie do 30 dni.
    • Właściwości threshold, durationSeconds i comparator nie są obsługiwane.
  • W elemencie dimensions tablicy conditions:
    • Musisz ustawić wartość właściwości certificate na ANY.
    • Musisz ustawić wartość właściwości proxy na ALL.
    • Właściwości statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName nie są obsługiwane.
  • Właściwość reportEnabled nie jest obsługiwana w przypadku alertów o wygaśnięciu.

Ten przykładowy wywołanie interfejsu API tworzy alert o wygaśnięciu, który jest wywoływany, gdy jakikolwiek certyfikat w środowisku produkcyjnym wygaśnie w ciągu najbliższych 30 dni. Gdy alert zostanie wywołany, na podany adres e-mail 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 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 na token dostępu OAuth 2.0 zgodnie z opisem w Uzyskiwanie tokena dostępu OAuth 2.0. Więcej informacji o opcjach cURL używanych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.

Pobieranie alertów o wygaśnięciu

Domyślnie interfejs Get Alerts API zwraca informacje o wszystkich zdefiniowanych alertach, zarówno stałych, jak i o wygaśnięciu. Ten interfejs API przyjmuje teraz parametry zapytania, które umożliwiają filtrowanie wyników:

  • enabled – jeśli true, określa, że mają być zwracane tylko włączone alerty. Wartością domyślną jest false.
  • alertType – określa typ alertu, który ma zostać zwrócony. Dozwolone wartości to runtime (domyślna) i cert.
  • alertSubType – określa podtyp alertu, który ma zostać zwrócony. Wartość domyślna to brak ustawienia, co oznacza, że mają być zwracane wszystkie podtypy alertów. Aby zwrócić alerty o wygaśnięciu, określ certfixed.

Aby na przykład zwrócić tylko włączone alerty w 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'

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 na token dostępu OAuth 2.0 zgodnie z opisem w Uzyskiwanie tokena dostępu OAuth 2.0. Więcej informacji o opcjach cURL używanych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.