getLogs()

Author: Mark

src/main/java/com/arangodb/ArangoDB.java

@@ -29,13 +29,15 @@
 import javax.net.ssl.SSLContext;
 
 import com.arangodb.entity.ArangoDBVersion;
+import com.arangodb.entity.LogEntity;
 import com.arangodb.entity.UserEntity;
 import com.arangodb.internal.ArangoDBConstants;
 import com.arangodb.internal.CollectionCache;
 import com.arangodb.internal.DocumentCache;
 import com.arangodb.internal.velocypack.VPackConfigure;
 import com.arangodb.internal.velocystream.Communication;
 import com.arangodb.model.DBCreateOptions;
+import com.arangodb.model.LogOptions;
 import com.arangodb.model.OptionsBuilder;
 import com.arangodb.model.UserCreateOptions;
 import com.arangodb.model.UserUpdateOptions;
@@ -585,4 +587,46 @@ public Response execute(final Request request) {
 	public CompletableFuture<Response> executeAsync(final Request request) {
 		return executeAsync(request, response -> response);
 	}
+
+	/**
+	 * Returns fatal, error, warning or info log messages from the server's global log.
+	 * 
+	 * @see <a href=
+	 *      "https://docs.arangodb.com/current/HTTP/AdministrationAndMonitoring/index.html#read-global-logs-from-the-server">API
+	 *      Documentation</a>
+	 * @param options
+	 *            Additional options, can be null
+	 * @return the log messages
+	 * @throws ArangoDBException
+	 */
+	public LogEntity getLogs(final LogOptions options) throws ArangoDBException {
+		return executeSync(getLogsRequest(options), LogEntity.class);
+	}
+
+	/**
+	 * Returns fatal, error, warning or info log messages from the server's global log.
+	 * 
+	 * @see <a href=
+	 *      "https://docs.arangodb.com/current/HTTP/AdministrationAndMonitoring/index.html#read-global-logs-from-the-server">API
+	 *      Documentation</a>
+	 * @param options
+	 *            Additional options, can be null
+	 * @return the log messages
+	 */
+	public CompletableFuture<LogEntity> getLogsAsync(final LogOptions options) {
+		return executeAsync(getLogsRequest(options), LogEntity.class);
+	}
+
+	private Request getLogsRequest(final LogOptions options) {
+		final LogOptions params = options != null ? options : new LogOptions();
+		return new Request(ArangoDBConstants.SYSTEM, RequestType.GET, ArangoDBConstants.PATH_API_ADMIN_LOG)
+				.putQueryParam(LogOptions.PROPERTY_UPTO, params.getUpto())
+				.putQueryParam(LogOptions.PROPERTY_LEVEL, params.getLevel())
+				.putQueryParam(LogOptions.PROPERTY_START, params.getStart())
+				.putQueryParam(LogOptions.PROPERTY_SIZE, params.getSize())
+				.putQueryParam(LogOptions.PROPERTY_OFFSET, params.getOffset())
+				.putQueryParam(LogOptions.PROPERTY_SEARCH, params.getSearch())
+				.putQueryParam(LogOptions.PROPERTY_SORT, params.getSort());
+	}
+
 }

src/main/java/com/arangodb/entity/LogEntity.java

@@ -0,0 +1,76 @@
+/*
+ * 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.List;
+
+/**
+ * @author Mark - mark at arangodb.com
+ *
+ * @see <a href=
+ *      "https://docs.arangodb.com/current/HTTP/AdministrationAndMonitoring/index.html#read-global-logs-from-the-server">API
+ *      Documentation</a>
+ */
+public class LogEntity {
+
+	private List<Long> lid;
+	private List<LogLevel> level;
+	private List<Long> timestamp;
+	private List<String> text;
+	private Long totalAmount;
+
+	/**
+	 * @return a list of log entry identifiers. Each log message is uniquely identified by its @LIT{lid} and the
+	 *         identifiers are in ascending order
+	 */
+	public List<Long> getLid() {
+		return lid;
+	}
+
+	/**
+	 * @return a list of the log-levels for all log entries
+	 */
+	public List<LogLevel> getLevel() {
+		return level;
+	}
+
+	/**
+	 * @return a list of the timestamps as seconds since 1970-01-01 for all log entries
+	 */
+	public List<Long> getTimestamp() {
+		return timestamp;
+	}
+
+	/**
+	 * @return a list of the texts of all log entries
+	 */
+	public List<String> getText() {
+		return text;
+	}
+
+	/**
+	 * @return the total amount of log entries before pagination
+	 */
+	public Long getTotalAmount() {
+		return totalAmount;
+	}
+
+}

src/main/java/com/arangodb/entity/LogLevel.java

@@ -0,0 +1,50 @@
+/*
+ * 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 enum LogLevel {
+
+	FATAL(0), ERROR(1), WARNING(2), INFO(3), DEBUG(4);
+
+	private final int level;
+
+	private LogLevel(final int level) {
+		this.level = level;
+	}
+
+	public int getLevel() {
+		return level;
+	}
+
+	public static LogLevel fromLevel(final int level) {
+		for (final LogLevel logLevel : LogLevel.values()) {
+			if (logLevel.level == level) {
+				return logLevel;
+			}
+		}
+		return null;
+	}
+
+}

src/main/java/com/arangodb/internal/ArangoDBConstants.java

@@ -53,6 +53,7 @@ public class ArangoDBConstants {
 	public static final String PATH_API_QUERY_CURRENT = "/_api/query/current";
 	public static final String PATH_API_QUERY_SLOW = "/_api/query/slow";
 	public static final String PATH_API_TRAVERSAL = "/_api/traversal";
+	public static final String PATH_API_ADMIN_LOG = "/_admin/log";
 
 	public static final String ENCRYPTION_PLAIN = "plain";
 

src/main/java/com/arangodb/internal/velocypack/VPackConfigure.java

@@ -29,6 +29,7 @@
 import com.arangodb.entity.CollectionStatus;
 import com.arangodb.entity.CollectionType;
 import com.arangodb.entity.DocumentField;
+import com.arangodb.entity.LogLevel;
 import com.arangodb.entity.QueryEntity;
 import com.arangodb.internal.CollectionCache;
 import com.arangodb.internal.velocystream.AuthenticationRequest;
@@ -96,13 +97,15 @@ public static void configure(
 		builder.registerSerializer(BaseDocument.class, VPackSerializers.BASE_DOCUMENT);
 		builder.registerSerializer(BaseEdgeDocument.class, VPackSerializers.BASE_EDGE_DOCUMENT);
 		builder.registerSerializer(TraversalOptions.Order.class, VPackSerializers.TRAVERSAL_ORDER);
+		builder.registerSerializer(LogLevel.class, VPackSerializers.LOG_LEVEL);
 
 		builder.registerDeserializer(Response.class, VPackDeserializers.RESPONSE);
 		builder.registerDeserializer(CollectionType.class, VPackDeserializers.COLLECTION_TYPE);
 		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);
+		builder.registerDeserializer(LogLevel.class, VPackDeserializers.LOG_LEVEL);
 	}
 
 }

src/main/java/com/arangodb/internal/velocypack/VPackDeserializers.java

@@ -32,6 +32,7 @@
 import com.arangodb.entity.BaseEdgeDocument;
 import com.arangodb.entity.CollectionStatus;
 import com.arangodb.entity.CollectionType;
+import com.arangodb.entity.LogLevel;
 import com.arangodb.velocypack.VPackDeserializer;
 import com.arangodb.velocystream.Response;
 
@@ -80,4 +81,7 @@ public class VPackDeserializers {
 		}
 		return null;
 	};
+
+	public static final VPackDeserializer<LogLevel> LOG_LEVEL = (parent, vpack, context) -> LogLevel
+			.fromLevel(vpack.getAsInt());
 }

src/main/java/com/arangodb/internal/velocypack/VPackSerializers.java

@@ -28,6 +28,7 @@
 import com.arangodb.entity.BaseEdgeDocument;
 import com.arangodb.entity.CollectionType;
 import com.arangodb.entity.DocumentField;
+import com.arangodb.entity.LogLevel;
 import com.arangodb.internal.velocystream.AuthenticationRequest;
 import com.arangodb.model.TraversalOptions;
 import com.arangodb.velocypack.VPackSerializer;
@@ -107,4 +108,7 @@ public class VPackSerializers {
 			builder.add(attribute, value.name());
 		}
 	};
+
+	public static final VPackSerializer<LogLevel> LOG_LEVEL = (builder, attribute, value, context) -> builder
+			.add(attribute, value.getLevel());
 }