Ta strona została przetłumaczona przez Cloud Translation API.

Omówienie interfejsu API Analytics

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

W tym artykule przedstawiamy interfejs Edge API Analytics.

Film: obejrzyj krótki film z omówieniem usług Analytics w Edge API.

Ulepszanie interfejsu API za pomocą funkcji analitycznych

Interfejs Edge API Analytics zbiera i oblicza ogromną ilość informacji, które przepływają przez serwery proxy interfejsu API. Możesz wizualizować te dane za pomocą wykresów w interfejsie Edge lub pobrać dane nieprzetworzone na potrzeby analizy offline za pomocą interfejsów API do zarządzania Edge.

Analytics pomaga uzyskać odpowiedzi na pytania w rodzaju:

Jakie są trendy dotyczące ruchu w interfejsie API z upływem czasu?
Które metody interfejsu API są najpopularniejsze?
Kto jest moim najlepszym deweloperem?
Kiedy czas odpowiedzi interfejsu API jest najkrótszy? Najwolniej?
W których regionach notuję najwięcej ruchu przez interfejs API?

Odpowiedzi na tego typu pytania pomogą Ci ulepszać interfejsy API, rozwiązywać problemy i podejmować lepsze decyzje biznesowe związane z programem interfejsów API.

Statystyki interfejsu API pomagają wszystkim w doskonaleniu

Dzięki ciągłemu procesowi zbierania, analizowania i wizualizacji danych usługa Edge API Analytics pomaga zespołowi interfejsów API ulepszać interfejsy API, a programistom aplikacji – ulepszać aplikacje:

Zespół interfejsów API – zespół interfejsów API korzysta z systemów wewnętrznych, aby tworzyć interesujące interfejsy API. Zespół interfejsów API chce wiedzieć, jak radzi sobie program interfejsów API, jak radzi sobie poszczególne interfejsy API oraz jak je ulepszyć.
Deweloperzy aplikacji – udostępniając informacje analityczne deweloperom aplikacji, możesz tworzyć lepsze aplikacje. Ci programiści wprowadzają innowacje w Twoim interfejsie API i tworzą kreatywne aplikacje, które pomagają zwiększać przychody Twojej firmy. Analytics pomaga deweloperom aplikacji sprawdzać, jak ich aplikacje się sprawdzają i jaki mają wpływ na wyniki finansowe Twojej firmy. Deweloperzy aplikacji chcą wiedzieć, jak mogą je ulepszyć.
Zespół ds. operacji – zespół ds. operacji chce poznać wzorce ruchu i przewidzieć, kiedy należy dodać zasoby backendu lub wprowadzić inne kluczowe zmiany.
Właściciel firmy – właściciel firmy chce sprawdzić, czy jego inwestycja w interfejs API się opłaca i gdzie w przyszłości zainwestować w interfejs API.

Jakiego rodzaju dane są gromadzone i analizowane?

Edge API Analytics zbiera i analizuje szeroki zakres danych przepływających przez serwery proxy interfejsu API, np.:

Czas odpowiedzi
Czas oczekiwania na żądanie
Rozmiar żądania
Błędy celu
Nazwa usługi API
Adres e-mail dewelopera
Nazwa aplikacji
wiele innych.

Pełną listę danych zbieranych przez Analytics API znajdziesz w artykule [GA4] Dane, wymiary i filtry Analytics.

Jak zbierać niestandardowe dane analityczne?

Edge domyślnie zbiera wiele danych. Możesz też zbierać dane analityczne dotyczące konkretnych serwerów proxy interfejsu API, aplikacji, usług lub deweloperów. Możesz na przykład zbierać dane analityczne z parametrów zapytania, nagłówków żądań, treści żądań i odpowiedzi lub zmiennych zdefiniowanych w interfejsach API.

Dane niestandardowe zbierasz za pomocą Zasad dotyczących StatisticsCollector. Po wyodrębnieniu danych niestandardowych możesz je analizować za pomocą interfejsu Analytics lub interfejsu API. Pełny przykład zbierania danych z niestandardowej usługi analitycznej znajdziesz w artykule Analiza treści wiadomości interfejsu API za pomocą niestandardowej usługi analitycznej.

Różnice między danymi Analytics a danymi z monitorowania interfejsu API

W tej sekcji opisujemy drobne różnice między danymi zbieranymi przez Edge Analytics a danymi z Monitorowania API. Ponieważ monitorowanie interfejsu API i Analytics korzystają z różnych strumieni 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 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ą się one pojawiać z kodem stanu 200, ale w raportach niestandardowych Monitorowania będą miały kod stanu 504 lub 499.

Kiedy i jak długo są dostępne moje dane analityczne?

Istnieją 2 przedziały czasu, które określają, kiedy i jak długo możesz wyświetlać dane Analytics:

Opóźnienie wyświetlania danych – po wywołaniu serwera proxy interfejsu API może minąć do 10 minut, zanim dane staną się dostępne do wyświetlenia lub wywołania za pomocą interfejsu API.
Przechowywanie danych – czas przechowywania danych Analytics zależy od abonamentu:
- Standardowa: 30 dni
- Enterprise: 3 miesiące
- Enterprise Plus: 14 miesięcy
Więcej informacji znajdziesz w cenniku zarządzania interfejsem API Apigee.

Jak uzyskać dostęp do danych analitycznych?

Interfejs Edge API Analytics udostępnia narzędzia do wizualizacji danych wbudowane w interfejs Edge. Narzędzia te obejmują wstępnie zdefiniowane panele analityczne i raporty niestandardowe, które wyświetlają dane w postaci wykresów i tabel, a także umożliwiają ich szczegółową analizę w różnych wymiarach (np. według serwera proxy interfejsu API, adresu IP lub kodu stanu HTTP).

Dane analityczne możesz też pobierać za pomocą interfejsu Edge Management API. Po pobraniu możesz zaimportować te dane do własnych narzędzi do wizualizacji danych lub systemu analitycznego.

Panele Analytics

Interfejs Edge zawiera zestaw wstępnie zdefiniowanych paneli, za pomocą których możesz wyświetlać dane analityczne. Na przykład na tych obrazach widać panel Skuteczność proxy:

Ten panel zawiera wykresy dotyczące:

Całkowity ruch – łączna liczba żądań interfejsu API otrzymanych przez Edge w środowisku interfejsu API w organizacji.
Sukces ruchu – łączna liczba żądań, które doprowadziły do pomyślnej odpowiedzi. Odpowiedzi z błędem nie są liczone.
Błędy ruchu – łączna liczba wszystkich nieudanych żądań do interfejsu API, czyli żądań, które nie zwracają odpowiedzi. Liczba obejmuje zarówno błędy serwera proxy (po stronie Apigee), jak i błędy Target (usługi backendu).
Średnia liczba żądań na sekundę – średnia liczba żądań do interfejsu API i odpowiedzi na nie na sekundę.

Dodatkowe wstępnie zdefiniowane panele:

Więcej informacji o tych wstępnie zdefiniowanych panelach znajdziesz w artykule Korzystanie z paneli analitycznych.

Raporty niestandardowe

Raporty niestandardowe umożliwiają zawężenie zakresu danych API i wyświetlanie tylko tych, które Cię interesują. Możesz utworzyć raport niestandardowy, korzystając z dowolnych danych analitycznych wbudowanych w Edge lub danych analitycznych niestandardowych zebranych przez zasady zbierania statystyk.

Podczas tworzenia raportu niestandardowego wybierasz dane, które chcesz wyświetlić (dane), grupować je w sensowny sposób (wymiary) i opcjonalnie ograniczać zwracane dane na podstawie ich określonych właściwości (filtrowanie).

Możesz też ustawić typ wykresu wyświetlanego w raporcie niestandardowym jako wykres kolumnowy lub liniowy. Na poniższych obrazach znajdziesz przykłady wykresów transakcji na sekundę pogrupowanych według serwera proxy interfejsu API:

Kolumna – każdy serwer proxy interfejsu API jest reprezentowany przez inną kolumnę:
Linia – każdy serwer proxy interfejsu API jest reprezentowany przez inną linię:

Więcej informacji znajdziesz w artykule [GA4] Tworzenie raportów niestandardowych i zarządzanie nimi.

Interfejs Analytics API

Aby pobrać dane analityczne, użyj interfejsu Edge Management API. Możesz na przykład użyć interfejsu API, aby tworzyć własne narzędzia do wizualizacji, które możesz umieszczać w portalach lub aplikacjach niestandardowych.

Oto przykład wywołania interfejsu API służącego do pobierania danych analitycznych dla serwerów proxy API:

curl  https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

To wywołanie zwraca:

Suma żądań (liczba wiadomości) na pojedynczą usługę API proxy
Przez 24 godziny
Pogrupowane według godziny

Parametr zapytania timeRange określa okres czasu w formie:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

Zwróć uwagę na %20 przed HH:MM. Parametr timeRange wymaga znaku spacji zakodowanego na potrzeby adresu URL przed HH:MM lub znaku +, jak w przypadku: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Więcej informacji znajdziesz w artykule Korzystanie z interfejsów API danych, który zawiera informacje o mierzeniu skuteczności programu interfejsów API.

Eksportowanie danych analitycznych do Google Cloud

Za pomocą interfejsu Edge Management API możesz wyeksportować wszystkie dane analityczne z Edge na cały dzień do własnego repozytorium danych, takiego jak Google Cloud Storage czy BigQuery. Możesz wtedy korzystać z zaawansowanych funkcji zapytań i uczenia maszynowego oferowanych przez Google Cloud BigQuery i TensorFlow, aby przeprowadzać własną analizę danych.

Więcej informacji znajdziesz w artykule Eksportowanie danych z usługi Analytics.

Jeśli uważasz, że deweloperzy aplikacji są Twoimi klientami, musisz im zapewnić dostęp do narzędzi i informacji, które pozwolą im w najlepszy sposób korzystać z Twojego interfejsu API.

Programiści aplikacji nie tylko dbają o jakość swoich aplikacji, ale też są bardzo zainteresowani interfejsami API. Portale deweloperów oparte na Drupalu zawierają opcjonalną stronę Wydajność aplikacji, która ma zapewnić deweloperom dostęp do ważnych danych o ich aplikacjach. Na tej stronie deweloperzy znajdą informacje o tych kwestiach:

Błędy: jakie błędy interfejsu API występują w aplikacji?
Wydajność: czy interfejs API działa obecnie wolno? Które metody interfejsu API są zwykle lub obecnie wolne?
Dostępność: czy interfejs API jest obecnie dostępny, czy niedostępny?
Limit: czy interfejs API ma limit? Jak wygląda sytuacja z limitem w przypadku dewelopera aplikacji?

Więcej informacji:

Drupal 7: wyświetlanie statystyk dotyczących korzystania z aplikacji
Drupal 8: Monitorowanie aplikacji
Zintegrowany portal: niedostępny

Możesz też udostępnić dane analityczne deweloperom, wykonując te czynności:

tworzenie raportów niestandardowych i udostępnianie ich deweloperom aplikacji. Więcej informacji znajdziesz w artykule [GA4] Tworzenie raportów niestandardowych.
Korzystanie z interfejsu Edge Management API do rejestrowania danych przez dłuższy czas, aby udostępniać je deweloperom aplikacji w trybie offline. Więcej informacji znajdziesz w artykule Korzystanie z interfejsów API danych do pomiaru wydajności programu API.

Jak generować pełne dane analityczne?

Co rozumiemy przez pełne dane analityczne? Możesz na przykład utworzyć serwer proxy API, a Edge będzie zbierać dane analityczne o tym serwerze. A jak jest w przypadku danych dewelopera lub aplikacji, która wywołała serwer proxy interfejsu API? Jeśli Edge nie wie, kto wywołał interfejs API, nie może zbierać tych danych.

Aby Edge mógł określić, którzy deweloperzy i które aplikacje deweloperów wywołują Twoje serwery proxy interfejsu API, musisz wykonać kilka czynności. Oto lista tych czynności z linkami do bardziej szczegółowych informacji:

Utwórz co najmniej 1 usługę API, czyli grupę serwerów proxy interfejsu API wraz z planem usług. Zobacz artykuł Zarządzanie usługami interfejsu API.
Rejestrowanie deweloperów aplikacji w Edge. Zobacz Rejestracja deweloperów aplikacji.
Zarejestruj aplikacje i wygeneruj klucze interfejsu API dla programistów. Zobacz Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API.
Dodaj do proxy API zasady zabezpieczeń, które weryfikują klucze API lub tokeny zabezpieczeń. Zapoznaj się z tymi tematami:Polityka weryfikacji klucza API, Polityka OAuth 2 i Polityka weryfikacji tokena JWT.
Jeśli używasz Edge Microgateway, sprawdź, czy wtyczka analityczna jest włączona (domyślnie jest włączona). Jeśli wtyczka analityczna jest wyłączona, Edge Microgateway nie będzie wysyłać danych analitycznych do usługi Edge Analytics.

W tych samouczkach znajdziesz instrukcje, które pomogą Ci wykonać niezbędne czynności, aby wyświetlać dane analityczne o deweloperach i aplikacjach: Zabezpieczanie interfejsu API przez wymaganie kluczy API oraz Zabezpieczanie interfejsu API za pomocą protokołu OAuth.

Porównywanie funkcji Analytics API z Monitorowaniem interfejsu API

Możesz korzystać zarówno z monitorowania interfejsu API w usłudze Edge, jak i z analityki interfejsu API. Monitorowanie interfejsu API analizuje dane analityczne, aby dostarczać w czasie rzeczywistym kontekstowe statystyki dotyczące wydajności interfejsu API. Dzięki temu możesz szybko diagnozować problemy i podejmować działania naprawcze w celu zapewnienia ciągłości działania firmy. Monitorowanie interfejsu API służy do szybkiego znajdowania problemów w interfejsach API i backendach. Interfejs Analytics API został zaprojektowany tak, aby rejestrować szeroki zakres danych analitycznych, z których mogą korzystać różne zespoły. Jednak dane te są zwykle używane do analizy w sytuacjach innych niż w czasie rzeczywistym.

Jedną z głównych różnic między monitorowaniem interfejsu API a statystykami interfejsu API jest mechanizm alertów wbudowany w monitorowaniu interfejsu API. W przypadku alertów możesz określić kod stanu HTTP (2xx/4xx/5xx), opóźnienie lub kod błędu, którego przekroczenie powoduje wysłanie powiadomienia o alertach do zespołu operacyjnego. Powiadomienia o alertach mogą być wysyłane przez różne kanały, takie jak e-mail, Slack, pagery czy webhooki, co pozwala na natychmiastowe reagowanie na problemy.

Więcej informacji o porównaniu tych usług znajdziesz w artykule Porównanie funkcji Monitorowanie interfejsu API z Edge API Analytics.