Sdílet prostřednictvím


Referenční informace k datům monitorování služby API Management

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

Tento článek obsahuje všechny referenční informace o monitorování pro tuto službu.

Podrobnosti o datech, která můžete shromažďovat pro Azure API Management a jak je používat, najdete v tématu Monitorování služby API Management .

Metriky

V této části jsou uvedeny všechny automaticky shromážděné metriky platformy pro tuto službu. Tyto metriky jsou také součástí globálního seznamu všech metrik platformy podporovaných ve službě Azure Monitor.

Informace o uchovávání metrik najdete v přehledu metrik služby Azure Monitor.

Podporované metriky pro Microsoft.ApiManagement/service

Následující tabulky uvádějí metriky dostupné pro typ prostředku Microsoft.ApiManagement/service.

Poznámka:

Metriky událostí služby Event Hubs nejsou aktuálně k dispozici pro vrstvy služby API Management v2.

  • Všechny sloupce nemusí být v každé tabulce.
  • Některé sloupce můžou být mimo oblast zobrazení stránky. Výběrem možnosti Rozbalit tabulku zobrazíte všechny dostupné sloupce.

Záhlaví tabulky

  • Kategorie – skupina metrik nebo klasifikace.
  • Metrika – zobrazovaný název metriky, jak se zobrazuje na webu Azure Portal.
  • Název v rozhraní REST API – název metriky, který se označuje v rozhraní REST API.
  • Jednotka – měrná jednotka .
  • Agregace – výchozí typ agregace . Platné hodnoty: Průměr (Průměr), Minimum (Minimum), Maximum (Maximum), Celkem (Součet), Počet.
  • - Dimenze dostupné pro metriku
  • - , ve kterých se metrika vzorkuje. Například označuje, PT1M že se metrika vzorkuje každou minutu, PT30M každých 30 minut, PT1H každou hodinu atd.
  • DS Export – určuje, jestli je metrika exportovatelná do protokolů služby Azure Monitor prostřednictvím nastavení diagnostiky. Informace o exportu metrik najdete v tématu Vytvoření nastavení diagnostiky ve službě Azure Monitor.

Kategorie: Kapacita

Metrika Název v rozhraní REST API Jednotka Agregace Dimenze Časová zrnka DS Vývoz
Kapacita

Metrika využití pro službu ApiManagement Poznámka: U skladových položek jiných než Premium zobrazí agregace Max hodnotu 0.
Capacity Procenta Průměr, Maximum Location PT1M Ano
Procento procesoru brány

Procento procesoru brány pro služby SKUv2
CpuPercent_Gateway Procenta Průměr, Maximum <žádné> PT1M Ano
Procento paměti brány

Procento paměti brány pro služby SKUv2
MemoryPercent_Gateway Procenta Průměr, Maximum <žádné> PT1M Ano

Kategorie: Události EventHubu

Metrika Název v rozhraní REST API Jednotka Agregace Dimenze Časová zrnka DS Vývoz
Vynechané události EventHubu

Počet událostí vynechaných kvůli dosažení limitu velikosti fronty
EventHubDroppedEvents Počet Celkem (součet) Location PT1M Ano
Odmítnuté události EventHubu

Počet odmítnutých událostí EventHubu (nesprávná konfigurace nebo neautorizováno)
EventHubRejectedEvents Počet Celkem (součet) Location PT1M Ano
Úspěšné události EventHubu

Počet úspěšných událostí EventHubu
EventHubSuccessfulEvents Počet Celkem (součet) Location PT1M Ano
Omezené události EventHubu

Počet omezených událostí EventHubu
EventHubThrottledEvents Počet Celkem (součet) Location PT1M Ano
Události EventHubu s časovým limitem

Počet vypršení časového limitu událostí EventHubu
EventHubTimedoutEvents Počet Celkem (součet) Location PT1M Ano
Velikost událostí EventHubu

Celková velikost událostí EventHubu v bajtech
EventHubTotalBytesSent Přijaté Celkem (součet) Location PT1M Ano
Total EventHub Events

Počet událostí odeslaných do EventHubu
EventHubTotalEvents Počet Celkem (součet) Location PT1M Ano
Události EventHubu, které selhaly

