Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
W tej sekcji porównano Monitorowanie interfejsów API i Edge Analytics. Chociaż monitorowanie interfejsów API i Edge Analytics umożliwiają gromadzenie i wyświetlanie danych interfejsu API, mają one różne cele:
- Monitorowanie interfejsów API ma na celu zapewnienie, że interfejsy API są aktywne i działają zgodnie z oczekiwaniami. W tym celu chcesz wyświetlić najnowsze dostępne dane. Monitorowanie interfejsów API dostarcza danych, które są niemal aktualizowane w czasie rzeczywistym, i umożliwia tworzenie alertów powiadamiających o pojawieniu się problemów.
- Usługa Edge Analytics umożliwia poznanie długoterminowego działania interfejsów API w celu sprawdzenia, czy są one zgodne z wymaganiami Twojej firmy, lub wprowadzenie zmian, jeśli to konieczne. W tych celach wyświetlanie danych w czasie rzeczywistym jest mniej istotne. W związku z tym dane Analytics są dostarczane z niewielkim opóźnieniem, nieprzekraczającym 10 minut.
Pamiętaj, że dane z Monitorowania interfejsu API, które są głównie związane z kodami błędów i czasem oczekiwania, są niewielkim podzbiorem danych Analytics.
Różnice między danymi Monitoring API a danymi Analytics
W tej sekcji opisujemy kilka drobnych różnic między danymi zbieranymi przez Edge Analytics i przez API Monitoring. Monitorowanie interfejsów API i Analytics używają różnych potoków danych, więc możesz zauważyć drobne różnice między raportami niestandardowymi wygenerowanymi przez usługę Monitoring a raportami generowanymi przez Analytics. Możesz na przykład zauważyć rozbieżności w raportowanych wynikach związanych z błędami przekroczenia limitu czasu – zarówno czasu oczekiwania backendu (kod stanu HTTP 504 w żądaniu), jak i limitów czasu klienta (kod stanu HTTP 499). W niestandardowych raportach Analytics mogą się one pojawiać z kodem stanu 200, ale w raportach niestandardowych usługi Monitoring – kod stanu 504 lub 499.Monitorowanie interfejsów API
Monitorowanie interfejsów API zapewnia wgląd w działanie interfejsów API w czasie rzeczywistym oraz pomaga szybko diagnozować i rozwiązywać problemy, aby zapewnić prawidłowe działanie interfejsów API.
API Monitoring umożliwia:
- Zwiększenie dostępności interfejsu API i skrócenie średniego czasu do diagnostyki (MTTD).
- Podejmij odpowiednie działania na podstawie alertów kontekstowych, zanim zaczną one wpływać na klientów.
- Wykorzystaj kody błędów Apigee, aby przyspieszyć diagnostykę.
- Szybko wydzielaj problematyczne obszary, aby zdiagnozować problemy dotyczące błędów, wydajności i opóźnień, a także ich źródła.
Analityka interfejsu Edge API
Interfejs Edge API Analytics zbiera i analizuje informacje przekazywane przez interfejsy API. Interfejs API Analytics zbiera takie informacje jak:
- Jak zmienia się ruch z interfejsów API na przestrzeni czasu
- Jakie są Twoje najpopularniejsze aplikacje
- Kim są Twoi najlepsi programiści
- Które metody interfejsu API są najpopularniejsze
- Kiedy czas odpowiedzi interfejsu API jest najkrótszy/najwolniejszy
- W których regionach geograficznych występuje największy ruch związany z interfejsami API
Dane zbierane przez interfejs API Analytics
Interfejs API Analytics gromadzi i analizuje szeroki zakres danych przesyłanych przez interfejsy API. Na przykład podczas wdrażania interfejsu API Analytics stale rejestruje liczbę otrzymanych wiadomości, liczbę programistów, czasy odpowiedzi, błędy, liczbę używanych aplikacji, rozmiar żądania i wiele innych danych.
Aby uzyskać dobre wprowadzenie do danych i informacji o tym, jak z nich korzystać, przeczytaj artykuł Używanie interfejsów API wskaźników do pomiaru wydajności programu interfejsów API. Pełną listę danych znajdziesz w artykule Informacje o danych, wymiarach i filtrach Analytics.
Zbieraj dane niestandardowe
Możesz też zbierać dane niestandardowe, korzystając z zasady StatisticsCollector. Zasada StatisticsCollector może zapisywać na serwerze Analytics informacje z nagłówków żądań, ładunków XML/JSON, parametrów zapytań, identyfikatorów URI i innych lokalizacji w celu przeprowadzania analiz i generowania raportów.
Dostęp do danych Analytics
Po wygenerowaniu w raportach wstępnie zdefiniowanych danych i danych niestandardowych możesz za pomocą narzędzi do wizualizacji interfejsu API Analytics, takich jak Panel informacyjny, raporty niestandardowe i GeoMapa. Więcej informacji o narzędziach do wizualizacji dostępnych w interfejsie API Analytics znajdziesz w artykule Panele informacyjne Analytics. Więcej informacji o raportach niestandardowych znajdziesz w artykule Tworzenie raportów niestandardowych.
Porównaj interfejsy API Monitoring i API Analytics
Programiści interfejsu API używają zarówno monitorowania interfejsu API, jak i API Analytics. Jedną z głównych różnic między nimi 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, dzięki czemu interfejsy API są dostępne i działają zgodnie z oczekiwaniami.
Warunki alertów definiują określony kod stanu (2xx/4xx/5xx), czas oczekiwania oraz progi kodów błędów, które po jego przekroczeniu powodują wyświetlanie alertów wizualnych w interfejsie i wysyłanie powiadomień za pomocą różnych kanałów, takich jak poczta e-mail, Slack, Pagerduty czy webhooki. Alerty możesz skonfigurować na poziomie środowiska, serwera proxy interfejsu API, usługi docelowej lub regionu.
Po uruchomieniu alertu zespół operacyjny może użyć interfejsu API Monitoring, aby zbadać problem i przeanalizować jego przyczynę. Następnie możesz wygenerować raport niestandardowy zawierający wstępnie zdefiniowane informacje o alercie, takie jak:
- Całkowity czas odpowiedzi
- Docelowy czas odpowiedzi
- Błędy serwera proxy
- Błędy związane z celem
- Identyfikator UUID żądania
- wiele innych
Interfejs API Analytics został zaprojektowany do rejestrowania szerokiego zakresu danych do użytku przez kilka zespołów. Na przykład:
- Zespół operacyjny może wykorzystać dane Analytics, aby zidentyfikować okresy dużego lub małego ruchu, a następnie dostosować usługi do zmieniających się potrzeb i zwiększać ich zakres.
- Zespół marketingowy może korzystać z danych Analytics, aby określać wzorce korzystania przez klientów z poszczególnych interfejsów API, aplikacji, klientów lub innych danych.
- Wszystkie zespoły mają dostęp do danych niestandardowych zebranych z żądań, aby śledzić określone informacje, takie jak wartości nagłówków, parametry zapytania czy ładunek żądania.