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

Troubleshooting: Provide concise troubleshooting guidelines #55

Merged
merged 4 commits into from
Jul 9, 2024

Conversation

amotl
Copy link
Member

@amotl amotl commented Feb 29, 2024

Problem

When encountering troubles with CrateDB database clusters, for example by observing any anomalies, there is no clear and complete information publicly available about the whole procedure to find out about potential root causes and whatnot.

Solution

With optional tool support, let's improve corresponding documentation on this matter. This patch makes a start on it, and invites you to contribute and collaborate. Feel free to add patches, or share any suggestions which come to mind as we go.

Preview

Before vs. after.

/cc @karynzv, @hlcianfagna, @hammerhead, @mkleen, @surister, @seut, @proddata, @simonprickett

@amotl amotl added enhancement New feature or request help wanted Extra attention is needed question Further information is requested sanding-500 Sanding medium-sized details. new content New content being added. guidance Matters of layout, shape, and structure. labels Feb 29, 2024
@amotl amotl mentioned this pull request Feb 29, 2024
16 tasks
docs/admin/troubleshooting/docker-jcmd.rst Outdated Show resolved Hide resolved
docs/admin/troubleshooting/docker-jcmd.rst Outdated Show resolved Hide resolved
@amotl amotl force-pushed the collab/troubleshooting branch 4 times, most recently from 74f1585 to 43f5094 Compare July 8, 2024 00:54
::::{grid} 1 2 2 2

:::{grid-item-card} {material-outlined}`download_for_offline;1.4em` Linux x64
:link: https://github.com/crate-workbench/cratedb-toolkit/actions/runs/9826830191/artifacts/1674929097
Copy link
Member

Choose a reason for hiding this comment

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

What is the approach to keep these links to release bundles up-to-date? I noticed it currently links to a specific GitHub Action run. Is there a possibility to have the artifacts as part of the regular release assets (https://github.com/crate-workbench/cratedb-toolkit/releases), so updating it here is just a matter of keeping it in sync with the latest cratedb-toolkit version number?

Copy link
Member Author

@amotl amotl Jul 8, 2024

Choose a reason for hiding this comment

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

Thanks, this is right on the spot. Currently, there is no solid approach yet, we just did the minimum things to establish a build matrix through a corresponding GitHub Actions workflow.

I've provided a relevant response citing you on the corresponding tracking ticket, so it will not get lost when merging this patch.

We will need to improve the situation with subsequent iterations.

Copy link
Member

@hammerhead hammerhead left a comment

Choose a reason for hiding this comment

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

There are some questionable (and partly also broken) queries on sys tables mentioned (example: SELECT _node['name'], _node['hostname'], * FROM sys.operations;). But since they already existed before, and this PR doesn't touch them, I'm ok with merging and doing another iteration.

docs/admin/troubleshooting/jcmd/index.md Outdated Show resolved Hide resolved
docs/admin/troubleshooting/system-tables.rst Outdated Show resolved Hide resolved
docs/admin/troubleshooting/system-tables.rst Outdated Show resolved Hide resolved
docs/admin/troubleshooting/system-tables.rst Outdated Show resolved Hide resolved
The number may change any day, and is not of any value to readers.
@amotl
Copy link
Member Author

amotl commented Jul 8, 2024

More details within the SQL statements in the system-tables page had to be fixed. 4b9fc77 now includes all of them, including yours. Thanks!

@amotl amotl requested a review from seut July 8, 2024 16:04
@amotl amotl merged commit 2b35345 into main Jul 9, 2024
3 checks passed
@amotl amotl deleted the collab/troubleshooting branch July 9, 2024 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request guidance Matters of layout, shape, and structure. help wanted Extra attention is needed new content New content being added. question Further information is requested sanding-500 Sanding medium-sized details.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants