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 do rastreamento de solicitação no console de teste quando o rastreamento é disparado, ou seja, o cabeçalho da solicitação Ocp-Apim-Trace está presente e definido como true e o cabeçalho da solicitação Ocp-Apim-Subscription-Key está presente e contém uma chave válida que permite o rastreamento.
  • 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.

Aviso

  • Permitir apenas o rastreamento em assinaturas destinadas a fins de depuração. O compartilhamento de chaves de assinatura com rastreamento permitido com usuários não autorizados poderia levar à divulgação de informações confidenciais contidas nos logs de rastreamento, tais como chaves, tokens de acesso, senhas, nomes de hosts internos e endereços IP.
  • No console de teste, o Gerenciamento de API desabilita automaticamente o rastreamento 1 hora depois de habilitado em uma assinatura.

Observação

Atualmente, não há suporte para rastreamento de solicitação de API nas camadas Básica v2 e Standard v2.

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: