Skip to content

Commit 0ff68fa

Browse files
rashtaorashtao
authored
3.8 GET /_admin/log/entries (#383)
* implemented support for GET /_admin/log/entries * javadoc upd * javadoc upd
1 parent ae62a82 commit 0ff68fa

File tree

9 files changed

+314
-13
lines changed

9 files changed

+314
-13
lines changed

‎ChangeLog.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
66

77
## [Unreleased]
88

9+
- added support for getting db log entries via `GET /_admin/log/entries` (ArangoDB v3.8)
910
- added support for index estimates (ArangoDB v3.8)
1011
- added support for ArangoSearch `AQL`, `Pipeline`, `Stopwords`, `GeoJSON`, `GeoPoint` analyzers
1112
- fixed active failover behavior for the asynchronous driver

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import com.arangodb.entity.ArangoDBVersion;
2525
import com.arangodb.entity.LoadBalancingStrategy;
2626
import com.arangodb.entity.LogEntity;
27+
import com.arangodb.entity.LogEntriesEntity;
2728
import com.arangodb.entity.LogLevelEntity;
2829
import com.arangodb.entity.Permissions;
2930
import com.arangodb.entity.ServerRole;
@@ -885,15 +886,30 @@ public synchronized ArangoDB build() {
885886
/**
886887
* Returns fatal, error, warning or info log messages from the server's global log.
887888
*
888-
* @param options Additional options, can be null
889+
* @param options
890+
* Additional options, can be null
889891
* @return the log messages
892+
*
890893
* @throws ArangoDBException
891-
* @see <a href=
892-
* "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API
894+
* @see <a href= "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API
893895
* Documentation</a>
896+
* @deprecated use {@link #getLogEntries(LogOptions)} instead
894897
*/
895898
LogEntity getLogs(LogOptions options) throws ArangoDBException;
896899

900+
/**
901+
* Returns the server logs
902+
*
903+
* @param options
904+
* Additional options, can be null
905+
* @return the log messages
906+
*
907+
* @see <a href= "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API
908+
* Documentation</a>
909+
* @since ArangoDB 3.8
910+
*/
911+
LogEntriesEntity getLogEntries(LogOptions options) throws ArangoDBException;
912+
897913
/**
898914
* Returns the server's current loglevel settings.
899915
*

‎src/main/java/com/arangodb/async/ArangoDBAsync.java‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import com.arangodb.entity.ArangoDBVersion;
3030
import com.arangodb.entity.LoadBalancingStrategy;
3131
import com.arangodb.entity.LogEntity;
32+
import com.arangodb.entity.LogEntriesEntity;
3233
import com.arangodb.entity.LogLevelEntity;
3334
import com.arangodb.entity.Permissions;
3435
import com.arangodb.entity.ServerRole;
@@ -280,14 +281,29 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor {
280281
/**
281282
* Returns fatal, error, warning or info log messages from the server's global log.
282283
*
283-
* @param options Additional options, can be null
284+
* @param options
285+
* Additional options, can be null
284286
* @return the log messages
285-
* @see <a href=
286-
* "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API
287+
*
288+
* @see <a href= "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API
287289
* Documentation</a>
290+
* @deprecated use {@link #getLogEntries(LogOptions)} instead
288291
*/
289292
CompletableFuture<LogEntity> getLogs(final LogOptions options);
290293

294+
/**
295+
* Returns the server logs
296+
*
297+
* @param options
298+
* Additional options, can be null
299+
* @return the log messages
300+
*
301+
* @see <a href= "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API
302+
* Documentation</a>
303+
* @since ArangoDB 3.8
304+
*/
305+
CompletableFuture<LogEntriesEntity> getLogEntries(final LogOptions options);
306+
291307
/**
292308
* Returns the server's current loglevel settings.
293309
*

‎src/main/java/com/arangodb/async/internal/ArangoDBAsyncImpl.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,11 @@ public CompletableFuture<LogEntity> getLogs(final LogOptions options) {
193193
return executor.execute(getLogsRequest(options), LogEntity.class);
194194
}
195195

196+
@Override
197+
public CompletableFuture<LogEntriesEntity> getLogEntries(final LogOptions options) {
198+
return executor.execute(getLogEntriesRequest(options), LogEntriesEntity.class);
199+
}
200+
196201
@Override
197202
public CompletableFuture<LogLevelEntity> getLogLevel() {
198203
return executor.execute(getLogLevelRequest(), LogLevelEntity.class);

‎src/main/java/com/arangodb/entity/LogEntriesEntity.java‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
/*
2+
* DISCLAIMER
3+
*
4+
* Copyright 2016 ArangoDB GmbH, Cologne, Germany
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*
18+
* Copyright holder is ArangoDB GmbH, Cologne, Germany
19+
*/
20+
21+
package com.arangodb.entity;
22+
23+
import java.util.List;
24+
25+
/**
26+
* @author Michele Rastelli
27+
* @see <a href= "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API
28+
* Documentation</a>
29+
* @since ArangoDB 3.8
30+
*/
31+
public class LogEntriesEntity implements Entity {
32+
33+
private Long total;
34+
private List<Message> messages;
35+
36+
public Long getTotal() {
37+
return total;
38+
}
39+
40+
public List<Message> getMessages() {
41+
return messages;
42+
}
43+
44+
public static class Message {
45+
Long id;
46+
String topic;
47+
String level;
48+
String date;
49+
String message;
50+
51+
public Long getId() {
52+
return id;
53+
}
54+
55+
public String getTopic() {
56+
return topic;
57+
}
58+
59+
public String getLevel() {
60+
return level;
61+
}
62+
63+
public String getDate() {
64+
return date;
65+
}
66+
67+
public String getMessage() {
68+
return message;
69+
}
70+
}
71+
72+
}

‎src/main/java/com/arangodb/internal/ArangoDBImpl.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,11 @@ public LogEntity getLogs(final LogOptions options) throws ArangoDBException {
234234
return executor.execute(getLogsRequest(options), LogEntity.class);
235235
}
236236

237+
@Override
238+
public LogEntriesEntity getLogEntries(final LogOptions options) throws ArangoDBException {
239+
return executor.execute(getLogEntriesRequest(options), LogEntriesEntity.class);
240+
}
241+
237242
@Override
238243
public LogLevelEntity getLogLevel() throws ArangoDBException {
239244
return executor.execute(getLogLevelRequest(), LogLevelEntity.class);

‎src/main/java/com/arangodb/internal/InternalArangoDB.java‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
public abstract class InternalArangoDB<E extends ArangoExecutor> extends ArangoExecuteable<E> {
4545

4646
private static final String PATH_API_ADMIN_LOG = "/_admin/log";
47+
private static final String PATH_API_ADMIN_LOG_ENTRIES = "/_admin/log/entries";
4748
private static final String PATH_API_ADMIN_LOG_LEVEL = "/_admin/log/level";
4849
private static final String PATH_API_ROLE = "/_admin/server/role";
4950
private static final String PATH_ENDPOINTS = "/_api/cluster/endpoints";
@@ -168,6 +169,18 @@ protected Request getLogsRequest(final LogOptions options) {
168169
.putQueryParam(LogOptions.PROPERTY_SORT, params.getSort());
169170
}
170171

172+
protected Request getLogEntriesRequest(final LogOptions options) {
173+
final LogOptions params = options != null ? options : new LogOptions();
174+
return request(ArangoRequestParam.SYSTEM, RequestType.GET, PATH_API_ADMIN_LOG_ENTRIES)
175+
.putQueryParam(LogOptions.PROPERTY_UPTO, params.getUpto())
176+
.putQueryParam(LogOptions.PROPERTY_LEVEL, params.getLevel())
177+
.putQueryParam(LogOptions.PROPERTY_START, params.getStart())
178+
.putQueryParam(LogOptions.PROPERTY_SIZE, params.getSize())
179+
.putQueryParam(LogOptions.PROPERTY_OFFSET, params.getOffset())
180+
.putQueryParam(LogOptions.PROPERTY_SEARCH, params.getSearch())
181+
.putQueryParam(LogOptions.PROPERTY_SORT, params.getSort());
182+
}
183+
171184
protected Request getLogLevelRequest() {
172185
return request(ArangoRequestParam.SYSTEM, RequestType.GET, PATH_API_ADMIN_LOG_LEVEL);
173186
}

‎src/test/java/com/arangodb/ArangoDBTest.java‎

Lines changed: 140 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,23 @@
2020

2121
package com.arangodb;
2222

23-
import com.arangodb.entity.*;
24-
import com.arangodb.model.*;
23+
import com.arangodb.entity.ArangoDBVersion;
24+
import com.arangodb.entity.DatabaseEntity;
25+
import com.arangodb.entity.License;
26+
import com.arangodb.entity.LogEntity;
27+
import com.arangodb.entity.LogEntriesEntity;
28+
import com.arangodb.entity.LogLevel;
29+
import com.arangodb.entity.LogLevelEntity;
30+
import com.arangodb.entity.Permissions;
31+
import com.arangodb.entity.ServerRole;
32+
import com.arangodb.entity.UserEntity;
33+
import com.arangodb.model.DBCreateOptions;
34+
import com.arangodb.model.DatabaseOptions;
35+
import com.arangodb.model.DatabaseUsersOptions;
36+
import com.arangodb.model.LogOptions;
2537
import com.arangodb.model.LogOptions.SortOrder;
38+
import com.arangodb.model.UserCreateOptions;
39+
import com.arangodb.model.UserUpdateOptions;
2640
import com.arangodb.util.TestUtils;
2741
import com.arangodb.velocypack.exception.VPackException;
2842
import com.arangodb.velocystream.Request;
@@ -36,7 +50,15 @@
3650
import org.junit.runners.Parameterized;
3751
import org.junit.runners.Parameterized.Parameters;
3852

39-
import java.util.*;
53+
import java.util.ArrayList;
54+
import java.util.Collection;
55+
import java.util.Collections;
56+
import java.util.HashMap;
57+
import java.util.List;
58+
import java.util.Map;
59+
import java.util.Optional;
60+
import java.util.UUID;
61+
import java.util.stream.Collectors;
4062

4163
import static org.hamcrest.MatcherAssert.assertThat;
4264
import static org.hamcrest.Matchers.*;
@@ -484,6 +506,121 @@ public void getLogsSortDesc() {
484506
}
485507
}
486508

509+
@Test
510+
public void getLogEntries() {
511+
assumeTrue(isAtLeastVersion(3,8));
512+
final LogEntriesEntity logs = arangoDB.getLogEntries(null);
513+
assertThat(logs, is(notNullValue()));
514+
assertThat(logs.getTotal(), greaterThan(0L));
515+
assertThat((long) logs.getMessages().size(), is(logs.getTotal()));
516+
}
517+
518+
@Test
519+
public void getLogEntriesUpto() {
520+
assumeTrue(isAtLeastVersion(3,8));
521+
final LogEntriesEntity logsUpto = arangoDB.getLogEntries(new LogOptions().upto(LogLevel.WARNING));
522+
assertThat(logsUpto, is(notNullValue()));
523+
assertThat(
524+
logsUpto.getMessages().stream()
525+
.map(LogEntriesEntity.Message::getLevel)
526+
.noneMatch("INFO"::equals),
527+
is(true)
528+
);
529+
}
530+
531+
@Test
532+
public void getLogEntriesLevel() {
533+
assumeTrue(isAtLeastVersion(3,8));
534+
final LogEntriesEntity logsInfo = arangoDB.getLogEntries(new LogOptions().level(LogLevel.INFO));
535+
assertThat(logsInfo, is(notNullValue()));
536+
assertThat(
537+
logsInfo.getMessages().stream()
538+
.map(LogEntriesEntity.Message::getLevel)
539+
.allMatch("INFO"::equals),
540+
is(true)
541+
);
542+
}
543+
544+
@Test
545+
public void getLogEntriesStart() {
546+
assumeTrue(isAtLeastVersion(3,8));
547+
final LogEntriesEntity logs = arangoDB.getLogEntries(null);
548+
final Long firstId = logs.getMessages().get(0).getId();
549+
final LogEntriesEntity logsStart = arangoDB.getLogEntries(new LogOptions().start(firstId + 1));
550+
assertThat(logsStart, is(notNullValue()));
551+
assertThat(
552+
logsStart.getMessages().stream()
553+
.map(LogEntriesEntity.Message::getId)
554+
.filter(firstId::equals)
555+
.count(),
556+
is(0L));
557+
}
558+
559+
@Test
560+
public void getLogEntriesSize() {
561+
assumeTrue(isAtLeastVersion(3,8));
562+
final LogEntriesEntity logs = arangoDB.getLogEntries(null);
563+
int count = logs.getMessages().size();
564+
assertThat(count, greaterThan(0));
565+
final LogEntriesEntity logsSize = arangoDB.getLogEntries(new LogOptions().size(count - 1));
566+
assertThat(logsSize, is(notNullValue()));
567+
assertThat(logsSize.getMessages().size(), is(count - 1));
568+
}
569+
570+
@Test
571+
public void getLogEntriesOffset() {
572+
assumeTrue(isAtLeastVersion(3,8));
573+
final LogEntriesEntity logs = arangoDB.getLogEntries(null);
574+
assertThat(logs.getTotal(), greaterThan(0L));
575+
Long firstId = logs.getMessages().get(0).getId();
576+
final LogEntriesEntity logsOffset = arangoDB.getLogEntries(new LogOptions().offset(1));
577+
assertThat(logsOffset, is(notNullValue()));
578+
assertThat(logsOffset.getMessages().stream()
579+
.map(LogEntriesEntity.Message::getId)
580+
.filter(firstId::equals)
581+
.count()
582+
, is(0L));
583+
}
584+
585+
@Test
586+
public void getLogEntriesSearch() {
587+
assumeTrue(isAtLeastVersion(3,8));
588+
final LogEntriesEntity logs = arangoDB.getLogEntries(null);
589+
final LogEntriesEntity logsSearch = arangoDB.getLogEntries(new LogOptions().search(BaseTest.TEST_DB));
590+
assertThat(logsSearch, is(notNullValue()));
591+
assertThat(logs.getTotal(), greaterThan(logsSearch.getTotal()));
592+
}
593+
594+
@Test
595+
public void getLogEntriesSortAsc() {
596+
assumeTrue(isAtLeastVersion(3,8));
597+
final LogEntriesEntity logs = arangoDB.getLogEntries(new LogOptions().sort(SortOrder.asc));
598+
assertThat(logs, is(notNullValue()));
599+
long lastId = -1;
600+
List<Long> ids = logs.getMessages().stream()
601+
.map(LogEntriesEntity.Message::getId)
602+
.collect(Collectors.toList());
603+
for (final Long id : ids) {
604+
assertThat(id, greaterThan(lastId));
605+
lastId = id;
606+
}
607+
}
608+
609+
@Test
610+
public void getLogEntriesSortDesc() {
611+
assumeTrue(isAtLeastVersion(3,8));
612+
final LogEntriesEntity logs = arangoDB.getLogEntries(new LogOptions().sort(SortOrder.desc));
613+
assertThat(logs, is(notNullValue()));
614+
long lastId = Long.MAX_VALUE;
615+
List<Long> ids = logs.getMessages().stream()
616+
.map(LogEntriesEntity.Message::getId)
617+
.collect(Collectors.toList());
618+
for (final Long id : ids) {
619+
assertThat(lastId, greaterThan(id));
620+
lastId = id;
621+
}
622+
}
623+
487624
@Test
488625
public void getLogLevel() {
489626
assumeTrue(isAtLeastVersion(3, 7)); // it fails in 3.6 active-failover (BTS-362)

0 commit comments

Comments
 (0)