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

[DOCS] Updated Kibana alerting/rules language #101977

Merged
merged 5 commits into from
Jun 17, 2021

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 10, 2021

Summary

This PR updates Kibana alert docs to remove an out-dated and unnecessary screenshot.

@lcawl lcawl added Team:Monitoring Stack Monitoring team v8.0.0 v7.14.0 labels Jun 10, 2021
@lcawl lcawl marked this pull request as ready for review June 14, 2021 19:38
@lcawl lcawl requested a review from a team June 14, 2021 19:38
@elasticmachine
Copy link
Contributor

Pinging @elastic/stack-monitoring (Team:Monitoring)

@lcawl
Copy link
Contributor Author

lcawl commented Jun 14, 2021

@elasticmachine merge upstream

@lcawl lcawl added release_note:enhancement release_note:skip Skip the PR/issue when compiling release notes and removed release_note:enhancement labels Jun 14, 2021
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
monitoring 730.9KB 730.9KB -4.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@lcawl lcawl requested a review from ravikesarwani June 15, 2021 15:01
@neptunian
Copy link
Contributor

neptunian commented Jun 15, 2021

Thanks! I think what you are changing should actually stay as "alerts" since the dropdown is listing alerts. In "setup mode" we display the rules we would need to toggle between "rules" and alerts" instead of just having "alerts" everywhere.

Should be "rules" (setup mode)
Screen Shot 2021-06-15 at 10 55 41 AM

Should stay "alerts" (not in setup mode)
Screen Shot 2021-06-15 at 11 08 05 AM

Part of the change is here https://github.com/elastic/kibana/blob/master/x-pack/plugins/monitoring/public/alerts/badge.tsx#L21, but would require usage of the variable inSetupMode to show "rules" vs "alerts".

@ravikesarwani do you agree?

Could have someone on the team do it if you prefer.

@ravikesarwani
Copy link
Contributor

I agree @neptunian . In "fired/active" state we need to refer to it as Alert.
In setup mode we need to change it to say Rules.

@lcawl lcawl added the docs label Jun 17, 2021
@lcawl
Copy link
Contributor Author

lcawl commented Jun 17, 2021

Thanks for the feedback @ravikesarwani and @neptunian !
I've updated this PR so that it contains only the documentation changes and have had a go at the code changes you suggested in
#102441

@ravikesarwani
Copy link
Contributor

Thank you so much @lcawl. I reviewed the help available here Kibana alert docs. One piece that has caused confusion to the users is around how to review and modify threshold etc. on the default rules that we have created.
Can you please add the following line to make this clear in the help =>
To review and modify all the available default rules, use Enter setup mode on the Cluster overview page in Stack monitoring.

This can be added potentially as a Note after "However, you can tailor them to meet your specific needs." so that it's highlighted. Thoughts?

@lcawl
Copy link
Contributor Author

lcawl commented Jun 17, 2021

@ravikesarwani Yes, that's the piece of info that was accidentally omitted from the previous PR. You can see it now in the preview here: https://kibana_101977.docs-preview.app.elstc.co/guide/en/kibana/master/kibana-alerts.html

@lcawl lcawl merged commit e3454ea into elastic:master Jun 17, 2021
@lcawl lcawl deleted the monitoring-rules branch June 17, 2021 18:14
@lcawl lcawl added the v7.13.3 label Jun 17, 2021
@lcawl lcawl changed the title [Monitoring] Updated Kibana alerting/rules language [DOCS] Updated Kibana alerting/rules language Jun 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs release_note:skip Skip the PR/issue when compiling release notes Team:Monitoring Stack Monitoring team v7.13.3 v7.14.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants