You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ta...@apache.org on 2018/08/16 16:38:14 UTC

qpid-jms git commit: QPIDJMS-411 Improve output of amqp.traceFrames with payload

Repository: qpid-jms
Updated Branches:
  refs/heads/master 495e27dcc -> b1b417ed8


QPIDJMS-411 Improve output of amqp.traceFrames with payload

Output payload as formatted string with truncation (configuration of
length added).

Project: http://git-wip-us.apache.org/repos/asf/qpid-jms/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-jms/commit/b1b417ed
Tree: http://git-wip-us.apache.org/repos/asf/qpid-jms/tree/b1b417ed
Diff: http://git-wip-us.apache.org/repos/asf/qpid-jms/diff/b1b417ed

Branch: refs/heads/master
Commit: b1b417ed8b4dfac096872cf2706e33282f1a064e
Parents: 495e27d
Author: Timothy Bish <ta...@gmail.com>
Authored: Thu Aug 16 12:36:11 2018 -0400
Committer: Timothy Bish <ta...@gmail.com>
Committed: Thu Aug 16 12:36:11 2018 -0400

----------------------------------------------------------------------
 .../jms/provider/amqp/AmqpProtocolTracer.java   | 102 +++++++++++++++++++
 .../qpid/jms/provider/amqp/AmqpProvider.java    |  23 ++---
 .../src/test/resources/log4j.properties         |   2 +
 3 files changed, 114 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/b1b417ed/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/AmqpProtocolTracer.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/AmqpProtocolTracer.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/AmqpProtocolTracer.java
new file mode 100644
index 0000000..b1fdc4e
--- /dev/null
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/AmqpProtocolTracer.java
@@ -0,0 +1,102 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.qpid.jms.provider.amqp;
+
+import org.apache.qpid.proton.amqp.Binary;
+import org.apache.qpid.proton.engine.impl.ProtocolTracer;
+import org.apache.qpid.proton.framing.TransportFrame;
+import org.slf4j.Logger;
+
+/**
+ * Proton-J ProtocolTracer implementation that writes AMQP frame data to the
+ * given logger target.
+ */
+public class AmqpProtocolTracer implements ProtocolTracer {
+
+    public static final int DEFAULT_PAYLOAD_STRING_LIMIT = 1024;
+
+    private final Logger logger;
+    private final int payloadStringLimit;
+
+    public AmqpProtocolTracer(Logger logger) {
+        this(logger, DEFAULT_PAYLOAD_STRING_LIMIT);
+    }
+
+    public AmqpProtocolTracer(Logger logger, int payloadStringLimit) {
+        this.logger = logger;
+        this.payloadStringLimit = payloadStringLimit;
+    }
+
+    @Override
+    public void receivedFrame(TransportFrame transportFrame) {
+        logger.trace("RECV: {} {}", transportFrame.getBody(), formatPayload(transportFrame));
+    }
+
+    @Override
+    public void sentFrame(TransportFrame transportFrame) {
+        logger.trace("SENT: {} {}", transportFrame.getBody(), formatPayload(transportFrame));
+    }
+
+    private String formatPayload(TransportFrame frame) {
+        Binary payload = frame.getPayload();
+
+        if (payload == null || payload.getLength() == 0 || payloadStringLimit <= 0) {
+            return "";
+        }
+
+        final byte[] binData = payload.getArray();
+        final int binLength = payload.getLength();
+        final int offset = payload.getArrayOffset();
+
+        StringBuilder builder = new StringBuilder();
+
+        // Prefix the payload with total bytes which gives insight regardless of truncation.
+        builder.append(" (").append(payload.getLength()).append(") ").append("\"");
+
+        int size = 0;
+        boolean truncated = false;
+        for (int i = 0; i < binLength; i++) {
+            byte c = binData[offset + i];
+
+            if (c > 31 && c < 127 && c != '\\') {
+                if (size + 1 <= payloadStringLimit) {
+                    size += 1;
+                    builder.append((char) c);
+                } else {
+                    truncated = true;
+                    break;
+                }
+            } else {
+                if (size + 4 <= payloadStringLimit) {
+                    size += 4;
+                    builder.append(String.format("\\x%02x", c));
+                } else {
+                    truncated = true;
+                    break;
+                }
+            }
+        }
+
+        builder.append("\"");
+
+        if (truncated) {
+            builder.append("...(truncated)");
+        }
+
+        return builder.toString();
+    }
+}

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/b1b417ed/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/AmqpProvider.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/AmqpProvider.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/AmqpProvider.java
index 1c97dfe..cc3915d 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/AmqpProvider.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/provider/amqp/AmqpProvider.java
@@ -82,10 +82,8 @@ import org.apache.qpid.proton.engine.Event.Type;
 import org.apache.qpid.proton.engine.Sasl;
 import org.apache.qpid.proton.engine.SaslListener;
 import org.apache.qpid.proton.engine.impl.CollectorImpl;
