Tworzenie raportów niestandardowych i zarządzanie nimi

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Raporty niestandardowe umożliwiają zgłębianie konkretnych danych interfejsu API i wyświetlanie dokładnych danych, które chcesz zobaczyć. Możesz utworzyć raport niestandardowy, używając dowolnych metrics i wymiaru wbudowanych w Edge. Dodatkowo możesz dołączyć zasadę StatisticsCollector do serwerów proxy interfejsu API, aby zbierać niestandardowe wskaźniki, takie jak identyfikator użytkownika lub produktu, cena, działanie REST, wersja docelowa, docelowy adres URL i długość wiadomości.

Filmy

Aby dowiedzieć się więcej o raportach niestandardowych, obejrzyj poniższe filmy.

Wideo	Opis
Tworzenie raportów niestandardowych za pomocą interfejsu użytkownika	Dowiedz się, jak tworzyć raporty niestandardowe w interfejsie Edge.
Raporty niestandardowe – omówienie	Zobacz, jak korzystać z raportów niestandardowych.
Śledzenie czasu oczekiwania interfejsu API	Zobacz, jak śledzić opóźnienia interfejsu API za pomocą raportów niestandardowych.
Śledzenie błędów interfejsu API	Śledź odpowiedzi na błędy interfejsu API za pomocą raportów niestandardowych.

Niestandardowe raporty – informacje

Tworząc raport niestandardowy, możesz wybrać dane, które chcesz widzieć (dane), pogrupować je w zrozumiały sposób (wymiary) i opcjonalnie ograniczyć zwracane dane na podstawie określonych cech (filtrów) danych.

Możesz też określić typ wykresu wyświetlanego w raporcie niestandardowym w postaci wykresu kolumnowego lub liniowego. Na tych obrazach widać przykłady wykresów z danymi o transakcjach na sekundę pogrupowane według wymiaru serwera proxy interfejsu API:

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

  

• Wiersz – każdy interfejs API jest reprezentowany przez inny wiersz:

  

Ustawianie danych i wymiarów

metrics wybrane do raportu niestandardowego określają, jakie informacje chcesz zmierzyć. Typowe wskaźniki:

• Transakcje na sekundę
• Czas odpowiedzi
• Błędy związane z naruszeniem zasad

Niektóre dane pozwalają skonfigurować funkcję agregacji, która będzie działać według danych. Możesz na przykład użyć tych funkcji agregacji z wskaźnikiem czasu odpowiedzi:

• avg: zwraca średni czas odpowiedzi.
• min: zwraca minimalny czas odpowiedzi.
• max: zwraca maksymalny czas odpowiedzi.
• sum: zwraca sumę łącznego czasu odpowiedzi.

Nie wszystkie wskaźniki obsługują wszystkie funkcje agregacji. Dokumentacja metrics zawiera tabelę, która określa nazwę danych i funkcję (sum, avg, min, max) obsługiwane przez ten rodzaj danych.

Wymiar określa sposób grupowania danych. Załóżmy np., że chcesz utworzyć raport niestandardowy zawierający dane o czasie odpowiedzi. Za pomocą wymiarów możesz pogrupować dane wskaźników według usługi API, serwera proxy interfejsu API lub adresu e-mail dewelopera, aby uzyskać:

• czas odpowiedzi dla poszczególnych usług interfejsu API,
• czas odpowiedzi na serwer proxy interfejsu API,
• Czas odpowiedzi na adres e-mail dewelopera

Sposób wyświetlania wymiaru na wykresie raportu niestandardowego zależy od typu wykresu:

• Kolumna: każda kolumna odpowiada innej wartości wymiaru.
• Linia: każda linia na wykresie odpowiada innej wartości wymiaru, a oś X przedstawia czas.

Tworzenie niestandardowych danych i wymiarów

