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+) Flush out Resource+Task troubleshooting #111773

Merged
merged 9 commits into from
Sep 12, 2024
Merged

(Docs+) Flush out Resource+Task troubleshooting #111773

merged 9 commits into from
Sep 12, 2024

Conversation

stefnestor
Copy link
Contributor

@stefnestor stefnestor commented Aug 10, 2024 •
edited
Loading

👋🏽 howdy, team!

This is a first stab to try to import more Support learnings from internal/unofficial resources for how-to problem box outages. Flow follows my USE Method for Elasticsearch for why these conglomeration of files fit together (but also are frequently cross-linked already as well).

This primarily expands

  • cpu pages to account for ESS-specific caveats and existing troubleshooting pages. Also recommends monitoring across the board.
  • ingest rejections mentions 3 major components but then only discusses one, links to a second, and skips how to resolve the third. This adds sections for each with preliminary APIs to poll before splitting-out into existing structure. Cross-pollination from my Elasticsearch Ingest Rejections. Also ports over many of the most common discovery/searched error strings for each of the 3.

This secondarily contains edits for

  • user's ESS API Console is not resilient to not including =true in API commands (internal ref) so these commands don't fully work as intended for them in current state
  • a common FAQ Support has to share during high severities is which API's responses are instantaneous, cumulative from cluster/index creation, and/or node uptime.
  • basics on interpreting List Node Tasks, simplified cross-pollination from here

@stefnestor stefnestor added >enhancement >docs General docs changes Team:Docs Meta label for docs team labels Aug 10, 2024
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine added v8.16.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Aug 10, 2024
@shainaraskas shainaraskas self-requested a review August 12, 2024 19:27
DaveCTurner
DaveCTurner requested changes Aug 12, 2024
View reviewed changes
Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

I'd rather we stuck to saying ?human&pretty&detailed rather than adding unnecessary =true suffices everywhere. Also there seems to be some confusion between the tasks and the pending tasks APIs.

docs/reference/esql/task-management.asciidoc Outdated Show resolved Hide resolved
docs/reference/transform/troubleshooting.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/task-queue-backlog.asciidoc Outdated Show resolved Hide resolved
shainaraskas
shainaraskas reviewed Aug 13, 2024
View reviewed changes
Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

love reviewing your PRs because I learn so much!

I've added my feedback as comments here, mostly because I am worried that I made some of your content incorrect during my edits. please give me feedback on how I can streamline this process for you :)

docs/reference/tab-widgets/cpu-usage.asciidoc Outdated Show resolved Hide resolved
docs/reference/tab-widgets/cpu-usage.asciidoc Outdated Show resolved Hide resolved
docs/reference/tab-widgets/cpu-usage.asciidoc Outdated Show resolved Hide resolved
docs/reference/tab-widgets/cpu-usage.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/high-cpu-usage.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/task-queue-backlog.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/task-queue-backlog.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/task-queue-backlog.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/task-queue-backlog.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/task-queue-backlog.asciidoc Outdated Show resolved Hide resolved
stefnestor and others added 2 commits August 16, 2024 15:07
@stefnestor @shainaraskas
feedback
7fe92b4 
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
@stefnestor
feedback
02befb3
shainaraskas
shainaraskas previously approved these changes Aug 19, 2024
View reviewed changes
Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

approved with one more comment to check.

@shainaraskas
Copy link
Contributor

one of the rest examples is failing ... quite a few were edited so I'm trying to track down the problem

@shainaraskas shainaraskas dismissed their stale review August 19, 2024 15:58

failing test

stefnestor and others added 2 commits August 20, 2024 08:36
@stefnestor
feedback
5925b61
@stefnestor @shainaraskas
feedback
9fd490b 
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
@stefnestor
Copy link
Contributor Author

Thanks, @shainaraskas ! @DaveCTurner this is ready for you again 🙏

@stefnestor
Copy link
Contributor Author

stefnestor commented Sep 4, 2024 •
edited
Loading

Bump @DaveCTurner 🙏 (oh, looks like he'll be back Sep09; good to wait I assume).

@stefnestor
Copy link
Contributor Author

Welcome back, @DaveCTurner ! Bump when you have a moment 🙏

DaveCTurner
DaveCTurner reviewed Sep 11, 2024
View reviewed changes
Copy link
Contributor

@DaveCTurner DaveCTurner 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 handful of nits about the API parameters, otherwise LGTM

docs/reference/troubleshooting/common-issues/hotspotting.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/rejected-requests.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/task-queue-backlog.asciidoc Outdated Show resolved Hide resolved
docs/reference/troubleshooting/common-issues/task-queue-backlog.asciidoc Outdated Show resolved Hide resolved
@stefnestor @DaveCTurner
feedback
439a0fa 
Co-authored-by: David Turner <david.turner@elastic.co>
@stefnestor
Copy link
Contributor Author

Thanks, @DaveCTurner! Requests applied, ready for your approval.

DaveCTurner
DaveCTurner approved these changes Sep 12, 2024
View reviewed changes
Copy link
Contributor

@DaveCTurner DaveCTurner 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 stefnestor merged commit 76ed892 into elastic:main Sep 12, 2024
4 checks passed
@stefnestor stefnestor mentioned this pull request Sep 12, 2024
Merged
stefnestor added a commit to stefnestor/elasticsearch that referenced this pull request Sep 12, 2024
@stefnestor @shainaraskas @DaveCTurner
(Docs+) Flush out Resource+Task troubleshooting (elastic#111773)
42bd3ea 
* (Docs+) Flush out Resource+Task troubleshooting

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: David Turner <david.turner@elastic.co>
@stefnestor stefnestor mentioned this pull request Sep 12, 2024
Merged
stefnestor added a commit to stefnestor/elasticsearch that referenced this pull request Sep 12, 2024
@stefnestor @shainaraskas @DaveCTurner
(Docs+) Flush out Resource+Task troubleshooting (elastic#111773)
59b985a 
* (Docs+) Flush out Resource+Task troubleshooting

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: David Turner <david.turner@elastic.co>
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
✅ 8.15
✅ 8.x

elasticsearchmachine pushed a commit that referenced this pull request Sep 12, 2024
@stefnestor @shainaraskas @DaveCTurner
(Docs+) Flush out Resource+Task troubleshooting (#111773) (#112818)
d039c28 
* (Docs+) Flush out Resource+Task troubleshooting

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: David Turner <david.turner@elastic.co>
elasticsearchmachine pushed a commit that referenced this pull request Sep 12, 2024
@stefnestor @shainaraskas @DaveCTurner
(Docs+) Flush out Resource+Task troubleshooting (#111773) (#112817)
c88cfb9 
* (Docs+) Flush out Resource+Task troubleshooting

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: David Turner <david.turner@elastic.co>
@stefnestor stefnestor mentioned this pull request Sep 12, 2024
Open
@stefnestor stefnestor deleted the stef_useMethod branch November 15, 2024 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shainaraskas shainaraskas shainaraskas approved these changes

@DaveCTurner DaveCTurner DaveCTurner approved these changes

Assignees
No one assigned
Labels
>docs General docs changes >enhancement external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v8.15.0 v8.16.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@stefnestor @elasticsearchmachine @shainaraskas @DaveCTurner @mark-vieira