Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-8738: Warn users that generating the debug zip can degrade the cluster #17952

Merged
merged 1 commit into from
Oct 23, 2023

Conversation

florence-crl
Copy link
Contributor

Addresses DOC-8738

(1) Updated cockroach debug zip page with cluster impact warning and recommendation to filter by time range.

@github-actions
Copy link

github-actions bot commented Oct 3, 2023

@netlify
Copy link

netlify bot commented Oct 3, 2023

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit da9fa8f
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/65369ce685d5da0007609d64

@netlify
Copy link

netlify bot commented Oct 3, 2023

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit da9fa8f
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/65369ce71a1fb6000830bc31

@netlify
Copy link

netlify bot commented Oct 3, 2023

Netlify Preview

Name Link
🔨 Latest commit da9fa8f
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/65369ce65ba23b00086ae29f
😎 Deploy Preview https://deploy-preview-17952--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

@kevinkokomani kevinkokomani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

src/current/v23.1/cockroach-debug-zip.md Outdated Show resolved Hide resolved
src/current/v23.2/cockroach-debug-zip.md Outdated Show resolved Hide resolved
Copy link

@kevin-v-ngo kevin-v-ngo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @florence-crl, do you think we can include guidance and document this new flag? We have a few threads and issues related to the range info filter.

Doc issue: #16919
PR: cockroachdb/cockroach#102289

@florence-crl
Copy link
Contributor Author

Before I can document #16919, I need to clarify what is the default value. For context, see this slack thread.

@florence-crl
Copy link
Contributor Author

Clarification: cockroachdb/cockroach#104133 changed the default to true and concat-ed the range info into 1 ranges.json file.

@florence-crl florence-crl force-pushed the DOC-8738 branch 2 times, most recently from ac25b0f to 65d9c75 Compare October 9, 2023 20:29
@florence-crl florence-crl requested a review from dt October 9, 2023 20:39
@florence-crl
Copy link
Contributor Author

@dt, PTAL, I included your recommendation under the --include-range-info flag description.

Copy link

@kevin-v-ngo kevin-v-ngo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Looks good Florence. Thanks for the updates.

…ommendation to filter by time range, and --include-range-info flag.
@florence-crl florence-crl merged commit ac52032 into main Oct 23, 2023
3 checks passed
@florence-crl florence-crl deleted the DOC-8738 branch October 23, 2023 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants