query tracking get/set, getCurrentlyRunningQueries

Mark · Mark · commit fd191fbdeab1 · 2016-10-10T10:30:39.000+02:00
diff --git a/src/main/java/com/arangodb/ArangoDatabase.java b/src/main/java/com/arangodb/ArangoDatabase.java
@@ -38,6 +38,8 @@
 import com.arangodb.entity.IndexEntity;
 import com.arangodb.entity.PathEntity;
 import com.arangodb.entity.QueryCachePropertiesEntity;
+import com.arangodb.entity.QueryEntity;
+import com.arangodb.entity.QueryTrackingPropertiesEntity;
 import com.arangodb.entity.TraversalEntity;
 import com.arangodb.internal.ArangoDBConstants;
 import com.arangodb.internal.CollectionCache;
@@ -620,6 +622,102 @@ private Request setQueryCachePropertiesRequest(final QueryCachePropertiesEntity
 				.setBody(serialize(properties));
 	}
 
+	/**
+	 * Returns the configuration for the AQL query tracking
+	 * 
+	 * @see <a href=
+	 *      "https://docs.arangodb.com/current/HTTP/AqlQuery/index.html#returns-the-properties-for-the-aql-query-tracking">API
+	 *      Documentation</a>
+	 * @return configuration for the AQL query tracking
+	 * @throws ArangoDBException
+	 */
+	public QueryTrackingPropertiesEntity getQueryTrackingProperties() throws ArangoDBException {
+		return executeSync(getQueryTrackingPropertiesRequest(), QueryTrackingPropertiesEntity.class);
+	}
+
+	/**
+	 * Returns the configuration for the AQL query tracking
+	 * 
+	 * @see <a href=
+	 *      "https://docs.arangodb.com/current/HTTP/AqlQuery/index.html#returns-the-properties-for-the-aql-query-tracking">API
+	 *      Documentation</a>
+	 * @return configuration for the AQL query tracking
+	 */
+	public CompletableFuture<QueryTrackingPropertiesEntity> getQueryTrackingPropertiesAsync() {
+		return executeAsync(getQueryTrackingPropertiesRequest(), QueryTrackingPropertiesEntity.class);
+	}
+
+	private Request getQueryTrackingPropertiesRequest() {
+		return new Request(name, RequestType.GET, ArangoDBConstants.PATH_API_QUERY_PROPERTIES);
+	}
+
+	/**
+	 * Changes the configuration for the AQL query tracking
+	 * 
+	 * @see <a href=
+	 *      "https://docs.arangodb.com/current/HTTP/AqlQuery/index.html#changes-the-properties-for-the-aql-query-tracking">API
+	 *      Documentation</a>
+	 * @param properties
+	 *            properties to be set
+	 * @return current set of properties
+	 * @throws ArangoDBException
+	 */
+	public QueryTrackingPropertiesEntity setQueryTrackingProperties(final QueryTrackingPropertiesEntity properties)
+			throws ArangoDBException {
+		return executeSync(setQueryTrackingPropertiesRequest(properties), QueryTrackingPropertiesEntity.class);
+	}
+
+	/**
+	 * Changes the configuration for the AQL query tracking
+	 * 
+	 * @see <a href=
+	 *      "https://docs.arangodb.com/current/HTTP/AqlQuery/index.html#changes-the-properties-for-the-aql-query-tracking">API
+	 *      Documentation</a>
+	 * @param properties
+	 *            properties to be set
+	 * @return current set of properties
+	 */
+	public CompletableFuture<QueryTrackingPropertiesEntity> setQueryTrackingPropertiesAsync(
+		final QueryTrackingPropertiesEntity properties) {
+		return executeAsync(setQueryTrackingPropertiesRequest(properties), QueryTrackingPropertiesEntity.class);
+	}
+
+	private Request setQueryTrackingPropertiesRequest(final QueryTrackingPropertiesEntity properties) {
+		return new Request(name, RequestType.PUT, ArangoDBConstants.PATH_API_QUERY_PROPERTIES)
+				.setBody(serialize(properties));
+	}
+
+	/**
+	 * Returns a list of currently running AQL queries
+	 * 
+	 * @see <a href=
+	 *      "https://docs.arangodb.com/current/HTTP/AqlQuery/index.html#returns-the-currently-running-aql-queries">API
+	 *      Documentation</a>
+	 * @return a list of currently running AQL queries
+	 * @throws ArangoDBException
+	 */
+	public Collection<QueryEntity> getCurrentlyRunningQueries() throws ArangoDBException {
+		return executeSync(getCurrentlyRunningQueriesRequest(), new Type<Collection<QueryEntity>>() {
+		}.getType());
+	}
+
+	/**
+	 * Returns a list of currently running AQL queries
+	 * 
+	 * @see <a href=
+	 *      "https://docs.arangodb.com/current/HTTP/AqlQuery/index.html#returns-the-currently-running-aql-queries">API
+	 *      Documentation</a>
+	 * @return a list of currently running AQL queries
+	 */
+	public CompletableFuture<Collection<QueryEntity>> getCurrentlyRunningQueriesAsync() {
+		return executeAsync(getCurrentlyRunningQueriesRequest(), new Type<Collection<QueryEntity>>() {
+		}.getType());
+	}
+
+	private Request getCurrentlyRunningQueriesRequest() {
+		return new Request(name, RequestType.GET, ArangoDBConstants.PATH_API_QUERY_CURRENT);
+	}
+
 	/**
 	 * Create a new AQL user function
 	 * 
diff --git a/src/main/java/com/arangodb/entity/QueryCachePropertiesEntity.java b/src/main/java/com/arangodb/entity/QueryCachePropertiesEntity.java
@@ -40,6 +40,9 @@ public QueryCachePropertiesEntity() {
 		super();
 	}
 
+	/**
+	 * @return the mode the AQL query cache operates in. The mode is one of the following values: off, on or demand
+	 */
 	public CacheMode getMode() {
 		return mode;
 	}