-import org.apache.qpid.proton.engine.impl.ProtocolTracer;
 import org.apache.qpid.proton.engine.impl.TransportImpl;
 import org.apache.qpid.proton.engine.impl.TransportInternal;
-import org.apache.qpid.proton.framing.TransportFrame;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -125,6 +123,7 @@ public class AmqpProvider implements Provider, TransportListener , AmqpResourceP
     private final Transport transport;
     private String vhost;
     private boolean traceFrames;
+    private int traceFramesPayloadLimit = AmqpProtocolTracer.DEFAULT_PAYLOAD_STRING_LIMIT;
     private boolean traceBytes;
     private boolean saslLayer = true;
     private Set<String> saslMechanisms;
@@ -789,17 +788,7 @@ public class AmqpProvider implements Provider, TransportListener , AmqpResourceP
 
     private void updateTracer() {
         if (isTraceFrames()) {
-            ((TransportImpl) protonTransport).setProtocolTracer(new ProtocolTracer() {
-                @Override
-                public void receivedFrame(TransportFrame transportFrame) {
-                    TRACE_FRAMES.trace("RECV: {}", transportFrame.getBody());
-                }
-
-                @Override
-                public void sentFrame(TransportFrame transportFrame) {
-                    TRACE_FRAMES.trace("SENT: {}", transportFrame.getBody());
-                }
-            });
+            ((TransportImpl) protonTransport).setProtocolTracer(new AmqpProtocolTracer(TRACE_FRAMES, traceFramesPayloadLimit));
         }
     }
 
@@ -1155,6 +1144,14 @@ public class AmqpProvider implements Provider, TransportListener , AmqpResourceP
         return this.traceFrames;
     }
 
+    public int getTraceFramesPayloadLimit() {
+        return traceFramesPayloadLimit;
+    }
+
+    public void setTraceFramesPayloadLimit(int traceFramesPayloadLimit) {
+        this.traceFramesPayloadLimit = traceFramesPayloadLimit;
+    }
+
     public void setTraceBytes(boolean trace) {
         this.traceBytes = trace;
     }

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/b1b417ed/qpid-jms-client/src/test/resources/log4j.properties
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/test/resources/log4j.properties b/qpid-jms-client/src/test/resources/log4j.properties
index eb2531a..cde6c04 100644
--- a/qpid-jms-client/src/test/resources/log4j.properties
+++ b/qpid-jms-client/src/test/resources/log4j.properties
@@ -34,6 +34,8 @@ log4j.logger.org.apache.qpid.jms.test.testpeer=TRACE
 log4j.appender.stdout=org.apache.log4j.ConsoleAppender
 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
 log4j.appender.stdout.layout.ConversionPattern=%d [%-15.15t] - %-5p %-30.30c{1} - %m%n
+log4j.appender.stdout.Threshold = TRACE
+log4j.appender.stdout.Target = System.out
 
 # File appender
 log4j.appender.out=org.apache.log4j.FileAppender


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org