camel debug

Debug local Camel integration

Usage

camel debug [options]

Options

Option Description Default Type

--ago

Use ago instead of yyyy-MM-dd HH:mm:ss in timestamp.

boolean

--background

Run in the background

false

boolean

--background-wait

To wait for run in background to startup successfully, before returning

true

boolean

--backlog-trace

Enables backlog tracing of the routed messages

false

boolean

--breakpoint

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

--camel-spring-boot-version

To run using a different Camel Spring Boot version than the default version.

String

--camel-version

To run using a different Camel version than the default version.

String

--code

Run the given text or file as Java DSL routes

String

--console

Developer console at /q/dev on local HTTP server (port 8080 by default)

false

boolean

--dep,--dependency

Add additional dependencies

List

--download

Whether to allow automatic downloading JAR dependencies (over the internet)

true

boolean

--empty

Run an empty Camel without loading source files

false

boolean

--exclude

Exclude files by name or pattern

List

--fresh

Make sure we use fresh (i.e. non-cached) resources

false

boolean

--gav

The Maven group:artifact:version (used during exporting)

String

--health (deprecated)

Deprecated: use --observe instead. Health check at /q/health on local HTTP server (port 8080 by default)

false

boolean

--ignore-loading-error

Whether to ignore route loading and compilation errors (use this with care!)

false

boolean

--jfr

Enables Java Flight Recorder saving recording to disk on exit

false

boolean

--jfr-profile

Java Flight Recorder profile to use (such as default or profile)

String

--jvm-debug

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

--kamelets-version

Apache Camel Kamelets version

String

--lazy-bean

Whether to use lazy bean initialization (can help with complex classloading issues)

false

boolean

--local-kamelet-dir

Local directory (or github link) for loading Kamelets (takes precedence). Multiple directories can be specified separated by comma.

String

--log-lines

Number of log lines to display on top of screen

10

int

--logging

Can be used to turn off logging

true

boolean

--logging-category

Used for individual logging levels (ex: org.apache.kafka=DEBUG)

List

--logging-color

Use colored logging

true

boolean

--logging-config-path

Path to file with custom logging configuration

String

--logging-json

Use JSON logging (ECS Layout)

false

boolean

--logging-level

Logging level ()

info

String

--management-port

To use a dedicated port for HTTP management (use 0 to dynamic assign a free random port number)

int

--mask

Whether to mask endpoint URIs to avoid printing sensitive information such as password or access keys

boolean

--maven-apache-snapshot-enabled

Whether downloading JARs from ASF Maven Snapshot repository is enabled

true

boolean

--maven-central-enabled

Whether downloading JARs from Maven Central repository is enabled

true

boolean

--maven-settings

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

--maven-settings-security

Optional location of Maven settings-security.xml file to decrypt settings.xml

String

--max-idle-seconds

For how long time in seconds Camel can be idle before stopping

0

int

--max-messages

Max number of messages to process before stopping

0

int

--max-seconds

Max seconds to run before stopping

0

int

--metrics (deprecated)

Deprecated: use --observe instead. Metrics (Micrometer and Prometheus) at /q/metrics on local HTTP server (port 8080 by default)

false

boolean

--modeline

Whether to support JBang style //DEPS to specify additional dependencies

true

boolean

--name

The name of the Camel application

CamelJBang

String

--observe

Enable observability services

false

boolean

--open-api

Adds an OpenAPI spec from the given file (json or yaml file)

String

--output

File to store the current message body (will override). This allows for manual inspecting the message later.

String

--package-scan-jars

Whether to automatic package scan JARs for custom Spring or Quarkus beans making them available for Camel JBang

false

boolean

--port

Embeds a local HTTP server on this port (port 8080 by default; use 0 to dynamic assign a free random port number)

int

--pretty

Pretty print message body when using JSon or XML format

boolean

--profile

Profile to run (dev, test, or prod).

dev

String

--prompt

Allow user to type in required parameters in prompt if not present in application

false

boolean

--prop,--property

Additional properties (override existing)

String

--properties

comma separated list of properties file (ex. /path/to/file.properties,/path/to/other.properties

String

--quarkus-artifact-id

Quarkus Platform Maven artifactId

quarkus-bom

String

--quarkus-group-id

Quarkus Platform Maven groupId

io.quarkus.platform

String

--quarkus-version

Quarkus Platform version

RuntimeType.QUARKUS_VERSION

String

--reload,--dev

Enables dev mode (live reload when source files are updated and saved)

boolean

--remote-attach

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

--repo,--repos

Additional maven repositories (Use commas to separate multiple repositories)

String

--runtime

Runtime ()

camel-main

RuntimeType

--show-body

Show message body in debug messages

true

boolean

--show-exception

Show exception and stacktrace for failed messages

true

boolean

--show-exchange-properties

Show exchange properties in debug messages

false

boolean

--show-exchange-variables

Show exchange variables in debug messages

true

boolean

--show-headers

Show message headers in debug messages

true

boolean

--skip-plugins

Skip plugins during export

false

boolean

--source

Prefer to display source filename/code instead of IDs

boolean

--source-dir

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

Spring Boot version

RuntimeType.SPRING_BOOT_VERSION

String

--stop-on-exit

Whether to stop the running Camel on exit

true

boolean

--stub

Stubs all the matching endpoint uri with the given component name or pattern. Multiple names can be separated by comma. (all = stub all endpoints).

String

--timestamp

Print timestamp.

true

boolean

--trace

Enables trace logging of the routed messages

false

boolean

--verbose

Verbose output of startup activity (dependency resolution and downloading

false

boolean

-h,--help

Display the help and sub-commands

boolean