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 Client-Side Errors

  • reference
    +
    Client-side errors can be written to a log file.

    HTTP method and URI

    POST /logClientError

    Description

    If a client experiences an error, a corresponding entry can be written to the info.log log file, which is maintained by Couchbase Server in the standard, platform-specific location — see Log-File Locations.

    This method and URI can be used by any Couchbase-Server role.

    Curl Syntax

    curl -X POST http://<ip-address-or-domain-name>:8091/logClientError
  -u <username>:<password>

    Responses

    Success returns 200 OK. Failure to authenticate returns 401 Unauthorized. An incorrectly specified URI returns 404 Object Not Found.

    Example

    The following call logs a client error:

    curl -X POST http://localhost:8091/logClientError -u Administrator:password

    Following successful execution, the log file info.log can be checked as follows:

    $ grep "client" info.log
[menelaus:warn,2023-06-06T16:43:11.136Z,ns_1@10.144.231.101:<0.19779.51>:menelaus_web:log_client_error:1115]Client-side error-report for user "<ud>Administrator</ud>" on node 'ns_1@10.144.231.101':

    See Also

    Logging, redaction, and file upload are described at Manage Logging. This also provides a list of log-files, and a description of how to use logging with Couchbase Web Console. It also provides an introduction to managing logging with the CLI.