Zdieľať cez


Tabuľa monitorovania a zapisovanie do denníka v jazyku GraphQL (ukážka)

Nota

Funkcia monitorovania tabule a zapisovania do denníka pre rozhranie API služby Fabric pre GraphQL je ukážky.

Po nasadení rozhrania API pre GraphQL v službe Fabric môžete chcieť pochopiť, ako rozhranie API používajú klienti, a riešiť problémy s chybami v prípade, že sa vyskytnú problémy s rozhraním API. Použite tabuľu na monitorovanie služby Fabric GraphQL na vizualizáciu, monitorovanie a riešenie problémov s aktivitami požiadavky rozhrania GraphQL API. Táto funkcia je momentálne vo verzii Preview. Tento článok vysvetľuje, ako efektívne monitorovať a používať súčasti tabule.

Predpoklady

Nota

  • K funkcii monitorovania sa účtujú dodatočné poplatky oproti vašej kapacite.
  • Monitorovanie pracovného priestoru je predvolene zakázané.
  • Uchovávanie údajov na monitorovanie aktivity je obmedzené na 30 dní.

Povolenie monitorovania rozhrania GraphQL API

V tejto časti si prejdeme kroky potrebné na povolenie monitorovania rozhrania API pre GraphQL. Táto funkcia je predvolene vypnutá.

  1. Ak chcete povoliť metriky a/alebo zapisovanie do denníka prostredia pre každé rozhranie API pre GraphQL vo svojom nájomníkovi, otvorte rozhranie GraphQL API a potom vyberte ikonu Nastavenia:

    Snímka obrazovky znázorňujúca výber rozhrania API pre nastavenia GraphQL.

  2. V okne Nastavenia rozhrania API vyberte v ľavej ponuke možnosť Monitorovanie (ukážka). Ak monitorovanie pracovného priestoru ešte nie je povolené, zobrazí sa poznámka, ktorá vás nasmeruje k prechodu na nastavenia pracovného priestoru, ju povolíte.

    Snímka obrazovky znázorňujúca výber položky Monitorovanie z rozhrania API pre nastavenia GraphQL.

  3. Po povolení monitorovania pracovného priestoru sa zobrazia možnosti povoliť metriky len (tabuľa rozhrania API), Zapisovanie do denníka iba (požiadavky rozhrania API) alebo oboje. Metriky a denníky sa ukladajú do samostatných tabuliek v kusto a každú funkciu môžete povoliť samostatne v závislosti od vašej požiadavky. Obe možnosti sú predvolene vypnuté:

    Snímka obrazovky s prepínačmi metrík a zapisovania do denníka z nastavenia Monitorovanie rozhrania API pre GraphQL.

Nota

Metriky a zapisovanie údajov do denníka sa odošlú samostatne do databázy Kusto súvisiacej s pracovným priestorom a vzniknú z nej dodatočné náklady. Ďalšie informácie o nákladoch a spotrebe nájdete v téme Oznámenie o monitorovaní pracovného priestoru.

Aktivita požiadavky rozhrania API

Po povolení monitorovania aktivita požiadavky rozhrania API na hornom páse s nástrojmi z rozhrania GraphQL API sa aktivuje. Vyberte ho a prejdite na podrobnosti monitorovania.

Snímka obrazovky zobrazujúca kartu aktivity požiadavky rozhrania API na hornom páse s nástrojmi.

Aktivita požiadavky rozhrania API sa skladá z dvoch primárnych zobrazení:

  1. tabuľa rozhrania API (pre metriky): na tejto stránke sa zobrazujú všetky počítadlá a grafy pre zadaný časový rozsah.
  2. požiadavky rozhrania API (na zapisovanie do denníka): Táto stránka uvádza požiadavky rozhrania API v zadanom časovom rozsahu.

V nasledujúcich častiach popíšeme funkčnosť jednotlivých možností.

Metriky (tabuľa rozhrania API)

Tabuľa rozhrania API poskytuje prehľad o aktivite rozhrania API s rôznymi metrikami a vizuálmi. Ak chcete získať prístup, na stránke aktivity požiadavky rozhrania API vyberte položku tabuľu rozhrania API. Teraz môžete na prvý pohľad zobraziť nasledujúce parametre pre konkrétny časový rozsah:

  • Celkový index GraphQL API Health, ktorý zahŕňa:

    • Požiadavka rozhrania API/s
    • Úspešnosť
    • Stav stavu
  • Počet požiadaviek rozhrania API

  • Latencia

  • Počet požiadaviek v pruhovom grafe znázorňujúci počet úspechov a chýb

Ukázaním na graf môžete zobraziť podrobné informácie o konkrétnom údajovom bode v popise.

snímka obrazovky s tabuľou rozhrania API.

