Var trace (#13088)

CAMEL-20408: camel-core - Tracer should include exchange variables
apache · Feb 11, 2024 · 400db38 · 400db38
1 parent 6cf17ad
commit 400db38
Show file tree

Hide file tree

Showing 24 changed files with 256 additions and 43 deletions.
diff --git a/.../generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json b/.../generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
@@ -143,6 +143,7 @@
     { "name": "camel.debug.fallbackTimeout", "description": "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.", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "integer", "javaType": "long", "defaultValue": 300 },
     { "name": "camel.debug.includeException", "description": "Trace messages to include exception if the message failed", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": true },
     { "name": "camel.debug.includeExchangeProperties", "description": "Whether to include the exchange properties in the traced message", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": true },
+    { "name": "camel.debug.includeExchangeVariables", "description": "Whether to include the exchange variables in the traced message", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": true },
     { "name": "camel.debug.loggingLevel", "description": "The debugger logging level to use when logging activity.", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "object", "javaType": "org.apache.camel.LoggingLevel", "defaultValue": "INFO", "enum": [ "ERROR", "WARN", "INFO", "DEBUG", "TRACE", "OFF" ] },
     { "name": "camel.debug.singleStepIncludeStartEnd", "description": "In single step mode, then when the exchange is created and completed, then simulate a breakpoint at start and end, that allows to suspend and watch the incoming\/complete exchange at the route (you can see message body as response, failed exception etc).", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": "false" },
     { "name": "camel.debug.standby", "description": "To set the debugger in standby mode, where the debugger will be installed by not automatic enabled. The debugger can then later be enabled explicit from Java, JMX or tooling.", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": "false" },

diff --git a/components/camel-stub/src/main/java/org/apache/camel/component/stub/StubConsole.java b/components/camel-stub/src/main/java/org/apache/camel/component/stub/StubConsole.java
@@ -165,7 +165,7 @@ protected JsonObject doCallJson(Map<String, Object> options) {
                 for (Exchange exchange : copy) {
                     try {
                         JsonObject msg
-                                = MessageHelper.dumpAsJSonObject(exchange.getMessage(), false, true, true, false, true,
+                                = MessageHelper.dumpAsJSonObject(exchange.getMessage(), false, true, true,true, false, true,
                                         128 * 1024);
                         arr.add(msg);
                     } catch (Exception e) {

diff --git a/core/camel-api/src/main/java/org/apache/camel/spi/BacklogDebugger.java b/core/camel-api/src/main/java/org/apache/camel/spi/BacklogDebugger.java
@@ -352,6 +352,16 @@ void setExchangePropertyOnBreakpoint(String nodeId, String exchangePropertyName,
      */
     void setIncludeExchangeProperties(boolean includeExchangeProperties);
 
+    /**
+     * Whether to include the exchange variables in the traced message
+     */
+    boolean isIncludeExchangeVariables();
+
+    /**
+     * Whether to include the exchange variables in the traced message
+     */
+    void setIncludeExchangeVariables(boolean includeExchangeVariables);
+
     /**
      * Trace messages to include exception if the message failed
      */

diff --git a/core/camel-api/src/main/java/org/apache/camel/spi/BacklogTracer.java b/core/camel-api/src/main/java/org/apache/camel/spi/BacklogTracer.java
@@ -109,6 +109,16 @@ public interface BacklogTracer {
      */
     void setIncludeExchangeProperties(boolean includeExchangeProperties);
 
+    /**
+     * Trace messages to include exchange variables
+     */
+    boolean isIncludeExchangeVariables();
+
+    /**
+     * Trace messages to include exchange variables
+     */
+    void setIncludeExchangeVariables(boolean includeExchangeVariables);
+
     /**
      * Trace messages to include exception if the message failed
      */

diff --git a/core/camel-base-engine/src/main/java/org/apache/camel/impl/debugger/BacklogTracer.java b/core/camel-base-engine/src/main/java/org/apache/camel/impl/debugger/BacklogTracer.java
@@ -61,6 +61,7 @@ public final class BacklogTracer extends ServiceSupport implements org.apache.ca
     private boolean bodyIncludeStreams;
     private boolean bodyIncludeFiles = true;
     private boolean includeExchangeProperties = true;
+    private boolean includeExchangeVariables = true;
     private boolean includeException = true;
     private boolean traceRests;
     private boolean traceTemplates;
@@ -236,6 +237,16 @@ public void setIncludeExchangeProperties(boolean includeExchangeProperties) {
         this.includeExchangeProperties = includeExchangeProperties;
     }
 
+    @Override
+    public boolean isIncludeExchangeVariables() {
+        return includeExchangeVariables;
+    }
+
+    @Override
+    public void setIncludeExchangeVariables(boolean includeExchangeVariables) {
+        this.includeExchangeVariables = includeExchangeVariables;
+    }
+
     @Override
     public boolean isIncludeException() {
         return includeException;

diff --git a/...amel-base-engine/src/main/java/org/apache/camel/impl/debugger/DefaultBacklogDebugger.java b/...amel-base-engine/src/main/java/org/apache/camel/impl/debugger/DefaultBacklogDebugger.java
@@ -82,6 +82,7 @@ public final class DefaultBacklogDebugger extends ServiceSupport implements Back
     private boolean bodyIncludeStreams;
     private boolean bodyIncludeFiles = true;
     private boolean includeExchangeProperties = true;
+    private boolean includeExchangeVariables = true;
     private boolean includeException = true;
 
     /**
@@ -677,6 +678,16 @@ public void setIncludeExchangeProperties(boolean includeExchangeProperties) {
         this.includeExchangeProperties = includeExchangeProperties;
     }
 
+    @Override
+    public boolean isIncludeExchangeVariables() {
+        return includeExchangeVariables;
+    }
+
+    @Override
+    public void setIncludeExchangeVariables(boolean includeExchangeVariables) {
+        this.includeExchangeVariables = includeExchangeVariables;
+    }
+
     @Override
     public boolean isIncludeException() {
         return includeException;
@@ -792,7 +803,7 @@ private void refreshBacklogTracerEventMessage(String nodeId, SuspendedExchange s
      * @return          the XML
      */
     private String dumpAsXml(Exchange exchange) {
-        return MessageHelper.dumpAsXml(exchange.getIn(), includeExchangeProperties, true, 2, true,
+        return MessageHelper.dumpAsXml(exchange.getIn(), includeExchangeProperties, includeExchangeVariables, true, 2, true,
                 isBodyIncludeStreams(), isBodyIncludeFiles(),
                 getBodyMaxChars());
     }
@@ -804,7 +815,7 @@ private String dumpAsXml(Exchange exchange) {
      * @return          the JSon
      */
     private String dumpAsJSon(Exchange exchange) {
-        return MessageHelper.dumpAsJSon(exchange.getIn(), includeExchangeProperties, true, 2, true,
+        return MessageHelper.dumpAsJSon(exchange.getIn(), includeExchangeProperties, includeExchangeVariables, true, 2, true,
                 isBodyIncludeStreams(), isBodyIncludeFiles(),
                 getBodyMaxChars(), true);
     }

diff --git a/.../camel-base-engine/src/main/java/org/apache/camel/impl/engine/CamelInternalProcessor.java b/.../camel-base-engine/src/main/java/org/apache/camel/impl/engine/CamelInternalProcessor.java
@@ -636,10 +636,13 @@ public DefaultBacklogTracerEventMessage before(Exchange exchange) throws Excepti
                 String toNode = processorDefinition.getId();
                 String exchangeId = exchange.getExchangeId();
                 boolean includeExchangeProperties = backlogTracer.isIncludeExchangeProperties();
-                String messageAsXml = MessageHelper.dumpAsXml(exchange.getIn(), includeExchangeProperties, true, 4,
+                boolean includeExchangeVariables = backlogTracer.isIncludeExchangeVariables();
+                String messageAsXml = MessageHelper.dumpAsXml(exchange.getIn(), includeExchangeProperties,
+                        includeExchangeVariables, true, 4,
                         true, backlogTracer.isBodyIncludeStreams(), backlogTracer.isBodyIncludeFiles(),
                         backlogTracer.getBodyMaxChars());
-                String messageAsJSon = MessageHelper.dumpAsJSon(exchange.getIn(), includeExchangeProperties, true, 4,
+                String messageAsJSon = MessageHelper.dumpAsJSon(exchange.getIn(), includeExchangeProperties,
+                        includeExchangeVariables, true, 4,
                         true, backlogTracer.isBodyIncludeStreams(), backlogTracer.isBodyIncludeFiles(),
                         backlogTracer.getBodyMaxChars(), true);
 
@@ -675,12 +678,15 @@ public void onDone(Exchange exchange) {
                     String routeId = routeDefinition != null ? routeDefinition.getRouteId() : null;
                     String exchangeId = exchange.getExchangeId();
                     boolean includeExchangeProperties = backlogTracer.isIncludeExchangeProperties();
+                    boolean includeExchangeVariables = backlogTracer.isIncludeExchangeVariables();
                     long created = exchange.getClock().getCreated();
-                    String messageAsXml = MessageHelper.dumpAsXml(exchange.getIn(), includeExchangeProperties, true, 4,
+                    String messageAsXml = MessageHelper.dumpAsXml(exchange.getIn(), includeExchangeProperties,
+                            includeExchangeVariables, true, 4,
                             true, backlogTracer.isBodyIncludeStreams(), backlogTracer.isBodyIncludeFiles(),
                             backlogTracer.getBodyMaxChars());
                     String messageAsJSon
-                            = MessageHelper.dumpAsJSon(exchange.getIn(), includeExchangeProperties, true, 4,
+                            = MessageHelper.dumpAsJSon(exchange.getIn(), includeExchangeProperties, includeExchangeVariables,
+                                    true, 4,
                                     true, backlogTracer.isBodyIncludeStreams(), backlogTracer.isBodyIncludeFiles(),
                                     backlogTracer.getBodyMaxChars(), true);
                     DefaultBacklogTracerEventMessage pseudoLast = new DefaultBacklogTracerEventMessage(

diff --git a/...n/src/generated/java/org/apache/camel/main/DebuggerConfigurationPropertiesConfigurer.java b/...n/src/generated/java/org/apache/camel/main/DebuggerConfigurationPropertiesConfigurer.java
@@ -37,6 +37,8 @@ public boolean configure(CamelContext camelContext, Object obj, String name, Obj
         case "IncludeException": target.setIncludeException(property(camelContext, boolean.class, value)); return true;
         case "includeexchangeproperties":
         case "IncludeExchangeProperties": target.setIncludeExchangeProperties(property(camelContext, boolean.class, value)); return true;
+        case "includeexchangevariables":
+        case "IncludeExchangeVariables": target.setIncludeExchangeVariables(property(camelContext, boolean.class, value)); return true;
         case "logginglevel":
         case "LoggingLevel": target.setLoggingLevel(property(camelContext, org.apache.camel.LoggingLevel.class, value)); return true;
         case "singlestepincludestartend":
@@ -68,6 +70,8 @@ public Class<?> getOptionType(String name, boolean ignoreCase) {
         case "IncludeException": return boolean.class;
         case "includeexchangeproperties":
         case "IncludeExchangeProperties": return boolean.class;
+        case "includeexchangevariables":
+        case "IncludeExchangeVariables": return boolean.class;
         case "logginglevel":
         case "LoggingLevel": return org.apache.camel.LoggingLevel.class;
         case "singlestepincludestartend":
@@ -100,6 +104,8 @@ public Object getOptionValue(Object obj, String name, boolean ignoreCase) {
         case "IncludeException": return target.isIncludeException();
         case "includeexchangeproperties":
         case "IncludeExchangeProperties": return target.isIncludeExchangeProperties();
+        case "includeexchangevariables":
+        case "IncludeExchangeVariables": return target.isIncludeExchangeVariables();
         case "logginglevel":
         case "LoggingLevel": return target.getLoggingLevel();
         case "singlestepincludestartend":

diff --git a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
@@ -143,6 +143,7 @@
     { "name": "camel.debug.fallbackTimeout", "description": "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.", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "integer", "javaType": "long", "defaultValue": 300 },
     { "name": "camel.debug.includeException", "description": "Trace messages to include exception if the message failed", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": true },
     { "name": "camel.debug.includeExchangeProperties", "description": "Whether to include the exchange properties in the traced message", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": true },
+    { "name": "camel.debug.includeExchangeVariables", "description": "Whether to include the exchange variables in the traced message", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": true },
     { "name": "camel.debug.loggingLevel", "description": "The debugger logging level to use when logging activity.", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "object", "javaType": "org.apache.camel.LoggingLevel", "defaultValue": "INFO", "enum": [ "ERROR", "WARN", "INFO", "DEBUG", "TRACE", "OFF" ] },
     { "name": "camel.debug.singleStepIncludeStartEnd", "description": "In single step mode, then when the exchange is created and completed, then simulate a breakpoint at start and end, that allows to suspend and watch the incoming\/complete exchange at the route (you can see message body as response, failed exception etc).", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": "false" },
     { "name": "camel.debug.standby", "description": "To set the debugger in standby mode, where the debugger will be installed by not automatic enabled. The debugger can then later be enabled explicit from Java, JMX or tooling.", "sourceType": "org.apache.camel.main.DebuggerConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": "false" },

diff --git a/core/camel-main/src/main/docs/main.adoc b/core/camel-main/src/main/docs/main.adoc
@@ -187,7 +187,7 @@ The camel.server supports 12 options, which are listed below.
 
 
 === Camel Debugger configurations
-The camel.debug supports 12 options, which are listed below.
+The camel.debug supports 13 options, which are listed below.
 
 [width="100%",cols="2,5,^1,2",options="header"]
 |===
@@ -200,6 +200,7 @@ The camel.debug supports 12 options, which are listed below.
 | *camel.debug.fallbackTimeout* | 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. | 300 | long
 | *camel.debug.includeException* | Trace messages to include exception if the message failed | true | boolean
 | *camel.debug.includeExchange{zwsp}Properties* | Whether to include the exchange properties in the traced message | true | boolean
+| *camel.debug.includeExchange{zwsp}Variables* | Whether to include the exchange variables in the traced message | true | boolean
 | *camel.debug.loggingLevel* | The debugger logging level to use when logging activity. | INFO | LoggingLevel
 | *camel.debug.singleStepInclude{zwsp}StartEnd* | In single step mode, then when the exchange is created and completed, then simulate a breakpoint at start and end, that allows to suspend and watch the incoming/complete exchange at the route (you can see message body as response, failed exception etc). | false | boolean
 | *camel.debug.standby* | To set the debugger in standby mode, where the debugger will be installed by not automatic enabled. The debugger can then later be enabled explicit from Java, JMX or tooling. | false | boolean

diff --git a/core/camel-main/src/main/java/org/apache/camel/main/BaseMainSupport.java b/core/camel-main/src/main/java/org/apache/camel/main/BaseMainSupport.java
@@ -1649,6 +1649,7 @@ private void setDebuggerProperties(
         debugger.setBodyIncludeStreams(config.isBodyIncludeStreams());
         debugger.setBodyIncludeFiles(config.isBodyIncludeFiles());
         debugger.setIncludeExchangeProperties(config.isIncludeExchangeProperties());
+        debugger.setIncludeExchangeVariables(config.isIncludeExchangeVariables());
         debugger.setIncludeException(config.isIncludeException());
         debugger.setLoggingLevel(config.getLoggingLevel().name());
         debugger.setSuspendMode(config.isWaitForAttach());

diff --git a/core/camel-main/src/main/java/org/apache/camel/main/DebuggerConfigurationProperties.java b/core/camel-main/src/main/java/org/apache/camel/main/DebuggerConfigurationProperties.java
@@ -50,6 +50,8 @@ public class DebuggerConfigurationProperties implements BootstrapCloseable {
     @Metadata(defaultValue = "true")
     private boolean includeExchangeProperties = true;
     @Metadata(defaultValue = "true")
+    private boolean includeExchangeVariables = true;
+    @Metadata(defaultValue = "true")
     private boolean includeException = true;
     @Metadata(label = "advanced", defaultValue = "300")
     private long fallbackTimeout = 300;
@@ -185,6 +187,17 @@ public void setIncludeExchangeProperties(boolean includeExchangeProperties) {
         this.includeExchangeProperties = includeExchangeProperties;
     }
 
+    public boolean isIncludeExchangeVariables() {
+        return includeExchangeVariables;
+    }
+
+    /**
+     * Whether to include the exchange variables in the traced message
+     */
+    public void setIncludeExchangeVariables(boolean includeExchangeVariables) {
+        this.includeExchangeVariables = includeExchangeVariables;
+    }
+
     public boolean isIncludeException() {
         return includeException;
     }
@@ -296,6 +309,14 @@ public DebuggerConfigurationProperties withIncludeExchangeProperties(boolean inc
         return this;
     }
 
+    /**
+     * Whether to include the exchange variables in the traced message
+     */
+    public DebuggerConfigurationProperties withIncludeExchangeVariables(boolean includeExchangeVariables) {
+        this.includeExchangeVariables = includeExchangeVariables;
+        return this;
+    }
+
     /**
      * Trace messages to include exception if the message failed
      */

diff --git a/...-api/src/main/java/org/apache/camel/api/management/mbean/ManagedBacklogDebuggerMBean.java b/...-api/src/main/java/org/apache/camel/api/management/mbean/ManagedBacklogDebuggerMBean.java
@@ -137,6 +137,12 @@ public interface ManagedBacklogDebuggerMBean {
     @ManagedAttribute(description = "Whether to include exchange properties in the trace message.")
     void setIncludeExchangeProperties(boolean includeExchangeProperties);
 
+    @ManagedAttribute(description = "Whether to include exchange variables in the trace message.")
+    boolean isIncludeExchangeVariables();
+
+    @ManagedAttribute(description = "Whether to include exchange variables in the trace message.")
+    void setIncludeExchangeVariables(boolean includeExchangeVariables);
+
     @ManagedOperation(description = "Dumps the messages in XML format from the suspended breakpoint at the given node.")
     String dumpTracedMessagesAsXml(String nodeId);
 

diff --git a/...nt-api/src/main/java/org/apache/camel/api/management/mbean/ManagedBacklogTracerMBean.java b/...nt-api/src/main/java/org/apache/camel/api/management/mbean/ManagedBacklogTracerMBean.java
@@ -93,15 +93,21 @@ public interface ManagedBacklogTracerMBean {
     @ManagedAttribute(description = "Whether to include exchange properties in the trace message.")
     boolean isIncludeExchangeProperties();
 
+    @ManagedAttribute(description = "Whether to include exchange properties in the trace message.")
+    void setIncludeExchangeProperties(boolean includeExchangeProperties);
+
+    @ManagedAttribute(description = "Whether to include exchange variables in the trace message.")
+    boolean isIncludeExchangeVariables();
+
+    @ManagedAttribute(description = "Whether to include exchange variables in the trace message.")
+    void setIncludeExchangeVariables(boolean includeExchangeVariables);
+
     @ManagedAttribute(description = "Whether tracing routes created from Rest DSL.")
     boolean isTraceRests();
 
     @ManagedAttribute(description = "Whether tracing routes created from route templates or kamelets.")
     boolean isTraceTemplates();
 
-    @ManagedAttribute(description = "Whether to include exchange properties in the trace message.")
-    void setIncludeExchangeProperties(boolean includeExchangeProperties);
-
     @ManagedOperation(description = "Dumps the traced messages for the given node or route")
     List<BacklogTracerEventMessage> dumpTracedMessages(String nodeOrRouteId);