Udostępnij za pośrednictwem


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ższej tabeli wymieniono metryki dostępne dla typu zasobu Microsoft.ApiManagement/service.

  • 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 Metric Nazwa w interfejsie API REST Jednostka Agregacja Wymiary Ziarna czasu Eksportowanie ds
Żądania bramy Czas trwania żądań zaplecza

Czas trwania żądań zaplecza w milisekundach
BackendDuration Milisekund Średnia, Maksymalna, Minimalna Location, , HostnameApiId PT1M Tak
Wydajność 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
Brama WebSocket 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 Count Suma (suma), średnia Location, , Source, , DestinationState PT1M Tak
Wydajność Procent użycia procesora CPU bramy

Procent użycia procesora CPU dla usług SKUUv2
CpuPercent_Gateway Procent Średnia, Maksymalna <none> PT1M Tak
Żądania bramy Ogólny czas trwania żądań bramy

Całkowity czas trwania żądań bramy w milisekundach
Duration Milisekund Średnia, Maksymalna, Minimalna Location, , HostnameApiId PT1M Tak
Zdarzenia w usłudze EventHub Porzucone zdarzenia usługi EventHub

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

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

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

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

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

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

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

Liczba zdarzeń usługi EventHub zakończonych niepowodzeniem
EventHubTotalFailedEvents Count Suma (suma) Location PT1M Tak
Żądania bramy Nieudane żądania bramy (przestarzałe)

Liczba błędów w żądaniach bramy — zamiast tego użyj metryki żądania wielowymiarowego z wymiarem GatewayResponseCodeCategory
FailedRequests Count Suma (suma) Location, Hostname PT1M Tak
Wydajność Procent pamięci bramy

Procent pamięci bramy dla usług SKUv2
MemoryPercent_Gateway Procent Średnia, Maksymalna <none> PT1M Tak
Stan sieci Stan łączności sieciowej zasobów (wersja zapoznawcza)

Stan łączności sieciowej zależnych typów zasobów z usługi API Management
NetworkConnectivity Count Suma (suma), średnia Location, ResourceType PT1M Tak
Żądania bramy Inne żądania bramy (przestarzałe)

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

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

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

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

Liczba nieautoryzowanych żądań bramy — zamiast tego użyj metryki żądania wielowymiarowego z wymiarem GatewayResponseCodeCategory
UnauthorizedRequests Count Suma (suma) Location, Hostname PT1M Tak
Brama WebSocket Komunikaty protokołu WebSocket (wersja zapoznawcza)

Liczba komunikatów protokołu WebSocket na podstawie wybranego źródła i miejsca docelowego
WebSocketMessages Count Suma (suma), średnia Location, , SourceDestination 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
  • BackendResponseCode
  • BackendResponseCodeCategory
  • Element docelowy
  • GatewayResponseCode
  • GatewayResponseCodeCategory
  • Hostname (Nazwa hosta)
  • LastErrorReason
  • Lokalizacja
  • ResourceType
  • Źródło
  • Stan

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 Nie Tak
GatewayLlmLogs Dzienniki związane z generowaniem bramy sztucznej inteligencji Nie Nie. 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 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.