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-425 How to use the new debug bundle cluster configs #862

Merged
merged 20 commits into from
Nov 20, 2024

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Nov 15, 2024

Description

Review deadline: 20 November

Cluster config reference docs will be updated in a separate PR as those are autogenerated cc @Deflaimun
As a result, the links to those configs won't work yet.

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Deflaimun and others added 15 commits October 30, 2024 16:22
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Kat Batuigas <[email protected]>
Co-authored-by: Jake Cahill <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Gellért Peresztegi-Nagy <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Copy link

netlify bot commented Nov 15, 2024

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit f8d0335
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/673cbd9067da48000836c8a1
😎 Deploy Preview https://deploy-preview-862--redpanda-docs-preview.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
Contributor

@michael-redpanda michael-redpanda left a comment

Choose a reason for hiding this comment

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

Just a couple of suggestions, otherwise it looks awesome!

modules/troubleshoot/partials/debug-bundle.adoc Outdated Show resolved Hide resolved
modules/troubleshoot/partials/debug-bundle.adoc Outdated Show resolved Hide resolved
modules/troubleshoot/partials/debug-bundle.adoc Outdated Show resolved Hide resolved

=== View metadata about the Redpanda data directory

To check the size of the directories and look for anomalies:
Copy link
Contributor

Choose a reason for hiding this comment

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

How about a "for example,..." that points out a couple common anomalies that users should watch out for?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@JFlath or @michael-redpanda do you have any advice we can provide here about what an anomalous RP directory size might look like?

Copy link

Choose a reason for hiding this comment

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

It's difficult because it's all a bit subjective and dependant on the dataset. Maybe just if one partition of a given topic is notably larger than others, or contains a lot more data that you would expect for that topic.

Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

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

lgtm

@JakeSCahill JakeSCahill merged commit 62205f5 into v-WIP/24.3 Nov 20, 2024
7 checks passed
@JakeSCahill JakeSCahill deleted the debug-configs branch November 20, 2024 13:02
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.

7 participants