Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
Vista geral
A política TraceCapture permite-lhe adicionar variáveis adicionais aos dados de rastreio do tempo de execução do Apigee. Se ativou o rastreio distribuído para o tempo de execução do Apigee, o tempo de execução, por predefinição, rastreia um conjunto de variáveis predefinidas. Para mais informações, consulte o artigo
Variáveis de rastreio predefinidas no relatório de rastreio.
No entanto, se quiser que o tempo de execução do Apigee rastreie variáveis de fluxo, políticas ou personalizadas adicionais, use a política TraceCapture. Pode usar esta política no fluxo de pedido ou de resposta. No relatório de rastreio distribuído, pode ver as variáveis adicionadas pela política TraceCapture no intervalo TraceCaptureExecution.
Esta política é uma política extensível e a utilização desta política pode ter implicações de custo ou utilização, consoante a sua licença do Apigee. Para ver informações sobre os tipos de políticas e as implicações de utilização, consulte Tipos de políticas.
<TraceCapture>
Define a política TraceCapture.
| Valor predefinido | N/A |
| Obrigatório? | Obrigatória |
| Tipo | Tipo complexo |
| Elemento principal | N/A |
| Elementos subordinados |
<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 seguinte 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 | Predefinição | Obrigatório? | Descrição |
|---|---|---|---|
name |
N/A | Obrigatório |
O nome interno da política. O valor do atributo Opcionalmente, use o elemento |
continueOnError |
falso | Opcional | Definido como false para devolver um erro quando uma política falha. Este comportamento é o esperado para a maioria das políticas. Definido como true para que a execução do fluxo continue mesmo depois de uma política falhar. Veja também:
|
enabled |
verdadeiro | Opcional | Defina como true para aplicar a política. Defina como false para desativar a política. A política não é aplicada, mesmo que permaneça anexada a um fluxo. |
async |
falso | Descontinuado | Este atributo foi descontinuado. |
A tabela seguinte fornece uma descrição geral dos elementos subordinados de <TraceCapture>:
| Elemento secundário | Obrigatório? | Descrição |
|---|---|---|
<DisplayName> |
Opcional | Especifica um nome personalizado para a política. |
<Variables> |
Opcional | Especifica a lista de variáveis a rastrear. |
<IgnoreUnresolvedVariables> |
Opcional | Especifica se o processamento é interrompido quando é encontrada uma variável não resolvida. |
<ThrowExceptionOnLimit> |
Opcional | Especifica se uma variável tem de ser truncada se o tamanho da variável exceder o limite de 256 bytes. |
| Outros elementos secundários | ||
<MergeBehavior> |
Opcional | Especifica o comportamento de união das mensagens de resposta. |
Referência de elemento secundário
Esta secção descreve os elementos subordinados de<TraceCapture>.
<DisplayName>
Use em conjunto com o atributo name para etiquetar a política no editor de proxy da IU de gestão com um nome diferente e mais natural.
O elemento <DisplayName> é comum a todas as políticas.
| Valor predefinido | N/A |
| Obrigatório? | Opcional. Se omitir <DisplayName>, é usado o valor do atributo name da política. |
| Tipo | String |
| Elemento principal | <PolicyElement> |
| Elementos subordinados | 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 nem elementos subordinados.
<Variables>
Especifica a lista de variáveis a rastrear.
| Valor predefinido | N/A |
| Obrigatório? | Obrigatória |
| Tipo | Tipo complexo |
| Elemento principal |
<TraceCapture> |
| Elementos subordinados |
<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 seguinte 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>
<Variable>
Especifica as variáveis a adicionar aos dados de rastreio.
| Valor predefinido | N/A |
| Obrigatório? | Obrigatória |
| Tipo | Tipo complexo |
| Elemento principal |
<Variables> |
| Elementos subordinados | Nenhum |
O elemento <Variable> usa a seguinte sintaxe:
Sintaxe
<Variable name="TRACE_VARIABLE_NAME" ref="FLOW_VARIABLE_NAME">DEFAULT_VALUE</Variable>
Exemplo
O exemplo seguinte define a variável de rastreio 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 é definida como o valor predefinido default-val-1.
A tabela seguinte descreve os atributos de <Variable>:
| Atributo | Obrigatório? | Tipo | Descrição |
|---|---|---|---|
name |
Obrigatória | String | Um nome para referenciar os dados recolhidos para a variável especificada. Este nome vai ser visível no seu relatório de rastreio distribuído. |
ref |
Obrigatória | String | A variável para a qual está a recolher os dados de rastreio. Esta variável pode ser uma variável de fluxo predefinida pela Apigee ou uma variável personalizada no seu proxy de API. |
<IgnoreUnresolvedVariables>
Determina se o processamento é interrompido quando é encontrada uma variável não resolvida.
| Valor predefinido | N/A |
| Obrigatório? | Opcional |
| Tipo | Booleano |
| Elemento principal |
<TraceCapture> |
| Elementos subordinados | Nenhum |
Definido como true para ignorar as variáveis não resolvidas e continuar o processamento; caso contrário, false. O valor predefinido é true.
Definir <IgnoreUnresolvedVariables> como true é diferente de definir o <TraceCapture> de
continueOnError como true. Se definir continueOnError como true, o Apigee ignora todos os erros, não apenas os erros nas variáveis.
O elemento <IgnoreUnresolvedVariables> usa a seguinte sintaxe:
Sintaxe
<IgnoreUnresolvedVariables>BOOLEAN_VALUE</IgnoreUnresolvedVariables>
Exemplo
O exemplo seguinte define <IgnoreUnresolvedVariables> como false:
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<ThrowExceptionOnLimit>
Especifica o comportamento da política quando o tamanho da variável excede o limite de 256 bytes.
- Se estiver definido como
true, a política gera um erro se o tamanho de uma variável exceder o limite. - Se estiver definida como
false, a política trunca a variável que excede o limite. A variável é truncada até ao tamanho do limite.
| Valor predefinido | N/A |
| Obrigatório? | Opcional |
| Tipo | Booleano |
| Elemento principal |
<TraceCapture> |
| Elementos subordinados | Nenhum |
O elemento <ThrowExceptionOnLimit> usa a seguinte sintaxe:
Sintaxe
<ThrowExceptionOnLimit>BOOLEAN_VALUE</ThrowExceptionOnLimit>
Exemplo
O exemplo seguinte define o valor <ThrowExceptionOnLimit>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:
|
steps.tracecapture.VariableValueLimitExceeded |
500 |
Este erro ocorre se o elemento |
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 |