Freigeben über

API-Verwaltungsüberwachungsdatenreferenz

  • Artikel

GILT FÜR: Alle API Management-Ebenen

Dieser Artikel enthält alle Referenzinformationen zur Überwachung dieses Dienstes.

Ausführliche Informationen zu den Daten, die Sie für Azure API Management sammeln können, und deren Verwendung finden Sie unter Überwachen der API-Verwaltung .

Metriken

In diesem Abschnitt werden alle automatisch erfassten Plattformmetriken für diesen Dienst aufgeführt. Diese Metriken sind auch Teil der globalen Liste aller in Azure Monitor unterstützten Plattformmetriken.

Informationen zur Aufbewahrung von Metriken finden Sie unter Überblick über Metriken in Azure Monitor.

Unterstützte Metriken für Microsoft.ApiManagement/service

In der folgenden Tabelle sind die Metriken aufgeführt, die für den Ressourcentyp "Microsoft.ApiManagement/service" verfügbar sind.

  • Möglicherweise sind nicht alle Spalten in jeder Tabelle vorhanden.
  • Einige Spalten können über den Anzeigebereich der Seite hinausgehen. Wählen Sie Tabelle erweitern aus, um alle verfügbaren Spalten anzuzeigen.

Tabellenüberschriften

  • Kategorie – Die Metrikgruppe oder -klassifizierung.
  • Metrik – Der Anzeigename der Metrik, wie er im Azure-Portal angezeigt wird.
  • Name in REST-API: Der Metrikname im REST-API
  • Einheit – Abrechnungseinheit.
  • Aggregation – Der Standard-Aggregationstyp. Gültige Werte: Mittelwert (Avg), Minimum (Min), Maximum (Max), Gesamt (Sum), Anzahl
  • Dimensionen - Für die Metrik verfügbare Dimensionen.
  • Aggregationsintervall - Intervalle, in denen die Metrik gesampelt wird. PT1M bedeutet zum Beispiel, dass die Metrik jede Minute abgerufen wird, PT30M alle 30 Minuten, PT1H jede Stunde usw.
  • DS-Export – Gibt an, ob die Metrik über Diagnose-Einstellungen in Azure Monitor-Protokolle exportiert werden kann. Informationen zum Exportieren von Metriken finden Sie unter Diagnoseeinstellungen in Azure Monitor erstellen.
Kategorie Metrik Name in der REST-API Einheit Aggregation Dimensionen Aggregationsintervalle DS-Export
Gatewayanforderungen Dauer von Back-End-Anforderungen

Dauer von Back-End-Anforderungen in Millisekunden		 BackendDuration Millisekunden Mittelwert, Maximum, Minimum Location, HostnameApiId PT1M Ja
Capacity Capacity

Auslastungsmetrik für ApiManagement-Dienst. Hinweis: Für andere SKUs als Premium gibt die Aggregation „Max“ den Wert als 0 an.		 Capacity Percent Mittelwert, Maximum Location PT1M Ja
Gateway-WebSocket WebSocket-Verbindungsversuche (Vorschau)

Anzahl der WebSocket-Verbindungsversuche basierend auf ausgewählter Quelle und ausgewähltem Ziel		 ConnectionAttempts Count Summe (Summe), Mittelwert Location, , SourceDestinationState PT1M Ja
Capacity CPU-Prozentsatz des Gateways

CPU-Prozentsatz des Gateways für SKUv2-Dienste		 CpuPercent_Gateway Percent Mittelwert, Maximum <none> PT1M Ja
Gatewayanforderungen Gesamtdauer der Gatewayanforderungen

Gesamtdauer von Gatewayanforderungen in Millisekunden		 Duration Millisekunden Mittelwert, Maximum, Minimum Location, HostnameApiId PT1M Ja
EventHub-Ereignisse Abgelegte EventHub-Ereignisse

Anzahl übersprungener Ereignisse aufgrund Erreichen der maximalen Warteschlangengröße		 EventHubDroppedEvents Count Gesamt (Summe) Location PT1M Ja
EventHub-Ereignisse Abgelehnte EventHub-Ereignisse

Anzahl abgelehnter EventHub-Ereignisse (falsche Konfiguration oder nicht autorisiert)		 EventHubRejectedEvents Count Gesamt (Summe) Location PT1M Ja
EventHub-Ereignisse Erfolgreiche EventHub-Ereignisse

Anzahl erfolgreicher EventHub-Ereignisse		 EventHubSuccessfulEvents Count Gesamt (Summe) Location PT1M Ja
EventHub-Ereignisse Drosselte EventHub-Ereignisse

Anzahl gedrosselter EventHub-Ereignisse		 EventHubThrottledEvents Count Gesamt (Summe) Location PT1M Ja
EventHub-Ereignisse Timeout eventHub-Ereignisse

Anzahl von EventHub-Ereignissen mit Zeitüberschreitung		 EventHubTimedoutEvents Count Gesamt (Summe) Location PT1M Ja
EventHub-Ereignisse Größe von EventHub-Ereignissen

Gesamtgröße von EventHub-Ereignissen in Byte		 EventHubTotalBytesSent Byte Gesamt (Summe) Location PT1M Ja
EventHub-Ereignisse Total EventHub-Ereignisse

Anzahl von an EventHub gesendeten Ereignissen		 EventHubTotalEvents Count Gesamt (Summe) Location PT1M Ja
EventHub-Ereignisse Fehlgeschlagene EventHub-Ereignisse

Anzahl fehlerhafter EventHub-Ereignisse		 EventHubTotalFailedEvents Count Gesamt (Summe) Location PT1M Ja
Gatewayanforderungen Fehlgeschlagene Gatewayanforderungen (veraltet)

Anzahl von Fehlern bei Gatewayanforderungen – verwenden Sie stattdessen die multidimensionale Anforderungsmetrik mit der GatewayResponseCodeCategory-Dimension.		 FailedRequests Count Gesamt (Summe) Location, Hostname PT1M Ja
Capacity Speicherprozentsatz des Gateways

Speicheranteil des Gateways für SKUv2-Dienste		 MemoryPercent_Gateway Percent Mittelwert, Maximum <none> PT1M Ja
Netzwerkstatus Netzwerkkonnektivitätsstatus von Ressourcen (Vorschau)

Netzwerkkonnektivitätsstatus abhängiger Ressourcentypen des API Management-Diensts		 NetworkConnectivity Count Summe (Summe), Mittelwert Location, ResourceType PT1M Ja
Gatewayanforderungen Andere Gatewayanforderungen (veraltet)

Anzahl von anderen Gatewayanforderungen – verwenden Sie stattdessen die multidimensionale Anforderungsmetrik mit der GatewayResponseCodeCategory-Dimension.		 OtherRequests Count Gesamt (Summe) Location, Hostname PT1M Ja
Gatewayanforderungen Anforderungen

Gatewayanforderungsmetriken mit mehreren Dimensionen		 Requests Count Summe (Summe), Maximum, Minimum Location, , HostnameLastErrorReason, BackendResponseCode, GatewayResponseCode, BackendResponseCodeCategory, , GatewayResponseCodeCategoryApiId PT1M Ja
Gatewayanforderungen Erfolgreiche Gatewayanforderungen (veraltet)

Anzahl von erfolgreichen Gatewayanforderungen – verwenden Sie stattdessen die multidimensionale Anforderungsmetrik mit der GatewayResponseCodeCategory-Dimension.		 SuccessfulRequests Count Gesamt (Summe) Location, Hostname PT1M Ja
Gatewayanforderungen Gesamtanzahl der Gatewayanforderungen (veraltet)

Anzahl von Gatewayanforderungen – verwenden Sie stattdessen die multidimensionale Anforderungsmetrik mit der GatewayResponseCodeCategory-Dimension.		 TotalRequests Count Gesamt (Summe) Location, Hostname PT1M Ja
Gatewayanforderungen Nicht autorisierte Gatewayanforderungen (veraltet)

Anzahl von nicht autorisierten Gatewayanforderungen – verwenden Sie stattdessen die multidimensionale Anforderungsmetrik mit der GatewayResponseCodeCategory-Dimension.		 UnauthorizedRequests Count Gesamt (Summe) Location, Hostname PT1M Ja
Gateway-WebSocket WebSocket-Nachrichten (Vorschau)

Anzahl der WebSocket-Meldungen basierend auf ausgewählter Quelle und ausgewähltem Ziel		 WebSocketMessages Count Summe (Summe), Mittelwert Location, SourceDestination PT1M Ja

Metrikdimensionen

Informationen darüber, was metrische Dimensionen sind, finden Sie unter Mehrdimensionale Metriken.

Bei diesem Dienst gelten die folgenden Dimensionen für die zugehörigen Metriken.

  • ApiId
  • BackendResponseCode
  • Back-EndResponseCodeCategory
  • Destination
  • GatewayResponseCode
  • GatewayResponseCodeCategory
  • Hostname
  • LastErrorReason
  • Location
  • ResourceType
  • `Source`
  • Staat

Ressourcenprotokolle

In diesem Abschnitt werden die Ressourcenprotokolltypen aufgeführt, die für diesen Service erfasst werden können. Der Abschnitt wird aus der Liste aller in Azure Monitor unterstützten Kategorietypen für Ressourcenprotokolle gezogen.

Unterstützte Ressourcenprotokolle für Microsoft.ApiManagement/service

Kategorie Anzeigename der Kategorie Protokolltabelle Unterstützt grundlegenden Protokollplan Unterstützt die Erfassungszeittransformation Beispielabfragen Exportkosten
DeveloperPortalAuditLogs Protokolle im Zusammenhang mit der Verwendung des Entwicklerportals APIMDevPortalAuditDiagnosticLog

Diagnoseprotokolle für API-Verwaltungsentwicklerportal-API.

 Ja Keine Ja
GatewayLlmLogs Protokolle im Zusammenhang mit dem generativen KI-Gateway No Nein Ja
GatewayLogs Protokolle im Zusammenhang mit dem ApiManagement-Gateway ApiManagementGatewayLogs

Azure ApiManagement-Gatewayprotokolle.

 Ja Ja Abfragen No
WebSocketConnectionLogs Protokolle im Zusammenhang mit Websocketverbindungen ApiManagementWebSocketConnectionLogs

Websocket-Verbindungsprotokolle stellen Protokolle zu Websocket-Verbindungsereignissen für das API-Verwaltungsgateway bereit. Die Protokollierung beginnt, wenn die Anforderung zum API-Verwaltungsgateway für Handshake eingeht und bis die Anforderung beendet wird. Jedes Anforderungsprotokoll kann mit CorrelationId eindeutig identifiziert werden.

 Ja Keine Ja

Unterstützte Ressourcenprotokolle für Microsoft.ApiManagement/service/workspaces

Kategorie Anzeigename der Kategorie Protokolltabelle Unterstützt grundlegenden Protokollplan Unterstützt die Erfassungszeittransformation Beispielabfragen Exportkosten
GatewayLogs Gatewayprotokolle für API-Verwaltungsarbeitsbereiche No Nein Ja

Tabellen in Azure Monitor-Protokollen

Dieser Abschnitt bezieht sich die für diesen Service relevanten Azure-Monitor-Protokolltabellen, die für die Abfrage durch Protokollanalyse mit Kusto-Abfragen zur Verfügung stehen. Diese Tabellen enthalten Ressourcenprotokolldaten und möglicherweise mehr, je nachdem, was erfasst und an sie weitergeleitet wird.

API-Verwaltung Von Microsoft.ApiManagement/Service

Aktivitätsprotokoll

In der verknüpften Tabelle sind die Vorgänge aufgeführt, die im Aktivitätsprotokoll für diesen Dienst aufgezeichnet werden können. Diese Operationen sind eine Teilmenge aller möglichen Ressourcenanbietervorgänge im Aktivitätsprotokoll.

Weitere Informationen zum Schema von Aktivitätsprotokolleinträgen finden Sie unter Ereignisschema des Azure-Aktivitätsprotokolls.

Zugehöriger Inhalt