VSCode Remote Debugging

Supported Languages

Language	Required Plugin	Dev Image Required
Java	Debugger for Java	N/A
Go	Go	dlv
Python	Python	debugpy
PHP	PHP Debug	xdebug
Node.js	N/A	N/A
Ruby	Ruby	ruby-debug-ide

Plugin Configuration

Java

The path to the Java Development Kit can be specified by the java.home setting in VS Code settings (workspace/user settings). If not specified, it is searched in the following order until a JDK meets current minimum requirement,for extension jdk configuration, see Setting the JDK.

• the JDK_HOME environment variable
• the JAVA_HOME environment variable
• on the current system path

Go

The extension uses a few command-line tools developed by the Go community。in particular, go, gopls, and dlv must be installed for this extension to work correctly. See the tools documentation for a complete list of tools the extension depends on.

In order to locate these command-line tools, the extension searches GOPATH/bin and directories specified in the PATH environment variable (or Path on Windows) with which the VS Code process has started. If the tools are not found, the extension will prompt you to install the missing tools and show the "⚠️ Analysis Tools Missing" warning in the bottom right corner. Please install them by responding to the warning notification, or by manually running the Go: Install/Update Tools command.

Debugging Process

1. Select the workload that you want to debug
2. Right-click the workload and select Dev Config, configure your debugging configuration
3. Then right-click this workload again and select Remote Debug
4. Nocalhost will automatically install the dependencies on the first debug
5. Nocalhost will automatically enter the DevMode and start remote debugging

Configuration

The development environment is different between developers. You should configure remote debug configurations according to the actual situation.

Sample Configuration

Java

Nocalhost Configs

name: java-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 5005

...

Maven Example

The shell command for Maven example:

jdk >= 1.8 and springBoot >=2.2.1.RELEASE

mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005"

For jdk <=1.7 you should replace -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 with -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005

For lower version of the springBoot you should replace -Drun.jvmArguments with -Dspring-boot.run.jvmArguments

Gradle Example

The startup command for Gradle example:

Gradle's debug.sh

./gradlew bootRun --debug-jvm --no-daemon

Python

Nocalhost Configs

name: python-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9009

...

VSCode

debug.sh

#! /bin/sh

pip3 install --no-cache-dir -r ./requirements.txt

export DEBUG_DEV=0

export FLASK_DEBUG=0

export FLASK_ENV=development

flask run --host=0.0.0.0 --port=9999

Jetbrains

debug.sh

#! /bin/sh

pip3 install --no-cache-dir -r ./requirements.txt

python -m debugpy --listen 9009 --wait-for-client productpage.py 9080

How does it Works?

Nocalhost using pydevd to debug Python application.

Principle of Remote Python Debugging

Go

Nocalhost Configs

name: go-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9009

...

debug.sh

#! /bin/sh

export GOPROXY=https://goproxy.cn

dlv --headless --log --listen :9009 --api-version 2 --accept-multiclient debug app.go

PHP

Nocalhost Configs

name: php-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9003

...

debug.sh

#！/bin/sh

php -t ./ -S 0.0.0.0:9999;

How does it works?

Nocalhost using Xdebug to debug PHP applications.

Principle of Remote PHP Debugging

Node.js

Nocalhost Configs

name: nodejs-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9229

...

debug.sh

#！/bin/sh

npm install

node --inspect=0.0.0.0:9229 ./index.js

Ruby

Nocalhost Configs

name: nodejs-remote-debugging

serviceType: deployment

containers:

- name: ""

dev:

...

command:

debug:

- ./debug.sh

debug:

remoteDebugPort: 9001

...

debug.sh

#！/bin/sh

rdebug-ide -h 0.0.0.0 -p 9001 -- details.rb 9080

Debugging Configurations in IDE

VSCode debug configuration

nocalhost will automatically configure launch.json of vscode when debug is finished, next time you can launch debug directly with shortcut key F5

Debugging parameters

debug supports custom parameters to start, you just need to add parameters under configurations in launch.json, and the plugin will pass the parameters to the debugger when debug is launched.

If you need to enable diagnostic output when debugging a Node.js application, you just need to change the following configuration.

launch.json

{

"version": "0.2.0",

"configurations": [

{

"type": "nocalhost",

"request": "attach",

"name": "Nocalhost Debug",

"trace": true

}

]

}

Supported debugging parameters

• Java: Debugger for Java
• Go: Go
• Python: Python
• PHP: PHP Debug
• Node.js: VSCode
• Ruby: Ruby

FAQ

The java debugger stops at return ma.invoke(obj, args);in the java.lang.reflect.Method.class file.

Execute the Java: Clean the Java language server workspace command