Del via


GraphQL-overvåking av instrumentbord og logging (forhåndsversjon)

Notat

Overvåking av instrumentbord og loggingsfunksjon for Fabric API for GraphQL er i forhåndsversjon.

Når du har distribuert en API for GraphQL i Fabric, kan det være lurt å forstå hvordan API-en brukes av klienter og feilsøke feil i tilfelle det oppstår problemer med API-en. Bruk instrumentbordet for Fabric GraphQL-overvåking til å visualisere, overvåke og feilsøke graphQL API-forespørselsaktiviteten. Denne funksjonen er for øyeblikket i forhåndsversjon. Denne artikkelen forklarer hvordan du aktiverer overvåking og bruker instrumentbordets komponenter effektivt.

Forutsetninger

Notat

  • Overvåkingsfunksjonen pådrar seg ekstra kostnader mot kapasiteten din.
  • Arbeidsområdeovervåking er deaktivert som standard.
  • Dataoppbevaring for aktivitetsovervåking er begrenset til 30 dager.

Aktivere GraphQL API-overvåking

I denne delen veileder vi deg gjennom trinnene som kreves for å aktivere overvåking for API-en for GraphQL. Som standard er denne funksjonen deaktivert.

  1. Hvis du vil aktivere måledata og/eller logging opplevelse for hver API for GraphQL i leieren, åpner du GraphQL-API-en og velger deretter Innstillinger-ikonet:

    Skjermbilde av å velge API for GraphQL-innstillinger.

  2. Velg alternativet Overvåking (forhåndsvisning) fra menyen til venstre i vinduet for API-innstillinger. Hvis overvåking av arbeidsområdet ikke allerede er aktivert, ser du et notat som veileder deg til å gå til innstillinger for arbeidsområde for å aktivere det.

    Skjermbilde av å velge Overvåking fra API-en for GraphQL-innstillinger.

  3. Når du har aktivert overvåking for arbeidsområdet, ser du alternativene for å aktivere bare måledata (API-instrumentbord), logging (API-forespørsler) eller begge deler. Måledataene og loggene lagres i separate tabeller i Kusto, og du kan aktivere hver funksjon separat avhengig av kravet ditt. Begge alternativene er deaktivert som standard:

    Skjermbilde av måledata og loggingsveksler fra overvåkingsinnstillingen for API for GraphQL.

Notat

Måledata og loggingsdata sendes separat til Kusto-databasen som er knyttet til arbeidsområdet, og det medfører ekstra kostnader. Hvis du vil ha mer informasjon om kostnads- og forbruksbruk, kan du se Kunngjøring om overvåking av arbeidsområde.

API-forespørselsaktivitet

Når overvåking er aktivert, blir API-forespørselsaktiviteten alternativet på det øverste båndet fra GraphQL-API-en aktiv. Velg den for å få tilgang til overvåkingsdetaljer.

Skjermbilde av API-forespørselsaktivitetsfanen fra det øverste båndet.

API-forespørselsaktivitet består av to primære visninger:

  1. API-instrumentbord (for måledata): Denne siden viser alle tellere og grafer for det angitte tidsområdet.
  2. API-forespørsler (for logging): Denne siden viser API-forespørsler innenfor det angitte tidsintervallet.

I avsnittene nedenfor beskriver vi funksjonaliteten til hvert alternativ.

Måledata (API-instrumentbord)

API-instrumentbordet gir en oversikt over API-aktivitet for deg med ulike måledata og visualobjekter. Hvis du vil ha tilgang, velger du API-instrumentbord-fanen fra API-forespørselsaktivitet-siden. Nå kan du se følgende parametere for et bestemt tidsintervall:

  • Samlet GraphQL API-tilstandsindeks som inkluderer:

    • API-forespørsel/sek
    • Suksessrate
    • Tilstandsstatus
  • Antall API-forespørsler

  • Ventetid

  • Antall forespørsler i stolpediagram som illustrerer antall vellykkede og feil

Ved å holde pekeren over grafen kan du se detaljert informasjon om et bestemt datapunkt i et verktøytips.

