Console

JVM since2.16.0 Nativeunsupported

Camel Developer Console

What’s inside

Please refer to the above link for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-console</artifactId>
</dependency>

Check the User guide for more information about writing Camel Quarkus applications.

Usage

Developer console endpoint

To access the developer console, you must first enable it by adding configuration to application.properties.

quarkus.camel.console.enabled=true

Alternatively you can use a camel-main configuration option.

camel.main.dev-console-enabled=true

The console is then available at the following URL.

http://localhost:8080/q/camel/dev-console

You can then call a console by its id, such as routes:

http://localhost:8080/q/camel/dev-console/routes

Exposing the developer console in prod mode

By default, the console is only exposed in dev and test modes. To expose the console in prod mode, add the following configuration to application.properties.

quarkus.camel.console.exposure-mode=ALL

See the configuration overview below for further details about exposure-mode.

The console authenticates nobody. Anyone who can reach it can read what the consoles expose, which includes route and endpoint configuration, in-flight and recent exchange data, JVM and environment details, and the application’s own configuration values. Confine it to a trusted network, or put authentication in front of it, before enabling ALL in prod.

The route is registered as a Quarkus non-application endpoint. Those are served on the main HTTP port under /q/ unless a separate management interface is enabled, so by default the console shares the socket that serves application traffic rather than sitting on a port you can firewall separately. To move it to its own port, enable the management interface.

quarkus.management.enabled=true

Additional Camel Quarkus configuration

Configuration property Type Default

quarkus.camel.console.enabled

Whether the Camel developer console is enabled.

boolean

false

quarkus.camel.console.path

The context path under which the Camel developer console is deployed (default /q/camel/dev-console).

string

camel/dev-console

quarkus.camel.console.exposure-mode

The modes in which the Camel developer console is available. The default dev-test enables the developer console only in dev mode and test modes. A value of all enables agent discovery in dev, test and prod modes. Setting the value to none will not expose the developer console HTTP endpoint.

all, dev-test, none

dev-test

Configuration property fixed at build time. All other configuration properties are overridable at runtime.

Back to top