Dodaj zasadę StatisticsCollector do serwerów proxy interfejsu API, aby zbierać niestandardowe dane analityczne, takie jak identyfikator użytkownika lub produktu, cena, działanie REST, wersja docelowa, docelowy adres URL i długość wiadomości. Dane mogą pochodzić ze zmiennych przepływu wstępnie zdefiniowanych przez Apigee, nagłówków żądań, parametrów zapytań lub zmiennych niestandardowych zdefiniowanych przez Ciebie. Po zebraniu danych możesz utworzyć raport niestandardowy, aby je wyświetlać.

Sposób wyświetlania niestandardowych danych Analytics w raporcie niestandardowym zależy od jego typu:

• W przypadku danych typu ciąg znaków odwołaj się do danych statystycznych jako wymiaru w raporcie niestandardowym.
• W przypadku typów danych liczbowych (liczba całkowita, liczba zmiennoprzecinkowa, długość i liczba zmiennoprzecinkowa) dane statystyczne w raporcie niestandardowym możesz odwoływać się do wymiarów lub danych.

Przykłady zbierania niestandardowych danych Analytics znajdziesz w zasadach dotyczących StatisticsCollector.

Ustawianie filtrów

Filtr umożliwia ograniczanie ilości danych wyświetlanych w raporcie niestandardowym przez określenie określonych cech danych, które mają być zwracane. Możesz na przykład utworzyć filtr, aby wyświetlać wskaźniki tylko dla czasu odpowiedzi dłuższego niż określona wartość lub tylko dla serwera proxy interfejsu API o określonej nazwie.

Filtry korzystają ze składni warunkowej, która umożliwia tworzenie złożonych filtrów za pomocą operatorów takich jak eq, ne, gt, lt i innych.

Przykłady raportów niestandardowych

W najprostszym raporcie niestandardowym wystarczy określić 1 metyka i 1 wymiar. Możesz np. zdefiniować raport niestandardowy z tymi ustawieniami:

• typ = Kolumna
• dane = średnia liczba transakcji na sekundę
• wymiar = serwer proxy API

Raport niestandardowy zawiera wykres kolumnowy z danymi „Średnia liczba transakcji na sekundę” pogrupowanymi według wymiaru serwera proxy interfejsu API:

Dane, które wyświetlają średnie, mają też po prawej stronie wykresu link Pokaż dyspersję, jak widać na wykresie powyżej. Najedź na niego kursorem, aby otworzyć pole rozproszenia. Pole rozproszenia pokazuje główne tendencje danych.

Do raportu niestandardowego możesz dodać wiele rodzajów danych. Definiujesz np. raport niestandardowy z dwoma rodzajami danych:

• typ = Kolumna
• dane = średnia liczba transakcji na sekundę
• wskaźnik = Błędy zasad
• wymiar = serwer proxy API

Raport niestandardowy zawiera oddzielny wykres dla każdego rodzaju danych:

Do raportu niestandardowego możesz dodać wiele wymiarów. Definiujesz np. raport niestandardowy z tymi ustawieniami, które obejmują 2 rodzaje danych i 2 wymiary:

• typ = Kolumna
• dane = średnia liczba transakcji na sekundę
• dane = Błędy związane z zasadami
• wymiar = serwer proxy API
• wymiar = Czasownik żądania

Wykres początkowo pokazuje dane pogrupowane według serwera proxy, czyli pierwszego wymiaru określonego podczas tworzenia raportu niestandardowego:

Następnie za pomocą menu Serwer proxy odpowiadającego pierwszemu wymiarowi możesz wybrać jeden serwer proxy. Zaktualizowany wykres przedstawia teraz dane dotyczące wybranego serwera proxy według czasownika żądania:

W miarę dodawania do raportu niestandardowego kolejnych wymiarów interfejs będzie się dostosowywać, aby umożliwić Ci zgłębianie raportu według poszczególnych wymiarów.

Wyświetlanie wszystkich raportów niestandardowych

