Udostępnij za pośrednictwem


Pulpit monitorowania i rejestrowania GraphQL (wersja zapoznawcza)

Notatka

Funkcja pulpitu nawigacyjnego monitorowania i rejestrowania dla Fabric API dla GraphQL jest dostępna w wersji zapoznawczej .

Po wdrożeniu interfejsu API dla języka GraphQL w sieci szkieletowej warto zrozumieć, jak interfejs API jest używany przez klientów i rozwiązywać problemy w przypadku wystąpienia problemów z interfejsem API. Użyj pulpitu monitorowania GraphQL w Fabric, aby wizualizować, monitorować i rozwiązywać problemy z aktywnością żądań API GraphQL. Ta funkcja jest obecnie dostępna w wersji zapoznawczej. W tym artykule wyjaśniono, jak efektywnie włączać monitorowanie i używać składników pulpitu nawigacyjnego.

Warunki wstępne

Uwaga

  • Funkcja monitorowania wiąże się z dodatkowymi opłatami w stosunku do pojemności.
  • Monitorowanie obszaru roboczego jest domyślnie wyłączone.
  • Przechowywanie danych na potrzeby monitorowania aktywności jest ograniczone do 30 dni.

Włączanie monitorowania interfejsu API GraphQL

W tej sekcji przeprowadzimy Cię przez kroki potrzebne do włączenia monitorowania dla interfejsu API GraphQL. Domyślnie ta funkcja jest wyłączona.

  1. Aby włączyć metryk i/lub rejestrowania środowiska dla każdego interfejsu API dla języka GraphQL w dzierżawie, otwórz interfejs API GraphQL, a następnie wybierz ikonę Ustawienia:

    Zrzut ekranu przedstawiający wybieranie interfejsu API dla ustawień języka GraphQL.

  2. W oknie ustawień interfejsu API wybierz opcję Monitorowanie (podgląd) z menu po lewej stronie. Jeśli monitorowanie obszaru roboczego nie zostało jeszcze włączone, zobaczysz notatkę prowadzącą do przejścia do ustawień obszaru roboczego , aby je włączyć.

    Zrzut ekranu przedstawiający wybieranie Monitorowania z ustawień API GraphQL.

  3. Po włączeniu monitorowania obszaru roboczego będą dostępne opcje włączenia tylko Metrics (konsola API), tylko Logging (żądania interfejsu API), lub obu tych opcji jednocześnie. Metryki i dzienniki są zapisywane w oddzielnych tabelach w usłudze Kusto i można włączyć każdą funkcję oddzielnie w zależności od wymagań. Domyślnie obie opcje są wyłączone:

    Zrzut ekranu przedstawiający przełączniki metryk i rejestrowania z ustawienia monitorowania interfejsu API GraphQL.

Notatka

Metryki i dane rejestrowania są wysyłane oddzielnie do bazy danych Kusto skojarzonej z obszarem roboczym i generują dodatkowe koszty. Aby uzyskać więcej informacji na temat kosztów i zużycia, zobacz ogłoszenie dotyczące monitorowania obszaru roboczego .

Działanie żądania interfejsu API

Po włączeniu monitorowania opcja aktywności żądania interfejsu API w górnym pasku narzędziowym z interfejsu API GraphQL staje się aktywna. Wybierz go, aby uzyskać dostęp do szczegółów monitorowania.

Zrzut ekranu karty aktywności żądania API z górnej wstążki.

Aktywność żądania API składa się z dwóch głównych widoków:

  1. Dashboard API (dla metryk): Ta strona wyświetla wszystkie dostępne liczniki i wykresy dla określonego zakresu czasu.
  2. żądania interfejsu API (dla logowania): Ta strona wyświetla żądania interfejsu API w określonym zakresie czasu.

W poniższych sekcjach opisano funkcje każdej opcji.

Metryki (panel API)

Panel zarządzania interfejsem API zawiera przegląd działań API z różnymi metrykami i wizualizacjami. Aby uzyskać dostęp, na stronie aktywności żądania API wybierz zakładkę pulpit nawigacyjny API. Teraz możesz na pierwszy rzut oka wyświetlić następujące parametry dla określonego zakresu czasu:

  • Ogólny indeks kondycji interfejsu API GraphQL, który obejmuje:

    • Żądanie interfejsu API na sekundę
    • Wskaźnik powodzenia
    • Stan kondycji
  • Liczba żądań interfejsu API

  • Opóźnienie

  • Liczba żądań na wykresie słupkowym ilustrująca liczbę sukcesów i błędów

Po umieszczeniu wskaźnika myszy na grafie można wyświetlić szczegółowe informacje dotyczące określonego punktu danych w etykietce narzędzia.

Zrzut ekranu przedstawiający pulpit nawigacyjny interfejsu API.

