Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację
Apigee X. info
W tej sekcji porównujemy monitorowanie interfejsów API z Edge Analytics. Zarówno monitorowanie interfejsów API, jak i Edge Analytics umożliwiają zbieranie i wyświetlanie danych interfejsów API, ale mają różne cele:
- Celem monitorowania interfejsów API jest zapewnienie, że interfejsy API działają zgodnie z oczekiwaniami. W tym celu chcesz wyświetlać najnowsze dostępne dane. Monitorowanie interfejsów API udostępnia dane bardzo zbliżone do danych w czasie rzeczywistym i umożliwia tworzenie alertów, które powiadamiają o wystąpieniu problemu.
- Celem Edge Analytics jest poznanie długoterminowego zachowania interfejsów API, aby mieć pewność, że spełniają one wymagania biznesowe, lub w razie potrzeby wprowadzić zmiany. W tym przypadku wyświetlanie danych w czasie rzeczywistym nie jest tak ważne. W związku z tym dane Analytics są nieco opóźnione, ale zwykle nie więcej niż o 10 minut.
Pamiętaj, że dane monitorowania interfejsów API, które są w większości związane z kodami błędów i opóźnieniami, stanowią niewielki podzbiór danych Analytics.
Różnice między danymi monitorowania interfejsów API a danymi Analytics
W tej sekcji opisujemy drobne różnice między danymi zbieranymi przez Edge Analytics a monitorowaniem interfejsów API. Ponieważ monitorowanie interfejsów API i Analytics korzystają z różnych potoków danych, możesz zauważyć drobne różnice między raportami niestandardowymi generowanymi przez monitorowanie a raportami generowanymi przez Analytics. Możesz na przykład zauważyć rozbieżności w raportowanych wynikach błędów przekroczenia limitu czasu – zarówno przekroczeń limitu czasu backendu (kod stanu HTTP 504 w żądaniu), jak i przekroczeń limitu czasu klienta (kod stanu HTTP 499). W raportach niestandardowych Analytics mogą one pojawiać się z kodem stanu 200, ale w raportach niestandardowych monitorowania będą wyświetlane z kodem stanu 504 lub 499.Monitorowanie interfejsów API
Monitorowanie interfejsów API zapewnia wgląd w wydajność interfejsów API w czasie rzeczywistym i pomaga szybko diagnozować i rozwiązywać problemy, aby interfejsy API działały zgodnie z oczekiwaniami.
Monitorowanie interfejsów API umożliwia:
- zwiększenie dostępności interfejsów API i skrócenie średniego czasu do diagnozy (MTTD);
- podejmowanie odpowiednich działań na podstawie alertów kontekstowych, zanim wpłyną one na konsumentów;
- wykorzystywanie kodów błędów Apigee do przyspieszenia diagnozy;
- szybkie izolowanie obszarów problemowych w celu diagnozowania błędów, problemów z wydajnością i opóźnieniami oraz ich źródła.
Edge API Analytics
Edge API Analytics zbiera i analizuje informacje przepływające przez interfejsy API. API Analytics rejestruje takie informacje jak:
- trendy ruchu w interfejsie API w czasie,
- najpopularniejsze aplikacje,
- najlepsi deweloperzy,
- najpopularniejsze metody API,
- kiedy czas odpowiedzi interfejsu API jest najszybszy lub najwolniejszy,
- gdzie geograficznie występuje największy ruch w interfejsie API.
Dane zbierane przez API Analytics
API Analytics zbiera i analizuje szeroki zakres danych przepływających przez interfejsy API. Na przykład, gdy interfejs API jest wdrożony, Analytics stale rejestruje liczbę otrzymanych wiadomości, liczbę deweloperów, czasy odpowiedzi, błędy, liczbę używanych aplikacji, rozmiar żądania i wiele innych danych.
Więcej informacji o danych i sposobach ich wykorzystania znajdziesz w artykule Korzystanie z interfejsów API danych do pomiaru skuteczności programu API. Pełną listę danych znajdziesz w artykule Dane, wymiary i filtry Analytics.
Zbieranie danych niestandardowych
Możesz też zbierać dane niestandardowe za pomocą zasady StatisticsCollector. Zasada StatisticsCollector może zapisywać informacje z nagłówków żądań, ładunków XML/JSON, parametrów zapytania, adresów URI i innych lokalizacji na serwerze Analytics w celu analizy i generowania raportów.
Dostęp do danych Analytics
Po wygenerowaniu możesz uzyskać dostęp do predefiniowanych i niestandardowych danych za pomocą narzędzi do wizualizacji API Analytics, w tym panelu informacyjnego, raportów niestandardowych i mapy geograficznej. Więcej informacji o narzędziach do wizualizacji udostępnianych przez API Analytics znajdziesz w artykule Panele informacyjne Analytics. Więcej informacji o raportach niestandardowych znajdziesz w artykule Tworzenie raportów niestandardowych.
Porównanie monitorowania interfejsów API i API Analytics
Deweloperzy interfejsów API korzystają zarówno z monitorowania interfejsów API, jak i z API Analytics. Jedną z głównych różnic między tymi narzędziami jest mechanizm alertów wbudowany w monitorowanie interfejsów API. Alerty umożliwiają zespołowi operacyjnemu reagowanie na problemy z interfejsami API w czasie rzeczywistym, aby zapewnić ich dostępność i prawidłowe działanie.
Warunki alertów określają konkretny kod stanu (2xx/4xx/5xx), opóźnienie i progi kodu błędu, których przekroczenie powoduje wyświetlanie alertów wizualnych w interfejsie i wysyłanie powiadomień różnymi kanałami, takimi jak e-mail, Slack, PagerDuty czy webhooki. Alerty możesz skonfigurować na poziomie środowiska, serwera proxy interfejsu API, usługi docelowej lub regionu.
Gdy alert zostanie wywołany, zespół operacyjny może użyć interfejsu monitorowania interfejsów API, aby zbadać problem i przejść do jego głównej przyczyny. Następnie możesz wygenerować raport niestandardowy, który zawiera predefiniowane informacje o alercie, takie jak:
- łączny czas odpowiedzi,
- czas odpowiedzi celu,
- błędy serwera proxy,
- błędy celu,
- UUID żądania,
- wiele innych.
API Analytics służy do rejestrowania szerokiego zakresu danych, które mogą być wykorzystywane przez różne zespoły. Na przykład:
- Zespół operacyjny może używać danych Analytics do identyfikowania okresów dużego lub małego ruchu, aby móc skalować usługi w górę lub w dół w zależności od zmieniających się wymagań.
- Zespół marketingowy może używać danych Analytics do określania wzorców korzystania z usług przez klientów na podstawie poszczególnych interfejsów API, aplikacji, klientów lub innych danych.
- Wszystkie zespoły mogą uzyskiwać dostęp do danych niestandardowych zebranych z żądania, aby śledzić konkretne informacje, takie jak wartości nagłówków, parametry zapytania lub ładunek żądania.