manifests/0000_90_kube-controller-manager-operator_05_alerts: Template console links in alert descriptions #837
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: wking The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
…e console links in alert descriptions Prometheus alerts support Go templating [1], and this commit uses that to provide more context like "which namespace?", "which PodDisruptionBudget?", "where can I find that PDB in the in-cluster web console?", and "what 'oc' command would I run to see garbage-collection sync logs?". This should make understanding the context of the alert more straightforward, with the responder having to dip into labels and guess. Using |- for trimmed, block style strings avoids YAML parsers choking on the "for more details: ..." colon with "mapping values are not allowed in this context" and similar. [1]: https://prometheus.io/docs/prometheus/latest/configuration/template_reference/
wking
force-pushed
the
template-alert-descriptions
branch
from
4a9d9e4 to
daae216
Compare
| @@ -25,7 +25,8 @@ spec: | |||
| - alert: PodDisruptionBudgetAtLimit | |||
| annotations: | |||
| summary: The pod disruption budget is preventing further disruption to pods. | |||
| description: The pod disruption budget is at the minimum disruptions allowed level. The number of current healthy pods is equal to the desired healthy pods. | |||
| description: |- | |||
| The {{ $labels.poddisruptionbudget }} pod disruption budget in the {{ $labels.namespace}} namespace is at the maximum allowed disruption. The number of current healthy pods is equal to the desired healthy pods.{{ with $console_url := "console_url" | query }}{{ if ne (len (label "url" (first $console_url))) 0}} For more information refer to {{ label "url" (first $console_url) }}/k8s/ns/{{ $labels.namespace }}/poddisruptionbudgets/{{ $labels.poddisruptionbudget }}{{ end }}{{ end }} | |||
There was a problem hiding this comment.
Hmm, not sure what to do with the unit failure:
: TestYamlCorrectness expand_less 0s
{=== RUN TestYamlCorrectness
assets_test.go:2 ... === RUN TestYamlCorrectness
assets_test.go:2 ...}
the test-case's stdout includes:
=== RUN TestYamlCorrectness
assets_test.go:20: Unexpected error reading manifests from ../../manifests/: failed to render "0000_90_kube-controller-manager-operator_05_alerts.yaml": template: 0000_90_kube-controller-manager-operator_05_alerts.yaml:29: undefined variable "$labels"
I guess the that's this assets.New call through assetFromTemplate through renderFile to this template.New. I'm not clear on why this operator feels like these manifests should be Go templates. Maybe we can pivot to using ManifestsFromFiles.
|
@wking: The following tests failed, say
Full PR test history. Your PR dashboard. 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-sigs/prow repository. I understand the commands that are listed here. |
Prometheus alerts support Go templating, and this pull uses that to provide more context like "which namespace?", "which PodDisruptionBudget?", "where can I find that PDB in the in-cluster web console?", and "what
occommand would I run to see garbage-collection sync logs?". This should make understanding the context of the alert more straightforward, with the responder having to dip into labels and guess.