Skip to content

Add shards capacity troubleshooting guide #95208

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 17 commits into from
Apr 19, 2023
Merged

Add shards capacity troubleshooting guide #95208

merged 17 commits into from
Apr 19, 2023

Conversation

@HiDAl
Copy link

@HiDAl HiDAl commented Apr 13, 2023

No description provided.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 13, 2023

Documentation preview:

@elasticsearchmachine elasticsearchmachine added v8.8.0 needs:triage Requires assignment of a team area label labels Apr 13, 2023
@HiDAl HiDAl added >docs General docs changes Team:Data Management Meta label for data/management team :Data Management/Health and removed needs:triage Requires assignment of a team area label labels Apr 13, 2023
@HiDAl HiDAl requested review from andreidan and dakrone April 13, 2023 07:52
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Apr 13, 2023
@elasticsearchmachine
Copy link
Collaborator

elasticsearchmachine commented Apr 13, 2023

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

elasticsearchmachine commented Apr 13, 2023

Pinging @elastic/es-data-management (Team:Data Management)

@HiDAl HiDAl mentioned this pull request Apr 13, 2023
Closed
7 tasks
dakrone
dakrone approved these changes Apr 17, 2023
View reviewed changes
Copy link
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

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

I left some minor comments, but otherwise looks good to me, thanks Pablo!

@HiDAl
Copy link
Author

HiDAl commented Apr 17, 2023

Thanks @dakrone !

andreidan
andreidan requested changes Apr 17, 2023
View reviewed changes
Copy link
Contributor

@andreidan andreidan left a comment

Choose a reason for hiding this comment

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

Thanks for working on this Pablo.

This generally looks good but it's missing the ESS/On prem widget (the ESS one describes how to get to dev tools etc)
This is how this PR guide currently displays https://elasticsearch_95208.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/troubleshoot-shards-capacity-issues.html

And this is what we're aiming for https://elasticsearch_95208.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/add-tier.html

@HiDAl
Copy link
Author

HiDAl commented Apr 17, 2023

@andreidan I though we do this only in the case there's a UI to modify these settings. Will update the PR tomorrow. thanks

@andreidan
Copy link
Contributor

andreidan commented Apr 17, 2023 •
edited
Loading

@HiDAl We do for all cases as the ESS tab was instructions on how to get to Dev tools (or in some cases where support is available, to the dedicated UI).
e.g. https://elasticsearch_95208.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/increase-shard-limit.html

@HiDAl
Copy link
Author

HiDAl commented Apr 18, 2023

@andreidan I have added tabs for ESS and OnPrem. Thanks for the support here!

@HiDAl HiDAl requested a review from andreidan April 18, 2023 08:46
andreidan
andreidan reviewed Apr 18, 2023
View reviewed changes
Copy link
Contributor

@andreidan andreidan left a comment

Choose a reason for hiding this comment

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

Thanks for iterating on this Pablo.

This looks great. Only one step to add in the guides and this is ready.

Thanks for working on this

docs/reference/tab-widgets/troubleshooting/troubleshooting-shards-capacity.asciidoc Outdated
[role="screenshot"]
image::images/kibana-console.png[{kib} Console,align="center"]

. Update the <<cluster-max-shards-per-node,`cluster.max_shards_per_node`>> setting:
Copy link
Contributor

@andreidan andreidan Apr 18, 2023

Choose a reason for hiding this comment

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

I think in all cases we should as a first step inspect the current value of the setting.
Either via the GET _cluster/settings API or via the _health_report/shards_capacity API.

But let's please display that step and indicate that we need to increase the value of the setting relative to what's currently configured - here's an example of how we indicate this for a cluster setting https://elasticsearch_95208.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/increase-cluster-shard-limit.html

@HiDAl HiDAl requested a review from andreidan April 18, 2023 13:49
@HiDAl
Copy link
Author

HiDAl commented Apr 18, 2023

Finally! @andreidan I added the missing step! thanks for your review

andreidan
andreidan approved these changes Apr 18, 2023
View reviewed changes
Copy link
Contributor

@andreidan andreidan left a comment

Choose a reason for hiding this comment

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

Thanks for iterating on this Pablo

🚀 LGTM

@HiDAl HiDAl merged commit 253fe63 into elastic:main Apr 19, 2023
@HiDAl HiDAl deleted the shards-capacity-troubleshooting-guide branch April 19, 2023 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dakrone dakrone dakrone approved these changes

@andreidan andreidan andreidan approved these changes

Assignees

No one assigned

Labels

:Data Management/Health >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v8.8.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@HiDAl @elasticsearchmachine @andreidan @dakrone