Справочник. Схема журнала шлюза
ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API
Эта статья содержит справочник по схеме для журнала ресурсов GatewayLogs службы управления API Azure. В записях журнала также содержатся поля в общей схеме верхнего уровня.
Сведения о включении сбора журнала ресурсов в Управлении API см. в разделе Журналы ресурсов.
Схема GatewayLogs
Для каждого запроса API регистрируются следующие свойства:
Свойство | Type | Описание |
---|---|---|
ApiId | строка | Идентификатор сущности API для текущего запроса |
ApimSubscriptionId | строка | Идентификатор сущности подписки для текущего запроса |
ApiRevision | строка | Версия API для текущего запроса |
BackendId | строка | Идентификатор сущности серверной части для текущего запроса |
BackendMethod | строка | Метод HTTP запроса, отправленного в серверную часть |
BackendProtocol | строка | Версия протокола HTTP для запроса, отправленного в серверную часть |
BackendRequestBody | строка | Текст запроса к серверной части |
BackendRequestHeaders | по строкам | Коллекция заголовков HTTP, отправляемых в серверную часть |
BackendResponseBody | строка | Текст ответа серверной части |
BackendResponseCode | INT | Код HTTP-ответа, полученного от серверной части |
BackendResponseHeaders | по строкам | Коллекция заголовков HTTP, полученных от серверной части |
BackendTime | длинный | Время в миллисекундах, затраченное на все операции ввода-вывода серверной части (подключение, отправка и получение байтов) |
BackendUrl | строка | URL-адрес запроса, отправленного в серверную часть |
Cache | строка | Состояние участия кэша Управления API в обработке запроса (попадания, пропуски, ничего) |
CacheTime | длинный | Время в миллисекундах, затраченное на все операции ввода-вывода кэша Управления API (подключение, отправка и получение байтов) |
ClientProtocol | строка | Версия протокола HTTP входящего запроса |
ClientTime | длинный | Время в миллисекундах, затраченное на все операции ввода-вывода клиента (подключение, отправка и получение байтов) |
ClientTlsVersion | строка | Версия TLS, используемая клиентом, отправляющим запрос |
ошибки | по строкам | Коллекция ошибок во время обработки запроса |
IsRequestSuccess | bool | На HTTP-запрос получен код состояния ответа в пределах диапазона 2xx или 3xx |
LastErrorElapsed | длинный | Время в миллисекундах, истекшее с момента поступления запроса в шлюз до возникновения ошибки |
LastErrorMessage | строка | Сообщение об ошибке |
LastErrorReason | строка | Причина ошибки |
LastErrorScope | строка | Область действия документа, содержащего политику, которая вызвала ошибку |
LastErrorSection | строка | Раздел документа, содержащего политику, которая вызвала ошибку |
LastErrorSource | строка | Имя политики или внутреннего обработчика, вызвавшего ошибку |
Способ | строка | Метод HTTP входящего запроса |
OperationId | строка | Идентификатор сущности операции для текущего запроса |
ИД продукта | строка | Идентификатор сущности продукта для текущего запроса |
RequestBody | строка | Текста запроса клиента |
RequestHeaders | по строкам | Коллекция заголовков HTTP, отправляемых клиентом |
RequestSize | INT | Число байтов, полученных от клиента во время обработки запроса |
ResponseBody | строка | Текст ответа шлюза |
ResponseCode | INT | Код состояния ответа HTTP, отправленного клиенту |
ResponseHeaders | по строкам | Коллекция заголовков HTTP, отправляемых клиенту |
ResponseSize | INT | Число байтов, отправленных клиенту во время обработки запроса |
общее_время | длинный | Время в миллисекундах, затраченное на HTTP-запрос (от первого байта, полученного Управлением API, до последнего байта, полученного обратно клиентом) |
TraceRecords | по строкам | Записи, создаваемые политиками трассировки |
URL | строка | URL-адрес входящего запроса |
UserId | строка | Идентификатор сущности пользователя для текущего запроса |
Следующие шаги
- Дополнительные сведения об API для мониторинга в Управлении API см. в статье Мониторинг опубликованных API-интерфейсов.
- Дополнительные сведения об общей схеме и схеме для конкретных служб для журналов ресурсов Azure см. в этой статье.
- Справочник по схеме DeveloperPortalAuditLogs