Add logging of query IDs via QueryLogIterator class

warehouse/query-core/src/main/java/datawave/query/config/ShardQueryConfiguration.java

@@ -492,6 +492,11 @@ public class ShardQueryConfiguration extends GenericQueryConfiguration implement
      */
     private boolean sortQueryByCounts = false;
 
+    /**
+     * Controls whether query IDs are logged on the tserver level via {@link datawave.query.iterator.QueryLogIterator}.
+     */
+    private boolean tserverLoggingActive = true;
+
     /**
      * Default constructor
      */
@@ -716,6 +721,7 @@ public ShardQueryConfiguration(ShardQueryConfiguration other) {
         this.setUseTermCounts(other.getUseTermCounts());
         this.setSortQueryBeforeGlobalIndex(other.isSortQueryBeforeGlobalIndex());
         this.setSortQueryByCounts(other.isSortQueryByCounts());
+        this.setTserverLoggingActive(other.isTserverLoggingActive());
     }
 
     /**
@@ -2736,14 +2742,25 @@ public void setSortQueryByCounts(boolean sortQueryByCounts) {
         this.sortQueryByCounts = sortQueryByCounts;
     }
 
+    public boolean isTserverLoggingActive() {
+        return this.tserverLoggingActive;
+    }
+
+    public void setTserverLoggingActive(boolean tserverLoggingActive) {
+        this.tserverLoggingActive = tserverLoggingActive;
+    }
+
     @Override
     public boolean equals(Object o) {
-        if (this == o)
+        if (this == o) {
             return true;
-        if (o == null || getClass() != o.getClass())
+        }
+        if (o == null || getClass() != o.getClass()) {
             return false;
-        if (!super.equals(o))
+        }
+        if (!super.equals(o)) {
             return false;
+        }
         // @formatter:off
         ShardQueryConfiguration that = (ShardQueryConfiguration) o;
         return isTldQuery() == that.isTldQuery() &&
@@ -2942,7 +2959,8 @@ public boolean equals(Object o) {
                 getUseFieldCounts() == that.getUseFieldCounts() &&
                 getUseTermCounts() == that.getUseTermCounts() &&
                 isSortQueryBeforeGlobalIndex() == that.isSortQueryBeforeGlobalIndex() &&
-                isSortQueryByCounts() == that.isSortQueryByCounts();
+                isSortQueryByCounts() == that.isSortQueryByCounts() &&
+                isTserverLoggingActive() == that.isTserverLoggingActive();
         // @formatter:on
     }
 
@@ -3146,7 +3164,8 @@ public int hashCode() {
                 getUseFieldCounts(),
                 getUseTermCounts(),
                 isSortQueryBeforeGlobalIndex(),
-                isSortQueryByCounts());
+                isSortQueryByCounts(),
+                isTserverLoggingActive());
         // @formatter:on
     }
 

warehouse/query-core/src/main/java/datawave/query/iterator/QueryLogIterator.java

@@ -0,0 +1,191 @@
+package datawave.query.iterator;
+
+import static datawave.query.iterator.QueryOptions.QUERY_ID;
+
+import java.io.IOException;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.accumulo.core.data.ByteSequence;
+import org.apache.accumulo.core.data.Key;
+import org.apache.accumulo.core.data.Range;
+import org.apache.accumulo.core.data.Value;
+import org.apache.accumulo.core.iterators.IteratorEnvironment;
+import org.apache.accumulo.core.iterators.OptionDescriber;
+import org.apache.accumulo.core.iterators.SortedKeyValueIterator;
+import org.apache.log4j.Logger;
+
+/**
+ * An iterator used to log the start and end of each method run by the {@link SortedKeyValueIterator} above it in the iterator stack. Logs the QueryID
+ * associated with each method. Logs are written on the TServer where the iterator is running
+ */
+public class QueryLogIterator implements SortedKeyValueIterator<Key,Value>, OptionDescriber {
+
+    private static final Logger log = Logger.getLogger(QueryLogIterator.class);
+    private static final String CLASS_NAME = QueryLogIterator.class.getSimpleName();
+
+    private String queryID;
+    private SortedKeyValueIterator<Key,Value> source;
+    private IteratorEnvironment env;
+
+    /**
+     * Default constructor
+     */
+    public QueryLogIterator() {
+        // no-arg constructor
+    }
+
+    /**
+     * Class copy constructor
+     */
+    public QueryLogIterator(QueryLogIterator other, IteratorEnvironment env) {
+        this.source = other.source.deepCopy(env);
+        this.env = other.env;
+        this.queryID = other.queryID;
+    }
+
+    /**
+     * Wraps the init() method of the iterator above it, logging the start/end of the method along with its query id.
+     */
+    @Override
+    public void init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env) throws IOException {
+
+        try {
+            logStartOf("init()");
+            this.queryID = options.get(QUERY_ID);
+            this.source = source;
+            this.env = env;
+        } finally {
+            logEndOf("init()");
+        }
+    }
+
+    /**
+     * Logs the query id and {@link SortedKeyValueIterator} method name before the method is run.
+     */
+    private void logStartOf(String methodName) {
+        if (log.isDebugEnabled()) {
+            log.debug(CLASS_NAME + " " + methodName + " Started QueryID: " + this.queryID);
+        }
+    }
+
+    /**
+     * Logs the query id and {@link SortedKeyValueIterator} method name after the method is run.
+     */
+    private void logEndOf(String methodName) {
+        if (log.isDebugEnabled()) {
+            log.debug(CLASS_NAME + " " + methodName + " Ended QueryID: " + this.queryID);
+        }
+    }
+
+    /**
+     * Wraps the hasTop() method of the iterator above it, logging the start and end of the method along with its query id.
+     */
+    @Override
+    public boolean hasTop() {
+        boolean result;
+
+        try {
+            logStartOf("hasTop()");
+            result = source.hasTop();
+        } finally {
+            logEndOf("hasTop()");
+        }
+        return result;
+    }
+
+    /**
+     * Wraps the next() method of the iterator above it, logging the start and end of the method along with its query id.
+     */
+    @Override
+    public void next() throws IOException {
+        try {
+            logStartOf("next()");
+            source.next();
+        } finally {
+            logEndOf("next()");
+        }
+    }
+
+    /**
+     * Wraps the getTopKey() method of the iterator above it, logging the start and end of the method along with its query id.
+     */
+    @Override
+    public Key getTopKey() {
+        Key k;
+        try {
+            logStartOf("getTopKey()");
+            k = source.getTopKey();
+        } finally {
+            logEndOf("getTopKey()");
+        }
+        return k;
+    }
+
+    /**
+     * Wraps the getTopValue() method of the iterator above it, logging the start and end of the method along with its query id.
+     */
+    @Override
+    public Value getTopValue() {
+        Value v;
+        try {
+            logStartOf("getTopValue()");
+            v = source.getTopValue();
+        } finally {
+            logEndOf("getTopValue()");
+        }
+        return v;
+    }
+
+    /**
+     * Wraps the deepCopy() method of the iterator above it, logging the start and end of the method along with its query id.
+     */
+    @Override
+    public SortedKeyValueIterator<Key,Value> deepCopy(IteratorEnvironment iteratorEnvironment) {
+
+        QueryLogIterator copy;
+
+        try {
+            logStartOf("deepCopy()");
+            copy = new QueryLogIterator(this, this.env);
+        } finally {
+            logEndOf("deepCopy()");
+        }
+        return copy;
+    }
+
+    /**
+     * Wraps the seek() method of the iterator above it, logging the start and end of the method along with its query id.
+     */
+    @Override
+    public void seek(Range range, Collection<ByteSequence> collection, boolean b) throws IOException {
+
+        try {
+            logStartOf("seek()");
+            this.source.seek(range, collection, b);
+        } finally {
+            logEndOf("seek()");
+        }
+    }
+
+    /**
+     * Returns a {@link org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions} object containing a description of the iterator and an option for
+     * the QueryID.
+     */
+    @Override
+    public IteratorOptions describeOptions() {
+        Map<String,String> options = new HashMap<>();
+        options.put(QUERY_ID, "The QueryID to be logged as methods are invoked");
+
+        return new IteratorOptions(getClass().getSimpleName(), "An iterator used to log the QueryID", options, null);
+    }
+
+    /**
+     * Returns true if the options provided contains the QueryID.
+     */
+    @Override
+    public boolean validateOptions(Map<String,String> options) {
+        return options.containsKey(QUERY_ID);
+    }
+}

warehouse/query-core/src/main/java/datawave/query/iterator/QueryOptions.java

@@ -21,7 +21,6 @@
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
-import java.util.TreeSet;
 import java.util.stream.Collectors;
 import java.util.zip.GZIPInputStream;
 import java.util.zip.GZIPOutputStream;
@@ -39,12 +38,7 @@
 import org.apache.log4j.Logger;
 import org.apache.zookeeper.server.quorum.QuorumPeerConfig.ConfigException;
 
-import com.esotericsoftware.kryo.Kryo;
-import com.esotericsoftware.kryo.io.Input;
-import com.esotericsoftware.kryo.io.Output;
 import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.common.base.CharMatcher;
 import com.google.common.base.Function;
 import com.google.common.base.Predicate;
@@ -557,6 +551,7 @@ public void deepCopy(QueryOptions other) {
 
         this.fieldCounts = other.fieldCounts;
         this.termCounts = other.termCounts;
+
     }
 
     public String getQuery() {