Kurz: Monitorování publikovaných rozhraní API

  • Článek

PLATÍ PRO: Všechny úrovně služby API Management

Prostřednictvím služby Azure Monitor můžete vizualizovat metriky nebo protokoly pocházející ze služby Azure API Management, zadávat na ně dotazy, směrovat je, archivovat je a provádět s nimi příslušné akce.

V tomto kurzu se naučíte:

  • Zobrazit metriky rozhraní API
  • Nastavení pravidla upozornění
  • Zobrazení protokolů aktivit
  • Povolení a zobrazení protokolů prostředků

Poznámka:

API Management podporuje řadu dalších nástrojů pro sledování rozhraní API, včetně integrovaných analýz a integrace s aplikačními Přehledy. Další informace

Požadavky

Zobrazení metrik vašich rozhraní API

Služba API Management každou minutu generuje metriky a poskytuje téměř v reálném čase přehled o stavu a stavu vašich rozhraní API. Následují dvě nejčastěji používané metriky. Seznam všech dostupných metrik najdete v tématu Podporované metriky.

  • Kapacita – pomáhá při rozhodování o upgradu nebo downgradu služeb API Management. Metrika se vygeneruje za minutu a odráží odhadovanou kapacitu brány v době generování sestav. Její hodnoty se pohybují v rozsahu od 0 do 100 a počítají se na základě prostředků brány, jako je využití procesoru nebo paměti.
  • Požadavky – pomáhá analyzovat provoz rozhraní API procházející službami API Management. Metrika se vygeneruje za minutu a hlásí počet požadavků brány s dimenzemi. Filtrujte požadavky podle kódů odpovědí, umístění, názvu hostitele a chyb.

Důležité

K květnu 2019 byly vyřazeny následující metriky a v srpnu 2023 budou vyřazeny: Celkový počet žádostí o bránu, úspěšné žádosti o bránu, žádosti o neoprávněnou bránu, neúspěšné požadavky brány, další požadavky brány. Migrujte na metriku Požadavky, která poskytuje ekvivalentní funkce.

Snímek obrazovky s metrikami v přehledu služby API Management

Přístup k metrikám:

  1. Na webu Azure Portal přejděte k vaší instanci služby API Management. Na stránce Přehled na kartě Monitorování zkontrolujte klíčové metriky vašich rozhraní API.

  2. Pokud chcete podrobně prozkoumat metriky, vyberte v nabídce vlevo metriky .

    Snímek obrazovky s položkou Metriky v nabídce Monitorování na portálu

  3. V rozevíracím seznamu vyberte metriky, které vás zajímají. Například Požadavky.

  4. Graf zobrazí celkový počet volání rozhraní API. Upravte časový rozsah tak, aby se zaměřoval na období zájmu.

  5. Graf můžete filtrovat pomocí dimenzí metriky Žádosti . Vyberte například Přidat filtr, vyberte Kategorie kódu odpovědi back-endu, zadejte 500 jako hodnotu. Graf zobrazuje počet neúspěšných požadavků v back-endu rozhraní API.

Nastavení pravidla upozornění

Můžete přijímat upozornění na základě metrik a protokolů aktivit. Ve službě Azure Monitor nakonfigurujte pravidlo upozornění, které provede akci při aktivaci. Mezi běžné akce patří:

  • Odeslání e-mailového oznámení
  • Volání webhooku
  • Vyvolání aplikace logiky Azure

Konfigurace ukázkového pravidla upozornění na základě metriky požadavku:

  1. Na webu Azure Portal přejděte k vaší instanci služby API Management.

  2. V nabídce vlevo vyberte Výstrahy .

    Snímek obrazovky s možností Výstrahy v nabídce Monitorování na portálu

  3. Vyberte + Vytvořit>pravidlo upozornění.

  4. V okně Vybrat signál na kartě Podmínka:

    1. V typu signálu vyberte Metriky.
    2. V názvu signálu vyberte Požadavky.
    3. V logice výstrahy zadejte prahovou hodnotu, což je počet výskytů, po kterých se má výstraha aktivovat.
    4. V části Rozdělit podle dimenzí vyberte v názvu dimenze kategorii kódu odpovědi brány.
    5. V hodnotách dimenze vyberte 4xx pro chyby klienta, jako jsou neautorizováno nebo neplatné požadavky. Pokud se hodnota dimenze nezobrazí, vyberte Přidat vlastní hodnotu a zadejte 4xx.
    6. V části Kdy vyhodnotit, přijměte výchozí nastavení nebo vyberte jiná nastavení a nakonfigurujte, jak často se pravidlo spouští. Vyberte Další.

    Snímek obrazovky s konfigurací logiky upozornění na portálu

  5. Na kartě Akce vyberte nebo vytvořte jednu nebo více skupin akcí, které uživatelům oznámí výstrahu a provedení akce. Můžete například vytvořit novou skupinu akcí pro odeslání e-mailu s oznámením .admin@contoso.com Podrobný postup najdete v tématu Vytváření a správa skupin akcí na webu Azure Portal.

    Snímek obrazovky s konfigurací oznámení pro novou skupinu akcí na portálu

  6. Na kartě Podrobnosti v okně Vytvořit pravidlo upozornění zadejte název a popis pravidla upozornění a vyberte úroveň závažnosti.

  7. Volitelně můžete nakonfigurovat zbývající nastavení. Pak na kartě Zkontrolovat a vytvořit vyberte Vytvořit.

  8. Teď otestujte pravidlo upozornění voláním rozhraní API konference bez klíče rozhraní API. Příklad:

    curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1

    Výstraha se aktivuje na základě zkušebního období a odešle e-mail na admin@contoso.comadresu .

    Výstrahy se také zobrazí na stránce Upozornění pro instanci služby API Management.

    Snímek obrazovky s upozorněními na portálu

Protokoly aktivit

Protokoly aktivit poskytují přehled o operacích ve službách API Management. Pomocí protokolů aktivit můžete zjistit obsah, autora a čas veškerých operací zápisu (PUT, POST, DELETE) provedených ve vašich službách API Management.

Poznámka:

Protokoly aktivit nezahrnují operace čtení (GET) ani operace prováděné na webu Azure Portal nebo pomocí původních rozhraní API pro správu.

Protokoly aktivit můžete zobrazit ve své službě API Management nebo k nim můžete získat přístup ze všech svých prostředků Azure prostřednictvím služby Azure Monitor.

Snímek obrazovky s protokolem aktivit na portálu

Zobrazení protokolu aktivit:

  1. Na webu Azure Portal přejděte k vaší instanci služby API Management.

  2. Vyberte protokol aktivit.

    Snímek obrazovky s položkou protokolu aktivit v nabídce Monitorování na portálu

  3. Vyberte požadovaný obor filtrování a pak použijte.

Protokoly prostředků

Protokoly prostředků (protokoly Služby Azure Monitor) poskytují bohaté informace o operacích a chybách služby API Management, které jsou důležité pro účely auditování a řešení potíží. Pokud je tato možnost povolená prostřednictvím nastavení diagnostiky, protokoly shromažďují informace o požadavcích rozhraní API přijatých a zpracovávaných bránou služby API Management.

Poznámka:

Úroveň Consumption nepodporuje kolekci protokolů prostředků.

Konfigurace protokolů prostředků:

  1. Na webu Azure Portal přejděte k vaší instanci služby API Management.

  2. Vyberte Nastavení diagnostiky.

    Snímek obrazovky s položkou Nastavení diagnostiky v nabídce Monitorování na portálu

  3. Vyberte + Přidat nastavení diagnostiky.

  4. Vyberte protokoly nebo metriky, které chcete shromažďovat.

    Máte několik možností, jak odesílat protokoly a metriky. Například archivujte protokoly prostředků spolu s metrikami do účtu úložiště, streamujte je do centra událostí nebo je odešlete do pracovního prostoru služby Log Analytics.

    Tip

    Pokud vyberete pracovní prostor služby Log Analytics, můžete data uložit do tabulky ApiManagementGatewayLogs specifické pro prostředky nebo uložit do obecné tabulky AzureDiagnostics. U protokolů, které ji podporují, doporučujeme jako cíl použít tabulku pro konkrétní prostředek. Další informace

  5. Po nakonfigurování podrobností pro cíl protokolu nebo cíle vyberte Uložit.

Poznámka:

Přidání objektu nastavení diagnostiky může způsobit selhání, pokud je vlastnost MinApiVersion vaší služby API Management nastavená na libovolnou verzi rozhraní API vyšší než 2022-09-01-preview.

Další informace najdete v tématu Vytvoření nastavení diagnostiky pro odesílání protokolů platformy a metrik do různých cílů.

Zobrazení diagnostických dat ve službě Azure Monitor

Pokud povolíte shromažďování protokolů nebo metrik v pracovním prostoru služby Log Analytics, může trvat několik minut, než se data zobrazí ve službě Azure Monitor.

Zobrazení dat:

  1. Na webu Azure Portal přejděte k vaší instanci služby API Management.

  2. V nabídce vlevo vyberte Protokoly .

    Snímek obrazovky s položkou Protokoly v nabídce Monitorování na portálu

  3. Spuštěním dotazů zobrazíte data. K dispozici je několik ukázkových dotazů nebo můžete spustit vlastní. Následující dotaz například načte posledních 24 hodin dat z tabulky ApiManagementGatewayLogs:

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    Snímek obrazovky s dotazováním tabulky ApiManagementGatewayLogs na portálu

Další informace o používání protokolů prostředků pro SLUŽBU API Management najdete tady:

Úprava nastavení protokolování rozhraní API

Když ve výchozím nastavení vytvoříte nastavení diagnostiky pro povolení shromažďování protokolů prostředků, povolí se protokolování pro všechna rozhraní API s výchozím nastavením. Můžete upravit nastavení protokolování pro všechna rozhraní API nebo je přepsat pro jednotlivá rozhraní API. Můžete například upravit vzorkovací frekvenci nebo úroveň podrobností dat nebo zakázat protokolování pro některá rozhraní API.

Podrobnosti o nastavení protokolování najdete v tématu Referenční informace o nastavení protokolování diagnostiky.

Konfigurace nastavení protokolování pro všechna rozhraní API:

  1. V levé nabídce instance služby API Management vyberte rozhraní API>Všechna rozhraní API.
  2. V horním panelu vyberte kartu Nastavení.
  3. Posuňte se dolů do části Diagnostické protokoly a vyberte kartu Azure Monitor .
  4. Zkontrolujte nastavení a v případě potřeby proveďte změny. Zvolte Uložit.

Konfigurace nastavení protokolování pro konkrétní rozhraní API:

  1. V levé nabídce vaší instance služby API Management vyberte rozhraní API a pak název rozhraní API.
  2. V horním panelu vyberte kartu Nastavení.
  3. Posuňte se dolů do části Diagnostické protokoly a vyberte kartu Azure Monitor .
  4. Zkontrolujte nastavení a v případě potřeby proveďte změny. Vyberte Uložit.

Další kroky

V tomto kurzu jste se naučili, jak:

  • Zobrazit metriky rozhraní API
  • Nastavení pravidla upozornění
  • Zobrazení protokolů aktivit
  • Povolení a zobrazení protokolů prostředků

Přejděte k dalšímu kurzu:

Trasování volání