GraphQL-övervakning: instrumentpanel och loggning (förhandsversion)

När du har distribuerat ett API för GraphQL i Fabric kanske du vill förstå hur API:et används av klienter och felsöka fel om det skulle uppstå problem med API:et. Använd Fabric GraphQL:s övervakningsinstrumentpanel för att visualisera, övervaka och felsöka din GraphQL API-begäransaktivitet. Den här funktionen är för närvarande i förhandsversion. Den här artikeln beskriver hur du aktiverar övervakning och använder instrumentpanelens komponenter effektivt.

Förutsättningar

• Aktiverad arbetsyteövervakning. Mer information finns i Översikt över arbetsyteövervakning och följ stegen för att aktivera övervakning av arbetsytor.
• Innan du börjar använda övervaknings- och loggningsfunktionerna måste du ha ett API för GraphQL i Fabric. Mer information finns i Skapa ett API för GraphQL i Fabric och lägg till data.

Aktivera GraphQL API-övervakning

I det här avsnittet går vi igenom de steg som krävs för att aktivera övervakning för ditt API för GraphQL. Den här funktionen är inaktiverad som standard.

1. För att aktivera mätvärden och/eller loggning för varje API för GraphQL i din klientorganisation, öppna ditt GraphQL-API och välj sedan på ikonen Inställningar:

   

2. I fönstret API-inställningar väljer du alternativet Övervakning (förhandsversion) på den vänstra menyn. Om arbetsyteövervakning inte redan har aktiverats visas en anteckning som vägleder dig att gå till arbetsyteinställningar för att aktivera den.

   

3. När du har aktiverat övervakning för arbetsytan visas alternativen för att aktivera endast Mått (API-instrumentpanel), Loggning endast (API-begäranden) eller båda. Måtten och loggarna sparas i separata tabeller i Kusto och du kan aktivera varje funktion separat beroende på dina behov. Som standard är båda alternativen inaktiverade:

   

API-begärandeaktivitet

När övervakningen är aktiverad blir API-begärandeaktivitetens alternativ i översta verktygsfältet från GraphQL-API:et aktivt. Välj den för att få åtkomst till övervakningsinformation.

Den API-begärandeaktiviteten består av två primära vyer:

1. API-instrumentpanel (för mått): Den här sidan visar alla räknare och diagram för det angivna tidsintervallet.
2. API-begäranden (för loggning): På den här sidan visas API-begäranden inom det angivna tidsintervallet.

I följande avsnitt beskriver vi funktionerna i varje alternativ.

Mått (API-kontrollpanel)

API-instrumentpanelen ger en översikt över API-aktivitet för dig med olika mått och visuella objekt. Om du vill komma åt den API-begärandeaktiviteten väljer du fliken API-instrumentpanel. Nu kan du snabbt se följande parametrar för ett visst tidsintervall:

• Övergripande GraphQL API Health-index som innehåller:

  • API-begäran/sek
  • Framgångsfrekvens
  • Hälsostatus

• Antal API-begäranden

• Latens

• Antal begäranden i stapeldiagram som illustrerar antalet lyckade och fel

Genom att hovra över diagrammet kan du se detaljerad information för en specifik datapunkt i en knappbeskrivning.

Nyckelfunktioner för mätvärden:

• Val av tidsintervall: Du kan välja olika tidsintervall för de data som visas i övervakningsdiagrammet. Observera att på grund av begränsningar för arbetsyteövervakning är datakvarhållningen endast tillgänglig i 30 dagar.

  

• API-begäran/sek: Du kan visa antalet API-begäranden som görs varje sekund i det valda tidsintervallet.

  

• Framgångsfrekvens: Du kan se framgångsfrekvensen, vilket är antalet lyckade begäranden jämfört med det totala antalet förfrågningar i det valda tidsintervallet.

  

• Övergripande GraphQL API-hälsotillstånd baserat på lyckandefrekvens per API:

  • Grön: 75–100% av begäranden lyckas (hälsosam)

  • Gul: 50–74% av begäranden lyckas (behöver uppmärksamhet)

  • Röd: Under 50% lyckade begäranden (Ohälsosam)

    

• Totalt antal API-begäranden: Du kan visa det totala antalet API-begäranden i det valda tidsintervallet.

• Svarstid linjediagram: Genom att hovra musen över grafer kan du se svarstiden och datumet för varje datapunkt.

  

• Antal begäranden stapeldiagram, som skiljer mellan lyckade begäranden och fel: Genom att hovra över grafer kan du se datum och antal lyckade och fel för varje datapunkt.

  

När du ser onormalt beteende på instrumentpanelen som kräver din uppmärksamhet kan du undersöka ytterligare genom att titta på loggar för att identifiera potentiella problem och ta reda på vilka begäranden som misslyckades och har högre svarstid och börja titta på logginformation för att felsöka. Om du vill komma åt loggningsinformation väljer du fliken API-begäranden på sidan för API-anropsaktivitet.

Loggning (API-begäranden)

Sidan API-begäranden innehåller detaljerad information om alla API-begäranden som har inträffat inom en viss tidsram. För att komma åt, välj fliken API-begäranden från sidan API-begärandeaktivitet.

Viktiga loggningsfunktioner:

• Val av tidsintervall: Du kan välja olika tidsintervall för de data som visas i listan med begäranden (timme/dag/vecka/månad). Observera att det finns kvarhållningsgräns på 30 dagar.

• Visa en lista över de senaste API-begärandena och tidigare begäranden som visas med begärande-ID.
• Visa typen av åtgärd (fråga eller mutation).
• Visa transportprotokollet som används av begäran (HTTP).
• Visa tidpunkten för begäran.
• Sortera listan över begäranden efter stigande/fallande tid.
• Visa varaktighet för begäran.
• Sortera listan med begäranden efter stigande/fallande varaktighet.
• Visa svarsstorlek.
• Visa statusen (lyckades eller misslyckades).
• Visa information om begäran, inklusive specifika svar/varningar/felmeddelanden.
• Filtrera och sök efter specifika strängar eller meningar.
• Ändra storlek på kolumner och sortera kolumnerna (stigande/fallande) från rapporttabellen.

Relaterat innehåll

• Microsoft Fabric API för GraphQL
• Meddelande om övervakning av arbetsyta
• översikt över arbetsyteövervakning
• API för GraphQL i Fabric
• Fabric API för GraphQL Editor
• Fabric API för GraphQL Schema View och för Explorer