You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/gateway-log-schema-reference.md
+40-17Lines changed: 40 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,23 +22,46 @@ The following properties are logged for each API request.
22
22
23
23
| Property | Type | Description |
24
24
| ------------- | ------------- | ------------- |
25
-
| method | string | HTTP method of the incoming request |
26
-
| url | string | URL of the incoming request |
27
-
| responseCode | integer | Status code of the HTTP response sent to a client |
28
-
| responseSize | integer | Number of bytes sent to a client during request processing |
29
-
| cache | string | Status of API Management cache involvement in request processing (hit, miss, none) |
30
-
| apiId | string | API entity identifier for current request |
31
-
| operationId | string | Operation entity identifier for current request |
32
-
| clientProtocol | string | HTTP protocol version of the incoming request |
33
-
| clientTime | integer | Number of milliseconds spent on overall client I/O (connecting, sending, and receiving bytes) |
34
-
| apiRevision | string | API revision for current request |
35
-
| clientTlsVersion| string | TLS version used by client sending request |
36
-
| lastError | object | For an unsuccessful request, details about the last request processing error |
37
-
| backendMethod | string | HTTP method of the request sent to a backend |
38
-
| backendUrl | string | URL of the request sent to a backend |
39
-
| backendResponseCode | integer | Code of the HTTP response received from a backend |
40
-
| backedProtocol | string | HTTP protocol version of the request sent to a backend |
41
-
| backendTime | integer | Number of milliseconds spent on overall backend IO (connecting, sending, and receiving bytes) |
25
+
| ApiId | string | API entity identifier for current request |
26
+
| ApimSubscriptionId | string | Subscription entity identifier for current request |
27
+
| ApiRevision | string | API revision for current request |
28
+
| BackendId | string | Backend entity identifier for current request |
29
+
| BackendMethod | string | HTTP method of the request sent to a backend |
30
+
| BackendProtocol | string | HTTP protocol version of the request sent to a backend |
31
+
| BackendRequestBody | string | Backend request body |
32
+
| BackendRequestHeaders | dynamic | Collection of HTTP headers sent to a backend |
33
+
| BackendResponseBody | string | Backend response body |
34
+
| BackendResponseCode | int | Code of the HTTP response received from a backend |
35
+
| BackendResponseHeaders | dynamic | Collection of HTTP headers received from a backend |
36
+
| BackendTime | long | Number of milliseconds spent on overall backend I/O (connecting, sending, and receiving bytes) |
37
+
| BackendUrl | string | URL of the request sent to a backend |
38
+
| Cache | string | Status of API Management cache involvement in request processing (hit, miss, none) |
39
+
| CacheTime | long | Number of milliseconds spent on overall API Management cache IO (connecting, sending and receiving bytes) |
40
+
| ClientProtocol | string | HTTP protocol version of the incoming request |
41
+
| ClientTime | long | Number of milliseconds spent on overall client I/O (connecting, sending, and receiving bytes) |
42
+
| ClientTlsVersion | string | TLS version used by client sending request |
43
+
| Errors | dynamic | Collection of error occurred during request processing |
44
+
| IsRequestSuccess | bool | HTTP request completed with response status code within 2xx or 3xx range |
45
+
| LastErrorElapsed | long | Number of milliseconds elapsed since gateway received request until the error occurred |
46
+
| LastErrorMessage | string | Error message |
47
+
| LastErrorReason | string | Error reason |
48
+
| LastErrorScope | string | Scope of the policy document containing policy caused the error |
49
+
| LastErrorSection | string | Section of the policy document containing policy caused the error |
50
+
| LastErrorSource | string | Naming of the policy or processing internal handler caused the error |
51
+
| Method | string | HTTP method of the incoming request |
52
+
| OperationId | string | Operation entity identifier for current request |
53
+
| ProductId | string | Product entity identifier for current request |
54
+
| RequestBody | string | Client request body |
55
+
| RequestHeaders | dynamic | Collection of HTTP headers sent by a client |
56
+
| RequestSize | int | Number of bytes received from a client during request processing |
57
+
| ResponseBody | string | Gateway response body |
58
+
| ResponseCode | int | Status code of the HTTP response sent to a client |
59
+
| ResponseHeaders | dynamic | Collection of HTTP headers sent to a client |
60
+
| ResponseSize | int | Number of bytes sent to a client during request processing |
61
+
| TotalTime | long | Number of milliseconds spent on overall HTTP request (from first byte received by API Management to last byte a client received back) |
62
+
| TraceRecords | dynamic | Records emitted by trace policies |
63
+
| Url | string | URL of the incoming request |
64
+
| UserId | string | User entity identifier for current request |
0 commit comments