Skip to content

Conversation

@stefnestor
Copy link
Contributor

@stefnestor stefnestor commented Jan 3, 2026

Summary

πŸ‘‹ Ports High CPU article to docs.

πŸ™‹β€β™€οΈ

  1. Should have Dev sign-off.
  2. allocated_processors in CAT nodes isn't available till v9.3.0 per this, (how) do we mark that?

Related understanding for top summary portion changes from

πŸ™ TIA!

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

@github-actions
Copy link
Contributor

github-actions bot commented Jan 3, 2026

Vale Linting Results

Summary: 1 warning, 5 suggestions found

⚠️ Warnings (1)
File Line Rule Message
troubleshoot/elasticsearch/high-cpu-usage.md 176 Elastic.BritishSpellings Use American English spelling 'behavior' instead of British English 'behaviour'.
πŸ’‘ Suggestions (5)
File Line Rule Message
troubleshoot/elasticsearch/high-cpu-usage.md 17 Elastic.Wordiness Consider using 'all' instead of 'all of '.
troubleshoot/elasticsearch/high-cpu-usage.md 112 Elastic.Acronyms 'JVM' has no definition.
troubleshoot/elasticsearch/high-cpu-usage.md 114 Elastic.Acronyms 'JVM' has no definition.
troubleshoot/elasticsearch/high-jvm-memory-pressure.md 21 Elastic.Acronyms 'JVM' has no definition.
troubleshoot/elasticsearch/task-queue-backlog.md 153 Elastic.WordChoice Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI.

Users with an [Elastic subscription](https://www.elastic.co/pricing) can [request Elastic's assistance]](/troubleshoot.md#contact-us) reviewing this output. When doing so, kindly ensure:

* Grant written permission for Elastic to review your uploaded heap dumps within the support case.
* Share only after receiving any necessary business approvals as this file might contain private information. Files are handled according to [Elastic's privacy statement](https://www.elastic.co/legal/privacy-statement).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Share only after receiving any necessary business approvals as this file might contain private information. Files are handled according to [Elastic's privacy statement](https://www.elastic.co/legal/privacy-statement).
* Share this file only after receiving any necessary business approvals as it might contain private information. Files are handled according to [Elastic's privacy statement](https://www.elastic.co/legal/privacy-statement).

* [Inspect hot threads on each node](#diagnose-task-queue-hot-thread)
* [Identify long-running node tasks](#diagnose-task-queue-long-running-node-tasks)
* [Look for long-running cluster tasks](#diagnose-task-queue-long-running-cluster-tasks)
* [Monitor Slow Logs](#diagnose-task-slow-logs)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* [Monitor Slow Logs](#diagnose-task-slow-logs)
* [Monitor slow logs](#diagnose-task-slow-logs)


Tasks with a high `timeInQueue` value are likely contributing to the backlog and might need to be [canceled](#resolve-task-queue-backlog-stuck-tasks).

### Monitor Slow Logs [diagnose-task-slow-logs]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Monitor Slow Logs [diagnose-task-slow-logs]
### Monitor slow logs [diagnose-task-slow-logs]


### Monitor Slow Logs [diagnose-task-slow-logs]

If you're not present during incident to investigate backlogged tasks, you might consider enabling [Slow Logs](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) to review later.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you're not present during incident to investigate backlogged tasks, you might consider enabling [Slow Logs](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) to review later.
If you're not present during an incident to investigate backlogged tasks, you might consider enabling [slow logs](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) to review later.

Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🦘

@stefnestor this is superb! Very, very nice work. The organization here is so much better than what we had before. I added lots of comments but they're all just minor phrasing things.


"allocated_processors in CAT nodes isn't available till v9.3.0 per elastic/elasticsearch#134692, (how) do we mark that?"

This suggestion (below) will add an "applies_to" tag to mark 9.3 GA.

@kilfoyle kilfoyle self-requested a review January 7, 2026 13:35
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! πŸ¦–
Thanks Stef!!! What a nice improvement for our docs.

@stefnestor
Copy link
Contributor Author

Cheers, @kilfoyle! Thanks for your help on this!

The very top part of CPU-vs-Java-vs-threads needs an ES Dev sign-off. I will request in Slack but please LMK if your team has a Github way of directing this to them πŸ™

@kilfoyle
Copy link
Contributor

kilfoyle commented Jan 7, 2026

The very top part of CPU-vs-Java-vs-threads needs an ES Dev sign-off. I will request in Slack but please LMK if your team has a Github way of directing this to them πŸ™

Sounds good! There are several elastic/es-* groups that we can tag in the reviewers part of the PR, but unfortunately I have no idea which of those teams is the right one to review. So I think Slack is the best bet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants