debug-cnb

The Cloud Foundry Debug Buildpack is a Cloud Native Buildpack V3 that enables the debug-ing of JVM applications.

Behavior

This buildpack will participate if all of the following conditions are met

• $BP_DEBUG is set

The buildpack will do the following:

• Contribute debug configuration to $JAVA_OPTS

Configuration

Environment Variable	Description
$BP_DEBUG	Whether to contribute debug support
$BPL_DEBUG_PORT	What port the debug agent will listen on. Defaults to 8000.
$BPL_DEBUG_SUSPEND	Whether the JVM will suspend execution until a debugger has attached. Defaults to n.

Creating SSH Tunnel

After starting an application with debugging enabled, an SSH tunnel must be created to the container. To create that SSH container, execute the following command:

$ cf ssh -N -T -L <LOCAL_PORT>:localhost:<REMOTE_PORT> <APPLICATION_NAME>

The REMOTE_PORT should match the port configuration for the application (8000 by default). The LOCAL_PORT can be any open port on your computer, but typically matches the REMOTE_PORT where possible.

Once the SSH tunnel has been created, your IDE should connect to localhost:<LOCAL_PORT> for debugging.

License

This buildpack is released under version 2.0 of the Apache License.