yahoo
diff --git a/‎elide-core/src/main/java/com/yahoo/elide/core/DataStoreTransaction.java‎
Lines changed: 2 additions & 1 deletion b/‎elide-core/src/main/java/com/yahoo/elide/core/DataStoreTransaction.java‎
Lines changed: 2 additions & 1 deletion
diff --git a/‎elide-core/src/main/java/com/yahoo/elide/core/RequestScope.java‎
Lines changed: 4 additions & 1 deletion b/‎elide-core/src/main/java/com/yahoo/elide/core/RequestScope.java‎
Lines changed: 4 additions & 1 deletion
diff --git a/‎elide-core/src/main/java/com/yahoo/elide/core/datastore/inmemory/HashMapStoreTransaction.java‎
Lines changed: 1 addition & 1 deletion b/‎elide-core/src/main/java/com/yahoo/elide/core/datastore/inmemory/HashMapStoreTransaction.java‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎elide-core/src/main/java/com/yahoo/elide/core/datastore/inmemory/InMemoryStoreTransaction.java‎
Lines changed: 2 additions & 2 deletions b/‎elide-core/src/main/java/com/yahoo/elide/core/datastore/inmemory/InMemoryStoreTransaction.java‎
Lines changed: 2 additions & 2 deletions
diff --git a/‎elide-core/src/main/java/com/yahoo/elide/core/datastore/wrapped/TransactionWrapper.java‎
Lines changed: 2 additions & 2 deletions b/‎elide-core/src/main/java/com/yahoo/elide/core/datastore/wrapped/TransactionWrapper.java‎
Lines changed: 2 additions & 2 deletions
diff --git a/‎elide-core/src/test/java/com/yahoo/elide/core/DataStoreTransactionTest.java‎
Lines changed: 1 addition & 1 deletion b/‎elide-core/src/test/java/com/yahoo/elide/core/DataStoreTransactionTest.java‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎elide-datastore/elide-datastore-aggregation/src/main/java/com/yahoo/elide/datastores/aggregation/AggregationDataStore.java‎
Lines changed: 3 additions & 1 deletion b/‎elide-datastore/elide-datastore-aggregation/src/main/java/com/yahoo/elide/datastores/aggregation/AggregationDataStore.java‎
Lines changed: 3 additions & 1 deletion
diff --git a/‎elide-datastore/elide-datastore-aggregation/src/main/java/com/yahoo/elide/datastores/aggregation/AggregationDataStoreTransaction.java‎
Lines changed: 43 additions & 18 deletions b/‎elide-datastore/elide-datastore-aggregation/src/main/java/com/yahoo/elide/datastores/aggregation/AggregationDataStoreTransaction.java‎
Lines changed: 43 additions & 18 deletions
diff --git a/‎elide-datastore/elide-datastore-aggregation/src/main/java/com/yahoo/elide/datastores/aggregation/QueryEngine.java‎
Lines changed: 7 additions & 0 deletions b/‎elide-datastore/elide-datastore-aggregation/src/main/java/com/yahoo/elide/datastores/aggregation/QueryEngine.java‎
Lines changed: 7 additions & 0 deletions
diff --git a/‎elide-datastore/elide-datastore-aggregation/src/main/java/com/yahoo/elide/datastores/aggregation/core/NoopQueryLogger.java‎
Lines changed: 41 additions & 0 deletions b/‎elide-datastore/elide-datastore-aggregation/src/main/java/com/yahoo/elide/datastores/aggregation/core/NoopQueryLogger.java‎
Lines changed: 41 additions & 0 deletions
@@ -266,6 +266,7 @@ default boolean supportsPagination(Class<?> entityClass, FilterExpression expres
     /**
      * Cancel running transaction.
      * Implementation must be thread-safe.
+     * @param scope contains request level metadata.
      */
-    void cancel();
+    void cancel(RequestScope scope);
 }