Skjermbilde av API-instrumentbord.

viktige funksjoner for måledata:

  • valg av tidsområde: Du kan velge forskjellige tidsområder for dataene som vises i overvåkingsgrafene. Vær oppmerksom på at på grunn av overvåking av arbeidsområdet grenser, er dataoppbevaring bare tilgjengelig i 30 dager.

    Skjermbilde av API-instrumentbord som viser tidsintervallalternativet.

  • API-forespørsel/sek: Du kan vise antall API-forespørsler som utføres hvert sekund i det valgte tidsområdet.

    Skjermbilde av API-instrumentbord som viser antall API-forespørsler per sekund.

  • Suksessrate: Du kan vise suksessraten som er antall vellykkede forespørsler over totalt antall forespørsler i det valgte tidsintervallet.

    Skjermbilde av API-instrumentbordet som viser suksessraten.

  • Samlet GraphQL API-tilstandsindeks basert på suksessrate per API:

    • Grønn: 75 -100% forespørsler lykkes (sunn)

    • Gul: 50 - 74% forespørsler er vellykket (Trenger oppmerksomhet)

    • Rød: Bellow 50% vellykkede forespørsler (Usunn)

      Skjermbilde av API-instrumentbordet som viser tilstandsindeksen.

  • totalt antall API-forespørsler: Du kan vise totalt antall API-forespørsler i det valgte tidsintervallet. Skjermbilde av API-instrumentbord som viser antall API-forespørsler.

  • ventetid linjediagram: Ved å holde musepekeren over grafer kan du se ventetiden og datoen for hvert datapunkt.

    Skjermbilde av API-instrumentbordet som viser stolpediagrammet for ventetid.

  • antall forespørsler stolpediagram, som skiller mellom vellykkede forespørsler og feil: Ved å holde pekeren over grafer kan du se datoen og antallet vellykkede forsøk og feil for hvert datapunkt.

    Skjermbilde av API-instrumentbordet som viser stolpediagram for nummerforespørsler.

Når du ser unormal virkemåte på instrumentbordet som krever din oppmerksomhet, kan du undersøke nærmere ved å se på logger for å identifisere potensielle problemer og finne ut hvilke forespørsler som mislyktes og ha høyere ventetid og begynne å se på loggdetaljer for å feilsøke. Hvis du vil ha tilgang til loggingsdetaljer, velger du API-forespørsler-fanen fra API-forespørselsaktivitet siden.

Logging (API-forespørsler)

API-forespørsler-siden gir detaljert informasjon om alle API-forespørslene som skjedde i en bestemt tidsramme. Hvis du vil ha tilgang, velger du API-forespørsler fanen fra API-forespørselsaktivitet siden.

Skjermbilde av API-forespørselssiden som viser listen over forespørsler.

Loggingsnøkkelfunksjoner:

  • Tidsområdevalg: Du kan velge forskjellige tidsintervaller for dataene som vises i forespørsleslisten (time/dag/uke/måned). Vær oppmerksom på at det er oppbevaringsgrense på 30 dager.

Skjermbilde av API-forespørselssiden som viser tidsintervallet for listen over forespørsler.

  • Vis en liste over nylige API-forespørsler og tidligere forespørsler som er oppført med forespørsels-ID.
  • Vis typen operasjon (spørring eller mutasjon).
  • Vis transportprotokollen som brukes av forespørselen (HTTP).
  • Vis tidspunktet for forespørselen.
  • Sorter listen over forespørsler etter stigende/synkende tid.
  • Vis varighet for forespørselen.
  • Sorter listen over forespørsler etter stigende/synkende varighet.
  • Vis svarstørrelse.
  • Vis statusen (vellykket eller mislykket).
  • Vis detaljene for forespørselen, inkludert spesifikke svar/advarsel/feilmeldinger.
  • Filtrere og søke etter bestemte strenger eller setninger.
  • Endre størrelse på kolonner og sorter kolonnene (stigende/synkende) fra rapporttabellen.