openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

RHDEVDOCS-3423-managing-user-defined-alerting-rules

Open bburt-rh opened this issue 3 years ago • 7 comments

Summary: This PR documents the TP feature for modifying and creating user-defined alerting rules based on core platform metrics in OCP monitoring

  • Aligned team: DevTools
  • For branches: 4.11+
  • Jira: https://issues.redhat.com/browse/RHDEVDOCS-3423
  • Direct link to doc preview (requires RH VPN access): http://file.rdu.redhat.com/bburt/RHDEVDOCS-3423-managing-user-defined-alerting-rules/monitoring/managing-alerts.html#managing-core-platform-alerting-rules_managing-alerts
  • SME review: @jan--f
  • QE review: @juzhao
  • Peer review: @rolfedh

bburt-rh avatar Aug 03 '22 21:08 bburt-rh

@simonpasquier @juzhao - Can you PTAL and provide review feedback? Thanks!

bburt-rh avatar Aug 05 '22 20:08 bburt-rh

I think the following 3 sections are needless, it is basic operation for oc, no need to so specific Listing user-defined alerting rules Listing user-modified default alerting rules Removing user-defined alerting rules

juzhao avatar Aug 08 '22 06:08 juzhao

I think the following 3 sections are needless, it is basic operation for oc, no need to so specific Listing user-defined alerting rules Listing user-modified default alerting rules Removing user-defined alerting rules

Thanks, @juzhao. @simonpasquier, what do you think? It's OK with me to remove these 3 sections if everyone agrees they're not needed.

bburt-rh avatar Aug 08 '22 13:08 bburt-rh

@juzhao PTAL at the changes I made in response to your feedback and lmk if further changes are required. Thank you!

bburt-rh avatar Aug 08 '22 20:08 bburt-rh

@jan--f Can you please provide feedback on this PR and approve if no changes are needed? Thanks!

bburt-rh avatar Aug 11 '22 21:08 bburt-rh

I think we should be more careful about naming here. modules/monitoring-creating-user-defined-alerting-rules.adoc describes how an admin user can create a new alerting rule. While this is technically a user-defined alert, we use user-defined as a term regularly for user workload monitoring (e.g. https://docs.openshift.com/container-platform/4.10/monitoring/enabling-monitoring-for-user-defined-projects.html). I think using user-defined here might give the wrong impression, since this feature is limited to admin users. However non-admin users can create user-workload monitoring instances. I think we can avoid too much confusion by trying to limit the use of user-defined where possible.Tthis only needs minor changes in the file mentioned above and in modules/monitoring-managing-core-platform-alerting-rules.adoc I think.

This is my only concern and certainly no requirement for merging this. Otherwise this looks great!

I agree that this phrasing could be confusing, and I've made your suggested changes throughout this PR.

bburt-rh avatar Aug 15 '22 19:08 bburt-rh

Apologies,one last change request. I was a bit confused about modifying alerts via AlertRelabelConfig. Looked it up and proposed some changes based on what I found. Hope this makes sense to everyone.

@jan--f - I revised this based on your suggestions. PTAL. Thanks!

bburt-rh avatar Aug 16 '22 16:08 bburt-rh

/lgtm

juzhao avatar Aug 18 '22 03:08 juzhao

/cherrypick enterprise-4.11

bburt-rh avatar Aug 18 '22 12:08 bburt-rh

/cherrypick enterprise-4.12

bburt-rh avatar Aug 18 '22 12:08 bburt-rh

@bburt-rh: new pull request created: #49298

In response to this:

/cherrypick enterprise-4.11

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@bburt-rh: new pull request created: #49299

In response to this:

/cherrypick enterprise-4.12

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.