Självstudie: Övervaka publicerade API:er

Med Azure Monitor kan du visualisera, fråga, dirigera, arkivera och vidta åtgärder för mått eller loggar som kommer från din Azure API Management-tjänst.

I den här guiden får du lära dig att:

Du kan också använda API Management inbyggda analysverktyg för att övervaka användning och prestanda för dina API:er.

Förutsättningar

• Lär dig Azure API Management-terminologin.
• Slutför följande snabbstart: Skapa en Azure API Management instans.
• Slutför även följande självstudie: Importera och publicera ditt första API.

Tillgänglighet

Visa mått för dina API:er

API Management sändar mått varje minut, vilket ger dig insyn i api:ernas tillstånd och hälsa nästan i realtid. Följande är de två mått som används oftast. En lista över alla tillgängliga mått finns i Mått som stöds.

• Kapacitet – hjälper dig att fatta beslut om att uppgradera/nedgradera dina APIM-tjänster. Måttet genereras per minut och återspeglar gatewaykapaciteten vid tidpunkten för rapporten. Måtten sträcker sig från 0 till 100 och beräknas utifrån gatewayens resurser som CPU och minnesanvändning.
• Begäranden – hjälper dig att analysera API-trafik genom dina API Management tjänster. Måttet genereras per minut och rapporterar antalet gateway-begäranden med dimensioner, inklusive svarskoder, plats, värdnamn och fel.

Så här får du åtkomst till mått:

1. I Azure Portal navigerardu till din API Management instans. På sidan Översikt granskar du viktiga mått för dina API:er.

2. Om du vill undersöka mått i detalj väljer du Mått på menyn längst ned på sidan.

   

3. Från listrutan väljer du mått som du är intresserad av. Till exempel begär.

4. Diagrammet visar det totala antalet API-anrop.

5. Diagrammet kan filtreras med hjälp av måttet Begäranden. Välj till exempel Lägg till filter, välj Kategori för svarskod för backend, ange 500 som värde. Nu visar diagrammet antalet begäranden som misslyckades i API-backend.

Konfigurera en aviseringsregel

Du kan få aviseringar baserat på mått och aktivitetsloggar. Azure Monitor kan du konfigurera en avisering så att den gör följande när den utlöses:

• Skicka ett e-postmeddelande
• Anropa en webbhook
• Anropa en Azure Logic App

Så här konfigurerar du en exempelaviseringsregel baserat på ett mått för begäran:

1. I Azure Portal navigerardu till din API Management instans.

2. Välj Aviseringar på menyraden längst ned på sidan.

   

3. Välj + Ny aviseringsregel.

4. I fönstret Skapa aviseringsregel väljer du villkor.

5. I fönstret Konfigurera signallogik:

   1. I Signaltyp väljer du Mått.
   2. I Signalnamn väljer du Begäranden.
   3. I Dela med dimensioner går du till Dimensionsnamn och väljer Kategori för gatewaysvarskod.
   4. I Dimensionsvärden väljer du 4xx för klientfel, till exempel obehöriga eller ogiltiga begäranden.
   5. I Aviseringslogik anger du ett tröskelvärde efter vilket aviseringen ska utlösas och väljer Klar.

   

6. Välj en befintlig åtgärdsgrupp eller skapa en ny. I följande exempel skapas en ny åtgärdsgrupp. Ett e-postmeddelande skickas till admin@contoso.com .

   

7. Ange ett namn och en beskrivning av aviseringsregeln och välj allvarlighetsgrad.

8. Välj Skapa varningsregel.

9. Testa nu aviseringsregeln genom att anropa konferens-API:et utan en API-nyckel. Exempel:

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

   En avisering utlöses baserat på utvärderingsperioden och e-post skickas till admin@contoso.com .

   Aviseringar visas också på sidan Aviseringar för den API Management instansen.

   

Aktivitetsloggar

Aktivitetsloggar ger insikt i de åtgärder som vidtogs för dina API Management-tjänster. Med aktivitetsloggar kan du bestämma ”vad, vem och när” för skrivåtgärder (PUT, POST, DELETE) som ska vidtas för dina API Management-tjänster.

Du kan få åtkomst till aktivitetsloggar i API Management-tjänsten eller få åtkomst till loggar för alla dina Azure-resurser i Azure Monitor.

Så här visar du aktivitetsloggen:

1. I Azure Portal navigerardu till din API Management instans.

2. Välj Aktivitetslogg.

   

3. Välj önskat filtreringsomfång och sedan Tillämpa.

Resursloggar

Resursloggar innehåller omfattande information om åtgärder och fel som är viktiga för granskning samt felsökning. Resursloggar skiljer sig från aktivitetsloggar. Aktivitetsloggen ger insikter om de åtgärder som utfördes på dina Azure-resurser. Resursloggar ger insikter om åtgärder som din resurs har utfört.

Så här konfigurerar du resursloggar:

1. I Azure Portal navigerardu till din API Management instans.

2. Välj Diagnostikinställningar.

   

3. Välj + Lägg till diagnostikinställning.

4. Välj de loggar eller mått som du vill samla in.

   Du kan arkivera resursloggar tillsammans med mått till ett lagringskonto, strömma dem till en händelsehubb eller skicka dem till en Log Analytics-arbetsyta.

Mer information finns i Skapa diagnostikinställningar för att skicka plattformsloggar och mått till olika mål.

Visa diagnostikdata i Azure Monitor

Om du aktiverar insamling av gatewayloggar eller mått på en Log Analytics-arbetsyta kan det ta några minuter innan data visas i Azure Monitor. Så här visar du data:

1. I Azure Portal navigerardu till din API Management instans.

2. Välj Loggar på menyn längst ned på sidan.

   

Kör frågor för att visa data. Flera exempelfrågor tillhandahålls eller kör egna. Följande fråga hämtar till exempel de senaste 24 timmarna data från tabellen GatewayLogs:

ApiManagementGatewayLogs
| where TimeGenerated > ago(1d) 

Mer information om hur du använder resursloggar för API Management finns i:

• Kom igång med Azure Monitor Log Analyticseller prova Log Analytics Demo-miljön.

• Översikt över loggfrågor i Azure Monitor.

Följande JSON anger en exempelpost i GatewayLogs för en lyckad API-begäran. Mer information finns i schemareferensen.

{
    "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"
}

Nästa steg

I den här självstudiekursen lärde du dig att:

Gå vidare till nästa kurs: