Řídicí panel a protokolování monitorování GraphQL (Preview)
Poznámka
Funkce monitorování řídicího panelu a protokolování pro rozhraní FABRIC API pro GraphQL je ve verzi Preview.
Po nasazení rozhraní API pro GraphQL v prostředí Fabric možná budete chtít pochopit, jak klienti rozhraní API používají, a řešit chyby v případě, že dojde k nějakým problémům s rozhraním API. Pomocí řídicího panelu monitorování Fabric GraphQL můžete vizualizovat, monitorovat a řešit potíže s aktivitou požadavků rozhraní GraphQL API. Tato funkce je aktuálně ve verzi Preview. Tento článek vysvětluje, jak efektivně povolit monitorování a používat komponenty řídicího panelu.
Požadavky
- Povoleno monitorování pracovního prostoru . Další informace najdete v tématu Přehled monitorování pracovního prostoru a postupujte podle pokynů k povolení monitorování pracovního prostoru.
- Než začnete používat funkce monitorování a protokolování, musíte mít k dispozici rozhraní API pro GraphQL ve Fabric. Další informace naleznete v části Vytvoření API pro GraphQL ve Fabric a přidání dat.
Poznámka
- Funkce monitorování způsobuje dodatečné poplatky proti vaší kapacitě.
- Monitorování pracovního prostoru je ve výchozím nastavení zakázané.
- Uchovávání dat pro monitorování aktivit je omezené na 30 dnů.
Povolení monitorování rozhraní GraphQL API
V této části vás provedeme kroky potřebnými k povolení monitorování rozhraní API pro GraphQL. Ve výchozím nastavení je tato funkce vypnutá.
Pokud chcete povolit metriky nebo protokolování prostředí pro každé rozhraní API pro GraphQL ve vašem tenantovi, otevřete rozhraní GraphQL API a pak vyberte ikonu Nastavení:
V okně nastavení rozhraní API vyberte v nabídce vlevo možnost Monitorování (náhled). Pokud monitorování pracovního prostoru ještě není povolené, uvidíte poznámku s pokyny, abyste přešli na nastavení pracovního prostoru a povolit ho.
Po povolení monitorování pracovního prostoru se zobrazí možnosti povolit pouze metriky (řídicí panel rozhraní API), pouze protokolování (požadavky rozhraní API) nebo obojí. Metriky a protokoly se ukládají do samostatných tabulek v Kusto a jednotlivé funkce můžete povolit samostatně v závislosti na vašem požadavku. Ve výchozím nastavení jsou obě možnosti vypnuté:
Poznámka
Metriky a protokolovací data se odesílají do databáze Kusto přidružené k pracovnímu prostoru a naúčtují se další náklady. Další informace o využití nákladů a spotřeby najdete v oznámení monitorování pracovního prostoru .
Aktivita požadavků rozhraní API
Po povolení monitorování se aktivita požadavku API na horním pásu karet z GraphQL API stane aktivní. Vyberte ho pro přístup k podrobnostem monitorování.
Aktivita požadavků rozhraní API se skládá ze dvou primárních zobrazení:
- řídicí panel API (pro metriky): Tato stránka zobrazuje všechny čítače a grafy pro zadaný časový rozsah.
- požadavky rozhraní API (pro protokolování): Tato stránka uvádí požadavky rozhraní API v zadaném časovém rozsahu.
V následujících částech popisujeme funkce jednotlivých možností.
Metriky (řídicí panel rozhraní API)
Řídicí panel rozhraní API poskytuje přehled aktivit rozhraní API pro vás s různými metrikami a vizuály. Pro přístup, na stránce aktivity žádosti API, vyberte záložku řídicího panelu API. Nyní můžete na první pohled prohlížet následující parametry pro konkrétní časový rozsah:
Celkový index stavu rozhraní GraphQL API, který zahrnuje:
- Požadavek rozhraní API za sekundu
- Úspěšnost
- Zdravotní stav
Počet požadavků rozhraní API
Latence
Počet žádostí v pruhovém grafu znázorňující počet úspěchů a chyb
Když najedete myší na graf, zobrazí se v nástrojovém tipu podrobné informace o konkrétním datovém bodu.
Klíčové funkce metrik :
výběr časového rozsahu: Pro data zobrazená v grafech monitorování můžete vybrat různé časové rozsahy. Mějte na paměti, že vzhledem k limitům monitorování pracovních prostorů je uchovávání dat k dispozici pouze po dobu 30 dnů.
žádosti rozhraní API za sekundu: Počet požadavků rozhraní API provedených každou sekundu ve vybraném časovém rozsahu můžete zobrazit.
Míra úspěšnosti: Můžete zobrazit míru úspěšnosti, což je počet úspěšných požadavků z celkového počtu požadavků ve vybraném časovém rozsahu.
Celkový index zdraví rozhraní GraphQL API na základě úspěšnosti jednotlivých API:
Zelená: 75 -100% požadavků jsou úspěšné (v pořádku)
Žlutá: 50 – 74% požadavků jsou úspěšné (vyžaduje pozornost)
Červená: Pod 50% úspěšných požadavků (není v pořádku)
celkový počet požadavků rozhraní API: Celkový počet požadavků rozhraní API můžete zobrazit ve vybraném časovém rozsahu.
Latence liniový graf: Když umístíte kurzor myši na grafy, uvidíte datum a latenci pro každý datový bod.
Počet požadavků pruhový graf, který se liší mezi žádostmi o úspěch a chybami: Když najedete myší na grafy, uvidíte datum a počet úspěchů a chyb pro každý datový bod.
Když na řídicím panelu uvidíte neobvyklé chování, které vyžaduje vaši pozornost, můžete se podrobněji podívat na protokoly, abyste zjistili potenciální problémy a zjistili, které požadavky selhaly a mají vyšší latenci, a začněte hledat podrobnosti protokolu pro řešení potíží. Pokud chcete získat přístup k podrobnostem protokolování, vyberte kartu požadavků rozhraní API na stránce aktivity požadavků rozhraní API.
Zaznamenávání (požadavky rozhraní API)
Stránka požadavků rozhraní API poskytuje podrobné informace o všech požadavcích rozhraní API, ke kterým došlo v určitém časovém rámci. Pokud chcete získat přístup, vyberte kartu požadavky rozhraní API z stránky aktivita požadavků rozhraní API.
protokolování klíčových funkcí:
- Výběr časového rozsahu: Pro data zobrazená v seznamu žádostí můžete vybrat různé časové rozsahy (hour/day/Week/Month). Všimněte si, že existuje 30denní limit uchovávání informací.
- Zobrazí seznam nedávných požadavků rozhraní API a předchozích požadavků uvedených s ID požadavku.
- Zobrazení typu operace (dotaz nebo mutací)
- Zobrazení přenosového protokolu používaného požadavkem (HTTP).
- Umožňuje zobrazit čas žádosti.
- Seřaďte seznam požadavků vzestupně nebo sestupně.
- Zobrazení doby trvání žádosti
- Seřaďte seznam požadavků podle vzestupného nebo sestupného trvání.
- Zobrazit velikost odpovědi
- Zobrazení stavu (úspěch nebo selhání)
- Prohlédněte si podrobnosti požadavku, včetně konkrétních odpovědí, upozornění nebo chybových zpráv.
- Filtrujte a hledejte konkrétní řetězce nebo věty.
- Změňte velikost sloupců a seřaďte sloupce (vzestupně/sestupně) na tabulce sestavy.
Související obsah
- rozhraní Microsoft Fabric API pro GraphQL
- oznámení monitorování pracovního prostoru
- Přehled monitorování pracovního prostoru
- API pro GraphQL ve Fabric
- Fabric API pro GraphQL editoru
- rozhraní FABRIC API pro zobrazení schématu GraphQL a průzkumníka