Pivotal Knowledge Base

Follow

How to remotely debug Java applications on PCF®

Environment

Product Version
Pivotal Cloud Foundry® 1.6.x, 1.7.x
Purpose
This article will provide instructions on how to enable remote debug configuration to Java applications on PCF at runtime. 
 
Procedure
1. Enable the JBP_CONFIG_DEBUG environment variable, this can be done by editing application manifest.yml or invoking the "cf set-env" command. In this article, we use application manifest as an example.
---
applications:
- name: <APP_NAME>
memory: 512M
instances: 1
path: path/java-app.war
env:
JBP_CONFIG_DEBUG: '{enabled: true}'

2. Use "cf push" to deploy the Java application to PCF or Pivotal Web Services.

3. Set up the SSH tunnel for the debug framework via JDWP. 

cf ssh -N -T -L 8000:localhost:8000 <APP_NAME>
Once the SSH tunnel has been created, Eclipse/STS should connect to the localhost:8000 for debug access. Please refer to the detailed instructions at the Java Buildpack Debug Framework
 
 
Additional Information
The instructions are only useful in Diego-based containers with SSH access enabled. Diego was introduced in PCF v1.6.x and turns to be mandatory in v1.7.x. Additionally, the remote debug feature is only available from Java Buildpack v3.4+.
 
PCF is not a development platform, you can use it but it is going to be slow. Users should develop software locally and treat PCF as a deployment target. PCF Dev is provided to set up a compact PCF on a local machine for development/debugging use.  
 

Comments

  • Avatar
    Manuel Morales

    This line paragraph does not jibe correctly. Is it intended to start as "PCF Dev is not ..."

    "PCF is not a development platform, you can use it but it is going to be slow. Users should develop software locally and treat PCF as a deployment target. PCF Dev is provided to set up a compact PCF on a local machine for development/debugging use. "

Powered by Zendesk