The cockroach debug merge-logs command merges log files from multiple nodes into a single time-ordered stream of messages with an added per-message prefix to indicate the corresponding node. You can use it in conjunction with logs collected using the debug zip command to aid in debugging.
The file produced by cockroach debug zip can contain highly sensitive, identifiable information, such as usernames, hashed passwords, and possibly your table's data. You can use the --redact flag to redact the sensitive data out of log files and crash reports before sharing them with Cockroach Labs.
Subcommands
While the cockroach debug command has a few subcommands, users are expected to use only the zip, encryption-active-key, merge-logs, list-files, tsdump, and ballast subcommands.
We recommend using the job-trace subcommand only when directed by the Cockroach Labs support team.
The other debug subcommands are useful only to CockroachDB's developers and contributors.
Synopsis
$ cockroach debug merge-logs [log file directory] [flags]
Flags
Use the following flags to filter the debug merge-logs results for a specified regular expression or time range.
| Flag | Description |
|---|---|
--filter |
Limit the results to the specified regular expression |
--from |
Start time for the time range filter. |
--to |
End time for the time range filter. |
--redact |
Redact sensitive data from the log files. |
Example
Generate a debug zip file:
$ cockroach debug zip ./cockroach-data/logs/debug.zip --insecure
Unzip the file:
$ unzip ./cockroach-data/logs/debug.zip
Merge the logs in the debug folder:
$ cockroach debug merge-logs debug/nodes/*/logs/*
Alternatively, filter the merged logs for a specified time range:
$ cockroach debug merge-logs debug/nodes/*/logs/* --from="220713 18:36:28.208553" --to="220713 18:36:29.232864"
You can also filter the merged logs for a regular expression:
cockroach debug merge-logs debug/nodes/*/logs/* --filter="RUNNING IN INSECURE MODE"
You can redact sensitive information from the merged logs:
cockroach debug merge-logs --redact debug/nodes/*/logs/*
See also
Was this helpful?