Otwórz stronę raportów niestandardowych w sposób opisany poniżej.

Na stronie raportów niestandardowych wyświetlane są wszystkie raporty niestandardowe utworzone dla Twojej organizacji, jak pokazano na tej ilustracji:

Jak zaznaczyliśmy na ilustracji, strona raportów niestandardowych umożliwia:

• Wyświetla listę wszystkich raportów niestandardowych.
• Dodaj raport niestandardowy.
• Uruchom raport niestandardowy, klikając jego nazwę na liście. Raport jest domyślnie generowany na podstawie danych zgromadzonych w ciągu ostatniej godziny, a dane są wyświetlane w panelu raportu niestandardowego. Więcej informacji znajdziesz w artykule Korzystanie z panelu raportów niestandardowych.
• Przeszukaj listę raportów niestandardowych, wpisując w polu wyszukiwania cały ciąg znaków lub jego część. Wszystkie wyświetlone pola zostaną wyszukane.
• Usuń raport niestandardowy.

Szczegóły panelu raportów niestandardowych

Panel raportów niestandardowych zawiera wyniki raportu niestandardowego z określonego przedziału czasu, w tym wykres kolumnowy lub liniowy wybranych danych:

Panel raportów niestandardowych umożliwia:

• Wyświetlanie danych z raportów niestandardowych dla wybranego zakresu czasu.
• Wybierz środowisko, dla którego chcesz wyświetlić dane do raportu niestandardowego.
• Wybierz konkretny wymiar, aby przefiltrować dane raportu niestandardowego. Ten obszar jest włączony tylko wtedy, gdy określisz wiele wymiarów w raporcie.

• Wybierz widok Wykres lub Tabela.

• Analizuj dane, klikając ikonę w wierszu tabeli powiązanych danych. Wyświetlaj anomalie i porównuj je z poprzednim okresem lub z innymi wskaźnikami.
• Kliknij i ustaw zakres czasowy, aby wygenerować raport niestandardowy.
• Pobierz raport niestandardowy w pliku CSV. Plik ma taką nazwę: metric.csv. Na przykład: Average_of_total_response_time.csv.
• Edytuj raport niestandardowy.

Poznaj panel analizy wskaźników

Jeśli wybierzesz ikonę w wierszu tabeli podsumowania, wyświetlą się te wykresy (górny wykres tylko wtedy, gdy skonfigurujesz raport tak, aby korzystał z wielu rodzajów danych):

Na wykresach wyświetlane są te informacje:

• Porównaj z: jeśli raport został skonfigurowany tak, aby korzystać z wielu rodzajów danych, porównaj je między sobą.
• Porównaj z poprzednim okresem: wyświetla dane dotyczące poprzedniego okresu. Jeśli np. wybierzesz raport niestandardowy dla ostatnich 24 godzin, ten wykres będzie zawierał dane z poprzednich 24 godzin.

• Analizuj anomalie: wyświetla w raporcie wszystkie odstające punkty danych. Ten wykres przedstawia 2 wartości:

  • Średnia krocząca danych wyświetlana w postaci linii. W przypadku danego punktu na linii wartość średniej kroczącej jest obliczana jako średnia wartości danych w danym momencie oraz wartości danych z 2 poprzednich punktów danych.
  • Niebieski obszar wykresu definiuje średnie maks. i średnie wartości minimalne danych. Średnia wartość maksymalna to 1,2 * (średnia krocząca), a średnia to 0,8 * (średnia ruchoma).

  Jeśli średnia krocząca wykracza poza zakres średniej maksymalnej lub średniej wartości minimalnej, jest uznawana za możliwą anomalię i rysowana jako czerwona kropka na wykresie.

Dodawanie raportu niestandardowego

Po dodaniu raportów niestandardowych możesz utworzyć zestaw wykresów, które będą przedstawiać informacje o każdym aspekcie Twojego programu do obsługi interfejsów API.

