A newer version of this documentation is available.

View Latest

Logs API

The Logs REST API provides the REST API endpoints for retrieving log and diagnostic information as well as how an SDK can add entries into a log.

Description

Couchbase Server logs various messages, which are available via the REST API. These log messages are optionally categorized by the module. A generic list of log entries or log entries for a particular category can be retrieved.

If the system is secured, administrator credentials are required to access logs.
Table 1. Log endpoints
HTTP method URI path Description Admin Role

GET

/diag

Retrieves log and additional server diagnostic information.

Full, Cluster, Bucket

GET

/sasl_logs

Retrieves a generic list of log information.

Full, Cluster, Bucket

GET

/sasl_logs/[log_name]

Retrieves information from the specified log category. Where the log_name is one of the following log types:

  • babysitter

  • couchdb

  • debug

  • error

  • info

  • mapreduce_errors

  • ssl_proxy

  • stats

  • view

  • xdcr

  • xdcr_errors

Full, Cluster, Bucket

POST

/logClientError

Adds entries to the central log from a custom Couchbase Server SDK.

Full, Cluster