Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di
Apigee Edge.
Questa sezione descrive come creare e gestire le sessioni di debug e visualizzare i dati di richiesta e risposta utilizzando l'API e l'interfaccia utente di Apigee.
Utilizza il debug offline per visualizzare e analizzare le sessioni di debug scaricate in precedenza.
Creazione di una sessione di debug
Quando crei una sessione di debug, puoi visualizzare i dati di richiesta e risposta nell'interfaccia utente per le richieste create nell'API o in un'altra origine esterna.
Crea una sessione di debug utilizzando l'API o l'interfaccia utente di Apigee, come descritto nelle sezioni seguenti.
Nuovo editor proxy
Per creare una sessione di debug nel nuovo editor proxy:
Se utilizzi l'interfaccia utente di Apigee nella console Cloud: seleziona Sviluppo proxy > Proxy API.
Se utilizzi la UI Apigee classica: seleziona Sviluppa > Proxy API e nel riquadro Proxy, seleziona l'ambiente per il proxy da eseguire il debug.
Seleziona il proxy API che vuoi eseguire il debug. Viene visualizzata la visualizzazione Panoramica dell'editor proxy.
- Fai clic sulla scheda Debug in alto a sinistra nella finestra.
- Fai clic su Avvia sessione di debug in alto a destra nel riquadro Debug. Viene visualizzata la finestra di dialogo Avvia sessione di debug.
Nella finestra di dialogo:
- Seleziona l'ambiente in cui vuoi eseguire la sessione di debug.
- (Facoltativo) Nell'elenco a discesa Filtro, seleziona un filtro da applicare a tutte le transazioni nella sessione di debug che stai creando.
Il valore predefinito è
None (All transactions), che include tutte le transazioni nei dati di debug.Per informazioni sull'utilizzo dei filtri, vedi Utilizzare i filtri in una sessione di debug. Per informazioni sui filtri integrati, consulta Utilizzare i filtri predefiniti.
- Fai clic su Avvia.
L'interfaccia utente di Apigee ora mostra la visualizzazione Sessione di debug in corso.
La sessione di debug registra le richieste per 10 minuti dopo la sua creazione. Il campo Termina entro mostra il tempo rimanente nella sessione.
Non verranno visualizzate informazioni nel riquadro di debug finché non invii una richiesta al proxy di cui stai eseguendo il debug nell'ambiente selezionato. per la sessione di debug.
Una volta inviata, la richiesta viene visualizzata nella parte inferiore del riquadro a sinistra.
Nota:durante una sessione di debug attiva, puoi avviarne un'altra nell'UI di Apigee. Per farlo, fai di nuovo clic su Avvia sessione di debug.
Visualizzazione del grafico di Gantt per una transazione
Per visualizzare i dettagli di una transazione (richiesta e risposta) nella visualizzazione di debug, fai clic sulla riga corrispondente alla transazione, come mostrato nell'immagine sopra.
Nel riquadro a destra viene visualizzato un grafico di Gantt che mostra i passaggi della richiesta e della risposta.
L'asse orizzontale del diagramma indica i tempi in cui si è verificato ogni passaggio, misurati in millisecondi. Ogni passaggio è rappresentato da un rettangolo che si estende dalla data e ora di inizio a quella di fine del passaggio.
Puoi eseguire la procedura passo passo di una sessione di debug utilizzando i pulsanti Indietro e Avanti in basso a destra nel riquadro di debug. Fai clic su:
- Indietro per spostare la riga selezionata al passaggio precedente del grafico.
- Avanti per spostare la riga selezionata al passaggio successivo del grafico.
Nell'esempio riportato sopra, il grafico mostra due criteri che vengono eseguiti nella risposta:
- ResponsePayload
- Aggiungere CORS
Puoi fare clic su uno di questi passaggi per visualizzarne i dettagli. Ad esempio, se fai clic sul criterio Aggiungi CORS, accanto al grafico di Gantt vengono visualizzati dettagli come quelli riportati di seguito.
Se poi decidi di modificare qualcosa nella configurazione delle norme, puoi fare clic su Sviluppa per passare alla visualizzazione Sviluppa, dove vedrai le stesse due norme nel flusso post-risposta.
Condividere una sessione di debug
Puoi condividere una sessione di debug con altri utenti che hanno accesso alla tua organizzazione e alle autorizzazioni necessarie. Per farlo, invia semplicemente l'URL visualizzato nel browser quando visualizzi la sessione di debug. Il link è valido solo per 24 ore dopo la creazione della sessione di debug.
Scaricare una sessione di debug
Al termine di una sessione di debug, puoi scaricarla per analizzarla in un secondo momento nello strumento Debug offline. Per farlo, fai clic su Scarica sessione nel riquadro a sinistra.
Tieni presente che una sessione di debug viene eliminata entro 24 ore dal momento in cui viene completata, quindi se vuoi visualizzarla dopo questo lasso di tempo, devi scaricarla prima.
Quando scarichi una sessione di debug, il nome del file di download ha il formato "debug-{session ID}.json", dove {session id} è l'ID della sessione di debug. Tuttavia, se vuoi, puoi rinominare il file.
Editor proxy classico
Per creare una sessione di debug nell'editor proxy classico:
- Accedi all'interfaccia utente di Apigee.
- Seleziona Proxy API dalla visualizzazione principale.
Seleziona il proxy API che vuoi eseguire il debug.
Viene visualizzata la scheda Panoramica.
- Fai clic sulla scheda Debug in alto a destra nella pagina:
Nella visualizzazione Debug vengono visualizzati:
- Nel riquadro Avvia una sessione di debug:
- Dall'elenco a discesa Env (Ambiente), seleziona l'ambiente e il numero di revisione del proxy API da eseguire il debug.
- (Facoltativo) Nell'elenco a discesa Filtro, seleziona un filtro da applicare a tutte le transazioni nella sessione di debug che stai creando.
Il valore predefinito è
None, che include tutte le transazioni nei dati di debug.Per informazioni sull'utilizzo dei filtri, vedi Utilizzare i filtri in una sessione di debug. Per informazioni sui filtri integrati, consulta Utilizzare i filtri predefiniti.
- Fai clic su Avvia sessione di debug.
L'interfaccia utente di Apigee ora mostra i dettagli della sessione di debug corrente, incluso il relativo ID, nel riquadro Dettagli di debug.
Anche se l'interfaccia utente ha creato la sessione di debug, devi comunque inviare la richiesta prima che siano disponibili dati da raccogliere.
Nel riquadro Dettagli di debug, puoi eseguire le seguenti operazioni:
Icona Funzione Descrizione 
Scarica Scarica i dati di debug della sessione attiva, che potrai poi visualizzare offline. 
Restituisci il dispositivo Torna al riquadro precedente, dove puoi avviare un'altra sessione di debug. La sessione di debug corrente continua fino a quando non raggiunge il timeout o il conteggio delle transazioni. 
Elimina Elimina i dati della sessione di debug attualmente selezionata. In questo modo vengono eliminati i dati della sessione, ma le sessioni non vengono interrotte. Esiste un limite di timeout predefinito di 10 minuti per una sessione di debug avviata nell'UI (è diverso per una sessione avviata con l'API).
Il timer inizia a funzionare non appena fai clic su Avvia sessione di debug, quindi puoi scegliere di attendere fino al passaggio successivo prima di fare clic su Avvia sessione di debug per massimizzare la quantità di dati raccolti.
L'esempio seguente mostra il riquadro Avvia una sessione di debug:
- Nel riquadro Invia richieste:
- Nel campo URL, inserisci l'endpoint a cui vuoi inviare una richiesta. Se vuoi, aggiungi i parametri della stringa di query all'URL. Non puoi inviare richieste
diverse da
GET.Come trovare l'URL dell'endpoint
- Vai ad Amministrazione > Ambienti > Gruppi.
- L'URL è il nome host del rispettivo ambiente in cui vuoi eseguire la sessione di debug.
- Fai clic su Invia.
Apigee invia una richiesta all'URL specificato. Ogni volta che fai clic su Invia, l'interfaccia utente di Apigee registra la richiesta nel riquadro Dettagli di debug.
L'esempio seguente mostra diverse richieste riuscite (che generano un codice di stato HTTP di
200):
Fai clic su Copia per copiare l'ID di debug per riferimento futuro o query.
Inoltre, l'interfaccia utente mostra i dati di debug nelle sezioni della mappa delle transazioni e dei dettagli della fase del riquadro Invia richieste e compila le sezioni Endpoint proxy, Intestazioni richiesta, Contenuto richiesta e Proprietà, come mostrato nell'esempio seguente:
Per ulteriori informazioni sulle fasi, sulla mappa delle transazioni e su altre sezioni della visualizzazione Invia richieste, consulta Come leggere un debug.
Il riquadro Invia richieste mostra solo i dati relativi alle richieste basate sull'interfaccia utente. Tieni presente, tuttavia, che il debug registra anche i dati per le richieste che non sono state avviate dall'interfaccia utente.
La sessione di debug è ora attiva e registra i dati relativi a tutte le richieste (a meno che non vengano escluse). La sessione rimarrà attiva fino al raggiungimento del timeout o al superamento del numero di richieste registrate nella sessione.
- Nel campo URL, inserisci l'endpoint a cui vuoi inviare una richiesta. Se vuoi, aggiungi i parametri della stringa di query all'URL. Non puoi inviare richieste
diverse da
- Puoi creare un numero illimitato di sessioni di debug nell'interfaccia utente. Per ulteriori informazioni, consulta Avvio di un'altra sessione di debug.
Avvio di un'altra sessione di debug nell'interfaccia utente
Durante una sessione di debug attiva, puoi avviarne un'altra nell'UI di Apigee. Per farlo, fai clic sull'icona a forma di freccia Indietro () nel riquadro Dettagli di debug:
L'interfaccia utente torna al riquadro Avvia una nuova sessione di debug, dove puoi avviare una nuova sessione di debug.
Quando termina una sessione di debug?
Non puoi semplicemente interrompere una sessione di debug attiva. Tuttavia, puoi eliminare i dati di una sessione attiva, come описано в Eliminare i dati della sessione di debug.
Quando crei una sessione di debug, due proprietà ne determinano la fine:
- timeout: il periodo di tempo per cui raccogli i dati durante una sessione. La durata predefinita dipende dal modo in cui hai avviato la sessione (tramite l'interfaccia utente o l'API). Il valore massimo è 600 secondi (o 10 minuti).
- count: il numero massimo di richieste registrate in una singola sessione per processore di messaggi. Poiché il numero di processori di messaggi nella maggior parte dei cluster è variabile, gli effetti del conteggio possono essere imprevedibili. Apigee non consiglia di personalizzare questa impostazione.
Quando viene raggiunto il timeout o il conteggio, la sessione di debug per il processore di messaggi termina.
I seguenti termini vengono utilizzati per descrivere lo stato di una sessione di debug:
- La sessione attiva è una sessione di debug che non ha ancora raggiunto il timeout o superato il conteggio. Una sessione attiva sta ancora registrando i dati delle richieste per le richieste che non vengono filtrate.
- sessione completata è una sessione di debug che ha raggiunto il timeout o superato il conteggio. Una sessione completata non registra più i dati sulle nuove richieste e i relativi dati vengono eliminati entro 24 ore dal termine della sessione.
Come leggere un debug
Lo strumento di debug è composto da due parti principali: la mappa delle transazioni e i dettagli della fase:
- La mappa delle transazioni utilizza icone per contrassegnare ogni passaggio importante che si verifica durante una transazione proxy API, inclusa l'esecuzione dei criteri, i passaggi condizionali e le transizioni. Passa il mouse sopra un'icona per visualizzare le informazioni di riepilogo. I passaggi del flusso di richiesta vengono visualizzati nella parte superiore della mappa delle transazioni e i passaggi del flusso di risposta nella parte inferiore.
- La sezione Dettagli fase dello strumento elenca informazioni sull'elaborazione interna del proxy, tra cui le variabili impostate o lette, le intestazioni di richiesta e risposta e molto altro ancora. Fai clic su un'icona per visualizzare i dettagli della fase per quel passaggio.
Di seguito è riportata una mappa di strumenti di debug di esempio con i segmenti di elaborazione del proxy principali etichettati:
Mappa delle transazioni dello strumento di debug
Legenda della mappa delle transazioni
La tabella seguente descrive lo scopo delle icone che vedrai nella mappa delle transazioni. Queste icone contrassegnano ciascuno dei passaggi di elaborazione più importanti nel flusso del proxy.
Icone della mappa delle transazioni
 |
