Referência: esquema de log do gateway
APLICA-SE A: todas as camadas do Gerenciamento de API
Neste artigo, você verá a referência de esquema para o log de recursos GatewayLogs do Gerenciamento de API do Azure. As entradas de log também incluem campos no esquema comum de nível superior.
Para habilitar a coleta do log de recursos no Gerenciamento de API, confira Monitorar APIs publicadas.
Esquema GatewayLogs
Confira a seguir as propriedades registradas para cada solicitação de API.
Propriedade | Type | Descrição |
---|---|---|
ApiId | string | Identificador da entidade de API para a solicitação atual |
ApimSubscriptionId | string | Identificador da entidade de assinatura para a solicitação atual |
ApiRevision | string | Revisão da API para a solicitação atual |
BackendId | string | Identificador da entidade de back-end para a solicitação atual |
BackendMethod | string | Método HTTP da solicitação enviada a um back-end |
BackendProtocol | string | Versão do protocolo HTTP da solicitação enviada a um back-end |
BackendRequestBody | string | Corpo da solicitação de back-end |
BackendRequestHeaders | dinâmico | Coleção de cabeçalhos HTTP enviados para um back-end |
BackendResponseBody | string | Corpo da resposta de back-end |
BackendResponseCode | INT | Código de resposta HTTP recebida de um back-end |
BackendResponseHeaders | dinâmico | Coleção de cabeçalhos HTTP recebidos de um back-end |
BackendTime | long | Número de milissegundos gastos na E/S do back-end no total (conectando, enviando e recebendo bytes) |
BackendUrl | string | URL da solicitação enviada a um back-end |
Cache | string | Status de envolvimento do cache do Gerenciamento de API no processamento da solicitação (ocorrências, ignorado, nenhum) |
CacheTime | long | Número de milissegundos gastos na E/S de cache do Gerenciamento de API no total (conectando, enviando e recebendo bytes) |
ClientProtocol | string | Versão do protocolo HTTP da solicitação de entrada |
ClientTime | long | Número de milissegundos gastos na E/S geral do cliente (conectando, enviando e recebendo bytes) |
ClientTlsVersion | string | Versão TLS usada pelo cliente que envia a solicitação |
Errors | dinâmico | A coleta de erros ocorreu durante o processamento da solicitação |
IsRequestSuccess | bool | A solicitação HTTP foi concluída com código de status de resposta dentro do intervalo 2xx a 3xx |
LastErrorElapsed | long | Número de milissegundos decorridos desde que o gateway recebeu a solicitação até o momento em que ocorreu o erro |
LastErrorMessage | string | Mensagem de erro |
LastErrorReason | string | Motivo do erro |
LastErrorScope | string | Escopo do documento de política que contém a política que causou o erro |
LastErrorSection | string | Seção do documento de política que contém a política que causou o erro |
LastErrorSource | string | Nome da política ou do manipulador interno de processamento que causou o erro |
Método | string | Método HTTP da solicitação de entrada |
OperationId | string | Identificador da entidade de operação para a solicitação atual |
ProductId | string | Identificador da entidade de produto para a solicitação atual |
RequestBody | string | Corpo da solicitação do cliente |
RequestHeaders | dinâmico | Coleção de cabeçalhos HTTP enviados por um cliente |
RequestSize | INT | Número de bytes recebidos de um cliente durante o processamento da solicitação |
ResponseBody | string | Corpo da resposta do gateway |
ResponseCode | INT | Código de status de resposta HTTP enviada a um cliente |
ResponseHeaders | dinâmico | Coleção de cabeçalhos HTTP enviados para um cliente |
ResponseSize | INT | Número de bytes enviados a um cliente durante o processamento da solicitação |
TotalTime | long | Número de milissegundos gastos na solicitação HTTP geral (do primeiro byte recebido por Gerenciamento de API para o último byte que um cliente recebeu de volta) |
TraceRecords | dinâmico | Registros emitidos por políticas de rastreamento |
Url | string | URL da solicitação de entrada |
UserId | string | Identificador da entidade de usuário para a solicitação atual |
Próximas etapas
- Para saber mais sobre como monitorar APIs no Gerenciamento de API, confira Monitorar APIs publicadas
- Saiba mais sobre o Esquema comum e específico de serviço para os Logs de Recursos do Azure
- Referência de esquema DeveloperPortalAuditLogs