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

modify withRunbookURL to allow internal annotation #1139

Merged
merged 3 commits into from
Feb 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions mixin-utils/utils.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -117,12 +117,13 @@ local g = import 'grafana-builder/grafana.libsonnet';
// withRunbookURL - Add/Override the runbook_url annotations for all alerts inside a list of rule groups.
// - url_format: an URL format for the runbook, the alert name will be substituted in the URL.
// - groups: the list of rule groups containing alerts.
withRunbookURL(url_format, groups)::
// - annotation_key: the key to use for the annotation whose value will be the formatted runbook URL.
withRunbookURL(url_format, groups, annotation_key='runbook_url')::
local update_rule(rule) =
if std.objectHas(rule, 'alert')
then rule {
annotations+: {
runbook_url: url_format % rule.alert,
[annotation_key]: url_format % rule.alert,
},
}
else rule;
Expand Down