@@ -65,10 +65,11 @@ public class RequestScope implements com.yahoo.elide.security.RequestScope {
     @Getter private final int updateStatusCode;
     @Getter private final MultipleFilterDialect filterDialect;
     @Getter private final String apiVersion;
+    @Getter @Setter private Map<String, String> headers;
 
     //TODO - this ought to be read only and set in the constructor.
     @Getter @Setter private EntityProjection entityProjection;
-    private final UUID requestId;
+    @Getter private final UUID requestId;
     private final Map<String, FilterExpression> expressionsByType;
 
     private PublishSubject<CRUDEvent> lifecycleEvents;
@@ -143,6 +144,7 @@ public RequestScope(String baseUrlEndPoint,
         this.dirtyResources = new LinkedHashSet<>();
         this.deletedResources = new LinkedHashSet<>();
         this.requestId = requestId;
+        this.headers = new HashMap<>();
 
         Function<RequestScope, PermissionExecutor> permissionExecutorGenerator = elideSettings.getPermissionExecutor();
         this.permissionExecutor = (permissionExecutorGenerator == null)
@@ -231,6 +233,7 @@ protected RequestScope(String path, String apiVersion,
         this.updateStatusCode = outerRequestScope.updateStatusCode;
         this.queuedLifecycleEvents = outerRequestScope.queuedLifecycleEvents;
         this.requestId = outerRequestScope.requestId;
+        this.headers = outerRequestScope.headers;
     }
 
     public Set<com.yahoo.elide.security.PersistentResource> getNewResources() {
 
@@ -189,7 +189,7 @@ private boolean containsObject(Object obj) {
     }
 
     @Override
-    public void cancel() {
+    public void cancel(RequestScope scope) {
         //nothing to cancel in HashMap store transaction
     }
 }
@@ -469,7 +469,7 @@ private Pair<Optional<Pagination>, Optional<Pagination>> splitPagination(
     }
 
    @Override
-   public void cancel() {
-       tx.cancel();
+   public void cancel(RequestScope scope) {
+       tx.cancel(scope);
    }
 }
@@ -126,7 +126,7 @@ public void close() throws IOException {
     }
 
     @Override
-    public void cancel() {
-        tx.cancel();
+    public void cancel(RequestScope scope) {
+        tx.cancel(scope);
     }
 }
@@ -162,7 +162,7 @@ public void createObject(Object entity, RequestScope scope) {
     }
 
     @Override
-    public void cancel() {
+    public void cancel(RequestScope scope) {
        //nothing
     }
 }
@@ -11,6 +11,7 @@
 import com.yahoo.elide.core.EntityDictionary;
 import com.yahoo.elide.datastores.aggregation.annotation.Join;
 import com.yahoo.elide.datastores.aggregation.cache.Cache;
+import com.yahoo.elide.datastores.aggregation.core.QueryLogger;
 import com.yahoo.elide.datastores.aggregation.metadata.models.Table;
 import com.yahoo.elide.datastores.aggregation.metadata.models.TimeDimension;
 import com.yahoo.elide.datastores.aggregation.queryengines.sql.annotation.FromSubquery;
@@ -36,6 +37,7 @@ public class AggregationDataStore implements DataStore {
     @NonNull private final QueryEngine queryEngine;
     private final Cache cache;
     private final Set<Class<?>> dynamicCompiledClasses;
+    private final QueryLogger queryLogger;
 
     /**
      * These are the classes the Aggregation Store manages.
@@ -74,6 +76,6 @@ public void populateEntityDictionary(EntityDictionary dictionary) {
 
     @Override
     public DataStoreTransaction beginTransaction() {
-        return new AggregationDataStoreTransaction(queryEngine, cache);
+        return new AggregationDataStoreTransaction(queryEngine, cache, queryLogger);
     }
 }
@@ -6,9 +6,13 @@
 package com.yahoo.elide.datastores.aggregation;
 
 import com.yahoo.elide.core.DataStoreTransaction;
+import com.yahoo.elide.core.HttpStatus;
 import com.yahoo.elide.core.RequestScope;
+import com.yahoo.elide.core.exceptions.HttpStatusException;
 import com.yahoo.elide.datastores.aggregation.cache.Cache;
 import com.yahoo.elide.datastores.aggregation.cache.QueryKeyExtractor;
+import com.yahoo.elide.datastores.aggregation.core.QueryLogger;
+import com.yahoo.elide.datastores.aggregation.core.QueryResponse;
 import com.yahoo.elide.datastores.aggregation.metadata.models.Table;
 import com.yahoo.elide.datastores.aggregation.query.Query;
 import com.yahoo.elide.datastores.aggregation.query.QueryResult;
@@ -19,6 +23,7 @@
 import lombok.ToString;
 
 import java.io.IOException;
+
 /**
  * Transaction handler for {@link AggregationDataStore}.
  */
@@ -27,11 +32,14 @@ public class AggregationDataStoreTransaction implements DataStoreTransaction {
     private final QueryEngine queryEngine;
     private final Cache cache;
     private final QueryEngine.Transaction queryEngineTransaction;
+    private final QueryLogger queryLogger;
 
-    public AggregationDataStoreTransaction(QueryEngine queryEngine, Cache cache) {
+    public AggregationDataStoreTransaction(QueryEngine queryEngine, Cache cache,
+                                           QueryLogger queryLogger) {
         this.queryEngine = queryEngine;
         this.cache = cache;
         this.queryEngineTransaction = queryEngine.beginTransaction();
+        this.queryLogger = queryLogger;
     }
 
     @Override
@@ -61,27 +69,43 @@ public void createObject(Object entity, RequestScope scope) {
 
     @Override
     public Iterable<Object> loadObjects(EntityProjection entityProjection, RequestScope scope) {
-        Query query = buildQuery(entityProjection, scope);
         QueryResult result = null;
-
+        QueryResponse response = null;
         String cacheKey = null;
-        if (cache != null && !query.isBypassingCache()) {
-            String tableVersion = queryEngine.getTableVersion(query.getTable(), queryEngineTransaction);
-            if (tableVersion != null) {
-                cacheKey = tableVersion + ';' + QueryKeyExtractor.extractKey(query);
-                result = cache.get(cacheKey);
+        try {
+            queryLogger.acceptQuery(scope.getRequestId(), scope.getUser(), scope.getHeaders(),
+                    scope.getApiVersion(), scope.getQueryParams(), scope.getPath());
+            Query query = buildQuery(entityProjection, scope);
+            if (cache != null && !query.isBypassingCache()) {
+                String tableVersion = queryEngine.getTableVersion(query.getTable(), queryEngineTransaction);
+                if (tableVersion != null) {
+                    cacheKey = tableVersion + ';' + QueryKeyExtractor.extractKey(query);
+                    result = cache.get(cacheKey);
+                }
             }
-        }
-        if (result == null) {
-            result = queryEngine.executeQuery(query, queryEngineTransaction);
-            if (cacheKey != null) {
-                cache.put(cacheKey, result);
+            boolean isCached = result == null ? false : true;
+            String queryText = queryEngine.explain(query);
+            queryLogger.processQuery(scope.getRequestId(), query, queryText, isCached);
+            if (result == null) {
+                result = queryEngine.executeQuery(query, queryEngineTransaction);
+                if (cacheKey != null) {
+                    cache.put(cacheKey, result);
+                }
             }
+            if (entityProjection.getPagination() != null && entityProjection.getPagination().returnPageTotals()) {
+                entityProjection.getPagination().setPageTotals(result.getPageTotals());
+            }
+            response = new QueryResponse(HttpStatus.SC_OK, result.getData(), null);
+            return result.getData();
+        } catch (HttpStatusException e) {
+            response = new QueryResponse(e.getStatus(), null, e.getMessage());
+            throw e;
+        } catch (Exception e) {
+            response = new QueryResponse(HttpStatus.SC_INTERNAL_SERVER_ERROR, null, e.getMessage());
+            throw e;
+        } finally {
+            queryLogger.completeQuery(scope.getRequestId(), response);
         }
-        if (entityProjection.getPagination() != null && entityProjection.getPagination().returnPageTotals()) {
-            entityProjection.getPagination().setPageTotals(result.getPageTotals());
-        }
-        return result.getData();
     }
 
     @Override
@@ -101,7 +125,8 @@ Query buildQuery(EntityProjection entityProjection, RequestScope scope) {
     }
 
     @Override
-    public void cancel() {
+    public void cancel(RequestScope scope) {
+        queryLogger.cancelQuery(scope.getRequestId());
         queryEngineTransaction.cancel();
     }
 }
@@ -193,4 +193,11 @@ public interface Transaction extends AutoCloseable {
     public Table getTable(String classAlias) {
         return tables.get(classAlias);
     }
+
+    /**
+     * Explains the specified query passed in
+     * @param query The query customized for a particular persistent storage or storage client
+     * @return SQL string corresponding to the given query
+     */
+    public abstract String explain(Query query);
 }
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2020, Yahoo Inc.
+ * Licensed under the Apache License, Version 2.0
+ * See LICENSE file in project root for terms.
+ */
+package com.yahoo.elide.datastores.aggregation.core;
+
+import com.yahoo.elide.datastores.aggregation.query.Query;
+import com.yahoo.elide.security.User;
+
+import java.util.Map;
+import java.util.Optional;
+import java.util.UUID;
+import javax.ws.rs.core.MultivaluedMap;
+
+/**
+ * Default NoopQuery Logger Implementation for Elide
+ */
+public class NoopQueryLogger implements QueryLogger {
+
+    @Override
+    public void acceptQuery(UUID queryId, User user, Map<String, String> headers, String apiVer,
+                            Optional<MultivaluedMap<String, String>> queryParams, String path) {
+        //does nothing
+    }
+
+    @Override
+    public void processQuery(UUID queryId, Query query, String apiQuery, boolean isCached) {
+        //does nothing
+    }
+
+    @Override
+    public void cancelQuery(UUID queryId) {
+        //does nothing
+    }
+
+    @Override
+    public void completeQuery(UUID queryId, QueryResponse response) {
+        //does nothing
+    }
+}
Original file line number	Diff line number	Diff line change
`@@ -266,6 +266,7 @@ default boolean supportsPagination(Class<?> entityClass, FilterExpression expres`
`266`	`266`	`/**`
`267`	`267`	`* Cancel running transaction.`
`268`	`268`	`* Implementation must be thread-safe.`
	`269`	`+ * @param scope contains request level metadata.`
`269`	`270`	`*/`
`270`		`- void cancel();`
	`271`	`+ void cancel(RequestScope scope);`
`271`	`272`	`}`
Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ private boolean containsObject(Object obj) {`
`189`	`189`	`}`
`190`	`190`
`191`	`191`	`@Override`
`192`		`- public void cancel() {`
	`192`	`+ public void cancel(RequestScope scope) {`
`193`	`193`	`//nothing to cancel in HashMap store transaction`
`194`	`194`	`}`
`195`	`195`	`}`
Original file line number	Diff line number	Diff line change
`@@ -469,7 +469,7 @@ private Pair<Optional<Pagination>, Optional<Pagination>> splitPagination(`
`469`	`469`	`}`
`470`	`470`
`471`	`471`	`@Override`
`472`		`- public void cancel() {`
`473`		`- tx.cancel();`
	`472`	`+ public void cancel(RequestScope scope) {`
	`473`	`+ tx.cancel(scope);`
`474`	`474`	`}`
`475`	`475`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ public void close() throws IOException {`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`@Override`
`129`		`- public void cancel() {`
`130`		`- tx.cancel();`
	`129`	`+ public void cancel(RequestScope scope) {`
	`130`	`+ tx.cancel(scope);`
`131`	`131`	`}`
`132`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ public void createObject(Object entity, RequestScope scope) {`
`162`	`162`	`}`
`163`	`163`
`164`	`164`	`@Override`
`165`		`- public void cancel() {`
	`165`	`+ public void cancel(RequestScope scope) {`
`166`	`166`	`//nothing`
`167`	`167`	`}`
`168`	`168`	`}`
Original file line number	Diff line number	Diff line change
`@@ -193,4 +193,11 @@ public interface Transaction extends AutoCloseable {`
`193`	`193`	`public Table getTable(String classAlias) {`
`194`	`194`	`return tables.get(classAlias);`
`195`	`195`	`}`
	`196`	`+`
	`197`	`+ /**`
	`198`	`+ * Explains the specified query passed in`
	`199`	`+ * @param query The query customized for a particular persistent storage or storage client`
	`200`	`+ * @return SQL string corresponding to the given query`
	`201`	`+ */`
	`202`	`+ public abstract String explain(Query query);`
`196`	`203`	`}`