Chapter 4. Using VS Code Debug Adapter for Apache Camel extension

• Camel Main mode for XML only.
• The use of Camel debugger by attaching it to a running Camel route written in Java, Yaml or XML using the JMX url.
• The local use of Camel debugger by attaching it to a running Camel route written in Java, Yaml or XML using the PID.
• You can use it for a single Camel context.
• Add or remove the breakpoints.
• The conditional breakpoints with simple language.
• Inspecting the variable values on suspended breakpoints.
• Resume a single route instance and resume all route instances.
• Stepping when the route definition is in the same file.
• Allow to update variables in scope Debugger, in the message body, in a message header of type String, and an exchange property of type String

• Supports the command Run Camel Application with JBang and Debug.

  • This command allows a one-click start and Camel debug in simple cases. This command is available through:

    • Command Palette. It requires a valid Camel file opened in the current editor.
    • Contextual menu in File explorer. It is visible to all *.xml, *.java, *.yaml and *.yml.
    • Codelens at the top of a Camel file (the heuristic for the codelens is checking that there is a from and a to or a log on java, xml, and yaml files).

• Supports the command Run Camel application with JBang.

  • It requires a valid Camel file defined in Yaml DSL (.yaml|.yml) opened in editor.
• Configuration snippets for Camel debugger launch configuration
• Configuration snippets to launch a Camel application ready to accept a Camel debugger connection using JBang, or Maven with Camel maven plugin

• Java Runtime Environment 17 or later with com.sun.tools.attach.VirtualMachine (available in most JVMs such as Hotspot and OpenJDK) must be installed.

• The Camel instance to debug must follow these requirements:

  • Camel 3.16 or later
  • Have camel-debug on the classpath.
  • Have JMX enabled.

Additional resources

• Debug Adapter for Apache Camel by Red Hat