Kluczowe funkcje metryk :

  • wybór zakresu czasu: możesz wybrać różne zakresy czasu dla danych wyświetlanych na wykresach monitorowania. Należy pamiętać, że ze względu na limity monitorowania obszaru roboczego przechowywanie danych jest dostępne tylko przez 30 dni.

    Zrzut ekranu pulpitu nawigacyjnego API pokazujący opcję zakresu czasu.

  • Żądania API na sekundę: Możesz zobaczyć liczbę żądań API wykonywanych na sekundę w wybranym zakresie czasu.

    Zrzut ekranu przedstawiający pulpit nawigacyjny interfejsu API przedstawiający liczbę żądań interfejsu API na sekundę.

  • współczynnik powodzenia: możesz wyświetlić współczynnik powodzenia, który jest liczbą żądań zakończonych powodzeniem w łącznej liczbie żądań w wybranym zakresie czasu.

    Zrzut ekranu pulpitu nawigacyjnego interfejsu API przedstawiający współczynnik powodzenia.

  • Ogólny indeks kondycji interfejsu API GraphQL oparty na współczynniku powodzenia dla każdego interfejsu API:

    • Zielony: 75 –100% żądań zakończonych powodzeniem (w dobrej kondycji)

    • Żółty: 50–74% żądań kończy się powodzeniem (warto zwrócić uwagę)

    • Czerwony: Poniżej 50% pomyślnych żądań (Niekorzystny)

      Zrzut ekranu pulpitu nawigacyjnego interfejsu API pokazującego indeks kondycji.

  • łączna liczba żądań interfejsu API: możesz wyświetlić łączną liczbę żądań interfejsu API w wybranym zakresie czasu. Zrzut ekranu panelu kontrolnego API pokazujący liczbę żądań API.

  • wykres liniowy opóźnienia: umieszczając wskaźnik myszy na wykresach, możesz zobaczyć opóźnienie i datę dla każdego punktu danych.

    Zrzut ekranu pulpitu nawigacyjnego interfejsu API przedstawiający diagram słupkowy opóźnienia.

  • liczba żądań wykres słupkowy, różnicowanie między żądaniami sukcesu i błędami: umieszczając wskaźnik myszy na wykresach, można zobaczyć datę i liczbę sukcesów i błędów dla każdego punktu danych.

    Zrzut ekranu pulpitu nawigacyjnego interfejsu API z wykresem słupkowym liczby żądań.

Jeśli widzisz nietypowe zachowanie na pulpicie nawigacyjnym, które wymaga uwagi, możesz dokładniej zbadać sytuację, analizując dzienniki. Pozwoli to zidentyfikować potencjalne problemy, dowiedzieć się, które żądania zakończyły się niepowodzeniem i mają wyższe opóźnienie. Następnie możesz przejść do przeglądania szczegółów dziennika, aby rozwiązać problemy. Aby uzyskać dostęp do szczegółów rejestrowania, wybierz kartę żądania interfejsu API na stronie działania żądania interfejsu API.

Rejestrowanie (żądania API)

Strona Żądania interfejsu API zawiera szczegółowe informacje o wszystkich żądaniach interfejsu API, które wystąpiły w określonym przedziale czasu. Aby uzyskać dostęp, wybierz kartę żądania interfejsu API na stronie działania żądania interfejsu API .

zrzut ekranu przedstawiający stronę żądania interfejsu API z listą żądań.

rejestrowania kluczowych funkcji:

  • Wybór zakresu czasu: możesz wybrać różne zakresy czasu dla danych wyświetlanych na liście żądań (godzina/dzień/tydzień/miesiąc). Należy pamiętać, że limit przechowywania wynosi 30 dni.

Zrzut ekranu strony żądań API pokazujący zakres czasu dla listy żądań.

  • Wyświetl listę ostatnich żądań interfejsu API i przeszłych żądań wymienionych przy użyciu identyfikatora żądania.
  • Wyświetl typ operacji (zapytanie lub mutacja).
  • Wyświetl protokół transportu używany przez żądanie (HTTP).
  • Wyświetl czas żądania.
  • Posortuj listę żądań według czasu rosnącego/malejącego.
  • Wyświetl czas trwania żądania.
  • Posortuj listę żądań według rosnącego/malejącego czasu trwania.
  • Wyświetl rozmiar odpowiedzi.
  • Wyświetl stan (powodzenie lub niepowodzenie).
  • Wyświetl szczegóły żądania, w tym konkretne komunikaty odpowiedzi/ostrzeżenia/błędu.
  • Filtruj i wyszukuj określone ciągi lub zdania.
  • Zmień rozmiar kolumn i posortuj kolumny (rosnąco/malejąco) z tabeli raportu.