Questa pagina si applica a Apigee e Apigee ibridi.
Visualizza
documentazione di Apigee Edge.
Panoramica
Il criterio Trace Capture consente di aggiungere altre variabili al runtime Apigee
traccia dei dati. Se hai abilitato il tracciamento distribuito per il runtime Apigee,
il runtime traccia per impostazione predefinita un insieme di variabili predefinite. Per ulteriori informazioni, vedi
Variabili di traccia predefinite nel report di tracciamento.
Se invece vuoi che il runtime Apigee tenga traccia di flussi, criteri o variabili personalizzate aggiuntivi, utilizza Trace Capture
. Puoi utilizzare questo criterio nel flusso di richiesta o di risposta. Nei tuoi asset distribuiti
di tracciamento, puoi visualizzare le variabili aggiunte dal criterio Trace Capture
nell'intervallo TraceCaptureExecution.
Questo criterio è una norma estendibile e il suo utilizzo potrebbe comportare costi o di utilizzo delle applicazioni, a seconda della licenza Apigee. Per informazioni sui tipi di norme e le implicazioni per l'utilizzo, consulta Tipi di criteri.
<TraceCapture>
Definisce il criterio Trace Capture.
| Valore predefinito | N/D |
| Obbligatorio? | Obbligatorio |
| Tipo | Tipo complesso |
| Elemento principale | N/D |
| Elementi secondari |
<DisplayName><IgnoreUnresolvedVariables><ThrowExceptionOnLimit><Variables> |
L'elemento <TraceCapture> utilizza la seguente sintassi:
Sintassi
<?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>
Esempio
L'esempio seguente mostra la definizione del criterio Trace Capture:
<?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>
Questo elemento ha i seguenti attributi comuni a tutti i criteri:
| Attributo | Predefinito | Obbligatorio? | Descrizione |
|---|---|---|---|
name |
N/A | Obbligatorio |
Il nome interno del criterio. Il valore dell'attributo Facoltativamente, utilizza l'elemento |
continueOnError |
falso | Facoltativo | Imposta su false per restituire un errore in caso di errore del criterio. Questo è un comportamento previsto per
la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un errore nel criterio. Vedi anche:
|
enabled |
true | Facoltativo | Imposta su true per applicare il criterio. Imposta su false per disattivare il
criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso. |
async |
falso | Deprecato | Questo attributo è stato ritirato. |
La seguente tabella fornisce una descrizione generale degli elementi secondari di <TraceCapture>:
| Elemento secondario | Obbligatorio? | Descrizione |
|---|---|---|
<DisplayName> |
Facoltativo | Specifica un nome personalizzato per la norma. |
<Variables> |
Facoltativo | Specifica l'elenco di variabili da tracciare. |
<IgnoreUnresolvedVariables> |
Facoltativo | Specifica se l'elaborazione si interrompe quando viene rilevata una variabile non risolta. |
<ThrowExceptionOnLimit> |
Facoltativo | Specifica se una variabile deve essere troncata se le sue dimensioni superano il limite di 256 byte. |
| Altri elementi secondari | ||
<MergeBehavior> |
Facoltativo | Specifica il comportamento di unione per i messaggi di risposta. |
Riferimento elemento secondario
In questa sezione vengono descritti gli elementi secondari di<TraceCapture>.
<DisplayName>
Da utilizzare in aggiunta all'attributo name per etichettare il criterio in
editor proxy UI di gestione con un nome diverso e più naturale.
L'elemento <DisplayName> è comune a tutti i criteri.
| Valore predefinito | N/D |
| Obbligatorio? | Facoltativo. Se ometti <DisplayName>, il valore del valore
viene utilizzato l'attributo name del criterio. |
| Tipo | Stringa |
| Elemento principale | <PolicyElement> |
| Elementi secondari | Nessuno |
L'elemento <DisplayName> utilizza la seguente sintassi:
Sintassi
<PolicyElement> <DisplayName>POLICY_DISPLAY_NAME</DisplayName> ... </PolicyElement>
Esempio
<PolicyElement> <DisplayName>My Validation Policy</DisplayName> </PolicyElement>
L'elemento <DisplayName> non ha attributi o elementi secondari.
<Variables>
Specifica l'elenco di variabili da tracciare.
| Valore predefinito | N/D |
| Obbligatorio? | Obbligatorio |
| Tipo | Tipo complesso |
| Elemento principale |
<TraceCapture> |
| Elementi secondari |
<Variable> |
L'elemento <Variables> utilizza la seguente sintassi:
Sintassi
<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>
Esempio
L'esempio seguente traccia le variabili di flusso 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>
Specifica le variabili da aggiungere nei dati di traccia.
| Valore predefinito | N/D |
| Obbligatorio? | Obbligatorio |
| Tipo | Tipo complesso |
| Elemento principale |
<Variables> |
| Elementi secondari | Nessuno |
L'elemento <Variable> utilizza la seguente sintassi:
Sintassi
<Variable name="TRACE_VARIABLE_NAME" ref="FLOW_VARIABLE_NAME">DEFAULT_VALUE</Variable>
Esempio
L'esempio seguente imposta la variabile di traccia trace-variable-1 su
valore della variabile di flusso flow-variable-1:
<Variable name="trace-variable-1" ref="flow-variable-1">default-val-1</Variable>
Se la variabile di flusso flow-variable-1 non è disponibile,
Il valore predefinito di default-val-1 è trace-variable-1.
Nella tabella seguente vengono descritti gli attributi di <Variable>:
| Attributo | Obbligatorio? | Tipo | Descrizione |
|---|---|---|---|
name |
Obbligatorio | Stringa | Un nome che fa riferimento ai dati raccolti per la variabile specificata. Questo nome sarà visibili nel report di tracciamento distribuito. |
ref |
Obbligatorio | Stringa | La variabile per la quale stai raccogliendo i dati di traccia. Questa variabile può essere un flusso variabile predefinita da Apigee o da una variabile personalizzata nel proxy API. |
<IgnoreUnresolvedVariables>
Determina se l'elaborazione si interrompe quando viene rilevata una variabile non risolta.
| Valore predefinito | N/D |
| Obbligatorio? | Facoltativo |
| Tipo | Booleano |
| Elemento principale |
<TraceCapture> |
| Elementi secondari | Nessuno |
Imposta su true per ignorare le variabili non risolte e continuare l'elaborazione. altrimenti false. La
il valore predefinito è true.
L'impostazione di <IgnoreUnresolvedVariables> su true è diversa dall'impostazione di <TraceCapture>
Da continueOnError a true. Se imposti continueOnError su true, Apigee ignora tutti gli errori, non
solo gli errori nelle variabili.
L'elemento <IgnoreUnresolvedVariables> utilizza la seguente sintassi:
Sintassi
<IgnoreUnresolvedVariables>BOOLEAN_VALUE</IgnoreUnresolvedVariables>
Esempio
L'esempio seguente imposta <IgnoreUnresolvedVariables> su false:
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<ThrowExceptionOnLimit>
Specifica il comportamento del criterio quando le dimensioni della variabile superano il limite di 256 byte.
- Se impostato su
true, il criterio genera un errore se la dimensione di una variabile supera il limite. - Se impostato su
false, il criterio tronca la variabile che supera il limite. La viene troncata alla dimensione del limite.
| Valore predefinito | N/D |
| Obbligatorio? | Facoltativo |
| Tipo | Booleano |
| Elemento principale |
<TraceCapture> |
| Elementi secondari | Nessuno |
L'elemento <ThrowExceptionOnLimit> utilizza la seguente sintassi:
Sintassi
<ThrowExceptionOnLimit>BOOLEAN_VALUE</ThrowExceptionOnLimit>
Esempio
Nell'esempio seguente, il valore <ThrowExceptionOnLimit>true.
<ThrowExceptionOnLimit>false</ThrowExceptionOnLimit>
Codici di errore
Questa sezione descrive i codici e i messaggi di errore restituiti, nonché le variabili di errore impostate da Apigee quando questo criterio attiva un errore. È importante sapere se stai sviluppando regole di errore per per gestire gli errori. Per saperne di più, consulta Cosa devi sapere sugli errori relativi ai criteri e sulla gestione di errore.
Errori di runtime
Questi errori possono verificarsi quando il criterio viene eseguito.
| Codice di errore | Stato HTTP | Causa |
|---|---|---|
steps.tracecapture.UnresolvedVariable |
500 |
Questo errore si verifica se una variabile specificata nel criterio Trace Capture è:
|
steps.tracecapture.VariableValueLimitExceeded |
500 |
Questo errore si verifica se l'elemento |
Variabili di errore
Ogni volta che si verificano errori di esecuzione in un criterio, Apigee genera messaggi di errore. Puoi visualizzare questi messaggi nella risposta. Molto spesso i messaggi di errore generati dal sistema potrebbero non essere pertinenti nel contesto del prodotto. Ti consigliamo di personalizzare i messaggi di errore in base alle tipo di errore per rendere i messaggi più significativi.
Per personalizzare i messaggi di errore, puoi utilizzare le regole di errore o il criterio RaiseFault. Per
informazioni sulle differenze tra le regole di errore e il criterio RaiseFault, vedi
FaultRules e il criterio RaiseFault.
Devi verificare le condizioni utilizzando l'elemento Condition sia nelle regole di errore sia nel criterio RaiseFault.
Apigee fornisce variabili di errore univoche per ciascun criterio e i valori delle variabili di errore vengono impostati quando un criterio attiva errori di runtime.
Utilizzando queste variabili, puoi verificare la presenza di condizioni di errore specifiche e intraprendere le azioni appropriate. Per ulteriori informazioni sulla verifica dell'errore
, consulta Condizioni di creazione.
La tabella seguente descrive le variabili di errore specifiche di questo criterio.
| Variabili | Dove | Esempio |
|---|---|---|
fault.name |
fault.name può corrispondere a tutti gli errori elencati nella tabella Errori di runtime.
Il nome dell'errore è l'ultima parte del codice di errore. |
fault.name Matches "UnresolvedVariable" |
tracecapture.POLICY_NAME.failed |
POLICY_NAME è il nome specificato dall'utente del criterio che ha generato l'errore. | tracecapture.trace-capture-1.failed = true |