Pulpit monitorowania i rejestrowania GraphQL (wersja zapoznawcza)

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

• Włączono monitorowanie obszaru roboczego . Aby uzyskać więcej informacji, zobacz Omówienie monitorowania obszaru roboczego i wykonaj kroki, aby włączyć monitorowanie obszaru roboczego.
• Przed rozpoczęciem korzystania z funkcji monitorowania i rejestrowania musisz mieć interfejs API dla GraphQL w Fabric. Aby uzyskać więcej informacji, zobacz Tworzenie interfejsu API dla GraphQL w Fabric i dodawanie danych.

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:

   

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ć.

   

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:

   

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.

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.

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.

  

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

  

• 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.

  

• 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)

    

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

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

  

• 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.

  

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 .

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.

• 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.

Powiązana zawartość

• interfejs API usługi Microsoft Fabric dla GraphQL
• Ogłoszenie monitorowania przestrzeni roboczej
• Monitorowanie obszaru roboczego — omówienie
• interfejs API dla języka GraphQL w usłudze Fabric
• interfejs API Fabric dla edytora GraphQL
• interfejs API Fabric dla widoku schematu GraphQL i eksploratora