Skip to content

Commit 2b69629

Browse files
committed
docs: add instructions for Camel plugin
Fix hawtio/hawtio-react#1824
1 parent df9df47 commit 2b69629

File tree

3 files changed

+63
-1
lines changed

3 files changed

+63
-1
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* Using Hawtio
66
** xref:configuration.adoc[]
77
** xref:plugins.adoc[]
8+
*** xref:plugins/camel.adoc[]
89
* Securing Hawtio
910
** xref:security.adoc[]
1011
** xref:oidc.adoc[]

modules/ROOT/pages/plugins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The following plugins are all included by default in Hawtio:
1717
|===
1818
|Plugin |Description
1919

20-
|https://github.com/hawtio/hawtio-next/tree/main/packages/hawtio/src/plugins/camel[Camel]
20+
|xref:plugins/camel.adoc[Camel]
2121
a|Adds support for https://camel.apache.org[Apache Camel]. Allows you to browse Camel contexts, routes, endpoints, etc.; visualise running routes and their metrics; create endpoints; send messages; trace message flows; and profile routes to identify which parts runs fast or slow.
2222

2323
Requirements:: A Camel application needs to be running in the JVM. The Camel application needs to include https://camel.apache.org/manual/jmx.html[Camel Management] component to enable JMX. The Source tab requires https://camel.apache.org/components/3.21.x/others/java-xml-jaxb-dsl.html[Camel XML DSL] support. The Debug tab requires https://camel.apache.org/components/3.21.x/others/debug.html[Camel Debug] component. The Trace tab requires enabling of https://camel.apache.org/manual/tracer.html[Camel Tracer].
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
= Camel
2+
3+
The Camel plugin adds support for https://camel.apache.org[Apache Camel]. It allows you to browse Camel contexts, routes, endpoints, etc.; visualise running routes and their metrics; create endpoints; send messages; trace message flows; and profile routes to identify which parts runs fast or slow.
4+
5+
== Requirements
6+
7+
A Camel application needs to be running in the JVM, which needs to include https://camel.apache.org/manual/jmx.html[Camel Management] component to enable JMX.
8+
9+
=== Source
10+
11+
The Source tab requires https://camel.apache.org/components/3.21.x/others/java-xml-jaxb-dsl.html[Camel XML DSL] support.
12+
13+
=== Debug
14+
15+
The Debug tab requires https://camel.apache.org/components/3.21.x/others/debug.html[Camel Debug] component.
16+
17+
=== Trace
18+
19+
The Trace tab requires enabling of https://camel.apache.org/manual/tracer.html[Camel Tracer].
20+
21+
=== Exchanges
22+
23+
To enable browsing of inflight exchanges in the **Exchanges** tab, the following Camel Main option needs to be enabled:
24+
25+
[source,java]
26+
.`application.properties`
27+
----
28+
camel.main.inflight-repository-browse-enabled = true
29+
----
30+
31+
=== Endpoints (in/out)
32+
33+
To activate the **Endpoints (in/out)** tab, either or both of the following Camel Main options need to be enabled:
34+
35+
[source,java]
36+
.`application.properties`
37+
----
38+
camel.main.endpoint-runtime-statistics-enabled = true
39+
camel.main.jmx-management-statistics-level = Extended
40+
----
41+
42+
== Usage
43+
44+
Click the Camel tab in the top navigation bar to view the running Camel Context in the current JVM.
45+
The selection will not appear on the navigation bar if there is no Camel Context running.
46+
47+
The Camel plugin allows you to view all the running Camel applications in the current JVM.
48+
You can among others see the following details:
49+
50+
- Lists of all running Camel applications
51+
- Detailed information of each Camel Context such as Camel version number, runtime statics
52+
- Lists of all routes in each Camel applications and their runtime statistics
53+
- Manage the lifecycle of all Camel applications and their routes, so you can restart / stop / pause / resume, etc.
54+
- Graphical representation of the running routes along with real time metrics
55+
- Live tracing and debugging of running routes
56+
- Profile the running routes with real time runtime statics; detailed specified per processor
57+
- Browsing and sending messages to Camel endpoint
58+
59+
== Source
60+
61+
https://github.com/hawtio/hawtio-next/tree/main/packages/hawtio/src/plugins/camel

0 commit comments

Comments
 (0)