Política de TraceCapture

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Pré-lançamento

Este produto ou recurso está sujeito aos "Termos das Soluções Pré-GA" na seção Termos Gerais de Serviço dos Termos Específicos de Serviço. Os produtos e recursos pré-GA estão disponíveis no estado em que se encontram e podem ter assistência limitada. Para mais informações, consulte as descrições das fases de lançamento.

A política TraceCapture permite adicionar mais variáveis aos dados de trace do ambiente de execução da Apigee. Se você tiver ativado o rastreamento distribuído para o ambiente de execução da Apigee, o ambiente de execução, por padrão, rastreará um conjunto de variáveis predefinidas. Saiba mais em Variáveis de trace padrão no relatório de rastreamento. No entanto, se você quiser que o ambiente de execução da Apigee rastreie outros fluxos, políticas ou variáveis personalizadas, use a política TraceCapture. Use essa política no fluxo de solicitação ou de resposta. No relatório de rastreamento distribuído, você pode ver as variáveis adicionadas pela política TraceCapture no período TraceCaptureExecution.

Esta é uma política extensível. O uso dela pode ter implicações no custo ou na utilização, dependendo da sua licença da Apigee. Para informações sobre tipos de política e implicações de uso, consulte Tipos de política.

<TraceCapture>

Define a política TraceCapture.

Valor padrão	N/A
Obrigatório?	Obrigatório
Tipo	Tipo complexo
Elemento pai	N/A
Elemento filho	<DisplayName> <IgnoreUnresolvedVariables> <ThrowExceptionOnLimit> <Variables>

O elemento <TraceCapture> usa a seguinte sintaxe:

Sintaxe

<?xml version="1.0" encoding="UTF-8"?>
<TraceCapture continueOnError="true" enabled="true" name="DistributedTraceCapture-1">
    <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
    <Variables>
        <Variable name="TRACE_VARIABLE_NAME" ref="FLOW_VARIABLE_NAME">DEFAULT_VALUE</Variable>
        <Variable name="TRACE_VARIABLE_NAME" ref="FLOW_VARIABLE_NAME">DEFAULT_VALUE</Variable>
    </Variables>
    <IgnoreUnresolvedVariables>BOOLEAN_VALUE</IgnoreUnresolvedVariables>
    <ThrowExceptionOnLimit>BOOLEAN_VALUE</ThrowExceptionOnLimit>
</TraceCapture>

Exemplo

O exemplo a seguir mostra a definição da política TraceCapture:

<?xml version="1.0" encoding="UTF-8"?>
<TraceCapture continueOnError="true" enabled="true" name="DistributedTraceCapture-1">
    <DisplayName>Distributed-Trace-Capture-Policy-1</DisplayName>
    <Variables>
        <Variable name="trace-variable-1" ref="flow-variable-1">default-val-1</Variable>
        <Variable name="trace-variable-2" ref="flow-variable-2">default-val-2</Variable>
    </Variables>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <ThrowExceptionOnLimit>false</ThrowExceptionOnLimit>
</TraceCapture>

Este elemento tem os seguintes atributos comuns a todas as políticas:

Atributo	Padrão	Obrigatório?	Descrição
name	N/A	Valor	O nome interno da política. O valor do atributo name pode conter letras, números, espaços, hifens, sublinhados e pontos. Esse valor não pode exceder 255 caracteres. Opcionalmente, use o elemento <DisplayName> para rotular a política no editor de proxy da IU de gerenciamento com um nome de linguagem natural diferente.
continueOnError	falso	Opcional	Defina como false para retornar um erro quando uma política falhar. Esse é o comportamento esperado para a maioria das políticas. Defina como true para que a execução do fluxo continue, mesmo depois que uma política falhar. Consulte também: As regras de falha são acionadas SOMENTE em um estado de erro (sobre continueOnError) Como corrigir falhas no fluxo atual
enabled	true	Opcional	Defina como true para aplicar a política. Defina como false para desativar a política. A política não será aplicada mesmo que permaneça vinculada a um fluxo.
async	falso	Obsoleto	Esse atributo está obsoleto.

A tabela a seguir fornece uma descrição de alto nível dos elementos-filhos de <TraceCapture>:

Elemento filho	Obrigatório?	Descrição
<DisplayName>	Opcional	Especifica um nome personalizado para a política.
<Variables>	Opcional	Especifica a lista de variáveis a serem rastreadas.
<IgnoreUnresolvedVariables>	Opcional	Determina se o processamento é interrompido quando uma variável não resolvida é encontrada.
<ThrowExceptionOnLimit>	Opcional	Especifica se uma variável precisa ser truncada se o tamanho dela exceder o limite de 256 bytes.
Outros elementos filhos
<MergeBehavior>	Opcional	Especifica o comportamento de mesclagem para as mensagens de resposta.

Referência a elementos filhos

Esta seção descreve os elementos filhos de <TraceCapture>.

<DisplayName>

Use além do atributo name para rotular a política no editor de proxy da IU de gerenciamento com um nome de som diferente e mais natural.

O elemento <DisplayName> é comum a todas as políticas.

Valor padrão	N/A
Obrigatório?	Opcional. Se você omitir <DisplayName>, o valor do atributo name da política será usado
Tipo	String
Elemento pai	<PolicyElement>
Elemento filho	Nenhum

O elemento <DisplayName> usa a seguinte sintaxe:

Sintaxe

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

Exemplo

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

O elemento <DisplayName> não tem atributos ou elementos filhos.

<Variables>

Especifica a lista de variáveis a serem rastreadas.

Valor padrão	N/A
Obrigatório?	Obrigatório
Tipo	Tipo complexo
Elemento pai	<TraceCapture>
Elemento filho	<Variable>

O elemento <Variables> usa a seguinte sintaxe:

Sintaxe

<Variables>
    <Variable name="TRACE_VARIABLE_NAME" ref="FLOW_VARIABLE_NAME">DEFAULT_VALUE</Variable>
    <Variable name="TRACE_VARIABLE_NAME" ref="FLOW_VARIABLE_NAME">DEFAULT_VALUE</Variable>
</Variables>

Exemplo

O exemplo a seguir rastreia as variáveis de fluxo flow-variable-1 e flow-variable-2:

<Variables>
    <Variable name="trace-variable-1" ref="flow-variable-1">default-val-1</Variable>
    <Variable name="trace-variable-2" ref="flow-variable-2">default-val-2</Variable>
</Variables>

Observação:

• Não é possível rastrear as variáveis private e policy.secret.
• A Apigee recomenda configurar no máximo 15 variáveis para o Cloud Trace e no máximo 25 para o Jaeger.

<Variable>

Especifica as variáveis a serem adicionadas aos dados de trace.

Valor padrão	N/A
Obrigatório?	Obrigatório
Tipo	Tipo complexo
Elemento pai	<Variables>
Elemento filho	Nenhum

O elemento <Variable> usa a seguinte sintaxe:

Sintaxe

<Variable name="TRACE_VARIABLE_NAME" ref="FLOW_VARIABLE_NAME">DEFAULT_VALUE</Variable>

Exemplo

No exemplo a seguir, definimos a variável de trace trace-variable-1 para o valor da variável de fluxo flow-variable-1:

<Variable name="trace-variable-1" ref="flow-variable-1">default-val-1</Variable>

Se a variável de fluxo flow-variable-1 não estiver disponível, trace-variable-1 será definido como o valor padrão default-val-1.

A tabela a seguir descreve os atributos de <Variable>:

Atributo	Obrigatório?	Tipo	Descrição
name	Obrigatório	String	Um nome para fazer referência aos dados coletados para a variável especificada. Esse nome ficará visível no relatório de rastreamento distribuído.
ref	Obrigatório	String	A variável em que você está coletando os dados de trace. Essa variável pode ser uma variável de fluxo predefinida pela Apigee ou uma variável personalizada no proxy da API.

Observação: é possível especificar um valor padrão opcional para uma variável. Se a variável especificada em ref não for definida em uma solicitação ou resposta, os dados do trace terão o valor padrão para a variável.

<IgnoreUnresolvedVariables>

Determina se o processamento é interrompido quando uma variável não resolvida é encontrada.

Valor padrão	N/A
Obrigatório?	Opcional
Tipo	Booleano
Elemento pai	<TraceCapture>
Elemento filho	Nenhum

Defina como true para ignorar variáveis não resolvidas e continuar o processamento. Caso contrário, false. O valor padrão é true.

Definir <IgnoreUnresolvedVariables> como true é diferente de definir o continueOnError do <TraceCapture> como true. Se você definir continueOnError como true, a Apigee vai ignorar todos os erros, e não apenas os erros nas variáveis.

O elemento <IgnoreUnresolvedVariables> usa a seguinte sintaxe:

Sintaxe

<IgnoreUnresolvedVariables>BOOLEAN_VALUE</IgnoreUnresolvedVariables>

Exemplo

O exemplo a seguir define <IgnoreUnresolvedVariables> como false:

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

Observação: o valor padrão do elemento é false.

<ThrowExceptionOnLimit>

Especifica o comportamento da política quando o tamanho da variável excede o limite de 256 bytes.

• Se definida como true, a política vai gerar um erro se um tamanho de variável exceder o limite.
• Se definida como false, a política vai truncar a variável que excede o limite. A variável é truncada para o tamanho do limite.

Observação: o valor padrão do elemento é false.

Valor padrão	N/A
Obrigatório?	Opcional
Tipo	Booleano
Elemento pai	<TraceCapture>
Elemento filho	Nenhum

O elemento <ThrowExceptionOnLimit> usa a seguinte sintaxe:

Sintaxe

<ThrowExceptionOnLimit>BOOLEAN_VALUE</ThrowExceptionOnLimit>

Exemplo

O exemplo a seguir define a <ThrowExceptionOnLimit> como true:

<ThrowExceptionOnLimit>false</ThrowExceptionOnLimit>

Códigos de erro

Esta secção descreve os códigos de falha e as mensagens de erro devolvidas, bem como as variáveis de falha definidas pelo Apigee quando esta política aciona um erro. Estas informações são importantes para saber se está a desenvolver regras de falhas para tratar falhas. Para saber mais, consulte o artigo O que precisa de saber acerca dos erros de políticas e o artigo Processamento de falhas.

Erros de tempo de execução

Estes erros podem ocorrer quando a política é executada.

Código de falha	Estado de HTTP	Causa
steps.tracecapture.UnresolvedVariable	500	Este erro ocorre se uma variável especificada na política TraceCapture for: Fora do âmbito (não disponível no fluxo específico onde a política está a ser executada) ou Não é possível resolver (não está definido)
steps.tracecapture.VariableValueLimitExceeded	500	Este erro ocorre se o elemento <ThrowExceptionOnLimit> estiver definido como true e o tamanho de qualquer variável exceder 256 bytes.

Variáveis de falha

Sempre que existem erros de execução numa política, o Apigee gera mensagens de erro. Pode ver estas mensagens de erro na resposta de erro. Muitas vezes, as mensagens de erro geradas pelo sistema podem não ser relevantes no contexto do seu produto. Pode personalizar as mensagens de erro com base no tipo de erro para tornar as mensagens mais significativas.

Para personalizar as mensagens de erro, pode usar regras de falhas ou a política RaiseFault. Para informações sobre as diferenças entre as regras de falhas e a política RaiseFault, consulte Regras de falhas vs. a política RaiseFault. Tem de verificar as condições através do elemento Condition nas regras de falhas e na política RaiseFault. O Apigee fornece variáveis de falhas exclusivas para cada política, e os valores das variáveis de falhas são definidos quando uma política aciona erros de tempo de execução. Ao usar estas variáveis, pode verificar condições de erro específicas e tomar as medidas adequadas. Para mais informações sobre a verificação das condições de erro, consulte o artigo Criar condições.

A tabela seguinte descreve as variáveis de falha específicas desta política.

Variáveis	Onde	Exemplo
fault.name	O fault.name pode corresponder a qualquer uma das falhas indicadas na tabela Erros de tempo de execução. O nome da falha é a última parte do código de falha.	fault.name Matches "UnresolvedVariable"
tracecapture.POLICY_NAME.failed	POLICY_NAME é o nome especificado pelo utilizador da política que gerou a falha.	tracecapture.trace-capture-1.failed = true

Para mais informações sobre erros de políticas, consulte o artigo O que precisa de saber sobre erros de políticas.