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 7103503 CAMEL-16861: Cleanup docs
7103503 is described below
commit 7103503547e8dbe03b38cb1aeb279b12c8015c93
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Mon Nov 1 19:28:37 2021 +0100
CAMEL-16861: Cleanup docs
---
.../modules/ROOT/pages/backlog-debugger.adoc | 77 +++++++---------------
docs/user-manual/modules/ROOT/pages/debugger.adoc | 26 ++++----
2 files changed, 35 insertions(+), 68 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/pages/backlog-debugger.adoc
b/docs/user-manual/modules/ROOT/pages/backlog-debugger.adoc
index d1ec1f8..84b4020 100644
--- a/docs/user-manual/modules/ROOT/pages/backlog-debugger.adoc
+++ b/docs/user-manual/modules/ROOT/pages/backlog-debugger.adoc
@@ -19,21 +19,11 @@ NOTE: This requires to enabled JMX by including
`camel-management` JAR in the cl
[width="100%",cols="10%,20%,70%",options="header",]
|=======================================================================
|Option |Default |Description
-
+|`bodyIncludeFiles` |`true` |Whether to include the message body of file based
messages. The overhead is that the file content has to be read from the file.
+|`bodyIncludeStreams` |`false` |Whether to include the message body of stream
based messages. If enabled then beware the stream may not be re-readable later.
See more about Stream Caching.
+|`bodyMaxChars` |`128kb` |To limit the message body to a maximum size in the
traced message. Use 0 or negative value to use unlimited size.
|`enabled` |`false` |Whether the debugger is enabled or not.
-
-|`singleStepMode` |`false` |Whether currently in single step mode of a single
-Exchange.
-
-|`bodyMaxChars` |`128kb` |To limit the message body to a maximum size in the
traced message. Use 0
-or negative value to use unlimited size.
-
-|`bodyIncludeStreams` |`false` |Whether to include the message body of stream
based messages. If enabled
-then beware the stream may not be re-readable later. See more about
-Stream Caching.
-
-|`bodyIncludeFiles` |`true` |Whether to include the message body of file based
messages. The overhead
-is that the file content has to be read from the file.
+|`singleStepMode` |`false` |Whether currently in single step mode of a single
Exchange.
|=======================================================================
== Operations
@@ -41,54 +31,31 @@ is that the file content has to be read from the file.
[width="100%",cols="10%,20%,70%",options="header",]
|=======================================================================
|Option |Type |Description
-
-|`enableDebugger` |`void` |To enable the debugger
-
+|`addBreakpoint(nodeId)` |`void` |To add a breakpoint at the given node.
+|`addConditionalBreakpoint(nodeId, language, predicate)` |`void` |To add a
conditional breakpoint at the given node. The predicate is created from the
language parameter.
+|`disableBreakpoint(nodeId)` |`void` |To disable a breakpoint temporary.
|`disableDebugger` |`void` |To disable the debugger
-
-|`getDebuggerCounter` |`long` |Gets the total number of debugged messages.
-
-|`resetDebuggerCounter` |`void` |To reset the debugger counter.
-
|`dumpTracedMessagesAsXml(nodeId)` |`String` |To dump the debugged messages
from the give node id in XML format.
-
-|`addBreakpoint(nodeId)` |`void` |To add a breakpoint at the given node.
-
-|`addConditionalBreakpoint(nodeId, language, predicate)` |`void` |To add a
conditional breakpoint at the given node. The predicate is
-created from the language parameter.
-
+|`enableBreakpoint(nodeId)` |`void` |To active a breakpoint which has been
temporary disabled.
+|`enableDebugger` |`void` |To enable the debugger
+|`getBreakpoints` |`Set<String>` |To get a set of all the nodes which has a
breakpoint added.
+|`getDebuggerCounter` |`long` |Gets the total number of debugged messages.
+|`getSuspendedBreakpointNodeIds` |`Set<String>` |To get a set of all the nodes
which has suspended breakpoints (eg an Exchange at the breakpoint which is
suspended).
|`removeBreakpoint(nodeId)` |`void` |To remove the breakpoint from the given
node id.
-
-|`resumeBreakpoint(nodeId)` |`void` |To resume a suspend breakpoint, which
will then continue routing the
-Exchange.
-
+|`resetDebuggerCounter` |`void` |To reset the debugger counter.
|`resumeAll` |`void` |To resume all suspended breakpoints.
-
-|`getSuspendedBreakpointNodeIds` |`Set<String>` |To get a set of all the nodes
which has suspended breakpoints (eg an
-Exchange at the breakpoint which is suspended).
-
-|`stepBreakpoint(nodeId)` |`void` |To start single step mode from a suspended
breakpoint at the given node.
-Then invoke `step` to step to next node in the route.
-
+|`resumeBreakpoint(nodeId)` |`void` |To resume a suspend breakpoint, which
will then continue routing the Exchange.
+|`setFallbackTimeout(value)` |`long` |Fallback Timeout in seconds (300 seconds
as default) when block the message processing in Camel. A timeout used for
waiting for a message to arrive at a given breakpoint. `
+|`setMessageBodyOnBreakpoint(nodeId,body)` |`void` |To update the message body
on the suspended Exchange at the node.
+|`setMessageHeaderOnBreakpoint(nodeId,headerName,value)` |`void` |To
update/add the message header on the suspended Exchange at the node.
+|`stepBreakpoint(nodeId)` |`void` |To start single step mode from a suspended
breakpoint at the given node. Then invoke `step` to step to next node in the
route.
|`step` |`void` |To step to next node when in single step mode.
-
-|`getBreakpoints` |`Set<String>` |To get a set of all the nodes which has a
breakpoint added.
-
-|`enableBreakpoint(nodeId)` |`void` |To active a breakpoint which has been
temporary disabled.
-
-|`disableBreakpoint(nodeId)` |`void` |To disable a breakpoint temporary.
-
-|`setMessageBodyOnBreakpoint(nodeId,body)` |`void` |To update the message body
on the suspended Exchange
-at the node.
-
-|`setMessageHeaderOnBreakpoint(nodeId,headerName,value)` |`void` |To
update/add the message header on the suspended
-Exchange at the node.
-
-| `setFallbackTimeout(value)` |`long` |Fallback Timeout in seconds (300
seconds as default) when block the message processing in Camel.
-A timeout used for waiting for a message to arrive at a given breakpoint. `
|=======================================================================
== Enabling
-You would need to enable this using the JMX API.
+You would need to enable backlogger debugger using the JMX API.
+
+== See Also
+See xref:debugger.adoc[Debugger]
\ No newline at end of file
diff --git a/docs/user-manual/modules/ROOT/pages/debugger.adoc
b/docs/user-manual/modules/ROOT/pages/debugger.adoc
index 6d02e6f..fc5ebdd 100644
--- a/docs/user-manual/modules/ROOT/pages/debugger.adoc
+++ b/docs/user-manual/modules/ROOT/pages/debugger.adoc
@@ -4,11 +4,11 @@ The Camel Debugger is intended for 3rd party tooling to make
it possible to
debug routes, trace messages and to use breakpoints with the EIP patterns in
the Camel routes.
The Debugger allows tooling or the likes to attach breakpoints which is
-being invoked when Exchanges is being routed.
+being invoked when xref:exchange.adoc[Exchanges] are routed.
-== Debugging Camel routes from `camel-test`
+== Debugging Camel routes
-If you are developing unit tests using the `camel-test` component, then
+If you are developing unit tests using the `camel-test-junit5` component, then
the Debugger is available if you turn it on via overriding the
`isUseDebugger()`
method and return `true`.
@@ -67,30 +67,30 @@ breakpoint was hit.
TIP: There is also a `debugAfter` method which is invoked after the processor
has been invoked. This allows you to _see_ what happens to the
-Exchange right after it has invoked a processor in
-the route.
+Exchange right after it has invoked a processor in the route.
The screenshot below shows the Debugger in action.
-The IDE (IDEA) has hit the breakpoint and we can inspect the
-parameters. Notice how we can see that the message is to be send to the
"mock:a"
+The IDE (IDEA) has hit the breakpoint, and we can inspect the
+parameters. Notice how we can see that the message is to be sent to the mock:a
endpoint.
image::images/debug.png[image]
-== Implementing a custom debugger
+=== Implementing a custom debugger
The debugger API is defined in `org.apache.camel.spi.Debugger`.
-This API has methods to attach and remove
-breakpoints. And to suspend/resume all breakpoints etc.
-You can also attach a condition to the breakpoint so it only reacts if
+This API has methods to attach and remove breakpoints.
+
+And to suspend/resume all breakpoints etc.
+You can also attach a condition to the breakpoint, so it only reacts if
the condition matches.
Camel provides a base implementation `org.apache.camel.impl.DefaultDebugger`,
which can be used to extend for custom implementations.
-== JMX debugger
+=== JMX debugger
-There is also a `BacklogDebugger` which allows to debug from JMX,
+There is also a xref:backlog-debugger.adoc[Backlog Debugger] which allows
debugging from JMX,
and some 3rd party tooling such as https://hawt.io/[hawtio] uses this for its
web based debugging functionality.
