HTTP interface for server logs

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
• trace or 5

Returns all log entries of log level level. Note that the query parameters upto and level are mutually exclusive.

Returns all log entries such that their log entry identifier (id value) is greater or equal to start.

Restricts the result to at most size log entries.

Starts to return log entries skipping the first offset log entries. offset and size can be used for pagination.

Only return the log entries containing the text specified in search.

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.

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.

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
• trace or 5

Returns all log entries of log level level. Note that the query parameters upto and level are mutually exclusive.

Returns all log entries such that their log entry identifier (lid value) is greater or equal to start.

Restricts the result to at most size log entries.

Starts to return log entries skipping the first offset log entries. offset and size can be used for pagination.

Only return the log entries containing the text specified in search.

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.

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.

Forwards the request to the specified server.

Set this option to true to return the individual log level settings of all log outputs (appenders) as well as the global settings.

The response structure is as follows:

{
  "global": {
    "agency": "INFO",
    "agencycomm": "INFO",
    "agencystore": "WARNING",
    ...
  },
  "appenders": {
    "-": {
      "agency": "INFO",
      "agencycomm": "INFO",
      "agencystore": "WARNING",
      ...
    },
    "file:///path/to/file": {
      "agency": "INFO",
      "agencycomm": "INFO",
      "agencystore": "WARNING",
      ...
    },
    ...
  }
}

Forwards the request to the specified server.

Set this option to true to set individual log level settings for log outputs (appenders). The request and response structure is as follows:

{
  "global": {
    "agency": "INFO",
    "agencycomm": "INFO",
    "agencystore": "WARNING",
    ...
  },
  "appenders": {
    "-": {
      "agency": "INFO",
      "agencycomm": "INFO",
      "agencystore": "WARNING",
      ...
    },
    "file:///path/to/file": {
      "agency": "INFO",
      "agencycomm": "INFO",
      "agencystore": "WARNING",
      ...
    },
    ...
  }
}

Changing the global settings affects all outputs and is the same as setting a log level with this option turned off.

Agents use this log topic to inform about any activity including the RAFT consensus gossip.

DB-Servers and Coordinators log the requests they send to the Agency.

Optional verbose logging of Agency write operations.

Pseudo-topic to address all log topics.

Logs information about the AQL query optimization and execution. DB-Servers and Coordinators log the cluster-internal communication around AQL queries. It also reports the AQL memory limit on startup.

Logs information related to ArangoSearch including Analyzers, the column cache, and the commit and consolidation threads.

Controls whether events such as successful logins and missing or wrong credentials are written to the audit log.

Controls whether events such as users trying to access databases without the necessary permissions are written to the audit log.

Controls whether events about collections creation, truncation, and deletion are written to the audit log.

Controls whether events about database creation and deletion are written to the audit log.

Controls whether document read and write events are written to the audit log.

Controls whether the Hot Backup creation, restore, and delete events are written to the audit log.

Controls whether the start and stop events of the audit service are written to the audit log.

Controls whether events about View creation and deletion are written to the audit log.

Logs events related to authentication, for example, when a JWT secret is generated or a token is validated against a secret.

Logs when a user has insufficient permissions for a request.

Logs events related to Hot Backup.

Logs events related to benchmarking with arangobench.

Logs events related to caching documents and index entries as well as the cache configuration on startup.

Logs information related to the cluster-internal communication as well as cluster operations. This includes changes to the state and readiness of DB-Servers and connectivity checks on Coordinators.

Logs lower-level network connection and communication events.

Logs information related to the startup options and server configuration.

Logs information about a fatal error including a backtrace before the process terminates.

Warns about deprecated features and the usage of options that will not be allowed or have no effect in a future version.

This log topic is reserved for the development of ArangoDB.

Logs events related to dumping data with arangodump.

Logs various information related to ArangoDB’s use of the RocksDB storage engine, like the initialization and file operations.

RocksDB’s internal log messages are passed through using the rocksdb log topic.

Logs events related to flushing data from memory to disk.

Logs all messages of general interest and that don’t fit under any of the other log topics. For example, it reports the ArangoDB version and the detected operating system and memory on startup.

Logs information related to graph operations including graph traversal and path search tracing.

Logs everything related to the cluster heartbeat for monitoring the intra-connectivity.

Logs the activity of the HTTP request subsystem that is used in replication, client tools, and V8.

Logs the internal log messages of IResearch, the underlying library of ArangoSearch.

Logs events related to the license management like the expiration of a license.

Logs the operations of the cluster maintenance including shard locking and collection creation.

Logs the memory configuration on startup and reports problems with memory alignment and operating system settings.

Logs slow queries as well as internal details about the execution of AQL queries at low log levels.

Logs information related to the data replication within a cluster.

Logs the handling of internal and external requests and can include IP addresses, endpoints, and HTTP headers and bodies when using low log levels.

It overlaps with the network communication log topic.

This log topic is only used by arangorestore.

Logs RocksDB’s internal log messages as well RocksDB background errors.

Information related to ArangoDB’s use of the RocksDB storage engine uses the engines log topic.

Logs the security configuration for V8.

Logs information related to the in-transit encryption of network communication using SSL/TLS.

Logs information related to the startup and shutdown of a server process as well as anything related to upgrading the database directory.

Logs events related to processing server statistics. This is independent of server metrics.

Logs information related to the Agency’s cluster supervision.

Logs events related to calling operating system functions. It reports problems related to file descriptors and the server process monitoring.

Logs information related to the use of operating system threads and the threading configuration of ArangoDB.

Logs information about transaction management.

Logs the activity of the background thread for time-to-live (TTL) indexes.

Logs various information related to ArangoDB’s use of the V8 JavaScript engine, like the initialization as well as entering and exiting contexts.

Logs when the schema validation fails for a document.

Logs certain events related to ArangoSearch Views.

Forwards the request to the specified server.

One of the possible log parameters.

One of the possible log parameters.

One of the possible log parameters.

The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database and administrate access to the _system database. If --log.recording-api-enabled is set to jwt, you need to use a superuser token to access the endpoint.

The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database and administrate access to the _system database. If --log.recording-api-enabled is set to jwt, you need to use a superuser token to access the endpoint.