You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2022/06/22 12:46:55 UTC

[camel] branch main updated: CAMEL-18149: camel-spring-boot - Add camel developer console as actuator that can be enabled.

This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/main by this push:
     new 2e68793ce12 CAMEL-18149: camel-spring-boot - Add camel developer console as actuator that can be enabled.
2e68793ce12 is described below

commit 2e68793ce121badd1f8c3a8bd0edfabf7938506c
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Jun 22 14:46:40 2022 +0200

    CAMEL-18149: camel-spring-boot - Add camel developer console as actuator that can be enabled.
---
 .../modules/ROOT/pages/camel-console.adoc          | 45 ++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/docs/user-manual/modules/ROOT/pages/camel-console.adoc b/docs/user-manual/modules/ROOT/pages/camel-console.adoc
index a3d04ec5a2c..4c0505a0f2c 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-console.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-console.adoc
@@ -27,6 +27,51 @@ configuration:
 camel.main.dev-console-enabled = true
 ----
 
+=== Using Dev Console in Camel Spring Boot
+
+The Camel developer console is available in Spring Boot as an _actuator_. To enable the console
+you need to add dependency:
+
+[source,xml]
+----
+<dependency>
+    <groupId>org.apache.camel.springboot</groupId>
+    <artifactId>camel-console-starter</artifactId>
+</dependency>
+----
+
+To include more details such as route metrics you need to include JMX management:
+
+[source,xml]
+----
+<dependency>
+    <groupId>org.apache.camel.springboot</groupId>
+    <artifactId>camel-management-starter</artifactId>
+</dependency>
+----
+
+And finally you **must** enable `camel` in the exposed list of HTTP actuator endpoints in `application.properties` as shown:
+
+[source,properties]
+----
+management.endpoints.web.exposure.include=info,health,camel
+----
+
+The console is then available on HTTP (using default port):
+
+[source,text]
+----
+http://localhost:8080/actuator/camel
+----
+
+This will list the available consoles, and you can then call a console by its id, such as `routes`:
+
+[source,text]
+----
+http://localhost:8080/actuator/camel/routes
+----
+
+
 === Dev Console and Camel JBang
 
 The Developer Console is easily available when using xref:camel-jbang.adoc[Camel JBang],