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.

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

[DOCS] Add 'Fix common cluster issues' docs #72097

Merged
merged 15 commits into from
Apr 28, 2021
Merged

[DOCS] Add 'Fix common cluster issues' docs #72097

merged 15 commits into from
Apr 28, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Apr 22, 2021 •
edited
Loading

Creates a troubleshooting doc that outlines how to diagnose and fix:

  • Circuit breaker errors
  • High JVM memory pressure
  • Red or yellow cluster status

There are likely other common problems we can add, but those are considered out of scope for this PR.

Based on the https://www.elastic.co/blog/managing-and-troubleshooting-elasticsearch-memory[Managing and troubleshooting Elasticsearch memory] blog post.

Closes #72053

Preview

https://elasticsearch_72097.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/fix-common-cluster-issues.html

@jrodewig jrodewig marked this pull request as ready for review April 23, 2021 13:23
@jrodewig jrodewig added the :Core/Infra/Circuit Breakers Track estimates of memory consumption to prevent overload label Apr 23, 2021
@elasticmachine elasticmachine added the Team:Core/Infra Meta label for core/infra team label Apr 23, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (Team:Core/Infra)

@jrodewig jrodewig requested review from gwbrown and stefnestor April 23, 2021 14:43
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Apr 23, 2021
@elasticmachine
Copy link
Collaborator

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

@jrodewig
Copy link
Contributor Author

jrodewig commented Apr 23, 2021 •
edited
Loading

Hi @gwbrown and @stefnestor! I based this guide on Stef's awesome upcoming blog post with some minor changes:

  • I omitted information about JVM heap configuration as we don't recommend it in most cases. That info is already covered in our config docs anyway.
  • I left out the information on oversharding and heap-to-shard ratios as that's covered in Size your shards. However, I do provide several cross-links to those docs.
  • I added some additional information about fixing a yellow or red cluster status. I don't know if it's possible to cover all possible resolutions, but I tried to cover the most common/likely ones.

The idea is that we can add more common problems to this guide later on. Please let me know if you have any feedback. Thanks!

@stefnestor
Copy link
Contributor

I love this! It goes way beyond my TLDR but is exactly top comments what I end up responding on tickets! Thanks for putting it together. 🙌🏼

cc: @danleerunk for FYI for Support team of up coming frequently linked doc :)

jrodewig
jrodewig commented Apr 23, 2021
View reviewed changes
Copy link
Contributor Author

@jrodewig jrodewig 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 the helpful review @stefnestor. I pushed some changes to address. Let me know if you have any other feedback!

docs/reference/how-to/fix-common-cluster-issues.asciidoc Show resolved Hide resolved
docs/reference/how-to/fix-common-cluster-issues.asciidoc Show resolved Hide resolved
docs/reference/how-to/fix-common-cluster-issues.asciidoc Show resolved Hide resolved
docs/reference/how-to/fix-common-cluster-issues.asciidoc Outdated Show resolved Hide resolved
stefnestor
stefnestor approved these changes Apr 23, 2021
View reviewed changes
Copy link
Contributor

@stefnestor stefnestor left a comment

Choose a reason for hiding this comment

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

Granted I don't know how to review asciidoc but the content's solid.

Preferably left two more comments, but would only really want the bulk one, but could live w/o it so approving. Thanks for putting this together!

@jrodewig
Copy link
Contributor Author

Thanks again @stefnestor. I'll give @gwbrown a chance to look this over before merging it in.

@jrodewig
Copy link
Contributor Author

Related blog post is now live: https://www.elastic.co/blog/managing-and-troubleshooting-elasticsearch-memory

gwbrown
gwbrown approved these changes Apr 27, 2021
View reviewed changes
Copy link
Contributor

@gwbrown gwbrown left a comment

Choose a reason for hiding this comment

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

LGTM - apologies for the delay on reviewing this!

@jrodewig
Copy link
Contributor Author

No worries at all. Thanks @gwbrown!

@jrodewig jrodewig merged commit f8666b9 into elastic:master Apr 28, 2021
@jrodewig jrodewig deleted the docs__fix-common-issues branch April 28, 2021 12:28
This was referenced Apr 28, 2021
Merged
Merged
Merged
jrodewig added a commit that referenced this pull request Apr 28, 2021
@jrodewig
[DOCS] Add 'Fix common cluster issues' docs (#72097) (#72384)
fef5baa
jrodewig added a commit that referenced this pull request Apr 28, 2021
@jrodewig
[DOCS] Add 'Fix common cluster issues' docs (#72097) (#72385)
a350056
jrodewig added a commit that referenced this pull request Apr 28, 2021
@jrodewig
[DOCS] Add 'Fix common cluster issues' docs (#72097) (#72386)
f2ee004
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stefnestor stefnestor stefnestor approved these changes

@gwbrown gwbrown gwbrown approved these changes

Assignees
No one assigned
Labels
:Core/Infra/Circuit Breakers Track estimates of memory consumption to prevent overload >docs General docs changes Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team v7.12.2 v7.13.0 v7.14.0 v8.0.0-alpha1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOCS] TLDR on ES Memory
6 participants
@jrodewig @elasticmachine @stefnestor @gwbrown @jakelandis @mark-vieira