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

APLICA-SE A: todas as camadas do Gerenciamento de API

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

• Coletar logs de recurso
• Integrar o Azure API Management ao Azure Application Insights

Observação

Determinadas configurações, quando indicadas, se aplicam somente ao registro em log no Application Insights.

Configuração	Type	Descrição
Habilitar	booleano	Especifica se o log desta 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	Agente do Azure Application Insights	Especifica o agente a ser usado para o log do Application Insights.
Amostragem (%)	decimal	Valores de 0 a 100 (porcentagem). Especifica o percentual de solicitações registradas. A amostragem de 0% significa zero solicitações registradas, enquanto a amostragem de 100% significa que todas as solicitações foram registradas. Padrão: 100 Para obter os impactos no desempenho do log do Application Insights, confira Implicações no desempenho e amostragem de log.
Sempre registrar erros	booleano	Se esta configuração estiver habilitada, todas as falhas serão registradas, independentemente da configuração de Amostragem.
Endereço IP do cliente de log	booleano	Se essa configuração estiver habilitada, o endereço IP do cliente das solicitações de API será registrado.
Detalhamento		Especifica o detalhamento dos logs e se os rastreamentos personalizados configurados nas políticas de rastreamento são registrados. * Erro – Solicitações com falha e rastreamentos personalizados de severidade error * Informações – Solicitações com falha e bem-sucedidas e rastreamentos personalizados de severidade error e information * Detalhamento – Solicitações com falha e bem-sucedidas e rastreamentos personalizados de severidade error, information e 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: Herdado Para obter mais informações, confira Correlação de telemetria no Application Insights.
Cabeçalhos a serem registrados	list	Especifica os cabeçalhos registrados para solicitações e respostas. Padrão: nenhum cabeçalho é registrado.
Número de bytes de carga útil (corpo) a serem registrados	Número inteiro	Especifica o número de bytes iniciais do corpo da solicitação ou resposta de front-end ou back-end que são registrados. Máximo: 8.192. Padrão: 0
Solicitação de front-end		Especifica se e como as solicitações de front-end (solicitações de entrada no gateway do Gerenciamento de API) são registradas. Se essa configuração estiver habilitada, especifique Cabeçalhos a serem registrados e/ou Número de bytes de conteúdo a serem registrados.
Resposta de front-end		Especifica se e como as respostas de front-end (respostas de saída do gateway do Gerenciamento de API) são registradas. Se essa configuração estiver habilitada, especifique Cabeçalhos a serem registrados e/ou Número de bytes de conteúdo a serem registrados.
Solicitação de back-end		Especifica se e como as solicitações de back-end (solicitações de saída do gateway do Gerenciamento de API) são registradas. Se essa configuração estiver habilitada, especifique Cabeçalhos a serem registrados e/ou Número de bytes de conteúdo a serem registrados.
Resposta de back-end		Especifica se e como as respostas de back-end (respostas de entrada do gateway do Gerenciamento de API) são registradas. Se essa configuração estiver habilitada, especifique Cabeçalhos a serem registrados e/ou Número de bytes de conteúdo a serem registrados.

Importante

Se habilitado, os conteúdos de solicitação ou resposta registrados podem ter até 8.192 bytes. O Gerenciamento de API também impõe um limite de 32 KB para uma entrada de log de diagnóstico enviada ao Azure Monitor, que inclui os conteúdos e outros atributos, como códigos de status, cabeçalhos e carimbos de data/hora. Se o tamanho combinado dos atributos exceder 32 KB, o Gerenciamento de API cortará a entrada removendo todo o corpo e o conteúdo do rastreamento.

Próximas etapas

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