A newer version of this documentation is available.

View Latest

collect-logs-status

    +

    Get log collection status

    SYNOPSIS

    couchbase-cli collect-logs-status [--cluster <url>] [--username <user>]
        [--password <password>]

    DESCRIPTION

    This command is used to check the status of the log collection task that is either currently running or last completed. This command is especially useful since it lists the exact location of the collected files on each node. Upon a successful run of this command the output will either be one of the two messages below.

    No log collection tasks were found

    or

    Status: <running | cancelled | completed>
    Details:
      Node: <node name>
      Status: <started | collected>
      path: <path to the location of the collected logs>

    If logs for multiple nodes were collected, then multiple nodes will be listed in the details section.

    OPTIONS

    -c
    --cluster

    Specifies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

    -u
    --user <username>

    Specifies the username of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error.

    -p
    --password <password>

    Specifies the password of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

    HOST FORMATS

    When specifying a host for the couchbase-cli command the following formats are expected:

    • couchbase://<addr>

    • <addr>:<port>

    • http://<addr>:<port>

    It is recommended to use the couchbase://<addr> format for standard installations. The other two formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091.

    EXAMPLES

    To see the status of a running or completed log collection task run the command below.

    $ couchbase-cli collect-logs-status -c 192.168.1.5 --username Administrator \
     --password password
    Status: completed
    Details:
      Node: n_0@192.168.1.5
      Status: collected
      path: /opt/couchbase/var/lib/couchbase/tmp/collectinfo-2016-09-27T005502-n_0@192.168.1.5.zip

    ENVIRONMENT AND CONFIGURATION VARIABLES

    CB_REST_USERNAME

    Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

    CB_REST_PASSWORD

    Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

    COUCHBASE-CLI

    Part of the couchbase-cli suite