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

Pomocí služby Azure Monitor můžete vizualizovat, dotazovat, směrovat, archivovat a provádět akce s metrikami nebo protokoly pocházejícími z vaší služby Azure API Management.

V tomto kurzu se naučíte:

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

K monitorování využití a výkonu vašich rozhraní API můžete použít také integrované analýzy API Management.

Požadavky

Dostupnost

Důležité

Tato funkce je dostupná v úrovních API Management Premium, Standard, Basic a Developer.

Zobrazení metrik vašich rozhraní API

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 podporovaných metrikách.

  • Kapacita – pomáhá při rozhodování o upgradu nebo downgradu služeb APIM. Metrika se generuje každou minutu a odráží kapacitu brány v čase vytvoření sestavy. 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. Vyfiltrujte požadavky podle kódů odpovědí, umístění, názvu hostitele a chyb.

Důležité

Následující metriky byly od května 2019 zastaralé a v srpnu 2023 budou vyřazeny: Celkový počet požadavků brány, úspěšné požadavky brány, neautorizované požadavky brány, neúspěšné požadavky brány, jiné požadavky brány. Migrujte na metriku Požadavky, která poskytuje ekvivalentní funkce.

Screenshot of Metrics in API Management Overview

Přístup k metrikám:

  1. V Azure Portal přejděte k vaší instanci API Management. Na stránce Přehled zkontrolujte klíčové metriky pro vaše rozhraní API.

  2. Pokud chcete podrobně prozkoumat metriky, vyberte v nabídce v dolní části stránky metriky .

    Screenshot of Metrics item in Monitoring menu

  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.

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

Nastavení pravidla upozornění

Výstrahy můžete přijímat na základě metrik a protokolů aktivit. Azure Monitor umožňuje nakonfigurovat výstrahu , která při aktivaci provede následující akce:

  • 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. V Azure Portal přejděte k vaší instanci API Management.

  2. V řádku nabídek v dolní části stránky vyberte Výstrahy .

    Screenshot of Alerts option in Monitoring menu

  3. Vyberte + Nové pravidlo upozornění.

  4. V okně Vytvořit pravidlo upozorněnívyberte podmínku.

  5. V okně Konfigurovat logiku signálu :

    1. V typu signálu vyberte Metriky.
    2. V názvu signálu vyberte Požadavky.
    3. V části Rozdělit podle dimenzí vyberte v názvu dimenzekategorii kódu odpovědi brány.
    4. V hodnotách dimenze vyberte 4xx, pokud se zobrazí chyby klienta, jako jsou neautorizováno nebo neplatné požadavky.
    5. V logice upozornění zadejte prahovou hodnotu , po které se má výstraha aktivovat.
    6. V části Vyhodnoceno na základě zadejte členitost agregace a frekvenci vyhodnocení a pak vyberte Hotovo.

    Screenshot of Configure Signal Logic windows

  6. Vyberte existující skupinu akcí nebo vytvořte novou. V následujícím příkladu se vytvoří nová skupina akcí. E-mail s oznámením se odešle na admin@contoso.comadresu .

    Screenshot of notifications for new action group

  7. Zadejte název a popis pravidla upozornění a vyberte úroveň závažnosti.

  8. Vyberte Vytvořit pravidlo upozornění.

  9. 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 API Management.

    Screenshot of alerts in portal

Protokoly aktivit

Protokoly aktivit poskytují přehled o operacích se službami 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.

Screenshot of activity log in portal

Zobrazení protokolu aktivit:

  1. V Azure Portal přejděte k vaší instanci API Management.

  2. Vyberte protokol aktivit.

    Screenshot of Activity log item in Monitoring menu

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

Protokoly prostředků

Protokoly prostředků poskytují bohaté informace o operacích a chybách, které jsou důležité pro účely auditování a řešení potíží. Protokoly prostředků se liší od protokolů aktivit. Protokol aktivit poskytuje přehled o operacích spuštěných ve vašich prostředcích Azure. Protokoly prostředků poskytují přehled o operacích, které váš prostředek spustil.

Konfigurace protokolů prostředků:

  1. V Azure Portal přejděte k vaší instanci API Management.

  2. Vyberte Nastavení diagnostiky.

    Screenshot of Diagnostic settings item in Monitoring menu

  3. Vyberte + Přidat nastavení diagnostiky.

  4. Vyberte protokoly nebo metriky, které chcete shromáždit.

    Protokoly prostředků můžete archivovat spolu s metrikami do účtu úložiště, streamovat je do centra událostí nebo je odeslat do pracovního prostoru služby Log Analytics.

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ů brány 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. V Azure Portal přejděte k vaší instanci API Management.

  2. V nabídce v dolní části stránky vyberte Protokoly .

    Screenshot of Logs item in Monitoring menu

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

ApiManagementGatewayLogs
| where TimeGenerated > ago(1d) 

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

Následující json označuje ukázkovou položku v GatewayLogs pro úspěšný požadavek rozhraní API. Podrobnosti najdete v referenčních informacích ke schématu.

{
    "Level": 4,
    "isRequestSuccess": true,
    "time": "2020-10-14T17:xx:xx.xx",
    "operationName": "Microsoft.ApiManagement/GatewayLogs",
    "category": "GatewayLogs",
    "durationMs": 152,
    "callerIpAddress": "xx.xx.xxx.xx",
    "correlationId": "3f06647e-xxxx-xxxx-xxxx-530eb9f15261",
    "location": "East US",
    "properties": {
        "method": "GET",
        "url": "https://apim-hello-world.azure-api.net/conference/speakers",
        "backendResponseCode": 200,
        "responseCode": 200,
        "responseSize": 41583,
        "cache": "none",
        "backendTime": 87,
        "requestSize": 526,
        "apiId": "demo-conference-api",
        "operationId": "GetSpeakers",
        "apimSubscriptionId": "master",
        "clientTime": 65,
        "clientProtocol": "HTTP/1.1",
        "backendProtocol": "HTTP/1.1",
        "apiRevision": "1",
        "clientTlsVersion": "1.2",
        "backendMethod": "GET",
        "backendUrl": "https://conferenceapi.azurewebsites.net/speakers"
    },
    "resourceId": "/SUBSCRIPTIONS/<subscription ID>/RESOURCEGROUPS/<resource group>/PROVIDERS/MICROSOFT.APIMANAGEMENT/SERVICE/APIM-HELLO-WORLD"
}

Další kroky

V tomto kurzu jste se naučili:

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

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