Dokumentacja: Schemat dziennika bramy
DOTYCZY: Wszystkie warstwy usługi API Management
Ten artykuł zawiera dokumentację schematu dla dziennika zasobów usługi Azure API Management GatewayLogs. Wpisy dziennika zawierają również pola w typowym schemacie najwyższego poziomu.
Aby włączyć zbieranie dziennika zasobów w usłudze API Management, zobacz Monitorowanie opublikowanych interfejsów API.
Schemat dzienników bramy
Następujące właściwości są rejestrowane dla każdego żądania interfejsu API.
Właściwość | Type | Opis |
---|---|---|
Identyfikator api | string | Identyfikator jednostki interfejsu API dla bieżącego żądania |
ApimSubscriptionId | string | Identyfikator jednostki subskrypcji dla bieżącego żądania |
ApiRevision | string | Poprawka interfejsu API dla bieżącego żądania |
Identyfikator zaplecza | string | Identyfikator jednostki zaplecza dla bieżącego żądania |
BackendMethod | string | Metoda HTTP żądania wysłanego do zaplecza |
BackendProtocol | string | Wersja protokołu HTTP żądania wysłanego do zaplecza |
BackendRequestBody | string | Treść żądania zaplecza |
BackendRequestHeaders | dynamiczna | Kolekcja nagłówków HTTP wysyłanych do zaplecza |
BackendResponseBody | string | Treść odpowiedzi zaplecza |
BackendResponseCode | int | Kod odpowiedzi HTTP odebranej z zaplecza |
BackendResponseHeaders | dynamiczna | Kolekcja nagłówków HTTP odebranych z zaplecza |
BackendTime | długi | Liczba milisekund wydanych na ogólne operacje we/wy zaplecza (łączenie, wysyłanie i odbieranie bajtów) |
Adres URL zaplecza | string | Adres URL żądania wysłanego do zaplecza |
Pamięć podręczna | string | Stan zaangażowania pamięci podręcznej usługi API Management w przetwarzanie żądań (trafienie, miss, brak) |
CacheTime | długi | Liczba milisekund wydanych na ogólne operacje we/wy pamięci podręcznej usługi API Management (łączenie, wysyłanie i odbieranie bajtów) |
ClientProtocol | string | Wersja protokołu HTTP żądania przychodzącego |
ClientTime | długi | Liczba milisekund wydanych na ogólne operacje we/wy klienta (łączenie, wysyłanie i odbieranie bajtów) |
ClientTlsVersion | string | Wersja protokołu TLS używana przez klienta wysyłającego żądanie |
Błędy | dynamiczna | Zbieranie błędów podczas przetwarzania żądań |
IsRequestSuccess | bool | Żądanie HTTP zostało ukończone z kodem stanu odpowiedzi w zakresie 2xx lub 3xx |
LastErrorElapsed | długi | Liczba milisekund upłynął od momentu odebrania żądania przez bramę do momentu wystąpienia błędu |
LastErrorMessage | string | Komunikat o błędzie |
LastErrorReason | string | Przyczyna błędu |
LastErrorScope | string | Zakres dokumentu zasad zawierającego zasady spowodował błąd |
LastErrorSection | string | Sekcja dokumentu zasad zawierająca zasady spowodowała błąd |
LastErrorSource | string | Nazewnictwo zasad lub procedury obsługi wewnętrznej spowodowało błąd |
Method | string | Metoda HTTP żądania przychodzącego |
Identyfikator operacji | string | Identyfikator jednostki operacji dla bieżącego żądania |
Identyfikator produktu | string | Identyfikator jednostki produktu dla bieżącego żądania |
RequestBody | string | Treść żądania klienta |
RequestHeaders | dynamiczna | Kolekcja nagłówków HTTP wysyłanych przez klienta |
RequestSize | int | Liczba bajtów odebranych od klienta podczas przetwarzania żądania |
Treść odpowiedzi | string | Treść odpowiedzi bramy |
Kod odpowiedzi | int | Kod stanu odpowiedzi HTTP wysłanej do klienta |
OdpowiedźHeaders | dynamiczna | Kolekcja nagłówków HTTP wysyłanych do klienta |
Rozmiar odpowiedzi | int | Liczba bajtów wysłanych do klienta podczas przetwarzania żądania |
TotalTime | długi | Liczba milisekund wydanych na ogólne żądanie HTTP (od pierwszego bajtu odebranego przez usługę API Management do ostatniego bajtu odebranego klienta) |
TraceRecords | dynamiczna | Rekordy emitowane przez zasady śledzenia |
Url | string | Adres URL żądania przychodzącego |
Identyfikator użytkownika | string | Identyfikator jednostki użytkownika dla bieżącego żądania |
Następne kroki
- Aby uzyskać informacje na temat monitorowania interfejsów API w usłudze API Management, zobacz Monitorowanie opublikowanych interfejsów API
- Dowiedz się więcej o typowym schemacie specyficznym dla usługi dla dzienników zasobów platformy Azure
- Dokumentacja schematu DeveloperPortalAuditLogs