Metriky kľúčové funkcie:

  • výber časového rozsahu: Pre údaje zobrazené v grafoch monitorovania môžete vybrať rôzne časové rozsahy. Z dôvodu obmedzení monitorovania pracovných priestorov je uchovávanie údajov k dispozícii len 30 dní.

    Snímka obrazovky s tabuľou rozhrania API zobrazujúca možnosť časového rozsahu.

  • požiadavka rozhrania API/s: Počet požiadaviek rozhrania API vykonaných každú sekundu môžete zobraziť vo vybratom časovom rozsahu.

    Snímka obrazovky s tabuľou rozhrania API zobrazujúca počet požiadaviek rozhrania API za sekundu.

  • Miera úspešnosti: Môžete zobraziť mieru úspešnosti, ktorá predstavuje počet úspešných žiadostí v rámci celkového počtu žiadostí vo vybratom časovom rozsahu.

    Snímka obrazovky s tabuľou rozhrania API zobrazujúca mieru úspešnosti.

  • Celkový index stavu rozhrania GraphQL API na základe úspešnosti na rozhranie API:

    • Zelená: 75 – 100% žiadostí sú úspešné (zdravé)

    • Žltá: 50 – 74% žiadostí sú úspešné (Vyžaduje sa pozornosť)

    • Červená: Nižšie 50% úspešných žiadostí (Nezdravo)

      Snímka obrazovky s tabuľou rozhrania API zobrazujúca index stavu.

  • Celkový počet žiadostí o rozhranie API: Vo vybratom časovom rozsahu môžete zobraziť celkový počet požiadaviek rozhrania API. Snímka obrazovky s tabuľou rozhrania API zobrazujúca počet požiadaviek rozhrania API.

  • latencie čiarovom grafe: Ukázaním kurzorom myši na grafy by ste mohli zobraziť latenciu a dátum pre každý údajový bod.

    Snímka obrazovky s tabuľou rozhrania API zobrazujúca pruhový graf latencie.

  • Počet požiadaviek pruhovom grafe, ktorý sa rozlišuje medzi žiadosťami o úspech a chybami: Ukázaním na grafy by ste mohli zobraziť dátum, počet úspešných položiek a chýb pre každý údajový bod.

    Snímka obrazovky s tabuľou rozhrania API zobrazujúca pruhový graf s číselnými žiadosťami.

Keď sa na tabuli zobrazí nezvyčajné správanie, ktoré si vyžaduje vašu pozornosť, môžete vykonať ďalšie preskúmanie tým, že preskúmate denníky na identifikáciu potenciálnych problémov a zistíte, ktoré žiadosti zlyhali, majú vyššiu latenciu a začnite skúmať podrobnosti denníka, aby ste mohli riešiť problémy. Ak chcete získať prístup k podrobnostiam zapisovania do denníka, vyberte kartu žiadosti rozhrania API na stránke požiadavky rozhrania rozhrania API.

Zapisovanie do denníka (požiadavky rozhrania API)

Stránka Žiadosti o rozhranie API poskytuje podrobné informácie o všetkých požiadavkách rozhrania API, ktoré sa stali v konkrétnom časovom rámci. Ak chcete získať prístup, na stránke požiadavky rozhrania API vyberte kartu so žiadosťou rozhrania API.

Snímka obrazovky so stránkou požiadavky rozhrania API zobrazujúca zoznam požiadaviek.

zapisovanie kľúčových funkcií do denníka:

  • Výber časového rozsahu: Pre údaje zobrazené v zozname požiadaviek (hodina/deň/týždeň/mesiac) môžete vybrať rôzne časové rozsahy. Všimnite si, že obmedzenie uchovávania údajov 30 dní.

Snímka obrazovky so stránkou požiadavky rozhrania API zobrazujúca časový rozsah zoznamu požiadaviek.

  • Zobrazte si zoznam naposledy použitých požiadaviek rozhrania API a minulých požiadaviek uvedených s identifikáciou Request ID.
  • Pozrite si typ operácie (Query alebo mutácia).
  • Pozrite si protokol prenosu používaný požiadavkou (HTTP).
  • Zobrazenie času žiadosti.
  • Zoraďte zoznam požiadaviek vzostupne alebo zostupne.
  • Zobrazenie trvania žiadosti.
  • Zoraďte zoznam požiadaviek podľa vzostupného alebo zostupného trvania.
  • Zobraziť veľkosť odpovede.
  • Zobraziť stav (úspech alebo zlyhanie).
  • Zobrazenie podrobností požiadavky vrátane konkrétnej odpovede/upozornenia/chybových hlásení.
  • Filtrujte a vyhľadajte konkrétne reťazce alebo vety.
  • Zmeňte veľkosť stĺpcov a zoraďte stĺpce (vzostupne/zostupne) z tabuľky zostáv.