GraphQL-bewakingsdashboard en logboekregistratie (preview)

Nadat u een API voor GraphQL in Fabric hebt geïmplementeerd, wilt u misschien begrijpen hoe de API wordt gebruikt door clients en fouten oplossen voor het geval er problemen zijn met de API. Gebruik het bewakingsdashboard van Fabric GraphQL om uw GraphQL API-aanvraagactiviteit te visualiseren, bewaken en problemen op te lossen. Deze functie is momenteel beschikbaar als preview-versie. In dit artikel wordt uitgelegd hoe u bewaking inschakelt en de onderdelen van het dashboard effectief gebruikt.

Voorwaarden

• Bewaking van werkruimte is ingeschakeld. Zie Overzicht van werkruimtebewaking voor meer informatie en volg de stappen om werkruimtebewaking in te schakelen.
• Voordat u de mogelijkheden voor bewaking en logboekregistratie gaat gebruiken, moet u beschikken over een API voor GraphQL in Fabric. Zie Een API maken voor GraphQL in Fabric en gegevens toevoegenvoor meer informatie.

GraphQL API-bewaking inschakelen

In deze sectie wordt u begeleid bij de stappen die nodig zijn voor het inschakelen van bewaking voor uw API voor GraphQL. Deze functie is standaard uitgeschakeld.

1. Als u metrieken en/of logboekregistratie voor elke GraphQL API in uw tenant wilt inschakelen, opent u uw GraphQL API en selecteert u vervolgens het Instellingen-pictogram:

   

2. Selecteer in het venster API-instellingen de optie Bewaking (preview) in het menu aan de linkerkant. Als werkruimtebewaking nog niet is ingeschakeld, ziet u een notitie om naar de werkruimte-instellingen te gaan om deze in te schakelen.

   

3. Nadat u bewaking voor de werkruimte hebt ingeschakeld, ziet u de opties om metrische gegevens alleen in te schakelen (API-dashboard), logboekregistratie alleen (API-aanvragen) of beide. De metrische gegevens en logboeken worden opgeslagen in afzonderlijke tabellen in Kusto en u kunt elke functie afzonderlijk inschakelen, afhankelijk van uw behoeften. Standaard zijn beide opties uitgeschakeld:

   

API-aanvraagactiviteit

Zodra bewaking is ingeschakeld, wordt de API-aanvraagactiviteit optie in het bovenste lint van de GraphQL-API actief. Selecteer deze om toegang te krijgen tot bewakingsgegevens.

De API-aanvraagactiviteit bestaat uit twee primaire weergaven:

1. API-dashboard (voor metrische gegevens): op deze pagina worden alle tellers en grafieken voor het opgegeven tijdsbereik weergegeven.
2. API-aanvragen (voor logboekregistratie): op deze pagina worden API-aanvragen binnen het opgegeven tijdsbereik vermeld.

In de volgende secties beschrijven we de functionaliteit van elke optie.

Metrische gegevens (API-dashboard)

Het API-dashboard biedt een overzicht van API-activiteiten voor u met verschillende metrische gegevens en visuals. Ga naar de pagina API-aanvraagactiviteit en selecteer het tabblad API-dashboard. U kunt nu in één oogopslag de volgende parameters voor een bepaalde tijdsperiode bekijken:

• Algemene GraphQL API Health-index met:

  • API-aanvraag per seconde
  • Slagingspercentage
  • Gezondheidsstatus

• Aantal API-aanvragen

• Wachttijd

• Aantal aanvragen in een staafdiagram dat het aantal successen en fouten illustreert

Door met de muis over de grafiek te bewegen, kunt u in een tooltip de gedetailleerde informatie voor een specifiek gegevenspunt zien.

Belangrijke functies voor metrische gegevens :

• tijdsbereikselectie: u kunt verschillende tijdsbereiken selecteren voor de gegevens die worden weergegeven in de bewakingsgrafieken. Houd er rekening mee dat vanwege de monitoring van werkruimte de beperkingen, de gegevensretentie slechts beschikbaar is voor 30 dagen.

  

• API-aanvraag per seconde: u kunt het aantal API-aanvragen weergeven dat elke seconde in het geselecteerde tijdsbereik is gedaan.

  

• slagingspercentage: u kunt het slagingspercentage bekijken dat het aantal geslaagde aanvragen is voor het totale aantal aanvragen in het geselecteerde tijdsbereik.

  

• Algemene GraphQL API Health-index op basis van slagingspercentage per API:

  • Groen: 75-100% verzoeken zijn succesvol (gezond)

  • Geel: 50 - 74% van de aanvragen zijn succesvol (Heeft aandacht nodig)

  • Rood: Minder dan 50% geslaagde aanvragen (ongezond)

    

• totaal aantal API-aanvragen: u kunt het totale aantal API-aanvragen in het geselecteerde tijdsbereik bekijken.

• latentie lijndiagram: door de muisaanwijzer op grafieken te houden, kunt u de latentie en datum voor elk gegevenspunt zien.

  

• aantal aanvragen staafdiagram, waarbij onderscheid wordt gemaakt tussen geslaagde aanvragen en fouten: door de muisaanwijzer over grafieken te bewegen, kunt u de datum en het aantal geslaagde en fouten voor elk gegevenspunt zien.

  

Wanneer u abnormaal gedrag ziet op het dashboard waarvoor uw aandacht is vereist, kunt u verder onderzoeken door logboeken te onderzoeken om potentiële problemen te identificeren en erachter te komen welke aanvragen zijn mislukt en een hogere latentie hebben en te beginnen met het onderzoeken van logboekdetails om problemen op te lossen. Om toegang te krijgen tot logdetails, selecteert u op de pagina API-aanvraagactiviteit het tabblad API-aanvragen.

Logboekregistratie (API-aanvragen)

De pagina API-aanvragen bevat gedetailleerde informatie over alle API-aanvragen die zich in een bepaald tijdsbestek hebben voorgedaan. Als u toegang wilt krijgen, selecteert u het tabblad API-aanvragen op de pagina API-aanvraagactiviteit.

Belangrijke functies voor logboekregistratie:

• Selectie van tijdsbereik: u kunt verschillende tijdsbereiken selecteren voor de gegevens die worden weergegeven in de lijst met aanvragen (uur/dag/week/maand). Houd er rekening mee dat er 30 dagen retentielimiet is.

• Bekijk een lijst met recente API-aanvragen en eerdere aanvragen die worden vermeld met aanvraag-id.
• Bekijk het type bewerking (Query of Mutatie).
• Bekijk het transportprotocol dat wordt gebruikt door de aanvraag (HTTP).
• De tijd van de aanvraag weergeven.
• Sorteer de lijst met aanvragen op aflopende/aflopende tijd.
• De duur van de aanvraag weergeven.
• Sorteer de lijst met aanvragen op aflopende/aflopende duur.
• De antwoordgrootte weergeven.
• Bekijk de status (geslaagd of mislukt).
• Bekijk de details van de aanvraag, inclusief specifieke reacties/waarschuwingen/foutberichten.
• Filteren en zoeken naar specifieke tekenreeksen of zinnen.
• Wijzig het formaat van kolommen en sorteer de kolommen (oplopend/aflopend) uit de rapporttabel.

Verwante inhoud

• Microsoft Fabric-API voor GraphQL-
• aankondiging van werkruimtebewaking
• Overzicht van werkruimtebewaking
• -API voor GraphQL in Fabric
• Fabric-API voor GraphQL Editor
• Fabric-API voor GraphQL-schemaweergave en Explorer-