L'app client che invia una richiesta a ProxyEndpoint del proxy API. |
 |
I cerchi indicano gli endpoint di transizione nel flusso del proxy. Sono presenti quando viene inviata una richiesta dal client, quando la richiesta viene inviata al target, quando la risposta viene restituita dal target e quando la risposta viene restituita al client. |
 |
Le barre alte indicano l'inizio di un segmento di flusso nel flusso del proxy API. I segmenti del flusso sono: richiesta ProxyEndpoint, richiesta TargetEndpoint, risposta TargetEndpoint e risposta ProxyEndpoint. Un segmento include PreFlow, Conditional Flows e PostFlow. Per ulteriori informazioni, consulta la sezione Configurazione dei flussi. |
 |
Indica che le azioni di Analytics si sono verificate in background. |
 |
Un flusso condizionale che restituisce true. Per un'introduzione ai flussi agevolati, consulta Configurare i flussi. Tieni presente che alcune condizioni sono generate da Apigee. Ad esempio, la seguente è un'espressione utilizzata da Apigee per verificare se si è verificato un errore in ProxyEndpoint: ((error.state equals PROXY_REQ_FLOW) or (error.state equals
PROXY_RESP_FLOW))
|
 |
Un flusso condizionale che restituisce false. Per un'introduzione ai flussi condizionali, consulta Configurare i flussi. Tieni presente che alcune condizioni sono generate da Apigee. Ad esempio, la seguente è un'espressione utilizzata da Apigee per verificare se si è verificato un errore in TargetEndpoint: (((error.state equals TARGET_REQ_FLOW) or (error.state equals
TARGET_RESP_FLOW)) or ((error.state equals REQ_SENT) or (error.state equals
RESP_START)))
|
|
|
Norme. Ogni tipo di criterio ha un'icona univoca. Questo è per il criterio AssignMessage. Queste icone ti consentono di vedere dove vengono eseguiti i criteri nell'ordine corretto e se l'esecuzione è andata a buon fine o meno. Puoi fare clic sull'icona di una norma per visualizzare i risultati della sua esecuzione e se sono previsti o meno. Ad esempio, puoi vedere se il messaggio è stato trasformato correttamente o se è memorizzato nella cache. I criteri eseguiti correttamente sono chiaramente indicati da segni di spunta. In caso di errore, sull'icona viene visualizzato un punto esclamativo rosso. |
 |
Il target di backend chiamato dal proxy API. |
 |
La linea del tempo indica il tempo (in millisecondi) necessario per completare l'elaborazione. Il confronto dei segmenti di tempo trascorso ti consente di isolare i criteri che impiegano più tempo per l'esecuzione e rallentano le chiamate API. |
 |
Epsilon indica un intervallo di tempo inferiore a un millisecondo. |
 |
Disabilitata. Viene visualizzata sull'icona di un criterio quando questo è disattivato. Un criterio può essere disattivato con l'API pubblica. Consulta il riferimento per la configurazione dei proxy API. |
 |
Errore. Viene visualizzata sull'icona di un criterio quando la condizione del passaggio del criterio ha valore false (vedi Voci e condizioni del flusso), o sull'icona del criterio RaiseFault ogni volta che viene eseguito un criterio RaiseFault. |
 |
Ignorata. Viene visualizzata sull'icona di un criterio quando il criterio non è stato eseguito perché la condizione del passaggio è risultata falsa. Per ulteriori informazioni, consulta la sezione Voci e condizioni del flusso. |
Informazioni su come interpretare i dettagli della fase
La sezione Dettagli fase dello strumento ti fornisce molte informazioni sullo stato del proxy in ogni fase di elaborazione. Ecco alcuni dei dettagli forniti nella sezione Dettagli della fase. Fai clic su qualsiasi icona nello strumento di debug per visualizzare i dettagli del passaggio selezionato oppure utilizza i pulsanti Avanti/Indietro per passare da un passaggio all'altro.
| Dettagli della fase | Descrizione |
| Endpoint proxy | Indica quale flusso ProxyEndpoint è stato selezionato per l'esecuzione. Un proxy API può avere più endpoint proxy denominati. |
| Variabili |
Elenca le variabili di flusso che sono state lette e a cui è stato assegnato un valore da un criterio. Consulta anche Utilizzare le variabili di flusso. Nota:
|
| Intestazioni delle richieste | Elenca le intestazioni delle richieste HTTP. |
| Richiedi contenuti | Mostra il corpo della richiesta HTTP. |
| Proprietà | Le proprietà rappresentano lo stato interno del proxy API. Per impostazione predefinita, non vengono mostrate. |
| Endpoint di destinazione | Indica quale TargetEndpoint è stato selezionato per l'esecuzione. |
| Intestazioni della risposta | Elenca le intestazioni della risposta HTTP. |
| Contenuto della risposta | Mostra il corpo della risposta HTTP. |
| PostClientFlow | Mostra informazioni su PostClientFlow, che viene eseguito dopo che la richiesta è stata riemessa all'app client richiedente. Solo i criteri di registrazione dei messaggi possono essere associati a PostClientFlow. Al momento, PostClientFlow viene utilizzato principalmente per misurare l'intervallo di tempo tra i timestamp di inizio e di fine del messaggio di risposta. |
API Apigee
Per creare una sessione di debug utilizzando l'API, invia una richiesta POST alla seguente
risorsa:
https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/debugsessions
In via facoltativa, puoi:
- Imposta la durata di una sessione di debug (in secondi) passando la proprietà
timeoutcome parametro di query o nel corpo della richiesta. Se sono specificati entrambi, ha la precedenza il valoretimeoutspecificato nel corpo della richiesta. - Filtra i dati in una sessione di debug passando la proprietà
filternel corpo della richiesta.
L'esempio seguente mostra come creare una sessione di debug utilizzando l'API.
curl "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/apis/PROXY/revisions/REV/debugsessions" \ -X POST \ -H "Authorization: Bearer $TOKEN"
dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta
Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.
Di seguito è riportato un esempio di risposta:
{
"name":"56382416-c4ed-4242-6381-591bbf2788cf",
"validity":300,
"count":10,
"tracesize":5120,
"timeout":"600"
}Le richieste successive al proxy API (fino a quando non viene raggiunta la durata della sessione o il numero massimo di richieste) verranno valutate e potenzialmente memorizzate nei dati della sessione di debug.
Per ulteriori informazioni, consulta l'API Create debug session.
Impostazione della durata di una sessione di debug utilizzando l'API
Per impostare la durata di una sessione di debug utilizzando l'API, includi quanto segue come payload nella richiesta di creazione della sessione di debug:
{
"timeout":"debug_session_length_in_seconds"
}L'esempio seguente crea una sessione di debug di soli 42 secondi:
curl https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/apis/PROXY/revisions/REV/debugsessions"
-X "POST" \
-H "Authorization: Bearer $TOKEN" \
-d ' {
"timeout":"42"
} 'Puoi impostare timeout di una sessione solo nelle richieste di creazione della sessione di debug. Non puoi
modificare la durata di una sessione dopo averla creata.
Il valore predefinito di timeout è 300 (5 minuti). Il valore massimo è 600 secondi
(10 minuti).
Eseguire il debug con lo strumento di debug
Il debug ti consente di vedere molti dettagli interni di un proxy API. Ad esempio:
- Puoi vedere a colpo d'occhio quali criteri vengono eseguiti correttamente o non.
- Supponiamo che tu abbia notato in una delle dashboard di Analytics che il rendimento di una delle tue API sta registrando un calo insolito. Ora puoi utilizzare il debug per identificare dove si verifica il collo di bottiglia. Il debug indica il tempo, in millisecondi, necessario per il completamento di ogni passaggio di elaborazione. Se un passaggio richiede troppo tempo, puoi intervenire per correggerlo.
- Puoi controllare le intestazioni inviate al backend, visualizzare le variabili impostate dai criteri e così via.
- Verificando il percorso di base, puoi assicurarti che un criterio indirizzi il messaggio al server corretto.
Filtrare i dati in una sessione di debug
Quando crei una sessione di debug, puoi aggiungere un filtro alla sessione in modo che Apigee restituisca solo i dati che ti interessano. Un filtro è un'istruzione condizionale che Apigee valuta in base ai messaggi di richiesta e risposta per determinare se i relativi dati di debug devono essere inclusi nella sessione di debug. Ad esempio, puoi escludere tutte le richieste con un codice di risposta HTTP inferiore a 599 o confrontare i valori nella richiesta con le variabili personalizzate.
Tieni presente quanto segue:
- Le richieste non incluse in una sessione di debug perché filtrate non vengono conteggiate per il numero massimo di transazioni nella sessione di debug.
- Apigee non supporta l'aggiunta di filtri nella stringa di query.
- Non puoi aggiungere un filtro a una sessione di debug dopo l'avvio. Per aggiungere un filtro, devi creare una sessione di debug.
Utilizzo dei filtri
Utilizza un filtro quando crei una sessione di debug utilizzando l'API o l'interfaccia utente di Apigee, come descritto nelle sezioni seguenti.
Interfaccia utente Apigee classica
Quando crei una sessione di debug nell'interfaccia utente, nell'elenco a discesa Filtri puoi scegliere un filtro predefinito da applicare nel riquadro Avvia una sessione di debug oppure scegliere Filtro personalizzato e crearne uno con la sintassi del filtro.
API Apigee
Per creare una sessione di debug con un filtro utilizzando l'API, includi quanto segue come payload nella richiesta di creazione della sessione di debug:
{
"filter":"filter_body"
}Per informazioni sulla creazione dei filtri, consulta la sezione Sintassi dei filtri.
L'esempio seguente crea una sessione di debug che include solo le transazioni in cui
l'intestazione A è uguale a 42 e l'intestazione B è uguale a 43 oppure
il codice di errore è ExpectedEOF:
curl -H "Authorization: Bearer $TOKEN" -X "POST"
https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/apis/PROXY/revisions/REV/debugsessions
-d ' {
"filter":"(request.header.A == '42' && request.header.B == '43') || fault.code == 'jsonparser.ExpectedEOF'"
} 'Puoi definire un filtro solo nelle richieste di creazione della sessione di debug. Non puoi aggiungere un filtro a una sessione di debug esistente e non puoi rimuovere un filtro da una sessione di debug attiva.
Sintassi filtro
I filtri supportano la stessa sintassi utilizzata dalle condizioni Apigee, come descritto nel riferimento alle condizioni. È incluso quanto segue:
- Raggruppamento
- Operatori AND (
&&) e OR (|") logici - Espressioni di percorso
- Operatori e operandi
- Valori letterali
(
null,trueefalse)
Inoltre, i filtri possono accedere a tutte le variabili di flusso descritte nel riferimento alle variabili di flusso, nonché alle variabili personalizzate. Gli esempi riportati di seguito mostrano solo alcune delle possibili variabili di flusso che puoi utilizzare nei filtri:
# Response codes: response.status.code <= 599 response.status.code >=301 && response.status.code <=420 # Requests/responses: request.verb == "GET" request.header.A == 'B' || request.queryparam.X == 'Y' # Query parameters: request.queryparam.myparam == 'fish' (request.queryparam.param1 == 'X' || request.queryparam.param2 == 'Y') && request.queryparam.param3 == 'Z' # Faults: fault.code != 'messaging.runtime.RouteFailed' fault.name == 'IPDeniedAccess'
Per informazioni sull'utilizzo delle variabili personalizzate, consulta Come utilizzare gli attributi personalizzati in Apigee nella community Apigee.
Filtri dell'interfaccia utente predefiniti
L'interfaccia utente di Apigee fornisce un insieme di filtri comuni per consentirti di non dover scrivere i tuoi filtri personalizzati. I filtri predefiniti sono riportati nella tabella seguente.
| Nome filtro | Descrizione |
|---|---|
Response Time Greater Than |
Verifica la presenza di problemi di latenza nei seguenti casi:
Ad esempio: target.duration > 420 && client.duration > 1000 Per ulteriori informazioni, consulta
|
Response Code |
Controlla se il codice di risposta HTTP corrisponde al valore specificato, ad esempio: response.status.code <= 599 |
Header |
Controlla se l'intestazione della richiesta specificata è uguale al valore specificato. Ad esempio: request.header.cache-control.1 == "16544" |
Path |
Controlla se la richiesta corrisponde al percorso specificato. Puoi utilizzare la corrispondenza con caratteri jolly nel valore, ad esempio: request.path == /myproxy/customer/4* |
Query Param |
Controlla se il parametro di query della richiesta specificato è uguale al valore specificato. Ad esempio: request.queryparam.lang == "language:en-us" |
Custom |
Consente di inserire le tue espressioni. Puoi utilizzare qualsiasi oggetto nel riferimento alle variabili di flusso e la sintassi nel riferimento alle condizioni. Inoltre, puoi utilizzare le variabili personalizzate. Per ulteriori informazioni sulla creazione di filtri personalizzati, consulta Sintassi dei filtri. |
Visualizzazione delle sessioni di debug
Apigee salva i dati della sessione di debug per 24 ore. Non puoi configurare questo valore. Dopo 24 ore, i dati non saranno più disponibili. Prima di questa data, puoi visualizzare le sessioni di debug.
Visualizza le sessioni di debug recenti utilizzando l'API o l'interfaccia utente di Apigee, come descritto nelle sezioni seguenti.
Nuovo editor proxy
Per visualizzare le sessioni di debug utilizzando il nuovo editor proxy:
Se utilizzi l'interfaccia utente di Apigee nella console Cloud: seleziona Sviluppo proxy > Proxy API.
Se utilizzi la UI Apigee classica: seleziona Sviluppa > Proxy API e nel riquadro Proxy, seleziona l'ambiente per il proxy da eseguire il debug.
- Seleziona il proxy da eseguire il debug.
- Fai clic sulla scheda Debug.
- La sezione Sessioni di debug recenti mostra un elenco delle sessioni di debug disponibili.
Fai clic sul link relativo alla sessione che vuoi visualizzare.
Editor proxy classico
Per visualizzare le sessioni di debug utilizzando l'editor proxy classico:
- Accedi all'interfaccia utente di Apigee.
- Seleziona Proxy API dalla visualizzazione principale.
- Seleziona il proxy da eseguire il debug.
- Fai clic sulla scheda Debug in alto a destra nella visualizzazione Deployment.
- Nel riquadro Sessioni di debug recenti:
- Nell'elenco a discesa Env, seleziona l'ambiente del proxy API di cui vuoi visualizzare la sessione di debug.
- Dall'elenco a discesa Rev (Revisione), seleziona il numero di revisione del proxy API di cui vuoi visualizzare la sessione di debug.
L'interfaccia utente di Apigee mostra un elenco delle sessioni di debug disponibili.
Fai clic sul link relativo alla sessione che vuoi visualizzare.
L'interfaccia utente di Apigee carica la sessione di debug e compila il riquadro Invia richieste con i dati di debug.
Selezionare le opzioni di visualizzazione nell'interfaccia utente
Nell'interfaccia utente di Apigee, puoi scegliere le opzioni di visualizzazione per la sessione di debug.
| Opzione | Descrizione |
| Mostra criteri disattivati | Mostra eventuali criteri disattivati. Un criterio può essere disattivato con l'API pubblica. Consulta Riferimento per la configurazione dei proxy API. |
| Mostra fasi saltate | Mostra eventuali fasi saltate. Una fase viene saltata quando il criterio non è stato eseguito perché la condizione del passaggio è risultata falsa. Per ulteriori informazioni, consulta la sezione Condizioni con variabili di flusso. |
| Mostra tutti i FlowInfo | Rappresentano le transizioni all'interno di un segmento di flusso. |
| Confronta automaticamente la fase selezionata | Confronta la fase selezionata con quella precedente. Disattiva questa opzione per visualizzare solo la fase selezionata. |
| Mostra variabili | Mostra o nascondi le variabili che sono state lette e/o a cui è stato assegnato un valore. |
| Mostra proprietà | Le proprietà rappresentano lo stato interno del proxy API. (Nascosto per impostazione predefinita). |
API Apigee
Con l'API puoi:
- Visualizzare tutte le sessioni di debug
- Visualizzare tutte le transazioni per una sessione di debug
- Visualizzare i dati delle transazioni per una sessione di debug
Visualizza tutte le sessioni di debug utilizzando l'API
Per visualizzare tutte le sessioni di debug recenti definite per una revisione del proxy API in un ambiente, invia una richiesta GET alla seguente risorsa:
https://apigee.googleapis.com/v1/organizations/org/environments/env/apis/api/revisions/rev/debugsessions
Se vuoi, puoi specificare uno dei seguenti parametri di ricerca per controllare la quantità di dati restituiti:
- pageSize: il numero massimo di sessioni di debug da elencare. Il valore predefinito per le dimensioni della pagina è 25.
- pageToken: il token di pagina restituito da una chiamata precedente che puoi utilizzare per recuperare la pagina successiva.
L'esempio seguente mostra come visualizzare le sessioni di debug per la revisione 1 del proxy API helloworld nell'ambiente test.
curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/apis/helloworld/revisions/1/debugsessions" \ -X GET \ -H "Authorization: Bearer $TOKEN"
dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta
Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.
La risposta include un oggetto sessions che contiene un elenco delle sessioni di debug attualmente attive, come mostrato nell'esempio seguente:
{
"sessions": [
{
"id": "a423ac73-0902-4cfa-4242-87a353a84d87",
"timestamp_ms": 1566330186000
},
{
"id": "f1eccbbe-1fa6-2424-83e4-3d063b47728a",
"timestamp_ms": 1566330286000
}
]
}Nella risposta sono incluse solo le sessioni di debug che contengono almeno una transazione. Le sessioni di debug che non hanno transazioni non sono incluse in questo elenco.
Per ulteriori informazioni, consulta l'API List Debug Sessions.
Visualizzare tutte le transazioni per una sessione di debug utilizzando l'API
Per visualizzare un elenco di transazioni per una sessione di debug, invia una richiesta GET alla seguente risorsa:
https://apigee.googleapis.com/v1/organizations/org/environments/env/apis/api/revisions/rev/debugsessions/debugsession/data
dove debugsession è l'ID di una sessione di debug restituito quando visualizzi le sessioni di debug.
L'esempio seguente mostra come visualizzare le transazioni per una sessione di debug per la revisione 1 dell'API helloworld nell'ambiente test.
curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/apis/helloworld/revisions/1/debugsessions/a423ac73-0902-4cfa-4242-87a353a84d87/data" \ -X GET \ -H "Authorization: Bearer $TOKEN"
dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta
Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.
La risposta include un array di ID transazione, come mostrato nell'esempio seguente:
[ "myorg-test-ver-5qxdb-64", "myorg-test-ver-5qxdb-65", "myorg-test-ver-5qxdb-66", "myorg-test-ver-5qxdb-67", "myorg-test-ver-5qxdb-68", "myorg-test-ver-5qxdb-69", "myorg-test-ver-5qxdb-70", "myorg-test-ver-5qxdb-71", "myorg-test-ver-5qxdb-72" ]
Per ulteriori informazioni, consulta l'API List debug session data.
Visualizzazione dei dati sulle transazioni per una sessione di debug mediante l'API
Per visualizzare i dati delle transazioni per una sessione di debug, invia una richiesta GET alla seguente risorsa:
https://apigee.googleapis.com/v1/organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/debugsessions/{debugsession}/data/{transactionId}dove debugsession è l'ID di una sessione di debug restituito quando visualizzi le sessioni di debug e transactionId è l'ID transazione restituito quando visualizzi un elenco di transazioni per una sessione di debug.
I dati della transazione salvati durante una sessione di debug sono formattati in JSON. Puoi caricare questi dati nello strumento di debug offline.
L'esempio seguente mostra come scaricare i dati delle transazioni per una sessione di debug per la revisione 1 dell'API helloworld nell'ambiente test.
curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/apis/helloworld/revisions/1/debugsessions/a423ac73-0902-4cfa-4242-87a353a84d87/data/myorg-test-ver-5qxdb-64" \ -X GET \ -H "Authorization: Bearer $TOKEN"
dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta
Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.
La risposta è costituita da un payload JSON contenente i dati relativi alla transazione specificata, come descritto in Scaricare la struttura dei dati.
I dati di debug contengono tutte le informazioni sulla richiesta e sulla risposta per ogni parte del flusso in un formato JSON proprietario. Puoi salvare questi dati e utilizzarli in un secondo momento nello strumento di debug offline.
Se non sono state aggiunte richieste alla sessione prima della sua fine, la risposta sarà simile alla seguente:
[]
Per saperne di più, consulta l'API Get debug session data.
Download dei dati della sessione di debug
Puoi scaricare un file di risultati di debug non elaborati per la visualizzazione offline. Il file scaricato mostra i dettagli completi della sessione di debug, inclusi i contenuti di tutte le intestazioni, le variabili e i criteri.
I dati della sessione di debug sono disponibili per il download o la visualizzazione nell'interfaccia utente solo per 24 ore. Dopo questo punto, Apigee elimina i dati della sessione.
Nuovo editor proxy
Per scaricare la sessione di debug corrente nel nuovo editor proxy, fai clic su Scarica sessione nel riquadro a sinistra della visualizzazione di debug.
Tieni presente che una sessione di debug viene eliminata entro 24 ore dal momento in cui viene completata, quindi se vuoi visualizzarla dopo questo lasso di tempo, devi scaricarla prima.
Editor proxy classico
Per scaricare i dati della sessione di debug corrente utilizzando la versione classica di Proxy Editor:
- Sessione attiva: fai clic sull'icona di download () nel riquadro Dettagli di debug.
- Sessione precedente:fai clic sul nome della sessione nel riquadro Sessioni di debug recenti, come descritto in Visualizzazione delle sessioni di debug. Poi,
fai clic su nel riquadro Dettagli di debug.
API Apigee
Per visualizzare gli ID di tutte le transazioni per la sessione di debug corrente utilizzando l'API Apigee, inserisci il seguente comando:
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/apis/PROXY/revisions/REV/debugsessions/SESSION_ID/datadove SESSION_ID è l'ID della sessione di debug che vuoi scaricare.
Consulta elencare gli ID transazione da una sessione di debug.
Per ottenere i dati di debug di una transazione utilizzando l'API Apigee, inserisci il seguente comando:
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \ https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/apis/PROXY/revisions/REV/debugsessions/SESSION_ID/data/TRANSACTION_ID
Scarica la struttura dei dati
La struttura di download dei dati della sessione di debug è diversa per l'interfaccia utente di Apigee e l'API Apigee.
Interfaccia utente Apigee classica
Quando scarichi i dati utilizzando l'interfaccia utente di Apigee, la struttura dei dati:
- Include tutte le transazioni nell'intera sessione
- Memorizza le transazioni in un array
Messages - Include i metadati sulla sessione (come oggetto
DebugSession)
API Apigee
Non puoi utilizzare l'API Apigee per visualizzare contemporaneamente i dati di un'intera sessione. Puoi solo utilizzare l'API per visualizzare i dati delle singole transazioni, come descritto in Visualizzazione delle sessioni di debug.
Ad esempio:
{
"completed": true,
"point": [
...
...
}Scaricare esempi di dati
L'esempio seguente mette in evidenza un oggetto metadati DebugSession nei dati scaricati. Questo oggetto è seguito dall'array Messages che contiene le transazioni nella sessione.
{
"DebugSession": {
"Retrieved": "2019-06-08T13:08:13.395Z",
"Organization": "myorg",
"Environment": "prod",
"API": "myproxy",
"Revision": "1",
"SessionId": "a2a271aa-4242-4ac6-97cb-aec8dcb115a9"
},
"Messages": [
{
"completed": true,
"point": [
{
"id": "Paused"
},
{
"id": "Resumed"
},
{
"id": "StateChange",
"results": [
{
"ActionResult": "DebugInfo",
"properties": {
"property": [
{
"name": "To",
"value": "REQ_HEADERS_PARSED"
},
{
"name": "From",
"value": "REQ_START"
}
]
},
"timestamp": "8-6-19 13:08:37:718"
},
{
"ActionResult": "RequestMessage",
"headers": [
{
"name": "accept",
"value": "*/*"
},
{
"name": "accept-encoding",
"value": "gzip,gzip,deflate,br"
},
{
"name": "content-length",
"value": "0"
},
{
"name": "host",
"value": "myorg.example.domain.net"
},
{
"name": "user-agent",
"value": "Google-Apigee"
},
{
"name": "x-b3-sampled",
"value": "0"
},
{
"name": "x-b3-spanid",
"value": "d4ee579206759662"
},
{
"name": "x-b3-traceid",
"value": "adc1e171777c237dd4ee579206759662"
},
{
"name": "x-forwarded-for",
"value": "66.102.8.98"
},
{
"name": "x-forwarded-proto",
"value": "https"
},
{
"name": "x-request-id",
"value": "54e05cba-4242-4490-4242-60c45c156f90"
}
],
"uRI": "/myproxy",
"verb": "GET"
}
]
},
{
"id": "FlowInfo",
"results": [
{
"ActionResult": "DebugInfo",
"properties": {
"property": [
{
"name": "environment.name",
"value": "prod"
},
{
"name": "environment.qualifiedname",
"value": "myorg__prod"
},
{
"name": "environment.orgname",
"value": "myorg"
}
]
},
"timestamp": "8-6-19 13:08:37:718"
}
]
},
{
"id": "FlowInfo",
"results": [
{
"ActionResult": "DebugInfo",
"properties": {
"property": [
{
"name": "organization.name",
"value": "myorg"
}
]
},
"timestamp": "8-6-19 13:08:37:718"
}
]
},
{
"id": "FlowInfo",
"results": [
{
"ActionResult": "DebugInfo",
"properties": {
"property": [
{
"name": "apiproxy.qualifiedname",
"value": "myproxy__1"
},
{
"name": "apiproxy.basepath",
"value": "/"
},
{
"name": "apiproxy.revision",
"value": "1"
},
{
"name": "apiproxy.name",
"value": "myproxy"
}
]
},
"timestamp": "8-6-19 13:08:37:718"
}
]
},
...
...
}
]
}Se la sessione di debug non ha incluso richieste, l'array Message è vuoto, come mostrato nell'esempio seguente:
{
"DebugSession": {
"Retrieved": "2019-06-08T13:08:13.395Z",
"Organization": "myorg",
"Environment": "prod",
"API": "myproxy",
"Revision": "1",
"SessionId": "a2a271aa-4242-4ac6-97cb-aec8dcb115a9"
},
"Messages": []
}Eliminazione dei dati di una sessione di debug
Elimina i dati per una sessione di debug utilizzando l'API o l'interfaccia utente di Apigee, come descritto nelle seguenti sezioni.
Nuovo editor proxy
Per eliminare una sessione di debug nel nuovo Editor proxy:
- Seleziona la riga della sessione che vuoi eliminare.
- Fai clic sul menu con tre puntini alla fine della riga e seleziona Elimina.
Editor proxy classico
Fai clic su
nel riquadro Dettagli di debug per la sessione di debug.
API Apigee
Per eliminare tutti i dati della sessione di debug utilizzando l'API, invia una richiesta DELETE alla seguente risorsa:
https://apigee.googleapis.com/v1/organizations/org/environments/env/apis/api/revisions/rev/debugsessions/debugsession/data
dove debugsession è l'ID di una sessione di debug restituito quando visualizzi le sessioni di debug.
L'esempio seguente mostra come eliminare i dati della sessione di debug per la revisione 1 dell'API helloworld nell'ambiente test.
curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/apis/helloworld/revisions/1/debugsessions/a423ac73-0902-4cfa-4242-87a353a84d87/data" \ -X DELETE \ -H "Authorization: Bearer $TOKEN"
dove $TOKEN è impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta
Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.
In caso di esito positivo, il corpo della risposta sarà vuoto.
I dati della sessione di debug vengono mantenuti solo per 24 ore. Se non lo elimini esplicitamente prima di questa data, Apigee lo elimina per te.