Počet neúspěšných událostí EventHubu
EventHubTotalFailedEvents Počet Celkem (součet) Location PT1M Ano

Kategorie: Požadavky brány

Metrika Název v rozhraní REST API Jednotka Agregace Dimenze Časová zrnka DS Vývoz
Doba trvání back-endových požadavků

Doba trvání back-endových požadavků v milisekundách
BackendDuration Milisekundy Průměr, Maximum, Minimum Location, , HostnameApiId PT1M Ano
Celková doba trvání požadavků brány

Celková doba trvání požadavků brány v milisekundách
Duration Milisekundy Průměr, Maximum, Minimum Location, , HostnameApiId PT1M Ano
Neúspěšné požadavky brány (zastaralé)

Počet selhání v požadavcích brány – Místo toho použijte metriku požadavků s více dimenzemi s dimenzí GatewayResponseCodeCategory.
FailedRequests Počet Celkem (součet) Location, Hostname PT1M Ano
Jiné požadavky brány (zastaralé)

Počet dalších požadavků brány – Místo toho použijte metriku požadavků s více dimenzemi s dimenzí GatewayResponseCodeCategory.
OtherRequests Počet Celkem (součet) Location, Hostname PT1M Ano
Žádosti

Metriky požadavků brány s více dimenzemi
Requests Počet Celkem (součet), maximum, minimum Location, Hostname, LastErrorReason, , BackendResponseCodeGatewayResponseCode, BackendResponseCodeCategory, , GatewayResponseCodeCategoryApiId PT1M Ano
Úspěšné požadavky brány (zastaralé)

Počet úspěšných požadavků brány – Místo toho použijte metriku požadavků s více dimenzemi s dimenzí GatewayResponseCodeCategory.
SuccessfulRequests Počet Celkem (součet) Location, Hostname PT1M Ano
Celkový počet žádostí o bránu (zastaralé)

Počet požadavků brány – Místo toho použijte metriku požadavku s více dimenzemi s dimenzí GatewayResponseCodeCategory.
TotalRequests Počet Celkem (součet) Location, Hostname PT1M Ano
Žádosti o neoprávněnou bránu (zastaralé)

Počet neautorizovaných požadavků brány – Místo toho použijte metriku požadavků s více dimenzemi s dimenzí GatewayResponseCodeCategory.
UnauthorizedRequests Počet Celkem (součet) Location, Hostname PT1M Ano

Kategorie: WebSocket brány

Metrika Název v rozhraní REST API Jednotka Agregace Dimenze Časová zrnka DS Vývoz
Pokusy o připojení WebSocket (Preview)

Počet pokusů o připojení WebSocket na základě vybraného zdroje a cíle
ConnectionAttempts Počet Celkem (Suma), Průměr Location, Source, , DestinationState PT1M Ano
Zprávy protokolu WebSocket (Preview)

Počet zpráv protokolu WebSocket na základě vybraného zdroje a cíle
WebSocketMessages Počet Celkem (Suma), Průměr Location, , SourceDestination PT1M Ano

Kategorie: Stav sítě

Metrika Název v rozhraní REST API Jednotka Agregace Dimenze Časová zrnka DS Vývoz
Stav připojení k síti prostředků (Preview)

Stav síťového připojení závislých typů prostředků ze služby API Management
NetworkConnectivity Počet Celkem (Suma), Průměr Location, ResourceType PT1M Ano

Rozměry metrik

Informace o rozměrech metrik najdete v tématu Vícerozměrné metriky.

Tato služba má přidružené následující dimenze ke svým metrikám.

  • ApiId
  • KódOdpovědiBackendu
  • BackendResponseCodeCategory
  • Cíl
  • GatewayResponseCode
  • GatewayResponseCodeCategory
  • Název hostitele
  • Poslední důvod chyby
  • Umístění
  • Druh zdroje
  • Zdroj
  • Stát

Podporované metriky pro Microsoft.ApiManagement/API brány

Následující tabulka uvádí metriky dostupné pro typ prostředku Microsoft.ApiManagement/gateways.

Záhlaví tabulky

