Övervaka API Management

GÄLLER FÖR: Alla API Management-nivåer

Azure Monitor samlar in och aggregerar mått och loggar från systemet för att övervaka tillgänglighet, prestanda och motståndskraft och meddela dig om problem som påverkar systemet. Du kan använda Azure-portalen, PowerShell, Azure CLI, REST API eller klientbibliotek för att konfigurera och visa övervakningsdata.

Olika mått och loggar är tillgängliga för olika resurstyper. Den här artikeln beskriver de typer av övervakningsdata som du kan samla in för den här tjänsten och hur du analyserar dessa data.

Samla in data med Azure Monitor

Den här tabellen beskriver hur du kan samla in data för att övervaka din tjänst och vad du kan göra med data när de har samlats in:

Listan över alla data som stöds av Azure Monitor finns i:

• Mått som stöds i Azure Monitor
• Resursloggar som stöds i Azure Monitor

Inbyggd övervakning för API Management

Azure API Management har följande inbyggda övervakningsfunktioner.

Hämta API-analys i Azure API Management

Azure API Management tillhandahåller analys för dina API:er så att du kan analysera deras användning och prestanda. Använd analys för övervakning på hög nivå och felsökning av dina API:er. Andra övervakningsfunktioner, inklusive nära realtidsmått och resursloggar för diagnostik och granskning, finns i Självstudie: Övervaka publicerade API:er.

• API Management tillhandahåller analys med hjälp av en Azure Monitor-baserad instrumentpanel. Instrumentpanelen aggregerar data på en Azure Log Analytics-arbetsyta.
• På de klassiska API Management-tjänstnivåerna innehåller din API Management-instans även äldre inbyggda analyser i Azure-portalen, och analysdata kan nås med hjälp av REST-API:t för API Management. Nära liknande data visas i den Azure Monitor-baserade instrumentpanelen och den inbyggda analysen.

Med API-analys analyserar du användningen och prestandan för API:erna i din API Management-instans över flera dimensioner, inklusive:

• Tidslinje
• Geografi
• API:er
• API-åtgärder
• Produkter
• Prenumerationer
• Användare
• Förfrågningar
• Språkmodeller (för API:er för stora språkmodeller)

API-analys tillhandahåller data om begäranden, inklusive misslyckade och obehöriga begäranden. Geografivärden baseras på IP-adressmappning. Det kan uppstå en fördröjning i tillgängligheten för analysdata.

Azure Monitor-baserad instrumentpanel

Om du vill använda den Azure Monitor-baserade instrumentpanelen behöver du en Log Analytics-arbetsyta som datakälla för API Management-gatewayloggar.

Om du behöver konfigurera en är följande korta steg för att skicka gatewayloggar till en Log Analytics-arbetsyta. Mer information finns i Aktivera diagnostikinställning för Azure Monitor-loggar senare i den här artikeln. Den här proceduren är en engångskonfiguration.

1. I Azure Portal navigerar du till din API Management-instans.

2. I den vänstra menyn går du till Övervakning och väljer Diagnostikinställningar>+ Lägg till diagnostikinställning.

3. Ange ett beskrivande namn för diagnostikinställningen.

4. I Loggar väljer du Loggar relaterade till ApiManagement Gateway.

   Tips/Råd

   Om du vill samla in loggar för API:er för stor språkmodell (LLM) för visning på den Azure Monitor-baserade instrumentpanelen väljer du även Loggar relaterade till generativ AI-gateway.

5. I Målinformation väljer du Skicka till Log Analytics och väljer en Log Analytics-arbetsyta i samma eller en annan prenumeration. Om du behöver skapa en arbetsyta kan du läsa Skapa en Log Analytics-arbetsyta.

6. Kontrollera att Resursspecifik är vald som måltabell.

7. Välj Spara.

Få åtkomst till instrumentpanelen

När en Log Analytics-arbetsyta har konfigurerats kommer du åt den Azure Monitor-baserade instrumentpanelen för att analysera användningen och prestandan för dina API:er.

1. I Azure Portal navigerar du till din API Management-instans.
2. I den vänstra menyn, under Övervakning, väljer du Analys. Analysinstrumentpanelen öppnas.
3. Välj ett tidsintervall för data.
4. Välj en rapportkategori för analysdata, till exempel tidslinje, geografi och så vidare.

Äldre inbyggda analyser

På vissa API Management-tjänstnivåer är inbyggd analys (även kallad äldre analys eller klassisk analys) också tillgänglig i Azure-portalen, och analysdata kan nås med API Management REST API.

Så här kommer du åt den inbyggda (klassiska) analysen i Azure-portalen:

1. I Azure Portal navigerar du till din API Management-instans.
2. I den vänstra menyn går du till Övervakning och väljer Analys (klassisk).
3. Välj ett tidsintervall för data eller ange ett anpassat tidsintervall.
4. Välj en rapportkategori för analysdata, till exempel tidslinje, geografi och så vidare.
5. Du kan också filtrera rapporten efter en eller flera andra kategorier.

Använd rapportåtgärder i API Management REST API för att hämta och filtrera analysdata för din API Management-instans.

Tillgängliga åtgärder returnerar rapportposter efter API, geografi, API-åtgärder, produkt, begäran, prenumeration, tid eller användare.

Azure Monitor-loggarna

Det här avsnittet visar hur du aktiverar Azure Monitor-loggar för granskning och felsökning av användning av olika funktioner i din API Management-instans. Genom att aktivera en diagnostikinställning kan du aktivera en samling av en eller flera av följande kategorier av resursloggar:

Mer information finns i REFERENS för API Management-övervakningsdata.

Aktivera diagnostikinställning för Azure Monitor-loggar

Så här konfigurerar du en diagnostikinställning för insamling av resursloggar:

1. I Azure Portal navigerar du till din API Management-instans.

2. I den vänstra menyn går du till Övervakning och väljer Diagnostikinställningar>+ Lägg till diagnostikinställning.

   

3. På sidan Diagnostikinställning anger eller väljer du information för inställningen:

   1. Namn på diagnostikinställning: Ange ett beskrivande namn.
   2. Kategorigrupper: Om du vill kan du göra ett val för ditt scenario.
   3. Under Kategorier: Välj en eller flera kategorier. Välj till exempel Loggar relaterade till ApiManagement Gateway för att samla in loggar för de flesta begäranden till API Management-gatewayen.
   4. Under Målinformation väljer du ett eller flera alternativ och anger information för målet. Du kan till exempel skicka loggar till en Azure Log Analytics-arbetsyta, arkivera loggar till ett lagringskonto eller strömma dem till en händelsehubb. Mer information finns i Diagnostikinställningar i Azure Monitor.
   5. Välj Spara.

   Tips/Råd

   • Om du vill visa API-analys på den Azure Monitor-baserade instrumentpanelen för API Management (bladet Övervakningsanalys>) väljer du en Azure Log Analytics-arbetsyta som mål.
   • Om du väljer en Log Analytics-arbetsyta kan du välja att lagra data i en resursspecifik tabell (till exempel en ApiManagementGatewayLogs-tabell) eller lagra dem i den allmänna AzureDiagnostics-tabellen. Vi rekommenderar att du använder den resursspecifika tabellen för loggmål som stöder den. Läs mer

4. När du har konfigurerat information för loggmålet eller mål väljer du Spara.

Visa Loggdata för Azure Monitor

Beroende på vilket loggmål du väljer kan det ta några minuter innan data visas.

Visa loggar i Log Analytics-arbetsytan

Om du aktiverar insamling av loggar eller mått på en Log Analytics-arbetsyta kan det ta några minuter innan data visas i Azure Monitor och den Azure Monitor-baserade instrumentpanelen för API Management (bladet Övervakningsanalys>).

För att visa data:

1. I Azure Portal navigerar du till din API Management-instans.

2. I den vänstra menyn, under Övervakning, väljer du Loggar.

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

   ApiManagementGatewayLogs
   | where TimeGenerated > ago(1d) 
   

   

Visa loggar i lagringskonto

Om du skickar loggar till ett lagringskonto kan du komma åt data i Azure-portalen och ladda ned dem för analys.

1. Gå till lagringskontots mål i Azure-portalen.
2. I den vänstra menyn väljer du Lagringswebbläsare.
3. Under Blobcontainrar väljer du ett namn för loggdata, till exempel insights-logs-developerportalauditlogs för användningsloggar i utvecklarportalen.
4. Navigera till containern för loggarna i DIN API Management-instans. Loggarna partitioneras i intervall om 1 timme.
5. Om du vill hämta data för ytterligare analys väljer du Ladda ned.

Ändra API-loggningsinställningar

När du använder portalen för att skapa en diagnostikinställning för att aktivera insamling av API Management-gateway- eller generativ AI-gatewayloggar (LLM) aktiveras loggning med standardinställningar. Standardinställningarna innehåller inte information om begäranden eller svar, till exempel begärande- eller svarsorgan. Du kan justera loggningsinställningarna för alla API:er eller åsidosätta dem för enskilda API:er. Du kan till exempel justera samplingshastigheten eller verbositeten för gatewayloggdata, aktivera loggning av LLM-begärande- eller svarsmeddelanden eller inaktivera loggning för vissa API:er.

Mer information om loggningsinställningarna finns i referenssidorna Diagnostik – Skapa eller Uppdatera och API-diagnostik – Skapa eller uppdatera REST API.

Så här konfigurerar du loggningsinställningar för alla API:er:

1. I den vänstra menyn i DIN API Management-instans väljer du >>
2. Välj fliken Inställningar i det övre fältet.
3. Rulla ned till avsnittet Diagnostikloggar och välj fliken Azure Monitor .
4. Granska inställningarna och gör ändringar om det behövs. Välj Spara.

Så här konfigurerar du loggningsinställningar för ett specifikt API:

1. I den vänstra menyn i API Management-instansen väljer du API:er>OCH sedan namnet på API:et.
2. Välj fliken Inställningar i det övre fältet.
3. Rulla ned till avsnittet Diagnostikloggar och välj fliken Azure Monitor .
4. Granska inställningarna och gör ändringar om det behövs. Välj Spara.

Använda Azure Monitor-verktyg för att analysera data

Dessa Azure Monitor-verktyg är tillgängliga i Azure-portalen för att hjälpa dig att analysera övervakningsdata:

• Vissa Azure-tjänster har en inbyggd instrumentpanel för övervakning i Azure-portalen. Dessa instrumentpaneler kallas insikter och du hittar dem i avsnittet Insikter i Azure Monitor i Azure Portal.

• Med Metrics Explorer kan du visa och analysera mått för Azure-resurser. Mer information finns i Analysera mått med Azure Monitor Metrics Explorer.

• Med Log Analytics kan du fråga och analysera loggdata med hjälp av KQL (Kusto Query Language). Mer information finns i Kom igång med loggfrågor i Azure Monitor.

• Azure Portal har ett användargränssnitt för visning och grundläggande sökningar i aktivitetsloggen. Om du vill göra mer djupgående analys dirigerar du data till Azure Monitor-loggar och kör mer komplexa frågor i Log Analytics.

• Application Insights övervakar tillgänglighet, prestanda och användning av dina webbprogram, så att du kan identifiera och diagnostisera fel utan att vänta på att en användare ska rapportera dem.
  Application Insights innehåller anslutningspunkter till olika utvecklingsverktyg och integreras med Visual Studio för att stödja dina DevOps-processer. Mer information finns i Programövervakning för App Service.

Verktyg som möjliggör mer komplex visualisering är:

• Instrumentpaneler som gör att du kan kombinera olika typer av data i ett enda fönster i Azure-portalen.
• Arbetsböcker, anpassningsbara rapporter som du kan skapa i Azure-portalen. Arbetsböcker kan innehålla text-, mått- och loggfrågor.
• Grafana, ett öppet plattformsverktyg som utmärker sig i operativa instrumentpaneler. Du kan använda Grafana för att skapa instrumentpaneler som innehåller data från flera andra källor än Azure Monitor.
• Power BI, en tjänst för affärsanalys som tillhandahåller interaktiva visualiseringar mellan olika datakällor. Du kan konfigurera Power BI för att automatiskt importera loggdata från Azure Monitor för att dra nytta av dessa visualiseringar.

Visualisera API Management-övervakningsdata med hjälp av en hanterad Grafana-instrumentpanel

Du kan använda Azure Managed Grafana för att visualisera API Management-övervakningsdata som samlas in på en Log Analytics-arbetsyta. Använd en fördefinierad API Management-instrumentpanel för realtidsvisualisering av loggar och mått som samlats in från din API Management-instans.

• Läs mer om Azure Managed Grafana
• Läs mer om observerbarhet i Azure API Management

På din API Management-instans:

• Om du vill visualisera resursloggar och mått för API Management konfigurerar du diagnostikinställningar för att samla in resursloggar och skicka dem till en Log Analytics-arbetsyta.

• Om du vill visualisera detaljerade data om begäranden till API Management-gatewayen integrerar du din API Management-instans med Application Insights.

  Anmärkning

  Om du vill visualisera data på en enda instrumentpanel konfigurerar du Log Analytics-arbetsytan för diagnostikinställningarna och Application Insights-instansen i samma resursgrupp som din API Management-instans.

På din hanterade Grafana-arbetsyta:

• Information om hur du skapar en hanterad Grafana-instans och arbetsyta finns i snabbstarten för portalen eller Azure CLI.
• Den hanterade Grafana-instansen måste finnas i samma prenumeration som API Management-instansen.
• När den skapas tilldelas Grafana-arbetsytan automatiskt en Microsoft Entra-hanterad identitet, som tilldelas rollen Övervaka läsare i prenumerationen. Den här metoden ger dig omedelbar åtkomst till Azure Monitor från den nya Grafana-arbetsytan utan att behöva ange behörigheter manuellt. Läs mer om hur du konfigurerar datakällor för Managed Grafana.

Importera först API Management-instrumentpanelen till din Management Grafana-arbetsyta.

Så här importerar du instrumentpanelen:

1. Gå till din Azure Managed Grafana-arbetsyta. På portalen går du till sidan Översikt för din hanterade Grafana-instans och väljer länken Slutpunkt .
2. I arbetsytan Managed Grafana går du till Instrumentpaneler>Bläddra>Import.
3. På sidan Importera under Importera via grafana.com anger du 16604 och väljer Läs in.
4. Välj en Azure Monitor-datakälla, granska eller uppdatera de andra alternativen och välj Importera.

Så här använder du API Management-instrumentpanelen:

1. På arbetsytan Hanterad Grafana går du till Instrumentpaneler>Bläddra och väljer din API Management-instrumentpanel.
2. I listrutorna längst upp gör du val för din API Management-instans. Om du har konfigurerat väljer du en Application Insights-instans och en Log Analytics-arbetsyta.

Granska standardvisualiseringarna på instrumentpanelen, som ser ut ungefär så här:

Exportera Azure Monitor-data

Du kan exportera data från Azure Monitor till andra verktyg med hjälp av:

• Mått: Använd REST-API:et för mätdata för att extrahera mätdata från måttdatabasen i Azure Monitor. Mer information finns i Azure Monitor REST API-referens.

• Loggar: Använd REST-API:et eller de associerade klientbiblioteken.

• Dataexport för Log Analytics-arbetsyta.

Information om hur du kommer igång med REST-API:t för Azure Monitor finns i guide för REST API för Azure Monitor.

Använda Kusto-frågor för att analysera loggdata

Du kan analysera Azure Monitor-loggdata med hjälp av Kusto-frågespråket (KQL). För mer information, se Loggfrågor i Azure Monitor.

Använda Azure Monitor-aviseringar för att meddela dig om problem

Med Azure Monitor-aviseringar kan du identifiera och åtgärda problem i systemet och proaktivt meddela dig när specifika villkor finns i dina övervakningsdata innan kunderna märker dem. Du kan avisera om valfritt mått eller loggdatakälla på Azure Monitor-dataplattformen. Det finns olika typer av Azure Monitor-aviseringar beroende på vilka tjänster du övervakar och vilka övervakningsdata du samlar in. Se Välja rätt typ av aviseringsregel.

Information om hur du konfigurerar en aviseringsregel i Azure API Management finns i Konfigurera en aviseringsregel.

Exempel på vanliga aviseringar för Azure-resurser finns i Exempelloggaviseringsfrågor.

Implementera aviseringar i stor skala

För vissa tjänster kan du övervaka i stor skala genom att tillämpa samma måttaviseringsregel på flera resurser av samma typ som finns i samma Azure-region. Azure Monitor Baseline Alerts (AMBA) tillhandahåller en halvautomatiserad metod för att implementera viktiga plattformsmåttaviseringar, instrumentpaneler och riktlinjer i stor skala.

Få anpassade rekommendationer med Hjälp av Azure Advisor

För vissa tjänster, om kritiska villkor eller överhängande ändringar inträffar under resursåtgärder, visas en avisering på sidan Tjänstöversikt i portalen. Du hittar mer information och rekommenderade korrigeringar för aviseringen i Advisor-rekommendationer under Övervakning i den vänstra menyn. Under normal drift visas inga advisor-rekommendationer.

Mer information om Azure Advisor finns i Översikt över Azure Advisor.

Relaterat innehåll

• Referens för API Management-övervakningsdata
• Självstudie: Övervaka publicerade API:er
• Övervaka Azure-resurser med Azure Monitor