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.

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

Merged
merged 9 commits into from
May 3, 2021

Conversation

ymao1
Copy link
Contributor

@ymao1 ymao1 commented Apr 29, 2021

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

  • Documentation was added for features that require explanation or tutorials

@ymao1 ymao1 self-assigned this Apr 29, 2021
@ymao1 ymao1 added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.14.0 v8.0.0 labels Apr 29, 2021
@ymao1 ymao1 marked this pull request as ready for review April 29, 2021 15:55
@ymao1 ymao1 requested a review from a team as a code owner April 29, 2021 15:55
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@ymao1 ymao1 requested a review from gchaps April 29, 2021 15:59
Copy link
Contributor

@gchaps gchaps left a 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.

docs/user/alerting/alerting-troubleshooting.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/alerting-troubleshooting.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/alerting-troubleshooting.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/alerting-troubleshooting.asciidoc Outdated Show resolved Hide resolved
Copy link
Member

@pmuellr pmuellr left a 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.

@pmuellr
Copy link
Member

pmuellr commented Apr 30, 2021

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.
==============================================
Copy link
Contributor Author

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!

@ymao1
Copy link
Contributor Author

ymao1 commented Apr 30, 2021

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

@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.

@ymao1 ymao1 requested a review from pmuellr April 30, 2021 17:21
Copy link
Member

@pmuellr pmuellr left a 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.

docs/user/alerting/alerting-troubleshooting.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/alerting-troubleshooting.asciidoc Outdated Show resolved Hide resolved
docs/user/alerting/alerting-troubleshooting.asciidoc Outdated Show resolved Hide resolved
@ymao1 ymao1 added the auto-backport Deprecated - use backport:version if exact versions are needed label May 3, 2021
@ymao1 ymao1 merged commit 582c6c7 into elastic:master May 3, 2021
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 3, 2021
…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
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
7.x

This backport PR will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request May 3, 2021
…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]>
@ymao1 ymao1 deleted the alerting/troubleshooting-docs branch May 19, 2021 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.14.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Alerting docs are missing an example to list the top rules that are executing slowly
5 participants