@@ -52,6 +55,9 @@ public void setMode(final CacheMode mode) {
 		this.mode = mode;
 	}
 
+	/**
+	 * @return the maximum number of query results that will be stored per database-specific cache
+	 */
 	public Long getMaxResults() {
 		return maxResults;
 	}
diff --git a/src/main/java/com/arangodb/entity/QueryEntity.java b/src/main/java/com/arangodb/entity/QueryEntity.java
@@ -0,0 +1,71 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * Licensed 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.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.entity;
+
+import java.util.Date;
+
+/**
+ * @author Mark - mark at arangodb.com
+ *
+ */
+public class QueryEntity {
+
+	public static final String PROPERTY_STARTED = "started";
+
+	private String id;
+	private String query;
+	private Date started;
+	private Double runTime;
+
+	public QueryEntity() {
+		super();
+	}
+
+	/**
+	 * @return the query's id
+	 */
+	public String getId() {
+		return id;
+	}
+
+	/**
+	 * @return the query string (potentially truncated)
+	 */
+	public String getQuery() {
+		return query;
+	}
+
+	/**
+	 * @return the date and time when the query was started
+	 */
+	public Date getStarted() {
+		return started;
+	}
+
+	/**
+	 * 
+	 * @return the query's run time up to the point the list of queries was queried
+	 */
+	public Double getRunTime() {
+		return runTime;
+	}
+
+}
diff --git a/src/main/java/com/arangodb/entity/QueryTrackingPropertiesEntity.java b/src/main/java/com/arangodb/entity/QueryTrackingPropertiesEntity.java
@@ -0,0 +1,130 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * Licensed 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.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.entity;
+
+/**
+ * @author Mark - mark at arangodb.com
+ *
+ */
+public class QueryTrackingPropertiesEntity {
+
+	private Boolean enabled;
+	private Boolean trackSlowQueries;
+	private Long maxSlowQueries;
+	private Long slowQueryThreshold;
+	private Long maxQueryStringLength;
+
+	public QueryTrackingPropertiesEntity() {
+		super();
+	}
+
+	/**
+	 * @return If set to true, then queries will be tracked. If set to false, neither queries nor slow queries will be
+	 *         tracked
+	 */
+	public Boolean getEnabled() {
+		return enabled;
+	}
+
+	/**
+	 * @param enabled
+	 *            If set to true, then queries will be tracked. If set to false, neither queries nor slow queries will
+	 *            be tracked
+	 */
+	public void setEnabled(final Boolean enabled) {
+		this.enabled = enabled;
+	}
+
+	/**
+	 * @return If set to true, then slow queries will be tracked in the list of slow queries if their runtime exceeds
+	 *         the value set in slowQueryThreshold. In order for slow queries to be tracked, the enabled property must
+	 *         also be set to true.
+	 */
+	public Boolean getTrackSlowQueries() {
+		return trackSlowQueries;
+	}
+
+	/**
+	 * @param trackSlowQueries
+	 *            If set to true, then slow queries will be tracked in the list of slow queries if their runtime exceeds
+	 *            the value set in slowQueryThreshold. In order for slow queries to be tracked, the enabled property
+	 *            must also be set to true.
+	 */
+	public void setTrackSlowQueries(final Boolean trackSlowQueries) {
+		this.trackSlowQueries = trackSlowQueries;
+	}
+
+	/**
+	 * @return The maximum number of slow queries to keep in the list of slow queries. If the list of slow queries is
+	 *         full, the oldest entry in it will be discarded when additional slow queries occur.
+	 */
+	public Long getMaxSlowQueries() {
+		return maxSlowQueries;
+	}
+
+	/**
+	 * @param maxSlowQueries
+	 *            The maximum number of slow queries to keep in the list of slow queries. If the list of slow queries is
+	 *            full, the oldest entry in it will be discarded when additional slow queries occur.
+	 */
+	public void setMaxSlowQueries(final Long maxSlowQueries) {
+		this.maxSlowQueries = maxSlowQueries;
+	}
+
+	/**
+	 * @return The threshold value for treating a query as slow. A query with a runtime greater or equal to this
+	 *         threshold value will be put into the list of slow queries when slow query tracking is enabled. The value
+	 *         for slowQueryThreshold is specified in seconds.
+	 */
+	public Long getSlowQueryThreshold() {
+		return slowQueryThreshold;
+	}
+
+	/**
+	 * @param slowQueryThreshold
+	 *            The threshold value for treating a query as slow. A query with a runtime greater or equal to this
+	 *            threshold value will be put into the list of slow queries when slow query tracking is enabled. The
+	 *            value for slowQueryThreshold is specified in seconds.
+	 */
+	public void setSlowQueryThreshold(final Long slowQueryThreshold) {
+		this.slowQueryThreshold = slowQueryThreshold;
+	}
+
+	/**
+	 * @return The maximum query string length to keep in the list of queries. Query strings can have arbitrary lengths,
+	 *         and this property can be used to save memory in case very long query strings are used. The value is
+	 *         specified in bytes.
+	 */
+	public Long getMaxQueryStringLength() {
+		return maxQueryStringLength;
+	}
+
+	/**
+	 * @param maxQueryStringLength
+	 *            The maximum query string length to keep in the list of queries. Query strings can have arbitrary
+	 *            lengths, and this property can be used to save memory in case very long query strings are used. The
+	 *            value is specified in bytes.
+	 */
+	public void setMaxQueryStringLength(final Long maxQueryStringLength) {
+		this.maxQueryStringLength = maxQueryStringLength;
+	}
+
+}
diff --git a/src/main/java/com/arangodb/internal/ArangoDBConstants.java b/src/main/java/com/arangodb/internal/ArangoDBConstants.java
@@ -49,6 +49,8 @@ public class ArangoDBConstants {
 	public static final String PATH_API_QUERY = "/_api/query";
 	public static final String PATH_API_QUERY_CACHE = "/_api/query-cache";
 	public static final String PATH_API_QUERY_CACHE_PROPERTIES = "/_api/query-cache/properties";
+	public static final String PATH_API_QUERY_PROPERTIES = "/_api/query/properties";
+	public static final String PATH_API_QUERY_CURRENT = "/_api/query/current";
 	public static final String PATH_API_TRAVERSAL = "/_api/traversal";
 
 	public static final String ENCRYPTION_PLAIN = "plain";
diff --git a/src/main/java/com/arangodb/internal/velocypack/VPackConfigure.java b/src/main/java/com/arangodb/internal/velocypack/VPackConfigure.java
@@ -20,13 +20,16 @@
 
 package com.arangodb.internal.velocypack;
 
+import java.util.Date;
+
 import org.json.simple.JSONValue;
 
 import com.arangodb.entity.BaseDocument;
 import com.arangodb.entity.BaseEdgeDocument;
 import com.arangodb.entity.CollectionStatus;
 import com.arangodb.entity.CollectionType;
 import com.arangodb.entity.DocumentField;
+import com.arangodb.entity.QueryEntity;
 import com.arangodb.internal.CollectionCache;
 import com.arangodb.internal.velocystream.AuthenticationRequest;
 import com.arangodb.model.TraversalOptions;
@@ -99,6 +102,7 @@ public static void configure(
 		builder.registerDeserializer(CollectionStatus.class, VPackDeserializers.COLLECTION_STATUS);
 		builder.registerDeserializer(BaseDocument.class, VPackDeserializers.BASE_DOCUMENT);
 		builder.registerDeserializer(BaseEdgeDocument.class, VPackDeserializers.BASE_EDGE_DOCUMENT);
+		builder.registerDeserializer(QueryEntity.PROPERTY_STARTED, Date.class, VPackDeserializers.DATE_STRING);
 	}
 
 }
diff --git a/src/main/java/com/arangodb/internal/velocypack/VPackDeserializers.java b/src/main/java/com/arangodb/internal/velocypack/VPackDeserializers.java
diff --git a/src/test/java/com/arangodb/ArangoDatabaseTest.java b/src/test/java/com/arangodb/ArangoDatabaseTest.java

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,9 @@ public QueryCachePropertiesEntity() {`
`40`	`40`	`super();`
`41`	`41`	`}`
`42`	`42`
	`43`	`+ /**`
	`44`	`+ * @return the mode the AQL query cache operates in. The mode is one of the following values: off, on or demand`
	`45`	`+ */`
`43`	`46`	`public CacheMode getMode() {`
`44`	`47`	`return mode;`
`45`	`48`	`}`
`@@ -52,6 +55,9 @@ public void setMode(final CacheMode mode) {`
`52`	`55`	`this.mode = mode;`
`53`	`56`	`}`
`54`	`57`
	`58`	`+ /**`
	`59`	`+ * @return the maximum number of query results that will be stored per database-specific cache`
	`60`	`+ */`
`55`	`61`	`public Long getMaxResults() {`
`56`	`62`	`return maxResults;`
`57`	`63`	`}`