Share via

Referência de configurações de logs de diagnóstico: Gerenciamento de API

  • Artigo

APLICA-SE A: Todas as camadas de gerenciamento de API

Esta referência descreve as configurações para o log de diagnóstico da API de uma instância do Gerenciamento de API. Para habilitar o registro em log de solicitações de API, consulte as seguintes orientações:

Nota

Certas configurações, quando observadas, aplicam-se apenas ao registro em log no Application Insights.

Definição Tipo Description
Ativar boolean Especifica se o registro em log dessa API está habilitado.

O registro em log pode ser habilitado para todas as APIs ou para uma API individual. As configurações de uma API individual substituem as configurações de todas as APIs, se habilitadas.
Destino Registador do Azure Application Insights Especifica o logger a ser usado para o log do Application Insights.
Amostragem (%) decimal Valores de 0 a 100 (por cento).
Especifica a porcentagem de solicitações que são registradas. 0% de amostragem significa zero solicitações registradas, enquanto 100% de amostragem significa todas as solicitações registradas. Padrão: 100

Para obter os impactos no desempenho do log do Application Insights, consulte Implicações de desempenho e amostragem de log.
Sempre registrar erros boolean Se essa configuração estiver habilitada, todas as falhas serão registradas, independentemente da configuração Amostragem .
Registrar o endereço IP do cliente boolean Se essa configuração estiver habilitada, o endereço IP do cliente para solicitações de API será registrado.
Verbosidade Especifica a detalhamento dos logs e se os rastreamentos personalizados configurados em políticas de rastreamento são registrados.

* Erro - solicitações falhadas e rastreamentos personalizados de gravidade error
* Informações - solicitações falhadas e bem-sucedidas, e rastreamentos personalizados de gravidade error e information
* Verbose - solicitações falhadas e bem-sucedidas, e rastreamentos personalizados de gravidade error, informatione verbose

Padrão: Informações
Protocolo de correlação Especifica o protocolo usado para correlacionar a telemetria enviada por vários componentes ao Application Insights. Padrão: Legacy

Para obter informações, consulte Correlação de telemetria no Application Insights.
Cabeçalhos a registar list Especifica os cabeçalhos que são registrados para solicitações e respostas. Padrão: nenhum cabeçalho é registrado.
Número de bytes de carga útil a registar integer Especifica o número de bytes iniciais do corpo que são registrados para solicitações e respostas. Máximo: 8.192. Padrão: 0
Pedido de Frontend Especifica se e como as solicitações de front-end (solicitações recebidas para o gateway de Gerenciamento de API) são registradas.

Se essa configuração estiver habilitada, especifique Cabeçalhos a serem registrados, Número de bytes de carga útil a serem registrados ou ambos.
Resposta Frontend Especifica se e como as respostas de frontend (respostas de saída do gateway de Gerenciamento de API) são registradas.

Se essa configuração estiver habilitada, especifique Cabeçalhos a serem registrados, Número de bytes de carga útil a serem registrados ou ambos.
Solicitação de back-end Especifica se e como as solicitações de back-end (solicitações de saída do gateway de Gerenciamento de API) são registradas.

Se essa configuração estiver habilitada, especifique Cabeçalhos a serem registrados, Número de bytes de carga útil a serem registrados ou ambos.
Resposta de back-end Especifica se e como as respostas de back-end (respostas recebidas para o gateway de Gerenciamento de API) são registradas.

Se essa configuração estiver habilitada, especifique Cabeçalhos a serem registrados, Número de bytes de carga útil a serem registrados ou ambos.

Próximos passos

  • Para obter mais informações, consulte a referência para a entidade de diagnóstico na API REST de gerenciamento de API.
  • Use a política de rastreamento para adicionar rastreamentos personalizados à telemetria do Application Insights, logs de recursos ou rastreamento de solicitações.