Este conteúdo não está disponível no idioma selecionado.

Chapter 4. Debug support for Camel


Important

The VS Code extensions for Apache Camel are listed as development support. For more information about scope of development support, see Development Support Scope of Coverage for Red Hat Build of Apache Camel.

4.1. Debug Adapter for Apache Camel routes

The VS Code Debug Adapter is a Visual Studio Code extension that you can use to debug running Camel routes written in Java, Yaml or XML DSL.

4.1.1. Features of Debug Adapter

The VS Code Debug Adapter for Apache Camel extension supports the following features:

  • 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

4.1.2. Requirements

The following points must be considered when using the VS Code Debug Adapter for Apache Camel extension:

Prerequsites

  • Java Runtime Environment:

    • 17 or later
    • com.sun.tools.attach.VirtualMachine installed.
  • The Camel instance:

    • Camel version 3.16 or later
    • camel-debug in the classpath.
    • JMX enabled.
Note

For some features, JBang must be available in the CLI environment.

4.1.3. Installing VS Code Debug Adapter for Apache Camel

You can download the VS Code Debug Adapter for Apache Camel extension from the VS Code Extension Marketplace and the Open VSX Registry. You can also install the Debug Adapter for Apache Camel extension directly in the Microsoft VS Code.

Procedure

  1. Open the VS Code editor.
  2. In the VS Code editor, select View > Extensions.
  3. In the search bar, type Camel Debug. Select the Debug Adapter for Apache Camel option from the search results and then click Install.

This installs the Debug Adapter for Apache Camel in the VS Code editor.

4.2. Using VSCode Debug Adapter for Apache Camel with standalone Camel routes

You can debug your camel application with the debug adapter.

Procedure

  1. Ensure that the jbang binary is available on the system commandline.
  2. Open a Camel route which can be started with Camel CLI.
  3. Call the command Palette using the keys Ctrl + Shift + P, and select the Run Camel Application with JBang and Debug command or click on the codelens Camel Debug with JBang that appears on top of the file.
  4. Wait until the route is started and debugger is connected.
  5. Put a breakpoint on the Camel route.
  6. Debug.

4.3. Using VSCode Debug Adapter for Apache Camel with Quarkus

You can debug your camel application with the debug adapter.

Procedure

  1. Ensure that the jbang binary is available on the system commandline.
  2. Open a Camel route which can be started with Camel CLI.
  3. Call the command Palette using the keys Ctrl + Shift + P, and select the Run Camel Application with JBang and Debug command or click on the codelens Camel Debug with JBang that appears on top of the file.
  4. Wait until the route is started and debugger is connected.
  5. Put a breakpoint on the Camel route.
  6. Debug.

4.4. Using VSCode Debug Adapter for Apache Camel with Spring Boot

You can debug your camel application with the debug adapter.

Procedure

  1. Ensure that the jbang binary is available on the system commandline.
  2. Open a Camel route which can be started with Camel CLI.
  3. Call the command Palette using the keys Ctrl + Shift + P, and select the Run Camel Application with JBang and Debug command or click on the codelens Camel Debug with JBang that appears on top of the file.
  4. Wait until the route is started and debugger is connected.
  5. Put a breakpoint on the Camel route.
  6. Debug.

Additional resources

Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat