Debug di un servizio Cloud Run in Cloud Code for VS Code

Cloud Code for VS Code consente di eseguire facilmente il debug di un'applicazione di cui è stato eseguito il deployment in Cloud Run sfruttando skaffold debug. Per informazioni dettagliate sul debug di Skaffold, consulta Eseguire il debug con Skaffold.

Non è necessario completare la configurazione manuale, ad esempio impostare il port forwarding o inserire argomenti di debug specifici per la lingua. Il debug richiede un'applicazione Cloud Run predisposta per Cloud Code che includa un file di configurazione skaffold.yaml e un file launch.json di tipo cloudcode.cloudrun.

Debug del servizio Cloud Run

Per eseguire il debug del servizio:

  1. Per eseguire il servizio e associarvi una sessione del debugger, apri la tavolozza dei comandi (premi Ctrl/Cmd+Shift+P o fai clic su Visualizza > Tavolozza comandi), quindi esegui il comando Debug sull'emulatore Cloud Run.

  2. Nella finestra di dialogo Esegui/Debug sull'emulatore di Cloud Run, imposta le specifiche per la configurazione:

    • Scegli Docker o Buildpacks come builder, quindi specifica il tuo Dockerfile o Buildpack.
    • (Facoltativo) Per specificare una destinazione o gli argomenti della build Dockerfile, fai clic su Mostra impostazioni build avanzate e poi specifica la destinazione o gli argomenti.
    • (Facoltativo) Per specificare un nome di servizio personalizzato, l'URL dell'immagine container, la porta del container, l'identità da utilizzare per il servizio, il numero di CPU dedicate o la quantità di memoria da allocare a ogni istanza container, fai clic su Mostra impostazioni di servizio avanzate e specifica i valori.
    • (Facoltativo) Per specificare eventuali variabili di ambiente, fai clic su Mostra impostazioni di servizio avanzate, poi su Variabili di ambiente e specifica i valori.
    • (Facoltativo) Per specificare le connessioni Cloud SQL, fai clic su Connessioni e specifica una connessione per riga.
    • (Facoltativo) Per fare in modo che VS Code ristabilisca una sessione di debug dopo aver salvato una modifica al codice, seleziona la casella di controllo Ricrea e riesegui automaticamente in caso di modifiche.

    Se vuoi personalizzare ulteriormente l'esecuzione del servizio, puoi modificare direttamente il file launch.json.

  3. Per iniziare il debug del servizio, fai clic su Debug.

  4. Se richiesto, autentica le tue credenziali per eseguire ed eseguire il debug di un'applicazione in locale.

  5. Per ogni contenitore di cui è possibile eseguire il debug nel tuo servizio, conferma o inserisci la directory nel contenitore remoto in cui è stato trovato il programma di cui vuoi eseguire il debug.

    In alternativa, puoi premere ESC per saltare il debug di un contenitore.

    Prompt radice remoto

    Cloud Code collega una sessione di debug per ogni container di cui è possibile eseguire il debug nel servizio.

    Per impostazione predefinita, quando salvi una modifica all'applicazione, Cloud Code esegue nuovamente il deployment dell'applicazione e configura una nuova sessione di debug. Puoi attivare/disattivare questa funzionalità con il flag watch nella configurazione di avvio del tuo progetto.

  6. Per aggiungere un punto di interruzione, fai clic sul margine dell'editor del file di cui stai eseguendo il debug.

    I cerchi pieni di colore rosso indicano i punti di interruzione attivi, mentre i cerchi vuoti grigi indicano i punti di interruzione disattivati.

    Per un controllo più preciso dei punti di interruzione, puoi utilizzare la sezione Punti di interruzione nella visualizzazione Debug di VS Code.

    Sezione Punti di interruzione nel riquadro a sinistra di Visualizzazione debug che consente di aggiungere, rimuovere e disabilitare i punti di interruzione

    Quando invii una nuova richiesta al tuo servizio, questa viene messa in pausa sulla riga specificata.

  7. Al termine della sessione, fai clic con il tasto destro del mouse per utilizzare i seguenti comandi:

    • Visualizza log: apri i log delle applicazioni di un deployment specifico con Esplora log di Cloud Code
    • Apri URL: apri l'URL del servizio dell'applicazione di un servizio specifico in un browser web
  8. Se hai disattivato la modalità smartwatch nella configurazione di avvio e vuoi apportare modifiche all'applicazione, nonché ricreare e rieseguire il deployment dell'applicazione, fai clic sulla barra di stato di Cloud Code e poi su Attiva modalità smartwatch.

  9. Se vuoi ispezionare variabili e informazioni sullo stack, utilizza la barra laterale di debug. Per interagire con la sessione di debug, utilizza la console di debug nel debugger del riquadro inferiore.

  10. Per interrompere il deployment, fai clic sul pulsante Arresta nella barra delle azioni per il deployment attuale.

    Barra delle azioni per il deployment di Cloud Run

Dettagli della configurazione

Cloud Code gestisce i seguenti dettagli di configurazione specifici per il linguaggio:

Node.js

Riscrittura del punto di ingresso per richiamare:

node --inspect=localhost:9229

Python

Installazione del modulo ptvsd utilizzando un container di inizializzazione e riscrittura dell'entrypoint per richiamare:

python -m ptvsd --host localhost --port 5678

Go

L'installazione del debugger dlv tramite un Init Container e la riscrittura del punto di ingresso in modo che la sessione di debug avviata venga eseguita solo con un server di debug (in modalità headless), il processo di debug continua all'avvio, l'accettazione di più connessioni client e l'ascolto all'indirizzo localhost:56268:

dlv exec --headless --continue --accept-multiclient --listen=localhost:56268 --api-version=2, <app> --

Java

Aggiunta di un ambiente JAVA_TOOLS_OPTIONS con la configurazione JDWP (Java Debug Wire Protocol) appropriata, in modo che l'agente di debug JDWP rilevi una connessione socket sulla porta 5005 e permetta alla VM di iniziare l'esecuzione prima che venga collegato il debugger:

jdwp=transport=dt_socket,server=y,suspend=n,address=5005,quiet=y

.NET

Le applicazioni .NET Core sono configurate per il deployment insieme a vsdbg per VS Code.

In caso di problemi con la configurazione automatica, consulta Configurazione e configurazione dettagliate del debugger per informazioni sulla risoluzione dei problemi.

Richiedi assistenza

Per inviare feedback, segnala problemi su GitHub o fai una domanda su Stack Overflow.