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í tabulka uvádí metriky dostupné pro typ prostředku Microsoft.ApiManagement/service.
- 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
- Intervaly časových zrn - , ve kterých se metrika vzorkuje. Například označuje,
PT1Mže se metrika vzorkuje každou minutu,PT30Mkaždých 30 minut,PT1Hkaž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 | Metrika | Název v rozhraní REST API | Unit | Agregace | Dimenze | Časová zrnka | DS Export |
|---|---|---|---|---|---|---|---|
| Požadavky brány | 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 |
| Kapacita | 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 |
| Brána WebSocket | 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 | Total (Sum), Average | Location, Source, , DestinationState |
PT1M | Ano |
| Kapacita | Procento procesoru brány Procento procesoru brány pro služby SKUv2 |
CpuPercent_Gateway |
Procenta | Průměr, Maximum | <žádné> | PT1M | Ano |
| Požadavky brány | 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 |
| Události EventHubu | 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 |
| Události EventHubu | 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 |
| Události EventHubu | Úspěšné události EventHubu Počet úspěšných událostí EventHubu |
EventHubSuccessfulEvents |
Počet | Celkem (součet) | Location |
PT1M | Ano |
| Události EventHubu | Omezené události EventHubu Počet omezených událostí EventHubu |
EventHubThrottledEvents |
Počet | Celkem (součet) | Location |
PT1M | Ano |
| Události EventHubu | 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 |
| Události EventHubu | Velikost událostí EventHubu Celková velikost událostí EventHubu v bajtech |
EventHubTotalBytesSent |
Přijaté | Celkem (součet) | Location |
PT1M | Ano |
| Události EventHubu | Total EventHub Events Počet událostí odeslaných do EventHubu |
EventHubTotalEvents |
Počet | Celkem (součet) | Location |
PT1M | Ano |
| Události EventHubu | Události EventHubu, které selhaly Počet neúspěšných událostí EventHubu |
EventHubTotalFailedEvents |
Počet | Celkem (součet) | Location |
PT1M | Ano |
| Požadavky brány | 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 |
| Kapacita | Procento paměti brány Procento paměti brány pro služby SKUv2 |
MemoryPercent_Gateway |
Procenta | Průměr, Maximum | <žádné> | PT1M | Ano |
| Stav sítě | 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 | Total (Sum), Average | Location, ResourceType |
PT1M | Ano |
| Požadavky brány | 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 |
| Požadavky brány | Žádosti Metriky požadavků brány s více dimenzemi |
Requests |
Počet | Celkem (součet), maximum, minimum | Location, Hostname, LastErrorReason, , GatewayResponseCodeBackendResponseCode, BackendResponseCodeCategory, , GatewayResponseCodeCategoryApiId |
PT1M | Ano |
| Požadavky brány | Ú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 |
| Požadavky brány | 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 |
| Požadavky brány | Žá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 |
| Brána WebSocket | Zprávy protokolu WebSocket (Preview) Počet zpráv protokolu WebSocket na základě vybraného zdroje a cíle |
WebSocketMessages |
Počet | Total (Sum), Average | Location, , SourceDestination |
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
- BackendResponseCode
- BackendResponseCodeCategory
- Cíl
- GatewayResponseCode
- GatewayResponseCodeCategory
- Název hostitele
- LastErrorReason
- Umístění
- ResourceType
- Zdroj
- State
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 |
Yes | Ne | Ano | |
GatewayLlmLogs |
Protokoly související s generující bránou AI | No | No | Ano | ||
GatewayLogs |
Protokoly související s bránou ApiManagement | ApiManagementGatewayLogs Protokoly brány Azure ApiManagement |
Ano | Yes | Dotazy | No |
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. |
Yes | 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 | No | No | 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
- APIMDevPortalAuditDiagnosticLog
- AzureActivity
- AzureMetrics
- AzureDiagnostics
- ApiManagementGatewayLogs
- ApiManagementWebSocketConnectionLogs
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.
Související obsah
- Popis monitorování služby Azure API Management najdete v tématu Monitorování služby API Management .
- Podrobnosti o monitorování prostředků Azure najdete v tématu Monitorování prostředků Azure pomocí služby Azure Monitor .