ArangoDB v3.10 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent stable version.

Logs

Server events and errors are logged depending on the defined log levels for the available log topics

Whether events are logged to a file, syslog, or only an attached terminal depends on the log startup options.

See Log levels for a detailed description of the FATAL, ERROR, and other levels of log messages.

Get the global server logs

get /_admin/log/entries

Returns fatal, error, warning or info log messages from the server’s global log. The result is a JSON object with the following properties:

total: the total amount of log entries before pagination
messages: an array with log messages that matched the criteria

This API can be turned off via the startup option --log.api-enabled. In case the API is disabled, all requests will be responded to with HTTP 403. If the API is enabled, accessing it requires admin privileges, or even superuser privileges, depending on the value of the --log.api-enabled startup option.

Path Parameters

Query Parameters

upto string
Returns all log entries up to log level upto. Note that upto must be:
- fatal or 0
- error or 1
- warning or 2
- info or 3
- debug or 4 The default value is info.
level string
Returns all log entries of log level level. Note that the query parameters upto and level are mutually exclusive.
start number
Returns all log entries such that their log entry identifier (lid .) is greater or equal to start.
size number
Restricts the result to at most size log entries.
offset number
Starts to return log entries skipping the first offset log entries. offset and size can be used for pagination.
search string
Only return the log entries containing the text specified in search.
sort string
Sort the log entries either ascending (if sort is asc) or descending (if sort is desc) according to their id values. Note that the id imposes a chronological order. The default value is asc.
serverId string
Returns all log entries of the specified server. All other query parameters remain valid. If no serverId is given, the asked server will reply. This parameter is only meaningful on Coordinators.

HTTP Headers

Responses

200 OK
is returned if the request is valid.
400 Bad Request
is returned if invalid values are specified for upto or level.
403 Forbidden
is returned if there are insufficient privileges to access the logs.

Get the global server logs (deprecated)

get /_admin/log

This endpoint should no longer be used. It is deprecated from version 3.8.0 on. Use /_admin/log/entries instead, which provides the same data in a more intuitive and easier to process format.

Returns fatal, error, warning or info log messages from the server’s global log. The result is a JSON object with the attributes described below.

Path Parameters

Query Parameters

upto string
Returns all log entries up to log level upto. Note that upto must be:
- fatal or 0
- error or 1
- warning or 2
- info or 3
- debug or 4 The default value is info.
level string
Returns all log entries of log level level. Note that the query parameters upto and level are mutually exclusive.
start number
Returns all log entries such that their log entry identifier (lid value) is greater or equal to start.
size number
Restricts the result to at most size log entries.
offset number
Starts to return log entries skipping the first offset log entries. offset and size can be used for pagination.
search string
Only return the log entries containing the text specified in search.
sort string
Sort the log entries either ascending (if sort is asc) or descending (if sort is desc) according to their lid values. Note that the lid imposes a chronological order. The default value is asc.
serverId string
Returns all log entries of the specified server. All other query parameters remain valid. If no serverId is given, the asked server will reply. This parameter is only meaningful on Coordinators.

HTTP Headers

Responses

200 OK
- level* string
  A list of the log levels for all log entries.
- lid* array of strings
  a list of log entry identifiers. Each log message is uniquely identified by its @LIT{lid} and the identifiers are in ascending order.
- text* string
  a list of the texts of all log entries
- timestamp* array of strings
  a list of the timestamps as seconds since 1970-01-01 for all log entries.
- topic* string
  a list of the topics of all log entries
- totalAmount* integer
  the total amount of log entries before pagination.
400 Bad Request
is returned if invalid values are specified for upto or level.
403 Forbidden
is returned if there are insufficient privileges to access the logs.

Get the server log levels

get /_admin/log/level

Returns the server’s current log level settings. The result is a JSON object with the log topics being the object keys, and the log levels being the object values.

Path Parameters

Query Parameters

serverId string
Forwards the request to the specified server.

HTTP Headers

Responses

200 OK
is returned if the request is valid
403 Forbidden
is returned if there are insufficient privileges to read log levels.

Set the server log levels

put /_admin/log/level

Modifies and returns the server’s current log level settings. The request body must be a JSON string with a log level or a JSON object with the log topics being the object keys and the log levels being the object values.

If only a JSON string is specified as input, the log level is adjusted for the “general” log topic only. If a JSON object is specified as input, the log levels will be set only for the log topic mentioned in the input object, but preserved for every other log topic. To set the log level for all log levels to a specific value, it is possible to hand in the special pseudo log topic “all”.

The result is a JSON object with all available log topics being the object keys, and the adjusted log levels being the object values.

Possible log levels are:

FATAL - There will be no way out of this. ArangoDB will go down after this message.
ERROR - This is an error. you should investigate and fix it. It may harm your production.
WARNING - This may be serious application-wise, but we don’t know.
INFO - Something has happened, take notice, but no drama attached.
DEBUG - output debug messages
TRACE - trace - prepare your log to be flooded - don’t use in production.

Path Parameters

Query Parameters

serverId string
Forwards the request to the specified server.

HTTP Headers

Request Body application/json

agency string
One of the possible log topics.
agencycomm string
One of the possible log topics.
agencystore string
One of the possible log topics.
all string
Pseudo-topic to address all log topics.
aql string
One of the possible log topics.
arangosearch string
One of the possible log topics.
audit-authentication string
One of the possible log topics (Enterprise Edition only).
audit-authorization string
One of the possible log topics (Enterprise Edition only).
audit-collection string
One of the possible log topics (Enterprise Edition only).
audit-database string
One of the possible log topics (Enterprise Edition only).
audit-document string
One of the possible log topics (Enterprise Edition only).
audit-hotbackup string
One of the possible log topics (Enterprise Edition only).
audit-service string
One of the possible log topics (Enterprise Edition only).
audit-view string
One of the possible log topics (Enterprise Edition only).
authentication string
One of the possible log topics.
authorization string
One of the possible log topics.
backup string
One of the possible log topics.
bench string
One of the possible log topics.
cache string
One of the possible log topics.
cluster string
One of the possible log topics.
clustercomm string
One of the possible log topics.
collector string
One of the possible log topics.
communication string
One of the possible log topics.
config string
One of the possible log topics.
crash string
One of the possible log topics.
development string
One of the possible log topics.
dump string
One of the possible log topics.
engines string
One of the possible log topics.
flush string
One of the possible log topics.
general string
One of the possible log topics.
graphs string
One of the possible log topics.
heartbeat string
One of the possible log topics.
httpclient string
One of the possible log topics.
ldap string
One of the possible log topics (Enterprise Edition only).
libiresearch string
One of the possible log topics.
license string
One of the possible log topics (Enterprise Edition only).
maintenance string
One of the possible log topics.
memory string
One of the possible log topics.
mmap string
One of the possible log topics.
performance string
One of the possible log topics.
pregel string
One of the possible log topics.
queries string
One of the possible log topics.
replication string
One of the possible log topics.
requests string
One of the possible log topics.
restore string
One of the possible log topics.
rocksdb string
One of the possible log topics.
security string
One of the possible log topics.
ssl string
One of the possible log topics.
startup string
One of the possible log topics.
statistics string
One of the possible log topics.
supervision string
One of the possible log topics.
syscall string
One of the possible log topics.
threads string
One of the possible log topics.
trx string
One of the possible log topics.
ttl string
One of the possible log topics.
v8 string
One of the possible log topics.
validation string
One of the possible log topics.
views string
One of the possible log topics.

Responses

200 OK
is returned if the request is valid
400 Bad Request
is returned when the request body contains invalid JSON.
403 Forbidden
is returned if there are insufficient privileges to adjust log levels.
405 Method Not Allowed
is returned when an invalid HTTP method is used.

Get the structured log settings

get /_admin/log/structured

Returns the server’s current structured log settings. The result is a JSON object with the log parameters being the object keys, and true or false being the object values, meaning the parameters are either enabled or disabled.

Responses

200 OK
is returned if the request is valid
403 Forbidden
is returned if there are insufficient privileges to read structured log parameters.
405 Method Not Allowed
is returned when an invalid HTTP method is used.

Set the structured log settings

put /_admin/log/structured

Modifies and returns the server’s current structured log settings. The request body must be a JSON object with the structured log parameters being the object keys and true or false object values, for either enabling or disabling the parameters.

The result is a JSON object with all available structured log parameters being the object keys, and true or false being the object values, meaning the parameter in the object key is either enabled or disabled.

Request Body application/json

database boolean
One of the possible log parameters.
url boolean
One of the possible log parameters.
username boolean
One of the possible log parameters.

Responses

200 OK
is returned if the request is valid
403 Forbidden
is returned if there are insufficient privileges to adjust log levels.
405 Method Not Allowed
is returned when an invalid HTTP method is used.