-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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.
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
[Alerting][Docs] Adding query to identify long running rules to docs #98773
Conversation
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor nits, otherwise LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking awesome! Made a bunch of notes; most important is the security aspect, since most users will not be able to run these queries out of the box.
Would we want to include a link to the event log readme, which documents the fields in the event log? https://github.com/elastic/kibana/blob/master/x-pack/plugins/event_log/README.md I don't think we tend to do this sort of thing in practice, but for a section like this, right now, seems fine. I guess open an issue to get some of the info in that README added to the asciidoc ... |
[IMPORTANT] | ||
============================================== | ||
By default, only user with a `superuser` role can query the {kib} event log because it is a system index. To enable additional users to execute this query, assign `read` privileges to the `.kibana-event-log*` index. | ||
============================================== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gchaps Can you review this addition to the docs? Thank you!
@gchaps Is it ok to link to a README in github from user facing docs? I don't see another example of this so wanted to check. |
…ing/troubleshooting-docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good!
Made a comment about perhaps changing the histogram interval. 10 seconds seems like too long as a bucket size. I hope it is!
Also noted the output has some histogram key values which seem to be nanosecond instead of the new (awesome) runtime field that converts that to seconds.
…lastic#98773) * Adding query to identify long running rules to docs * Wording suggestsion from PR review * Adding event.provider to query. Allowing copy to console * Adding note for system privileges * Adding runtime field to query * Removing extra dollar sign * PR fixes
💚 Backport successful
This backport PR will be merged automatically after passing CI. |
…98773) (#99141) * Adding query to identify long running rules to docs * Wording suggestsion from PR review * Adding event.provider to query. Allowing copy to console * Adding note for system privileges * Adding runtime field to query * Removing extra dollar sign * PR fixes Co-authored-by: ymao1 <[email protected]>
Resolves #98729
Summary
Docs preview: https://kibana_98773.docs-preview.app.elstc.co/guide/en/kibana/master/alerting-troubleshooting.html#rules-long-execution-time
Checklist