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

Pomocí Azure Monitor můžete vizualizovat metriky nebo protokoly přicházející ze služby Azure API Management a provádět na nich dotazy, směrovat je, archivovat je a provádět s nimi akce.

V tomto kurzu se naučíte:

Pomocí předdefinovaných analýz API Management taky můžete monitorovat využití a výkon vašich rozhraní API.

Požadavky

• Seznamte se s terminologií služby Azure API Management.
• Dokončete následující rychlý Start: vytvoření instance služby Azure API Management.
• Projděte si také následující kurz: Navíc kurzu: Import a publikování vašeho prvního rozhraní API.

Dostupnost

Zobrazení metrik vašich rozhraní API

API Management generuje metriky každou minutu a poskytuje vám téměř v reálném čase přehled o stavu a stavu vašich rozhraní API. Níže jsou uvedené 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/downgrade služeb APIM Services. 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áhají analyzovat provoz rozhraní API, který prochází přes vaše API Management služby. Metrika je vygenerována za minutu a oznamuje počet požadavků brány s dimenzemi, včetně kódů odpovědí, umístění, názvu hostitele a chyb.

Přístup k metrikám:

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

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

   

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 lze filtrovat pomocí dimenzí metriky požadavků . Vyberte například Přidat filtr, vyberte kategorie kódu odpovědi back-end a jako hodnotu zadejte 500. Graf teď zobrazuje počet požadavků, které se v back-endu rozhraní API nezdařily.

Nastavení pravidla výstrahy

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

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

Postup konfigurace ukázkového pravidla výstrahy na základě metriky požadavku:

1. V Azure Portalpřejděte k instanci API Management.

2. V řádku nabídek poblíž dolního okraje stránky vyberte výstrahy .

   

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

4. V okně vytvořit pravidlo výstrahy Vyberte podmínka.

5. V okně Konfigurovat logiku signálu :

   1. V typ signálu vyberte metriky.
   2. V názvu signálu vyberte požadavky.
   3. V rozdělit podle dimenzí v názvu dimenze vyberte kategorie kódu odpovědi brány.
   4. V hodnotách dimenze vyberte 4xx, v případě chyb klienta, například neoprávněných nebo neplatných požadavků.
   5. V poli logika výstrahy zadejte prahovou hodnotu, po které má být výstraha aktivována, a vyberte možnost Hotovo.

   

6. Vyberte existující skupinu akcí nebo vytvořte novou. V následujícím příkladu je vytvořena nová skupina akcí. Pošle se vám e-mail s oznámením admin@contoso.com .

   

7. Zadejte název a popis pravidla výstrahy a vyberte úroveň závažnosti.

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

9. Nyní otestujte pravidlo výstrahy voláním rozhraní API pro konferenci bez klíče rozhraní API. Například:

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

   Na základě zkušebního období se aktivuje výstraha a pošle se e-mail na adresu admin@contoso.com .

   Výstrahy se také zobrazí na stránce s upozorněními pro instanci API Management.

   

Protokoly aktivit

Protokoly aktivit poskytují přehled o operacích provedených vašimi 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.

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.

Postup zobrazení protokolu aktivit:

1. V Azure Portalpřejděte k instanci API Management.

2. Vyberte Protokol aktivit.

   

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

Protokoly prostředků

Protokoly prostředků poskytují podrobné informace o operacích a chybách, které jsou důležité pro auditování, a také pro účely řešení potíží. Protokoly prostředků se liší od protokolů aktivit. Protokol aktivit nabízí přehled o operacích provedených na vašich prostředcích Azure. Protokoly prostředků poskytují přehled o operacích, které provedl váš prostředek.

Konfigurace protokolů prostředků:

1. V Azure Portalpřejděte k instanci API Management.

2. Vyberte nastavení diagnostiky.

   

3. Vyberte + Přidat nastavení diagnostiky.

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

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

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

Zobrazit diagnostická data v Azure Monitor

Pokud povolíte shromažďování GatewayLogs nebo metrik v pracovním prostoru Log Analytics, může trvat několik minut, než se data zobrazí v Azure Monitor. Zobrazení dat:

1. V Azure Portalpřejděte k instanci API Management.

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

   

Spusťte dotazy pro zobrazení dat. Je k dispozici několik ukázkových dotazů nebo vlastní spuštění. Například následující dotaz načte nejaktuálnější 24 hodin dat z tabulky GatewayLogs:

ApiManagementGatewayLogs
| where TimeGenerated > ago(1d) 

Další informace o použití protokolů prostředků pro API Management najdete v tématech:

• Začněte s Azure Monitor Log Analyticsnebo vyzkoušejte ukázkové prostředí Log Analytics.

• Přehled dotazů protokolu v Azure monitor.

Následující JSON označuje vzorový záznam v GatewayLogs pro úspěšnou žádost o rozhraní API. Podrobnosti najdete v referenčníchinformací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:

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