Debugging Codebeamer customizations
Customizations running in Codebeamer can be debugged by starting Codebeamer with debugging enabled and connecting a debugger to the running Codebeamer instance.
It is highly recommended that you use a local Codebeamer installation to debug your customizations and not run the companies test or even the production server in debug-mode.
 |
This page only contains information supporting local Codebeamer debugging! When using, for example, dockerized Codebeamer instances configuration parameter values might differ.
|
Starting Codebeamer in Debug-Mode
Assuming your Codebeamer is started automatically as a service, make sure that service is stopped.
After doing that open a console, cd to CODE_BEAMER/tomcat/bin and execute catalina.bat jpda run (Windows) or ./catalina.sh jpda run (Linux)
Once you did that you should see Codebeamer / Tomcat starting in the console listening for a debugger to connect on port 8000.
Once startup is complete you will be able to connect to Codebeamer using the usual URL.
Setup Remote Debugging in Eclipse
• Select Run / Debug Configurations menu item.
• On the appearing window Select Java Remote Application.
• Press Right mouse click on this menu item and Select New.
• Specify a name for the new Debug Configuration.
• Default connection type and property should be fine if you are debugging a local Codebeamer instance.
• Click on the Debug button.
◦ Check the debug tab (if does not exists you can add using the Windows / Show View menu item)
◦ If something went wrong error occurs.
• Set a breakpoint in the code and start using your server.
◦ Open your local Codebeamer.
◦ Run will stop for debugging on your breakpoint.
Remote Debugging in Other IDEs
Please refer to the documentation of your favorite IDE to find out how to setup remote debugging.
When configuring the remote debugger make sure to use settings:
• Transport: Socket.
• Debugger Mode: Attach.
• Host: localhost or the IP host name of the machine running Codebeamer in debug-mode.
• Port: 8000.
| | Only locally installed Codebeamer instances are supported, parameter values might differ when using docker to run Codebeamer. |