Po dodaniu raportu niestandardowego musisz run go synchronicznie lub asynchronicznie.

Aby dodać raport niestandardowy:

1. Otwórz stronę Raporty niestandardowe.
2. Kliknij + Raport niestandardowy.
3. W sekcji Podstawowe wpisz następujące informacje:

   Pole	Opis
   Nazwa raportu	Nazwa raportu.
   Zgłoś opis	Opis raportu.
   Typ wykresu	Wybierz styl wykresu, którego chcesz używać do prezentowania niestandardowych danych analitycznych. Kolumna: oś X przedstawia grupy oznaczone według wymiarów. Linia: oś X przedstawia czas.

4. W sekcji Dane:
   1. Kliknij ikonę obok opcji Wskaźniki.
   2. Wybierz dane, które chcesz przeanalizować.
   3. Wybierz funkcję agregacji, aby wyświetlić wartości sumy, średniej, minimalnej lub maksymalnej wartości.
   4. Kliknij Zapisz.
   5. Kliknij ikonę , aby dodać więcej danych.
5. W sekcji Wymiary kliknij i wybierz wymiar, np. „Serwer proxy”, aby ograniczyć zbiór danych wykorzystywany do generowania raportów. Możesz dodać kolejne wymiary, aby dodatkowo ograniczyć dane.

6. W sekcji Filtry możesz dodatkowo zawęzić wyświetlane dane, dodając filtry do definicji raportu. Możesz np. dodać filtr, który wyklucza dane dotyczące serwera proxy pogody API lub dewelopera anna@example.com.

   1. Kliknij i wybierz nazwę elementu, według którego chcesz filtrować, operator (np. = lub !=) oraz wartość.
   2. Kliknij Dodaj, aby zapisać filtr.
   3. Kliknij , aby dodać więcej filtrów, i wybierz oprogramowanie sprzęgające ORAZ i LUB.

7. Aby ograniczyć dostęp do raportu niestandardowego, edytuj niestandardowe role zdefiniowane na potrzeby raportu.

   1. Kliknij , aby edytować ustawienia roli niestandardowej.
   2. Wybierz rolę niestandardową wymaganą do uzyskania dostępu do raportu i poziom dostępu (wyświetlanie, edytowanie i usuwanie).
   3. Kliknij Dodaj.
   4. Kliknij , aby edytować dodatkowe role.
8. Kliknij Zapisz, aby zapisać raport.

Generowanie raportu niestandardowego

Edge Analytics umożliwia generowanie raportu synchronicznie lub asynchronicznie.

• W przypadku raportu synchronicznego wysyłasz żądanie raportu i jest ono blokowane, dopóki serwer analiz nie odpowie. Jednak ze względu na to, że raport musi przetworzyć dużą ilość danych (na przykład 100 GB), raport synchroniczny może zakończyć się niepowodzeniem z powodu przekroczenia limitu czasu.

  Maksymalny zakres czasowy raportu synchronicznego może wynosić 14 dni. Jeśli wybierzesz zakres czasowy obejmujący co najmniej 15 dni, raport będzie zawsze generowany asynchronicznie.

• W przypadku raportu asynchronicznego uruchamiasz żądanie raportu i pobierasz wyniki później. Oto kilka sytuacji, w których asynchroniczne przetwarzanie zapytań może być dobrym rozwiązaniem:

  • analizowanie i tworzenie raportów, które obejmują długie okresy.
  • analizowanie danych z wykorzystaniem różnych wymiarów grupowania i innych ograniczeń, które zwiększają złożoność zapytania;
  • Zarządzanie zapytaniami, gdy stwierdzisz, że ilość danych znacznie wzrosła w przypadku niektórych użytkowników lub organizacji.

  W tym dokumencie opisujemy, jak wygenerować raport asynchroniczny za pomocą interfejsu użytkownika. Możesz też użyć interfejsu API w sposób opisany w artykule Korzystanie z asynchronicznego interfejsu API niestandardowych raportów.

Aby wygenerować raport niestandardowy dla określonego przedziału czasu:

1. Otwórz stronę Raporty niestandardowe.
2. Wybierz raport do wygenerowania. Domyślnie raport zawiera dane z poprzedniej godziny.

3. Aby wygenerować raport dla innego okresu:

   1. Kliknij obszar zakresu czasu u góry raportu, aby otworzyć wyskakujące okienko Wybór czasu raportu niestandardowego.
   2. Masz do wyboru te opcje:
      • Wstępnie zdefiniowany zakres czasu, np. Ostatnia godzina, Wczoraj lub Ostatnie 7 dni.

      • Zakres niestandardowy, wybierając datę i godzinę w polach Od/Do, lub wybierz daty rozpoczęcia i zakończenia w kalendarzu. Kliknij UTC, aby używać uniwersalnego czasu koordynowanego (UTC).

   3. Aby wygenerować raport, wybierz jedną z tych opcji:

      • Zastosuj, by wygenerować raport synchronicznie. Po utworzeniu raportu wyniki będą wyświetlane w panelu raportów niestandardowych. Jeśli wygenerowanie raportu zajmie więcej niż 60 sekund, zostanie automatycznie przekształcone w raport asynchroniczny.

      • Prześlij zadanie, by wygenerować raport asynchronicznie w ramach zadania w tle. Zostanie wyświetlone następujące okno dialogowe:

        

        Kliknij Wyświetl stan w oknie, aby zobaczyć stan zadania tworzenia raportu niestandardowego.

Wyświetlanie asynchronicznych zadań niestandardowych raportów

Aby wyświetlić asynchroniczne zadania raportu niestandardowego, wybierz jedną z tych opcji:

• Kliknij Wyświetl stan w oknie „Raport przesłany jako zadanie w tle”.
• Na pasku nawigacyjnym po lewej stronie kliknij Analiza > Raporty niestandardowe > Zadania raportów.

Zostanie wyświetlona strona Zadania raportów, tak jak to pokazano na tej ilustracji:

Na stronie Zadania raportów możesz:

• Wyświetl wszystkie wyniki zadań w raporcie niestandardowym dotyczącym asynchronicznego raportu, które zostały przesłane w ciągu ostatnich 7 dni.

• Wybierz środowisko, dla którego chcesz wyświetlać niestandardowe zadania raportowania.

• Aby wyświetlić raport niestandardowy, upewnij się, że jego Stan jest kompletny. Następnie najedź kursorem na wiersz powiązany z raportem. Pojawią się ikony i . Wybierz , aby wyświetlić raport.

• Aby pobrać raport niestandardowy, kliknij .

  Pełny raport jest pobierany jako plik ZIP o nazwie OfflineQueryResult-xxx.zip zawierający pliki CSV.

• Przeszukaj listę raportów niestandardowych, wpisując w polu wyszukiwania cały ciąg znaków lub jego część. W ten sposób wyszukasz ciąg we wszystkich wyświetlanych polach.

Edytowanie raportu niestandardowego

Aby edytować raport niestandardowy:

1. Otwórz stronę Raporty niestandardowe.
2. Najedź kursorem myszy na nazwę raportu, który chcesz edytować. Ikony edycji i usuwania pojawią się w prawej części strony.
3. Kliknij ikonę edycji.
4. Zmodyfikuj szczegóły raportu niestandardowego.
5. Kliknij Zapisz.

Zostaną wyświetlone wyniki raportu niestandardowego.

Usuwanie raportu niestandardowego

Aby usunąć raport niestandardowy:

1. Otwórz stronę Raporty niestandardowe.
2. Najedź kursorem myszy na nazwę raportu, który chcesz edytować. Ikony edycji i usuwania pojawią się w prawej części strony.
3. Aby usunąć raport, kliknij ikonę usuwania.