Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Logging

  • reference
March 16, 2025
+ 12
REST API endpoints are provided for retrieving log and diagnostic information, for collecting logs for upload and review, and for logging client-side errors.

APIs in this Section

The Couchbase-Server Logging facility records important events, and saves the details to log files, on disk. REST API endpoints are provided for retrieving log and diagnostic information, for logging client-side errors, and for collecting logs for upload and review.

The APIs are as follows.

HTTP Method URI Documented at

POST

/controller/startLogsCollection

Collecting Logs

POST

/controller/cancelLogsCollection

Collecting Logs

GET

/pools/default/tasks

Getting Cluster Tasks

GET

/diag

Retrieving Diagnostic and Log Information

GET

/sasl_logs

Retrieving Diagnostic and Log Information

POST

/logClientError

Logging Client-Side Errors