Compartilhar via

Trace

  • Artigo

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

A política trace adiciona um rastreamento personalizado à saída de rastreamento de solicitação no console de teste, telemetrias do Application Insights e/ou logs de recursos.

  • A política adiciona um rastreamento personalizado à saída de rastreamento de solicitação no console de teste quando o rastreamento é disparado.
  • A política cria uma telemetria de Rastreamento no Application insights, quando a integração do Application Insights está habilitada e o severity especificado na política é igual ou maior que o verbosity especificado na configuração de diagnóstico.
  • A política adiciona uma propriedade na entrada de log quando os logs de recursos estão habilitados e o nível de severidade especificado na política é igual ou superior ao nível de detalhes especificado na configuração de diagnóstico.
  • A política não é afetada pela amostragem do Application Insights. Todas as invocações da política serão registradas.

Importante

  • O Gerenciamento de API não dá mais suporte a assinaturas para rastreamento ou ao cabeçalho Ocp-Apim-Trace.
  • Para melhorar a segurança da API, o rastreamento agora pode ser habilitado no nível de uma API individual obtendo um token com limite de tempo usando a API REST do Gerenciamento de API e passando o token em uma solicitação para o gateway. Para obter detalhes, confira Habilitar o rastreamento de uma API.
  • Tome cuidado ao habilitar o rastreamento, pois ele pode expor informações confidenciais nos dados de rastreamento. Verifique se você tem as medidas de segurança apropriadas em vigor para proteger os dados de rastreamento.

Observação

Defina os elementos da política e os elementos filho na ordem fornecida na declaração da política. Saiba mais sobre como definir e editar as políticas de Gerenciamento de API.

Declaração de política

<trace source="arbitrary string literal" severity="verbose | information | error">
    <message>String literal or expressions</message>
    <metadata name="string literal or expressions" value="string literal or expressions"/>
</trace>

Atributos

Atributo Descrição Obrigatório Padrão
source Literal de cadeia de caracteres significativo para o visualizador de rastreamento e especificando a fonte da mensagem. Expressões de política não são permitidas. Sim N/D
severidade Especifica o nível de gravidade do rastreamento. Os valores permitidos são verbose, information, error (do mais baixo ao mais alto). Expressões de política não são permitidas. Não verbose

Elementos

Nome Descrição Obrigatório
message Uma cadeia de caracteres ou expressão a ser registrada. Expressões de política são permitidas. Sim
metadata Adiciona uma propriedade personalizada à telemetria de rastreamento do Application Insights. Não

Atributos de metadados

Atributo Descrição Obrigatório Padrão
name Nome da propriedade. Sim N/D
valor Valor da propriedade. Sim N/D

Uso

Exemplo

<trace source="PetStore API" severity="verbose">
    <message>@((string)context.Variables["clientConnectionID"])</message>
    <metadata name="Operation Name" value="New-Order"/>
</trace>

Conteúdo relacionado

Para obter mais informações sobre como trabalhar com políticas, consulte: