Rastreio

  • Artigo

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

A trace política 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 é acionado, ou seja, Ocp-Apim-Trace o cabeçalho da solicitação está presente e definido como true e Ocp-Apim-Subscription-Key o cabeçalho da solicitação 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 do 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 são habilitados e o nível de gravidade especificado na política é igual ou superior ao nível de detalhamento 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

  • Permita o rastreio apenas em subscrições destinadas a fins de depuração. A partilha de chaves de subscrições com o rastreio permitido com utilizadores não autorizados pode levar à divulgação de informações confidenciais contidas nos relatórios de monitorização, como chaves, tokens de acesso, palavra-passe, nomes de anfitrião internos e endereços IP.
  • No console de teste, o Gerenciamento de API desativa automaticamente o rastreamento 1 hora após sua habilitação em uma assinatura.

Nota

Atualmente, o rastreamento de solicitações de API não é suportado nas camadas Basic v2 e Standard v2.

Nota

Defina os elementos da política e os elementos filho na ordem fornecida na declaração de política. Saiba mais sobre como definir ou editar 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 Description Necessário Predefinição
origem String literal significativa para o visualizador de rastreamento e especificando a origem da mensagem. Expressões de política não são permitidas. Sim N/A
gravidade Especifica o nível de severidade do rastreamento. Os valores permitidos são verbose, information, error (do mais baixo para o mais alto). Expressões de política não são permitidas. Não verbose

Elementos

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

atributos de metadados

Atributo Description Necessário Predefinição
nome Nome do imóvel. Sim N/A
valor Valor do imóvel. Sim N/A

Utilização

Exemplo

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

Conteúdos relacionados

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