Udostępnij za pomocą

Dokumentacja danych monitorowania usługi API Management

DOTYCZY: Wszystkie warstwy usługi API Management

Ten artykuł zawiera wszystkie informacje referencyjne dotyczące monitorowania tej usługi.

Zobacz Monitorowanie usługi API Management , aby uzyskać szczegółowe informacje o danych, które można zbierać w usłudze Azure API Management i sposobie ich używania.

Metryki

W tej sekcji wymieniono wszystkie automatycznie zebrane metryki platformy dla tej usługi. Te metryki są również częścią globalnej listy wszystkich metryk platformy obsługiwanych w usłudze Azure Monitor.

Aby uzyskać informacje na temat przechowywania metryk, zobacz Omówienie metryk usługi Azure Monitor.

Obsługiwane metryki dla elementu Microsoft.ApiManagement/service

W poniższych tabelach wymieniono metryki dostępne dla typu zasobu Microsoft.ApiManagement/service.

Uwaga / Notatka

Metryki zdarzeń usługi Event Hubs są obecnie niedostępne dla warstw usługi API Management w wersji 2.

  • Wszystkie kolumny mogą nie być obecne w każdej tabeli.
  • Niektóre kolumny mogą wykraczać poza obszar wyświetlania strony. Wybierz pozycję Rozwiń tabelę , aby wyświetlić wszystkie dostępne kolumny.

Nagłówki tabeli

  • Kategoria — grupa metryk lub klasyfikacja.
  • Metryka — nazwa wyświetlana metryki wyświetlana wyświetlana w witrynie Azure Portal.
  • Nazwa w interfejsie API REST — nazwa metryki określona w interfejsie API REST.
  • Jednostka — jednostka miary.
  • Agregacja — domyślny typ agregacji. Prawidłowe wartości: Średnia (średnia), Minimalna (Minimalna), Maksymalna (Maksymalna), Łączna (Suma), Liczba.
  • - Wymiary dostępne dla metryki.
  • Interwały ziarna - czasu, w których próbkowana jest metryka. Na przykład wskazuje, PT1M że metryka jest próbkowana co minutę, PT30M co 30 minut, PT1H co godzinę itd.
  • Eksportowanie ds — określa, czy metryka jest eksportowana do dzienników usługi Azure Monitor za pośrednictwem ustawień diagnostycznych. Aby uzyskać informacje na temat eksportowania metryk, zobacz Tworzenie ustawień diagnostycznych w usłudze Azure Monitor.

Kategoria: Pojemność

Wskaźnik Nazwa w interfejsie API REST Jednostka Agregacja Wymiary Ziarna czasu Eksportowanie ds
Wydajność

Metryka Wykorzystania dla usługi ApiManagement. Uwaga: w przypadku jednostek SKU innych niż Premium agregacja "Max" będzie wyświetlać wartość jako 0.		 Capacity Procent Średnia, Maksymalna Location PT1M Tak
Procent użycia procesora CPU bramy

Procent użycia procesora CPU dla usług SKUUv2		 CpuPercent_Gateway Procent Średnia, Maksymalna <żadne> PT1M Tak
Procent pamięci bramy

Procent pamięci bramy dla usług SKUv2		 MemoryPercent_Gateway Procent Średnia, Maksymalna <żadne> PT1M Tak

Kategoria: EventHub Events

Wskaźnik Nazwa w interfejsie API REST Jednostka Agregacja Wymiary Ziarna czasu Eksportowanie ds
Porzucone zdarzenia usługi EventHub

Liczba zdarzeń pominiętych z powodu osiągnięcia limitu rozmiaru kolejki		 EventHubDroppedEvents Liczba Suma (suma) Location PT1M Tak
Odrzucone zdarzenia usługi EventHub

Liczba odrzuconych zdarzeń usługi EventHub (nieprawidłowa konfiguracja lub brak autoryzacji)		 EventHubRejectedEvents Liczba Suma (suma) Location PT1M Tak
Pomyślne zdarzenia usługi EventHub

Liczba pomyślnych zdarzeń usługi EventHub		 EventHubSuccessfulEvents Liczba Suma (suma) Location PT1M Tak
Zdarzenia usługi EventHub z ograniczeniami

Liczba zdarzeń usługi EventHub z ograniczeniami		 EventHubThrottledEvents Liczba Suma (suma) Location PT1M Tak
Przekroczono limit czasu zdarzeń usługi EventHub

Liczba przekroczonych limitów czasu zdarzeń usługi EventHub		 EventHubTimedoutEvents Liczba Suma (suma) Location PT1M Tak
Rozmiar zdarzeń usługi EventHub

Całkowity rozmiar zdarzeń usługi EventHub w bajtach		 EventHubTotalBytesSent Bajty Suma (suma) Location PT1M Tak
Łączna liczba zdarzeń usługi EventHub

