cbbackupmgr collect-logs

Collects debugging information from a backup archive

SYNOPSIS

cbbackupmgr collect-logs [--archive <archive_dir>] [--output-dir <dir>]
                         [--redact] [--salt <salt>]

DESCRIPTION

Collects debugging information to make it easier to debug user issues. This command collects the logs, the output of the list command, the range.json files from each backup, the seqnos and failover logs from each backup, and the backup_meta.json files from each repo. This data is put into a zip file that contains the date that the collect-info command was run. This command will only collect meta from the backup archive.

OPTIONS

Below are a list of parameters for the compact command.

Required

-a,--archive <archive_dir>: The location of the archive directory.
-o,--output_dir <dir>: Specifies a path where the zip file that this command writes should be written. If this flag is not used then the zip file is written to the logs directory of the archive the command is run against.

Optional

--redact: When the redact flag is specified a redacted copy of the logs will be produced, in the same directory as the un-redacted version. The redacted zip directory will be prefixed by `redacted-`.
--salt <salt>: Specifies the salt to used to hash the data. If possible the salt should be the same used by Couchbase Server to allow the logs to be easily cross referenced. The Couchbase Server salt is at the top of the couchbase.log in the zip file generated by cbcollect_info. If no salt is specified it will be auto-generated.

EXAMPLES

To generate debugging information for an archive dir "/data/backup" and output the file to "/data/output/logs" run the following command.

$ cbbackupmgr collect-logs -a /data/backup

To generate debugging information for an archive dir "/data/backup" and output the file to "/tmp" run the following command.

$ cbbackupmgr collect-logs -a /data/backup -o /tmp

ENVIRONMENT AND CONFIGURATION VARIABLES

CB_ARCHIVE_PATH: Specifies the path to the backup archive. If the archive path is supplied as a command line argument then this value is overridden.

FILES

shard-*.fdb: The compact command will compact all shard-*.fdb files in the backup specified by the compact command.

CBBACKUPMGR

Part of the cbbackupmgr suite