camel debug
Debug local Camel integration
Options
| Option | Description | Default | Type |
|---|---|---|---|
|
Use ago instead of yyyy-MM-dd HH:mm:ss in timestamp. |
boolean |
|
|
Run in the background |
false |
boolean |
|
To wait for run in background to startup successfully, before returning |
true |
boolean |
|
Enables backlog tracing of the routed messages |
false |
boolean |
|
To set breakpoint at the given node id (Multiple ids can be separated by comma). If no breakpoint is set, then the first route is automatic selected. |
String |
|
|
To run using a different Camel Spring Boot version than the default version. |
String |
|
|
To run using a different Camel version than the default version. |
String |
|
|
Run the given text or file as Java DSL routes |
String |
|
|
Developer console at /q/dev on local HTTP server (port 8080 by default) |
false |
boolean |
|
Add additional dependencies |
List |
|
|
Whether to allow automatic downloading JAR dependencies (over the internet) |
true |
boolean |
|
Run an empty Camel without loading source files |
false |
boolean |
|
Run an example by name, or list available examples when no name is given. |
String |
|
|
Exclude files by name or pattern |
List |
|
|
Make sure we use fresh (i.e. non-cached) resources |
false |
boolean |
|
The Maven group:artifact:version (used during exporting) |
String |
|
|
Deprecated: use --observe instead. Health check at /q/health on local HTTP server (port 8080 by default) |
false |
boolean |
|
Whether to ignore route loading and compilation errors (use this with care!) |
false |
boolean |
|
Java version (21, 25) |
21 |
String |
|
Enables Java Flight Recorder, saving a recording to <name>.jfr on exit. Automatically adds JFR support for the runtime and turns on the Camel runtime instrumentation events (route, processor, exchange, etc.). |
false |
boolean |
|
Java Flight Recorder settings profile to use (such as default or profile). Implies --jfr. |
String |
|
|
Additional JVM arguments (e.g. -Xmx256m -Xms128m) |
String |
|
|
To enable JVM remote debugging on port 4004 by default. The supported values are true to enable the remote debugging, false to disable the remote debugging or a number to use a custom port |
int |
|
|
Apache Camel Kamelets version (auto-detected from classpath if not set) |
String |
|
|
Whether to use lazy bean initialization (can help with complex classloading issues) |
false |
boolean |
|
Local directory (or github link) for loading Kamelets (takes precedence). Multiple directories can be specified separated by comma. |
String |
|
|
Number of log lines to display on top of screen |
10 |
int |
|
Can be used to turn off logging |
true |
boolean |
|
Used for individual logging levels (ex: org.apache.kafka=DEBUG) |
List |
|
|
Use colored logging. Default is auto-detected based on NO_COLOR, CI, FORCE_COLOR environment variables and terminal capabilities |
boolean |
|
|
Path to file with custom logging configuration |
String |
|
|
Use JSON logging (ECS Layout) |
false |
boolean |
|
Logging level (ERROR, WARN, INFO, DEBUG, TRACE) |
info |
String |
|
To use a dedicated port for HTTP management (use 0 to dynamic assign a free random port number) |
int |
|
|
Whether to mask endpoint URIs to avoid printing sensitive information such as password or access keys |
boolean |
|
|
Whether downloading JARs from ASF Maven Snapshot repository is enabled |
true |
boolean |
|
Whether downloading JARs from Maven Central repository is enabled |
true |
boolean |
|
Optional location of Maven settings.xml file to configure servers, repositories, mirrors and proxies. If set to false, not even the default ~/.m2/settings.xml will be used. |
String |
|
|
Optional location of Maven settings-security.xml file to decrypt settings.xml |
String |
|
|
For how long time in seconds Camel can be idle before stopping |
0 |
int |
|
Max number of messages to process before stopping |
0 |
int |
|
Max seconds to run before stopping |
0 |
int |
|
Embed dev/diagnostics MCP tools on the local HTTP management server (/mcp by default). When management shares the main HTTP port, MCP is served on the main server bind address. Also binds the management server to 127.0.0.1 (affecting health/metrics when --observe is used). |
false |
boolean |
|
Deprecated: use --observe instead. Metrics (Micrometer and Prometheus) at /q/metrics on local HTTP server (port 8080 by default) |
false |
boolean |
|
Whether to support JBang style //DEPS to specify additional dependencies |
true |
boolean |
|
The name of the Camel application |
CamelJBang |
String |
|
Enable observability services (health, metrics, dev console, and lightweight Camel-only tracing in the TUI Spans tab) |
false |
boolean |
|
Adds an OpenAPI spec from the given file (json or yaml file) |
String |
|
|
Enable OpenTelemetry Java Agent for auto-instrumentation of third-party libraries (HTTP clients, JDBC, Kafka clients, gRPC, etc.). Traces are shown in the TUI Spans tab with Camel spans in cyan and 3rd-party agent spans in magenta. |
false |
boolean |
|
Where to export OpenTelemetry Agent telemetry: tui (embedded receiver in TUI), otlp (external OTLP collector for traces), or observability (full stack with traces and logs). With otlp, start a trace backend first (e.g. 'camel infra run jaeger'). With observability, start the stack via 'camel infra run observability'. The value 'jaeger' is deprecated and works as an alias for 'otlp'. |
tui |
String |
|
Swagger UI for REST OpenAPI at /q/openapi (OpenAPI document at /q/openapi.json; port 8080 by default) |
false |
boolean |
|
File to store the current message body (will override). This allows for manual inspecting the message later. |
String |
|
|
Whether to automatic package scan JARs for custom Spring or Quarkus beans making them available for Camel CLI |
false |
boolean |
|
Embeds a local HTTP server on this port (port 8080 by default; use 0 to dynamic assign a free random port number) |
int |
|
|
Pretty print message body when using JSon or XML format |
boolean |
|
|
Profile to run (dev, test, prod). |
dev |
String |
|
Allow user to type in required parameters in prompt if not present in application |
false |
boolean |
|
Additional properties (override existing) |
String |
|
|
comma separated list of properties file (ex. /path/to/file.properties,/path/to/other.properties |
String |
|
|
Deprecated. This value is not used anymore. It is kept only for backwards compatibility and will be removed in Camel 5.x. Camel commands may use either 'quarkus-bom' or 'quarkus-camel-bom' artifactIds depending on the context. |
quarkus-bom |
String |
|
The base URI of Quarkus Extension Registry. The default is {@value RuntimeType#QUARKUS_EXTENSION_REGISTRY_BASE_URL} unless camel.jbang.quarkus.platform.url system property is set (the /client/platforms suffix is removed if present). |
String |
|
|
groupId of Quarkus Platform BOM; honored only if --quarkus-version is set |
io.quarkus.platform |
String |
|
version of Quarkus Platform BOM; the default value is looked up in Quarkus Extension Registry |
String |
|
|
Enables dev mode (live reload when source files are updated and saved) |
boolean |
|
|
Attaches debugger remotely to an existing running Camel integration. (Add camel-cli-debug JAR to the existing Camel application and run before attaching this debugger) |
boolean |
|
|
Additional maven repositories for download on-demand (Use commas to separate multiple repositories) |
String |
|
|
Additional resource directories to include on the classpath (recursive, preserving structure) |
List |
|
|
Runtime (camel-main, spring-boot, quarkus) |
camel-main |
RuntimeType |
|
Show message body in debug messages |
true |
boolean |
|
Show exception and stacktrace for failed messages |
true |
boolean |
|
Show exchange properties in debug messages |
false |
boolean |
|
Show exchange variables in debug messages |
true |
boolean |
|
Show message headers in debug messages |
true |
boolean |
|
Skip resolving plugin dependencies |
false |
boolean |
|
Prefer to display source filename/code instead of IDs |
boolean |
|
|
Source directory for dynamically loading Camel file(s) to run. When using this, then files cannot be specified at the same time. |
String |
|
|
Spring Boot version |
RuntimeType.SPRING_BOOT_VERSION |
String |
|
Whether to stop the running Camel on exit |
true |
boolean |
|
Stubs all the matching endpoint uri with the given component name or pattern. Multiple names can be separated by comma. (all = stub all endpoints, remote = stub only remote components). |
String |
|
|
Print timestamp. |
true |
boolean |
|
Enables trace logging of the routed messages |
false |
boolean |
|
Verbose output of startup activity (dependency resolution and downloading |
false |
boolean |
|
Display the help and sub-commands |
boolean |