Alerting: Correctly escape provisioning API exports (#99039)
When exporting contact-points, mute-timings, and notification policies in the provisioning API, we need to escape the `$` character which is used in interpolation by file provisioning. Follow up to #97985
This commit is contained in:
Moustafa Baiou
@@ -0,0 +1,21 @@
|
||||
# config file version
|
||||
apiVersion: 1
|
||||
|
||||
# List of contact points to import or update
|
||||
contactPoints:
|
||||
# <int> organization ID, default = 1
|
||||
- orgId: 1
|
||||
# <string, required> name of the contact point
|
||||
name: cp_1_$$escaped
|
||||
|
||||
receivers:
|
||||
# <string, required> unique identifier for the receiver. Should not exceed 40 symbols. Only letters, numbers, - (hyphen), and _ (underscore) allowed.
|
||||
- uid: first_uid
|
||||
# <string, required> type of the receiver
|
||||
type: prometheus-alertmanager
|
||||
# <bool, optional> Disable the additional [Incident Resolved] follow-up alert, default = false
|
||||
disableResolveMessage: false
|
||||
# <object, required> settings for the specific receiver type
|
||||
settings:
|
||||
url: http://test:9000
|
||||
something: $$escaped
|
||||
@@ -0,0 +1,159 @@
|
||||
# config file version
|
||||
apiVersion: 1
|
||||
|
||||
contactPoints:
|
||||
# <int> organization ID, default = 1
|
||||
- orgId: 1
|
||||
# <string, required> name of the contact point
|
||||
name: $$xyz
|
||||
|
||||
receivers:
|
||||
# <string, required> unique identifier for the receiver. Should not exceed 40 symbols. Only letters, numbers, - (hyphen), and _ (underscore) allowed.
|
||||
- uid: first_uid
|
||||
# <string, required> type of the receiver
|
||||
type: prometheus-alertmanager
|
||||
# <bool, optional> Disable the additional [Incident Resolved] follow-up alert, default = false
|
||||
disableResolveMessage: false
|
||||
# <object, required> settings for the specific receiver type
|
||||
settings:
|
||||
url: http://test:9000
|
||||
something: $$escaped
|
||||
|
||||
muteTimes:
|
||||
# <int> organization ID, default = 1
|
||||
- orgId: 1
|
||||
# <string, required> name of the mute time interval, must be unique
|
||||
name: $mute_time_1
|
||||
# <list> time intervals that should trigger the muting
|
||||
# refer to https://prometheus.io/docs/alerting/latest/configuration/#time_interval-0
|
||||
time_intervals:
|
||||
- times:
|
||||
- start_time: "06:00"
|
||||
end_time: "23:59"
|
||||
location: "UTC"
|
||||
weekdays: ["monday:wednesday", "saturday", "sunday"]
|
||||
months: ["1:3", "may:august", "december"]
|
||||
years: ["2020:2022", "2030"]
|
||||
days_of_month: ["1:5", "-3:-1"]
|
||||
- orgId: 1
|
||||
# <string, required> name of the mute time interval, must be unique
|
||||
name: $mute_time_2
|
||||
# <list> time intervals that should trigger the muting
|
||||
# refer to https://prometheus.io/docs/alerting/latest/configuration/#time_interval-0
|
||||
time_intervals:
|
||||
- times:
|
||||
- start_time: "09:00"
|
||||
end_time: "10:00"
|
||||
location: "UTC"
|
||||
weekdays: ["monday:wednesday", "saturday", "sunday"]
|
||||
months: ["1:3", "may:august", "december"]
|
||||
years: ["2020:2022", "2030"]
|
||||
days_of_month: ["1:5", "-3:-1"]
|
||||
|
||||
# ONLY THESE PATHS ARE NOT TEMPLATED and therefore don't need escaping:
|
||||
# Alert rule annotations: groups[].rules[].annotations
|
||||
# Alert rule time range: groups[].rules[].relativeTimeRange
|
||||
# Alert rule query model: groups[].rules[].data.model
|
||||
groups:
|
||||
# <int> organization ID, default = 1
|
||||
- orgId: 1
|
||||
# <string, required> name of the rule group
|
||||
name: my_rule_group
|
||||
# <string, required> name of the folder the rule group will be stored in
|
||||
folder: my_first_folder_with_$$escaped_symbols
|
||||
# <duration, required> interval that the rule group should evaluated at
|
||||
interval: 60s
|
||||
# <list, required> list of rules that are part of the rule group
|
||||
rules:
|
||||
# <string, required> unique identifier for the rule. Should not exceed 40 symbols. Only letters, numbers, - (hyphen), and _ (underscore) allowed.
|
||||
- uid: my_id_1
|
||||
# <string, required> title of the rule that will be displayed in the UI
|
||||
title: my_first_rule_with_$$escaped_symbols
|
||||
# <string, required> which query should be used for the condition
|
||||
condition: A
|
||||
# <list, required> list of query objects that should be executed on each
|
||||
# evaluation - should be obtained through the API
|
||||
data:
|
||||
- refId: A
|
||||
datasourceUid: "__expr__"
|
||||
model:
|
||||
conditions:
|
||||
- evaluator:
|
||||
params:
|
||||
- 3
|
||||
type: gt
|
||||
operator:
|
||||
type: and
|
||||
query:
|
||||
params:
|
||||
- A
|
||||
reducer:
|
||||
type: last
|
||||
type: query
|
||||
datasource:
|
||||
type: __expr__
|
||||
uid: "__expr__"
|
||||
expression: 1==0
|
||||
intervalMs: 1000
|
||||
maxDataPoints: 43200
|
||||
refId: A
|
||||
type: math
|
||||
# <string> UID of a dashboard that the alert rule should be linked to
|
||||
dashboardUid: my_dashboard
|
||||
# <int> ID of the panel that the alert rule should be linked to
|
||||
panelId: 123
|
||||
# <string> the state the alert rule will have when no data is returned
|
||||
# possible values: "NoData", "Alerting", "OK", default = NoData
|
||||
noDataState: Alerting
|
||||
# <string> the state the alert rule will have when the query execution
|
||||
# failed - possible values: "Error", "Alerting", "OK"
|
||||
# default = Alerting
|
||||
execErrState: Alerting
|
||||
# <duration, required> for how long should the alert fire before alerting
|
||||
for: 60s
|
||||
# <map<string, string>> a map of strings to pass around any data
|
||||
annotations:
|
||||
some_key: some_value
|
||||
$no_escaping_needed: $no_escaping_needed
|
||||
# <map<string, string> a map of strings that can be used to filter and
|
||||
# route alerts
|
||||
labels:
|
||||
team: sre_team_1
|
||||
label_keys_not_$escaped: $$escaped_value
|
||||
something: "escaped in the middle of things $$value"
|
||||
templated: "{{ $$labels.team }}"
|
||||
middle: "u$$ing_escaped_symbols"
|
||||
notification_settings:
|
||||
receiver: $$xyz
|
||||
group_by:
|
||||
- label_keys_not_$$escaped
|
||||
- something
|
||||
group_wait: 5m
|
||||
group_interval: 10m
|
||||
repeat_interval: 10m
|
||||
mute_time_intervals:
|
||||
- $mute_time_1
|
||||
- $mute_time_2
|
||||
|
||||
policies:
|
||||
# <int> organization ID, default = 1
|
||||
- orgId: 1
|
||||
# <string> name of the contact point that should be used for this route
|
||||
receiver: $$xyz
|
||||
group_by:
|
||||
- label_keys_not_$$escaped
|
||||
# <list> a list of prometheus-like matchers that an alert rule has to fulfill to match the node (allowed chars
|
||||
# [a-zA-Z_:])
|
||||
matchers:
|
||||
- alertname = Watchdog
|
||||
- service_id_X = serviceX
|
||||
- severity =~ "warning|critical"
|
||||
# <list> a list of grafana-like matchers that an alert rule has to fulfill to match the node
|
||||
object_matchers:
|
||||
- ["alertname", "=", "CPUUsage"]
|
||||
- ["service_id-X", "=", "serviceX"]
|
||||
- ["severity", "=~", "warning|critical"]
|
||||
group_wait: 30s
|
||||
group_interval: 5m
|
||||
repeat_interval: 4h
|
||||
routes: []
|
||||
@@ -0,0 +1,20 @@
|
||||
# config file version
|
||||
apiVersion: 1
|
||||
|
||||
# ONLY THESE PATHS ARE NOT TEMPLATED and therefore don't need escaping:
|
||||
# Mute timings name: muteTimes[].name
|
||||
# Mute timings time intervals: muteTimes[].time_intervals[]
|
||||
muteTimes:
|
||||
- orgId: 1
|
||||
name: $mute_time_a
|
||||
# <list> time intervals that should trigger the muting
|
||||
# refer to https://prometheus.io/docs/alerting/latest/configuration/#time_interval-0
|
||||
time_intervals:
|
||||
- times:
|
||||
- start_time: "06:00"
|
||||
end_time: "23:59"
|
||||
location: "UTC"
|
||||
weekdays: ["monday:wednesday", "saturday", "sunday"]
|
||||
months: ["1:3", "may:august", "december"]
|
||||
years: ["2020:2022", "2030"]
|
||||
days_of_month: ["1:5", "-3:-1"]
|
||||
Reference in New Issue
Block a user