Metrika – zobrazovaný název metriky, jak se zobrazuje na webu Azure Portal.
Název v Rest API - Název metriky, jak je uveden v REST API.
Jednotka – měrná jednotka .
Agregace – výchozí typ agregace . Platné hodnoty: průměr, minimum, maximum, celkem, počet.
- Dimenze dostupné pro metriku
Časové úseky - Intervaly, ve kterých je metrika vzorkována. Například označuje, PT1M že se metrika vzorkuje každou minutu, PT30M každých 30 minut, PT1H každou hodinu atd.
DS Export- Zda je metriku možné exportovat do Azure Monitor Logs prostřednictvím diagnostických nastavení.

Pro informace o exportu metrik viz - Export metrik pomocí pravidel sběru dat a Vytvoření diagnostických nastavení v Azure Monitor.

Informace o uchovávání metrik najdete v přehledu metrik služby Azure Monitor.

Kategorie: Využití

Metrika Název v rozhraní REST API Jednotka Agregace Dimenze Časová zrnka DS Vývoz
Využití procesoru (%)

Celkové využití procesoru napříč všemi jádry brány rozhraní API
CpuPercent_Gateway Procenta Průměr, Maximum <žádné> PT1M Ano
Využití paměti (%)

Procento fyzické paměti používané aktivními procesy v rámci brány rozhraní API
MemoryPercent_Gateway Procenta Průměr, Maximum <žádné> PT1M Ano

Protokoly prostředků

Tato část obsahuje seznam typů protokolů prostředků, které můžete pro tuto službu shromažďovat. Oddíl načítá ze seznamu všech typů protokolů prostředků podporovaných ve službě Azure Monitor.

Podporované protokoly prostředků pro Microsoft.ApiManagement/service

Kategorie Zobrazovaný název kategorie Tabulka protokolů Podporuje základní plán protokolu. Podporuje transformaci v čase příjmu dat. Vzorové dotazy Náklady na export
DeveloperPortalAuditLogs Protokoly související s využitím portálu pro vývojáře APIMDevPortalAuditDiagnosticLog

Diagnostické protokoly pro rozhraní API Management Developer Portal API

Ano Ano Ano
GatewayLlmLogs Protokoly související s generující bránou AI ApiManagementGatewayLlmLog

Protokoly brány týkající se jazykových modelů v rámci správy API.

Ano Ano Ano
GatewayLogs Protokoly související s bránou ApiManagement ApiManagementGatewayLogs

Protokoly brány Azure ApiManagement

Ano Ano Dotazy Ne
WebSocketConnectionLogs Protokoly související s připojeními protokolu Websocket ApiManagementWebSocketConnectionLogs

Protokoly připojení websocket poskytují protokoly událostí připojení websocket pro službu API Management Gateway. Protokolování se spustí, když požadavek dorazí do služby API Management Gateway pro metodu handshake a dokud se požadavek neukončí. Každý protokol požadavků lze jednoznačně identifikovat pomocí Id korelace.

Ano Ne Ano

Podporované protokoly prostředků pro Microsoft.ApiManagement/service/workspaces

Kategorie Zobrazovaný název kategorie Tabulka protokolů Podporuje základní plán protokolu. Podporuje transformaci v čase příjmu dat. Vzorové dotazy Náklady na export
GatewayLogs Protokoly brány pro pracovní prostory služby API Management AzureDiagnostics

Protokoly z několika prostředků Azure.

Ne Ne Ano

Tabulky protokolů služby Azure Monitor

Tato část uvádí tabulky protokolů služby Azure Monitor relevantní pro tuto službu, které jsou k dispozici pro dotazování službou Log Analytics pomocí dotazů Kusto. Tabulky obsahují data protokolu prostředků a případně i více v závislosti na tom, co se na nich shromažďuje a směruje.

API Management Microsoft.ApiManagement/service

Protokol aktivit

Propojená tabulka uvádí operace, které lze zaznamenat v protokolu aktivit pro tuto službu. Tyto operace jsou podmnožinou všech možných operací poskytovatele prostředků v protokolu aktivit.

Další informace o schématu položek protokolu aktivit naleznete v tématu Schéma protokolu aktivit.