cockroachdb / cockroachdb/cockroach

Invoke Collection of TSDump and Debug Zip in Single Action

Open
#130,342 0 comments 0 reactions 0 assignees View on GitHub
C-enhancement O-support P-3 T-supportability
Dominant language
Go
Stars
32.5k
Forks
4.1k
PR merge metrics
PR metrics pending

Description

**Is your feature request related to a problem? Please describe.**

These days, it has become common practice to request for [Debug Zips](https://www.cockroachlabs.com/docs/stable/cockroach-debug-zip) and Timeseries analysis files ([TSDumps](https://www.cockroachlabs.com/docs/v24.2/cockroach-debug-tsdump.html)) when investigating issues in CockroachDB. At present, these are two separate actions that we must ask an organization to gather when the data is requested.

**Describe the solution you'd like**

Given that current trends show that it is typically good troubleshooting practice to obtain both datasets, we should consider creating a new command that pulls both the Debug Zip and TSDump data. We can explore what that would look like (for example, if the actions are invoked in the cluster in parallel or sequentially, and if the resulting set of data is compressed into a single zip file). With a single command (and perhaps a single output), it may be easier on the customer to focus on a single upload to their ticket that contains all the information we need to investigate further.

**Describe alternatives you've considered**

At present, our alternative is to gather the data separately via two separate uploads.

Jira issue: CRDB-42007

Contributor guide

Open the contributing guide

Research direction

Start by reading the linked Debug Zip and TSDump documentation to understand the two existing data-collection actions. Then investigate the CockroachDB CLI entry points for these actions and decide how a combined command should handle sequencing, parallelism, and output packaging. Done means one customer-facing action gathers both datasets in an uploadable result.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.