Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
W tej sekcji porównujemy monitorowanie interfejsu API z Edge Analytics. Zarówno monitorowanie interfejsu API, jak i Edge Analytics umożliwiają zbieranie i wyświetlanie danych interfejsu API, ale mają różne cele:
- Celem monitorowania interfejsu API jest zapewnienie, że interfejsy API działają zgodnie z zamierzeniami. W tym celu musisz mieć dostęp do najnowszych dostępnych danych. Monitorowanie interfejsu API zapewnia dane bardzo zbliżone do rzeczywistych i umożliwia tworzenie alertów, które powiadamią Cię w przypadku wystąpienia problemu.
- Celem Edge Analytics jest poznanie długoterminowego zachowania interfejsów API, aby można było sprawdzić, czy spełniają one wymagania biznesowe, lub w razie potrzeby wprowadzić zmiany. W takim przypadku nie jest tak ważne, aby wyświetlane były dane w czasie rzeczywistym. W związku z tym dane Analytics są nieco opóźnione, ale zwykle o maksymalnie 10 minut.
Pamiętaj, że dane monitorowania interfejsu API, które dotyczą głównie kodów błędów i czasu oczekiwania, stanowią niewielką część danych Analytics.
Różnice między danymi z monitorowania API a danymi Analytics
W tej sekcji opisujemy drobne różnice między danymi zbieranymi przez Edge Analytics a danymi z Monitorowania interfejsu API. Ponieważ Monitoring interfejsu API i Analytics korzystają z różnych ścieżek danych, możesz zauważyć drobne różnice między raportami niestandardowymi generowanymi przez Monitoring a raportami generowanymi przez Analytics. Możesz na przykład zauważyć rozbieżności w raportowanych wynikach dotyczących błędów limitu czasu – zarówno w przypadku limitu czasu backendu (kod stanu HTTP 504 w żądaniu) jak i klienta (kod stanu HTTP 499). W raportach niestandardowych Analytics mogą one występować z kodem stanu 200, ale w raportach niestandardowych Monitorowania będą miały kod stanu 504 lub 499.Monitorowanie interfejsu API
Monitorowanie interfejsu API zapewnia informacje o wydajności interfejsu API w czasie rzeczywistym i pomaga szybko diagnozować oraz rozwiązywać problemy, aby interfejs API działał zgodnie z oczekiwaniami.
Monitorowanie interfejsu API umożliwia:
- Zwiększ dostępność interfejsu API i zmniejsz średni czas diagnostyki (MTTD).
- Podejmij odpowiednie działania na podstawie alertów kontekstowych, zanim konsumenci odczują skutki.
- Korzystaj z kodów błędów Apigee, aby przyspieszyć diagnostykę.
- Szybko izoluj obszary problemowe, aby diagnozować błędy, problemy z wydajnością i opóźnienia oraz ich przyczyny.
Interfejs Edge API Analytics
Analizy interfejsu Edge API zbierają i analizują informacje przesyłane przez interfejsy API. Interfejs API Analytics rejestruje takie informacje jak:
- Jakie trendy dotyczą ruchu przez interfejs API na przestrzeni czasu
- Które aplikacje są najpopularniejsze
- Którzy deweloperzy są najpopularniejsi
- Które metody interfejsu API są najpopularniejsze
- Kiedy czas odpowiedzi interfejsu API jest najkrótszy/najdłuższy
- Gdzie geograficznie występuje najwięcej ruchu przez interfejs API
Dane zbierane przez Analytics API
Analiza interfejsu API zbiera i analizuje szerokie spektrum danych przepływających przez interfejsy API. Podczas wdrażania interfejsu API Analytics stale rejestruje m.in. liczbę otrzymanych wiadomości, liczbę deweloperów, czasy odpowiedzi, błędy, liczbę używanych aplikacji i wiele innych danych.
Więcej informacji o wskaźnikach i sposobach ich wykorzystania znajdziesz w artykule Używanie interfejsów API danych do pomiaru skuteczności programu interfejsu API. Pełną listę danych znajdziesz w artykule [GA4] Dane, wymiary i filtry Analytics.
Zbieranie danych niestandardowych
Możesz też zbierać dane niestandardowe za pomocą zasady StatisticsCollector. Polityka StatisticsCollector może zapisywać informacje z nagłów żądań, ładunków XML/JSON, parametrów zapytań, identyfikatorów URI i innych lokalizacji na serwerze Analytics na potrzeby analizy i tworzenia raportów.
Dostęp do danych Analytics
Po wygenerowaniu możesz uzyskać dostęp do wstępnie zdefiniowanych i niestandardowych danych za pomocą narzędzi do wizualizacji Analytics, takich jak panel, raporty niestandardowe i Mapa geograficzna. Więcej informacji o narzędziach wizualizacji udostępnianych przez Analytics API znajdziesz w artykule Pulpity Analytics. Więcej informacji o raportach niestandardowych znajdziesz w artykule [GA4] Tworzenie raportów niestandardowych.
Porównanie monitorowania interfejsu API i statystyk interfejsu API
Deweloperzy interfejsów API korzystają zarówno z monitorowania interfejsu API, jak i z statystyk interfejsu API. Jedną z głównych różnic między tymi usługami jest mechanizm alertów wbudowany w Monitorowaniu interfejsu 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 alertu definiują określony kod stanu (2xx/4xx/5xx), opóźnienie i progi kodów błędów, które po przekroczeniu uruchamiają alerty wizualne w interfejsie użytkownika i wysyłają powiadomienia przez różne kanały, takie jak e-mail, Slack, pagerduty czy webhooki. Alerty możesz konfigurować na poziomie środowiska, serwera proxy API, usługi docelowej lub regionu.
Po wywołaniu alertu zespół operacyjny może użyć interfejsu monitorowania interfejsu API, aby zbadać problem i znalezć jego główną przyczynę. Następnie możesz wygenerować raport niestandardowy zawierający wstępnie zdefiniowane informacje o alertach, takie jak:
- Łączny czas odpowiedzi
- Docelowy czas odpowiedzi
- Błędy proxy
- Błędy celu
- Identyfikator UUID prośby
- i wiele innych.
Interfejs Analytics API został zaprojektowany tak, aby rejestrować szeroki zakres danych, z których mogą korzystać różne zespoły. Na przykład:
- Zespół operacyjny może używać danych Analytics do identyfikowania okresów dużego lub małego natężenia ruchu, aby w zależności od zmieniających się potrzeb zwiększać lub zmniejszać skalę usług.
- Zespół marketingowy może używać danych Analytics do określania wzorców korzystania przez klientów, które są identyfikowane przez poszczególne interfejsy API, aplikacje, klientów lub inne dane.
- Wszystkie zespoły mają dostęp do danych niestandardowych zbieranych z żądania, aby śledzić określone informacje, np. wartości nagłówków, parametry zapytania lub ładunek żądania.