A newer version of this documentation is available.

View Latest


Starts the cluster-wide log collection.


The basic syntax is:

couchbase-cli collect-logs-start -c [host]:8091 -u [admin] -p [password] [options]


This command initiates a log collection process. You must specify whether to collect logs from all nodes or only from the specified nodes.

You can optionally request that the logs be uploaded to Couchbase Server, in which case you must include the name of your organization and (optionally) a support ticket number.


The following are the command options:

Table 1. collect-logs-start options
Option Description


Collects logs from all accessible cluster nodes.


Specifies the subset of nodes from which the logs are collected.


Name of the customer sending the logs. This name is mandatory when the option --upload is specified.


Number of the support ticket (optional).


Collects logs to a specified host.


The host to which the logs are uploaded. This name is mandatory when the option --upload is specified.


To upload all logs from the customer ABC to a specified server and connect it with the support ticket AB12345. The upload host is a remote internet server such as AWS S3.

couchbase-cli collect-logs-start -c -u Administrator -p password \
--all-nodes --upload-host= --customer=ABC --ticket=AB12345