Liczba zdarzeń wysłanych do usługi EventHub		 EventHubTotalEvents Liczba Suma (suma) Location PT1M Tak
Zdarzenia usługi EventHub, które zakończyły się niepowodzeniem

Liczba zdarzeń usługi EventHub zakończonych niepowodzeniem		 EventHubTotalFailedEvents Liczba Suma (suma) Location PT1M Tak

Kategoria: Żądania bramy

Wskaźnik Nazwa w interfejsie API REST Jednostka Agregacja Wymiary Ziarna czasu Eksportowanie ds
Czas trwania żądań zaplecza

Czas trwania żądań zaplecza w milisekundach		 BackendDuration Milisekund Średnia, Maksymalna, Minimalna Location, , HostnameApiId PT1M Tak
Ogólny czas trwania żądań bramy

Całkowity czas trwania żądań bramy w milisekundach		 Duration Milisekund Średnia, Maksymalna, Minimalna Location, , HostnameApiId PT1M Tak
Nieudane żądania bramy (przestarzałe)

Liczba błędów w żądaniach bramy — zamiast tego użyj metryki żądania wielowymiarowego z wymiarem GatewayResponseCodeCategory		 FailedRequests Liczba Suma (suma) Location, Hostname PT1M Tak
Inne żądania bramy (przestarzałe)

Liczba innych żądań bramy — zamiast tego użyj metryki żądania wielowymiarowego z wymiarem GatewayResponseCodeCategory		 OtherRequests Liczba Suma (suma) Location, Hostname PT1M Tak
Żądania

Metryki żądania bramy z wieloma wymiarami		 Requests Liczba Suma (suma), maksimum, minimum Location, Hostname, , LastErrorReason, BackendResponseCodeGatewayResponseCode, , BackendResponseCodeCategory, , GatewayResponseCodeCategoryApiId PT1M Tak
Pomyślne żądania bramy (przestarzałe)

Liczba pomyślnych żądań bramy — zamiast tego użyj metryki żądania wielowymiarowego z wymiarem GatewayResponseCodeCategory		 SuccessfulRequests Liczba Suma (suma) Location, Hostname PT1M Tak
Łączna liczba żądań bramy (przestarzała)

Liczba żądań bramy — zamiast tego użyj metryki żądania wielowymiarowego z wymiarem GatewayResponseCodeCategory		 TotalRequests Liczba Suma (suma) Location, Hostname PT1M Tak
Żądania nieautoryzowanej bramy (przestarzałe)

Liczba nieautoryzowanych żądań bramy — zamiast tego użyj metryki żądania wielowymiarowego z wymiarem GatewayResponseCodeCategory		 UnauthorizedRequests Liczba Suma (suma) Location, Hostname PT1M Tak

Kategoria: Brama WebSocket

Wskaźnik Nazwa w interfejsie API REST Jednostka Agregacja Wymiary Ziarna czasu Eksportowanie ds
Próby połączenia protokołu WebSocket (wersja zapoznawcza)

Liczba prób połączenia protokołu WebSocket na podstawie wybranego źródła i miejsca docelowego		 ConnectionAttempts Liczba Suma (suma), średnia Location, , Source, , DestinationState PT1M Tak
Komunikaty protokołu WebSocket (wersja zapoznawcza)

Liczba komunikatów protokołu WebSocket na podstawie wybranego źródła i miejsca docelowego		 WebSocketMessages Liczba Suma (suma), średnia Location, , SourceDestination PT1M Tak

Kategoria: Stan sieci

Wskaźnik Nazwa w interfejsie API REST Jednostka Agregacja Wymiary Ziarna czasu Eksportowanie ds
Stan łączności sieciowej zasobów (wersja zapoznawcza)

Stan łączności sieciowej zależnych typów zasobów z usługi API Management		 NetworkConnectivity Liczba Suma (suma), średnia Location, ResourceType PT1M Tak

Wymiary metryk

Aby uzyskać informacje na temat wymiarów metryk, zobacz Metryki wielowymiarowe.

Ta usługa ma następujące wymiary skojarzone z jej metrykami.

  • Identyfikator api
  • KodOdpowiedziBackendowej
  • BackendResponseCodeCategory
  • Element docelowy
  • GatewayResponseCode
  • GatewayResponseCodeCategory
  • Hostname (Nazwa hosta)
  • PowódOstatniegoBłędu
  • Lokalizacja
  • Typ Zasobu
  • Źródło
  • Stan

Obsługiwane metryki dla Microsoft.ApiManagement/gateways

W poniższej tabeli wymieniono metryki dostępne dla typu zasobu Microsoft.ApiManagement/gateways.

Nagłówki tabeli

Metryka — nazwa wyświetlana metryki wyświetlana wyświetlana w witrynie Azure Portal.
Nazwa w REST API — nazwa metryki tak, jak to określono w REST API.
Jednostka — jednostka miary.
Agregacja — domyślny typ agregacji. Dozwolone wartości: Średnia, Minimum, Maksimum, Suma, Liczba.
- Wymiary dostępne dla metryki.
Przedziały czasowe - Interwały, w których metryka jest próbkowana. Na przykład wskazuje, PT1M że metryka jest próbkowana co minutę, PT30M co 30 minut, PT1H co godzinę itd.
DS Export — określa, czy metrykę można eksportować do dzienników usługi Azure Monitor za pośrednictwem ustawień diagnostycznych.

Aby uzyskać informacje na temat eksportowania metryk, zobacz - Eksport metryk przy użyciu reguł zbierania danych oraz Tworzenie ustawień diagnostycznych w Azure Monitor.

Aby uzyskać informacje na temat przechowywania metryk, zobacz Omówienie metryk usługi Azure Monitor.

Kategoria: Wykorzystanie

Wskaźnik Nazwa w interfejsie API REST Jednostka Agregacja Wymiary Ziarna czasu Eksportowanie ds
Wykorzystanie procesora CPU (%)

Łączne użycie procesora we wszystkich rdzeniach bramy interfejsu API.		 CpuPercent_Gateway Procent Średnia, Maksymalna <żadne> PT1M Tak
Wykorzystanie pamięci (%)

Procent pamięci fizycznej używanej przez aktywne procesy w bramie interfejsu API.		 MemoryPercent_Gateway Procent Średnia, Maksymalna <żadne> PT1M Tak

Dzienniki zasobów

W tej sekcji wymieniono typy dzienników zasobów, które można zbierać dla tej usługi. Sekcja pobiera z listy wszystkich typów kategorii dzienników zasobów obsługiwanych w usłudze Azure Monitor.

Obsługiwane dzienniki zasobów dla elementu Microsoft.ApiManagement/service

Kategoria Nazwa wyświetlana kategorii Tabela dzienników Obsługuje podstawowy plan dziennika Obsługuje transformację czasu pozyskiwania Przykładowe zapytania Koszty eksportowania
DeveloperPortalAuditLogs Dzienniki związane z użyciem portalu deweloperów APIMDevPortalAuditDiagnosticLog

Dzienniki diagnostyczne dla interfejsu API portalu deweloperów usługi API Management.

 Tak Tak Tak
GatewayLlmLogs Dzienniki związane z generowaniem bramy sztucznej inteligencji ApiManagementGatewayLlmLog

Logi bramy związane z modelami językowymi do zarządzania językami API.

 Tak Tak Tak
GatewayLogs Dzienniki związane z bramą ApiManagement ApiManagementGatewayLogs

Dzienniki bramy usługi Azure ApiManagement.

 Tak Tak Zapytania Nie
WebSocketConnectionLogs Dzienniki związane z połączeniami protokołu Websocket ApiManagementWebSocketConnectionLogs

Dzienniki połączeń protokołu Websocket udostępniają dzienniki zdarzeń połączenia protokołu Websocket dla bramy usługi API Management. Rejestrowanie rozpoczyna się po nadejściu żądania do bramy usługi API Management w celu uzgadniania i do momentu zakończenia żądania. Każdy dziennik żądań może być jednoznacznie identyfikowany z identyfikatorem CorrelationId.

 Tak Nie Tak

Obsługiwane dzienniki zasobów dla elementu Microsoft.ApiManagement/service/workspaces

Kategoria Nazwa wyświetlana kategorii Tabela dzienników Obsługuje podstawowy plan dziennika Obsługuje transformację czasu pozyskiwania Przykładowe zapytania Koszty eksportowania
GatewayLogs Dzienniki bramy dla obszarów roboczych usługi API Management AzureDiagnostics

Dzienniki z wielu zasobów platformy Azure.

 Nie Nie Tak

Tabele dzienników usługi Azure Monitor

W tej sekcji wymieniono tabele dzienników usługi Azure Monitor dotyczące tej usługi, które są dostępne do wykonywania zapytań przez usługę Log Analytics przy użyciu zapytań Kusto. Tabele zawierają dane dziennika zasobów i prawdopodobnie więcej w zależności od tego, co jest zbierane i kierowane do nich.

API Management Microsoft.ApiManagement/service

Dziennik aktywności

Tabela połączona zawiera listę operacji, które można zarejestrować w dzienniku aktywności dla tej usługi. Te operacje są podzbiorem wszystkich możliwych operacji dostawcy zasobów w dzienniku aktywności.

Aby uzyskać więcej informacji na temat schematu wpisów dziennika aktywności, zobacz Schemat dziennika aktywności.

Powiązana zawartość

  • Last updated on