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

Omówienie interfejsu API Analytics

Przeglądasz 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

Edge API Analytics gromadzi i oblicza masę informacji, które przepływają przez serwery proxy interfejsów API. Dane te można wizualizować za pomocą wykresów w interfejsie Edge lub pobrać nieprzetworzone dane analizy offline za pomocą interfejsów API do zarządzania brzegiem.

Analytics pomaga uzyskać odpowiedzi na pytania w rodzaju:

Jak zmienia się ruch generowany przez interfejs API na przestrzeni czasu?
Które metody interfejsu API są najpopularniejsze?
Kto jest moim najlepszym deweloperem?
Kiedy czas odpowiedzi interfejsu API jest najkrótszy? Najwolniejszy?
W której lokalizacji geograficznej odnotowuję największy ruch generowany przez interfejsy API?

Odpowiedzi na takie pytania pomogą Ci ulepszyć interfejsy API, rozwiązać problemy i ulepszyć decyzji biznesowych związanych z programem API.

Statystyki interfejsu API pomagają wszystkim ulepszać swoje działania

Dzięki ciągłemu procesowi gromadzenia, analizowania i wizualizacji danych Edge API Analytics pomaga zespół ds. API może ulepszać ich interfejsy API i pomaga deweloperom w ulepszaniu aplikacji:

Zespół ds. interfejsów API – zespół ds. API analizuje wewnętrzne systemy, aby tworzyć interesujące interfejsy API. Zespół ds. interfejsów API chce poznać ogólne wyniki programu API, wyniki poszczególnych interfejsów API i ulepszania interfejsów API.
Deweloperzy aplikacji – udostępniając informacje analityczne deweloperom aplikacji, ale i tym lepiej. Ci deweloperzy innowacji w Twoim interfejsie API i tworzą aplikacje dla twórców, które pomagają zwiększać swoje przychody. Analytics pozwala deweloperom aplikacji sprawdzić, jak radzą sobie ich aplikacje i jaka jest ich skuteczność przyczyniają się do poprawy zysków firmy. Deweloperzy aplikacji chcą wiedzieć, jak mogą ulepszyć swoje aplikacje.
Zespół operacyjny – zespół operacyjny chce poznać wzorce ruchu można przewidzieć czas dodania zasobów backendu lub wprowadzenia innych krytycznych zmian.
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 gromadzi i analizuje szeroki zakres danych, które przepływają przez serwery proxy interfejsów API, takie jak:

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 API Analytics znajdziesz w artykule Odniesienie do danych, wymiarów i filtrów Analytics.

Jak mogę zbierać niestandardowe dane analityczne?

Edge domyślnie zbiera wiele danych. Możesz też zbierać niestandardowe dane analityczne do serwerów proxy API, aplikacji, usług lub deweloperów. Możesz np. gromadzić dane analityczne, z parametrów zapytań, nagłówków żądań, treści żądań i odpowiedzi lub zmiennych zdefiniowanych w interfejsach API.

Niestandardowe dane analityczne zbierasz za pomocą zasady InsightsCollector. Po wyodrębnieniu danych niestandardowych możesz je przeanalizować za pomocą interfejsu użytkownika lub interfejsu API Analytics. Przeczytaj artykuł Analizowanie treści wiadomości interfejsu API przy użyciu niestandardowych statystyk. , aby uzyskać pełny przykład zbierania niestandardowych danych analitycznych.

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

W tej sekcji opisano niewielkie różnice między danymi gromadzonymi przez Edge Analytics a monitorowanie interfejsów API. Ponieważ funkcje monitorowania interfejsów API i Analytics korzystają w potokach danych, możesz zauważyć drobne różnice między raportami niestandardowymi generowanymi przez usługę Monitoring a raportami generowanymi przez Analytics. Na przykład możesz zobaczyć rozbieżności w raportowanych wynikach związanych z błędami limitu czasu – oba limity czasu backendu (kod stanu HTTP 504 w żądaniu) i limity czasu klienta (kod stanu HTTP 499). Mogą się one wyświetlać w raportach niestandardowych Analytics z kodem stanu 200. ale będą miały kod stanu 504 lub 499 w raportach niestandardowych usługi Monitoring.

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

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

Okres opóźnienia danych – po wywołaniu serwera proxy interfejsu API może minąć do 10 minut na udostępnienie danych do wyświetlania lub przez wywołania interfejsu API do zarządzania.
Przechowywanie danych – czas przechowywania danych analitycznych w Edge różni się w zależności od abonamentu. W zależności od abonamentu dane analityczne mogą być dostępne za ostatnie 30, 60, 90 lub 365 dni.

Jak mogę uzyskać dostęp do danych analitycznych?

Interfejs Edge API Analytics zawiera narzędzia do wizualizacji danych wbudowane w interfejs Edge. Narzędzia te to: wstępnie zdefiniowane panele analityczne i raporty niestandardowe, które wyświetlają dane w postaci wykresów oraz umożliwiają przejść do bardziej szczegółowego widoku, aby zobaczyć dane pogrupowane według różnych wymiarów (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łasnego narzędzia do wizualizacji danych lub do systemu analitycznego.

Panele statystyk

Interfejs Edge oferuje zestaw wstępnie zdefiniowanych paneli, których możesz używać do wyświetlania danych analitycznych. Na przykład na tych obrazach widać panel Skuteczność proxy:

Ten panel zawiera wykresy:

Łączny ruch – łączna liczba żądań do interfejsu API otrzymanych przez Edge z środowiska API w organizacji.
Trafikowanie – łączna liczba żądań, które zakończyły się pomyślną odpowiedzią. Odpowiedzi na błędy nie są wliczane.
Błędy ruchu – łączna liczba wszystkich nieudanych żądań do interfejsu API; co oznacza, że żądanie nie odpowiada. Liczba ta obejmuje oba błędy serwera proxy (po stronie Apigee). i Błędy celów (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ą analizowanie konkretnych danych interfejsu API i wyświetlanie konkretnych informacji, które chcesz widzieć. Możesz utworzyć raport niestandardowy, korzystając z dowolnych danych analitycznych wbudowanych w Edge lub niestandardowych. dane zbierane przez InsightsCollector.

Tworząc raport niestandardowy, wybierasz dane, które chcesz wyświetlać (dane), a potem grupujesz je (wymiary) i opcjonalnie ograniczyć zwracane dane na podstawie określonych cech danych (filtrowania).

Możesz też określić typ wykresu wyświetlanego w raporcie niestandardowym w postaci wykresu kolumnowego lub liniowego. Poniższe obrazy przedstawiają przykładowe wykresy dotyczące transakcji na sekundę pogrupowanych według serwera proxy interfejsu API:

Kolumna – każdy serwer proxy interfejsu API jest reprezentowany przez inną kolumnę:
Wiersz – każdy serwer proxy interfejsu API jest reprezentowany przez inny wiersz:

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

Interfejs Analytics API

Pobieraj dane analityczne za pomocą interfejsu Edge Management API. Za pomocą interfejsu API można na przykład tworzyć własne narzędzia do wizualizacji, które możesz umieszczać w portalach lub aplikacjach niestandardowych.

Oto przykładowe wywołanie interfejsu API, które pobiera dane analityczne na potrzeby serwerów proxy interfejsu 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 połączenie zwraca:

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

Parametr zapytania timeRange określa przedział czasu w formularzu:

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

Zwróć uwagę na %20 przed HH:MM. Parametr timeRange wymaga: spacja zakodowana w adresie URL przed HH:MM lub znak +, na przykład: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM

Więcej informacji można znaleźć w sekcji Użycie interfejsów API wskaźników do pomiaru skuteczności programu API.

Eksportowanie danych analitycznych do Google Cloud

Za pomocą interfejsu Edge Management API możesz eksportować z Edge wszystkie dane analityczne z całego dnia do własnego repozytorium danych, takiego jak Google Cloud Storage lub BigQuery. Pozwoli Ci to korzystać z zaawansowanych możliwości tworzenia zapytań i systemów uczących się, które są oferowane w ramach Google Cloud BigQuery i TensorFlow, aby przeprowadzać własne analizy danych.

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

Myśląc o deweloperach aplikacji jako o swoich klientach, warto zadbać o to, by mieli oni dostęp do narzędzi, i dostępnych informacji, aby jak najlepiej wykorzystać możliwości interfejsu API.

Deweloperzy aplikacji nie tylko dbają o jakość swoich aplikacji, ale też są bardzo zainteresowani interfejsami API. portale dla deweloperów oparte na Drupal zawiera opcjonalną stronę Wydajność aplikacji, która daje deweloperom aplikacji dostęp do ważne dane dotyczące aplikacji. Na tej stronie znajdziesz informacje dla deweloperów:

Błędy: jakie błędy interfejsu API napotyka moja aplikacja?
Wydajność: czy interfejs API działa obecnie wolno? Które metody interfejsu API są zwykle lub obecnie wolne?
Dostępność: czy interfejs API działa obecnie czy nie?
Limit: czy Twój interfejs API ma limit? Jak jako deweloper aplikacji wypadam na tle innych?

Więcej informacji:

Drupal 7: wyświetlanie statystyk użytkowania aplikacji
Drupal 8: monitorowanie aplikacji
Zintegrowany portal: niedostępny

Ponadto możesz udostępniać statystyki swoim programistom przez:

Tworzenie raportów niestandardowych i udostępnianie ich deweloperom aplikacji. Aby dowiedzieć się więcej, Więcej informacji: Tworzenie raportów niestandardowych.
Używanie interfejsu Edge Management API do rejestrowania danych z dłuższego okresu w celu ich udostępnienia aplikacji 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 kompleksową analitykę? Możesz na przykład utworzyć serwer proxy interfejsu API, a Edge będzie zbierać dane analityczne o tym serwerze proxy. Co jednak z danymi dewelopera lub aplikacji, która wywołała serwer proxy 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 wywołują Twoje proxy API, musisz wykonać kilka czynności. Oto lista tych czynności wraz z linkami do bardziej szczegółowych informacji:

Utwórz co najmniej jedną usługę API, która będzie grupą serwerów proxy interfejsów API, razem z abonament. Zobacz Zarządzanie usługami interfejsu API.
Zarejestruj deweloperów aplikacji w Edge. Zobacz Rejestrowanie deweloperów aplikacji
Zarejestruj aplikacje i wygeneruj klucze interfejsu API dla programistów. Zobacz Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API
Dodaj zasady zabezpieczeń do serwerów proxy API, które weryfikują klucze API lub tokeny zabezpieczeń. Zapoznaj się z tymi artykułami:Sprawdzanie zasad klucza interfejsu API, Zasady protokołu OAuthV2 i Weryfikowanie zasad JWT.
Jeśli korzystasz z Edge Microgateway, sprawdź, czy wtyczka Analytics jest włączona (która jest domyślnie włączona). Jeśli wtyczka analityczna jest wyłączona, Edge Microgateway nie będzie wysyłać danych analitycznych do analityki Edge.

W tych samouczkach znajdziesz instrukcje, jak to zrobić, aby uzyskać dostęp do statystyk dla deweloperów i aplikacji: zabezpieczanie interfejsu API przez wymaganie kluczy API. i Zabezpiecz interfejs API za pomocą protokołu OAuth.

Porównywanie funkcji Statystyki interfejsu API i Monitorowanie interfejsu API

Możesz korzystać zarówno z monitorowania interfejsów API Edge, i API Analytics. Monitorowanie API analizuje dane analityczne, by w czasie rzeczywistym wyświetlać kontekstowe obserwacje wydajność interfejsu API, dzięki czemu możesz szybko diagnozować problemy i ułatwić ich działania, aby zachować ciągłość działania; Monitorowanie interfejsów API zaprojektowano z myślą o szybkim znajdowaniu miejsc, w których występują problemy, 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. Dane te są zwykle wykorzystywane do analizy w sytuacjach innych niż w czasie rzeczywistym.

Jedną z głównych różnic między API Monitoring a API Analytics jest stworzony mechanizm tworzenia alertów w API Monitoring. Alerty określają kod stanu HTTP (2xx/4xx/5xx), czas oczekiwania lub kod błędu próg procentowy, po przekroczeniu którego Twój zespół operacyjny otrzymuje powiadomienie o alercie. Powiadomienia o alertach mogą mogą być wysyłane za pomocą różnych kanałów, takich jak e-mail, Slack, pagery czy webhooki, aby umożliwić Ci odpowiadanie. natychmiast je zgłaszać.

Zobacz Porównanie API Monitoring i Edge API Analytics aby uzyskać bardziej szczegółowe porównanie tych usług.