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

(Doc+) Flush out Slow Logs #118518

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

(Doc+) Flush out Slow Logs #118518

wants to merge 7 commits into from
+180 −102

Conversation

stefnestor
Copy link
Contributor

👋 howdy, team!

Our Slow Log docs are brief on their purpose during troubleshooting. This PR

  • shifts-up content related to both searching+indexing slow logs into a header global area, e.g. where/how edit+access, view current overrides, include triggering user info
  • adds on an indexing example event
  • adds in a how-to use in troubleshooting section, e.g. default starting commands & if circuit breaking need audit logging per this

TIA! 🙏

@stefnestor stefnestor added >enhancement >docs General docs changes Team:Docs Meta label for docs team Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. labels Dec 11, 2024
@stefnestor stefnestor requested a review from a team December 11, 2024 23:55
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine added the external-contributor Pull request authored by a developer outside the Elasticsearch team label Dec 11, 2024
@stefnestor stefnestor added auto-backport Automatically create backport pull requests when merged v8.17.0 labels Dec 12, 2024
shainaraskas
shainaraskas approved these changes Dec 23, 2024
View reviewed changes
Copy link
Contributor

@shainaraskas shainaraskas left a comment •
edited
Loading

Choose a reason for hiding this comment

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

👋 🎄 thanks for this! the overview is super helpful as is the general reshape of the doc. I broke it up a little further and did a language pass. if you're happy with the changes you can go ahead and ship :)

@stefnestor
Copy link
Contributor Author

⏳ tests are erring for "best practices" console blobs, had been because of missing commas in the JSON but now because

[[_all]] org.elasticsearch.index.IndexNotFoundException: no such index [[_all]]

which 🤷‍♀️ on how to fix since _all should wildcard to all indices in the ES cluster. So seeing what // NOTCONSOLE does since that's in other places to ignore tests. But TBF I expect I'll need help getting these consoles to pass, sorry, @shainaraskas 🙏

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

Assignees
No one assigned
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes >enhancement external-contributor Pull request authored by a developer outside the Elasticsearch team Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. Team:Docs Meta label for docs team v8.17.0 v8.18.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stefnestor @elasticsearchmachine @shainaraskas