Zobacz przykładowy scenariusz

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

Przejdź przez przykładowy scenariusz pokazujący, jak rozwiązać problemy z interfejsami API 5xx.

# Step Opis
1 Monitorowanie ostatniego ruchu przez interfejsy API Wyświetl ostatnie dane monitorowania interfejsu API dla wszystkich serwerów proxy i celów API, w przypadku których zarejestrowano ruch w ciągu ostatniej godziny. Analiza serwerów proxy interfejsu API lub celów z dużą częstotliwością błędów.
2 Identyfikowanie trendów w danych monitorowania interfejsu API Dostęp do historycznego widoku danych monitorowania interfejsu API do ostatnich 3 miesięcy, aby zyskać szerszą perspektywę.
3 Sprawdzanie problemów z kodem 5xx Wyświetl kody błędów, które w danym okresie wystąpiły w największej względnej ilości danych, aby dokładniej zbadać źródło problemów 5xx. (Zazwyczaj kody stanu 5xx można sklasyfikować za pomocą co najmniej jednego kodu błędu).
4 Konfigurowanie alertu 5xx Skonfiguruj alert, aby otrzymywać powiadomienia, gdy liczba kodów stanu 5xx przekroczy określony próg.
5 Generowanie raportu niestandardowego ze szczegółami klienta (opcjonalnie) Opcjonalnie wygeneruj raport niestandardowy, aby zidentyfikować szczegółowe informacje o kliencie, który powoduje błędy 5xx.

Uwaga: aby wygenerować raport niestandardowy, musisz być administratorem organizacji.
6 Grupowanie serwerów proxy interfejsu API w kolekcję Utwórz kolekcję, aby grupować serwery proxy interfejsu API i skonfigurować odpowiednie wartości progów alertów dla wszystkich członków grupy, aby szybciej diagnozować problemy.
7 Rozwiązywanie problemów z błędami 5xx Na podstawie wyników badań i diagnozy podejmij odpowiednie działania, aby rozwiązać problemy 5xx.

Krok 1. Monitoruj ostatni ruch przez interfejsy API

Aby wyświetlić dane monitorowania interfejsów API dla serwerów proxy i celów API, które miały ruch w ciągu ostatniej godziny:

  1. Wybierz Analiza > Monitorowanie interfejsów API > Ostatnie w interfejsie Edge, aby uzyskać dostęp do panelu Najnowsze.

  2. Zwróć uwagę na serwery proxy i elementy docelowe interfejsu API, które w ciągu ostatniej godziny miały wysoki odsetek błędów.

  3. Kliknij serwer proxy interfejsu API lub cel z dużą częstotliwością błędów, aby wyświetlić szczegóły w panelu po prawej stronie. Zwróć uwagę na wysoki odsetek błędów 5xx w tym przykładzie.

Więcej informacji o tym kroku znajdziesz w artykule Monitorowanie ostatniego ruchu w interfejsie API.

Krok 2. Rozpoznaj trendy w danych monitorowania interfejsów API

Aby uzyskać dostęp do historycznego widoku danych monitorowania interfejsu API dla serwerów proxy i celów API, w których wystąpił ruch w ciągu ostatnich 3 miesięcy:

  1. W panelu po prawej stronie panelu Ostatnie kliknij Menu Więcej > Wyświetl na osi czasu, aby otworzyć panel Oś czasu. Możesz też kliknąć Analiza > Monitorowanie interfejsów API > Oś czasu w interfejsie użytkownika Edge.
  2. Wyświetl trend dotyczący serwera proxy lub celu interfejsu API na przestrzeni czasu. Zwróć uwagę, że w ciągu ostatnich 7 dni ten trend był spójny.

Więcej informacji o tym kroku znajdziesz w artykule Identyfikowanie trendów w danych monitorowania interfejsu API.

Krok 3. Zbadaj problemy z kodem 5xx

Apigee udostępnia zestaw kodów błędów, które pomagają diagnozować problemy. Zwykle kody stanu 5xx można sklasyfikować za pomocą co najmniej 1 kodu błędu.

Aby zbadać problemy 5xx:

  1. W prawym panelu w panelu Oś czasu kliknij Menu Więcej > Wyświetl w narzędziu Zbadaj, aby uzyskać dostęp do panelu Zbadaj. Możesz też kliknąć Analiza > Monitorowanie interfejsów API > Zbadaj w interfejsie użytkownika Edge.

    Panel Zbadaj umożliwia porównywanie aktywności relacyjnej między danymi, na przykład kodem błędu z czasem.

  2. Wyświetl kod błędu w porównaniu z tablicą czasową, aby zobaczyć aktywność związaną z kodem błędu w ciągu ostatniej godziny. Zwróć uwagę na kody błędów, które są najbardziej względne ze względu na odcienie koloru bryły. Im ciemniejszy blok, tym większa głośność.

    Na przykład kody błędów policies.ratelimit.SpikeArrestViolation i policies.ratelimit.QuotaViolation wskazują większą względną głośność w tej macierzy: Kody błędów

  3. Kliknij najciemniejszy blok (pierwszy blok) w wierszu policies.ratelimit.SpikeArrestViolation, aby wyświetlić więcej szczegółów w panelu po prawej stronie.

  4. Zwróć uwagę, że źródłem błędu jest serwer proxy interfejsu API perfBenchmark_invalid_v1, a kod stanu HTTP to perfBenchmark_invalid_v1. Kod stanu 500 to często spotykany kod błędu w czasie działania w przypadku naruszenia zasad dotyczących obiektu Spike Arrest.

  5. Wyświetl sekcję Rozpowszechnianie według aplikacji dewelopera tuż pod panelem Możliwa przyczyna, aby zidentyfikować aplikacje z największym odsetkiem błędów.

Więcej informacji o tym kroku znajdziesz w artykule Identyfikowanie problemów.

Krok 4. Skonfiguruj alert 5xx

W panelu Zbadaj szczegóły skonfiguruj alert na podstawie wybranego kontekstu, aby otrzymywać powiadomienia, gdy liczba kodów stanu 5xx przekroczy określony próg.

  1. W prawym panelu panelu Zbadaj kliknij Menu Więcej > Utwórz alert.

  2. Wypełnij pola w oknie alertu. Pola warunku są wstępnie wypełnione danymi z bieżącego kontekstu. Na przykład:

  3. Kliknij Zapisz.

W przyszłości, gdy odsetek błędów 5xx przez okres 5 minut w przypadku serwera proxy interfejsu API perfBenchmark_invalid_v1, zostanie wysłane perfBenchmark_invalid_v1 na podany adres e-mail, a w interfejsie pojawi się perfBenchmark_invalid_v1. Na przykład:

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

Krok 5. Wygeneruj raport niestandardowy ze szczegółami klienta (opcjonalnie)

Opcjonalnie wygeneruj raport niestandardowy, aby zidentyfikować więcej informacji o kliencie, który powoduje błędy 5xx.

Na stronie Raporty raporty niestandardowe utworzone na podstawie alertu mają nazwy w tym formacie: API Monitoring Generated: alert-name.

  1. Raport niestandardowy utworzony podczas konfigurowania alertu możesz otworzyć na jeden z tych sposobów:

    • Aby wyświetlić stronę Raporty, na lewym pasku nawigacyjnym kliknij Analiza > Raporty niestandardowe > Raporty. Kliknij nazwę raportu na liście: API Monitoring Generated: 5xx Alert (Monitorowanie interfejsów API zostało wygenerowane: alert 5xx).

    • Kliknij w powiadomieniu wyświetlanym po utworzeniu alertu. Na przykład:

  2. Dodaj te wymiary:

    • Aplikacja dewelopera
    • Identyfikator klienta
    • Adres IP klienta

  3. Aby wyświetlić raport dotyczący określonej aplikacji dewelopera z wysokim odsetkiem błędów, dodaj filtr podobny do tego:

    and (developer_app eq 'perfBenchmarkApp0')

    Uwaga: w tym przypadku usuń aplikację dewelopera z listy wymiarów.

  4. Kliknij Zapisz.

  5. Wygeneruj raport, aby wyświetlić szczegółowe informacje o aplikacji dewelopera i klientach, które wywołują kod stanu 5xx.

Więcej informacji o tym kroku znajdziesz w artykule Tworzenie raportów niestandardowych.

Krok 6. Grupuj serwery proxy interfejsu API w kolekcję

Utwórz kolekcję, aby grupować serwery proxy interfejsu API i skonfigurować odpowiednie wartości progów alertów dla wszystkich członków grupy, aby szybciej diagnozować problemy.

  1. W interfejsie użytkownika Edge wybierz Analiza > Monitorowanie interfejsów API > Kolekcje, aby wyświetlić panel Kolekcje.
  2. Kliknij + Kolekcja.
  3. Kliknij Serwer proxy.
  4. W menu środowiska wybierz prod.
  5. Kliknij Dalej.
  6. Wypełnij pola w oknie kolekcji.
  7. Kliknij Zapisz.

Następnie możesz skonfigurować alert (podobnie jak w kroku 4) i ustawić wymiar na zbiór zdefiniowany powyżej.

Więcej informacji o tym kroku znajdziesz w artykule Zarządzanie kolekcjami.

Krok 7. Rozwiąż problemy 5xx

Podejmij odpowiednie działania, aby rozwiązać problemy 5xx. Na podstawie diagnozy możesz np. wykonać jedno z tych zadań:

  • Za pomocą Apigee Sense określ, czy wzrost liczby żądań jest podejrzany, i zdecyduj, czy chcesz zablokować adres IP klienta określony w raporcie niestandardowym.
  • Dodaj zasady limitów, aby ograniczyć liczbę połączeń, które aplikacje mogą nawiązać z serwerem proxy interfejsu API w określonym czasie.
  • Zarabiaj na interfejsie API, aby naliczać deweloperom opłaty za korzystanie z określonej liczby wywołań.