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
    • 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.

    • 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 .) 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.

    • 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.

    • 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
      • is returned if the request is valid.

      • is returned if invalid values are specified for upto or level.

      • 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.

      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
        • 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.

        • 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.

        • 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.

        • 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
            • Response Body
            • A list of the log levels for all log entries.

            • a list of log entry identifiers. Each log message is uniquely identified by its @LIT{lid} and the identifiers are in ascending order.

            • a list of the texts of all log entries

            • a list of the timestamps as seconds since 1970-01-01 for all log entries.

            • a list of the topics of all log entries

            • the total amount of log entries before pagination.

          • is returned if invalid values are specified for upto or level.

          • 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.

          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
            • Forwards the request to the specified server.

            HTTP Headers
              Responses
              • is returned if the request is valid

              • 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.

              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
                • Forwards the request to the specified server.

                HTTP Headers
                  Request Body application/json
                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • Pseudo-topic to address all log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics.

                  • One of the possible log topics (Enterprise Edition only).

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  • One of the possible log topics.

                  Responses
                  • is returned if the request is valid

                  • is returned when the request body contains invalid JSON.

                  • is returned if there are insufficient privileges to adjust log levels.

                  • 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.

                  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.

                  Responses
                  • is returned if the request is valid

                  • is returned if there are insufficient privileges to read structured log parameters.

                  • 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.

                  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.

                  Request Body application/json
                  • One of the possible log parameters.

                  • One of the possible log parameters.

                  • One of the possible log parameters.

                  Responses
                  • is returned if the request is valid

                  • is returned if there are insufficient privileges to adjust log levels.

                  • is returned when an invalid HTTP method is used.