-
Notifications
You must be signed in to change notification settings - Fork 7
/
alerting_notifications.py
345 lines (280 loc) · 11.6 KB
/
alerting_notifications.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
import json
import logging
from .model import APIModel, APIEndpoints, RequestsMethods
from .api import Api
class AlertingNotifications:
"""The class includes all necessary methods to access the Grafana alerting notifications API endpoints
Args:
grafana_api_model (APIModel): Inject a Grafana API model object that includes all necessary values and information
Attributes:
grafana_api_model (APIModel): This is where we store the grafana_api_model
"""
def __init__(self, grafana_api_model: APIModel):
self.grafana_api_model = grafana_api_model
def get_all_notification_channels(self) -> list:
"""The method includes a functionality to get all alerting notification channels
Raises:
Exception: Unspecified error by executing the API call
Returns:
api_call (list): Returns all notification channels
"""
api_call: list = (
Api(self.grafana_api_model)
.call_the_api(
APIEndpoints.ALERT_NOTIFICATIONS.value,
RequestsMethods.GET,
)
.json()
)
if api_call == list() or api_call[0].get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
def get_all_notification_channels_lookup(self) -> list:
"""The method includes a functionality to lookup and get reduced information of all alerting notification channels
Raises:
Exception: Unspecified error by executing the API call
Returns:
api_call (list): Returns all notification channels as reduced information
"""
api_call: list = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.ALERT_NOTIFICATIONS.value}/lookup",
RequestsMethods.GET,
)
.json()
)
if api_call == list() or api_call[0].get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
def get_notification_channel_by_uid(self, uid: str) -> dict:
"""The method includes a functionality to get an alerting notification channel specified by the uid
Args:
uid (str): Specify the uid of the notification channel
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (dict): Returns the specified notification channel
"""
if len(uid) != 0:
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.ALERT_NOTIFICATIONS.value}/uid/{uid}",
RequestsMethods.GET,
)
.json()
)
if api_call == dict() or api_call.get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
else:
logging.error("There is no uid defined.")
raise ValueError
def get_notification_channel_by_id(self, id: int) -> dict:
"""The method includes a functionality to get an alerting notification channel specified by the id
Args:
id (int): Specify the id of the notification channel
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (dict): Returns the specified notification channel
"""
if id != 0:
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.ALERT_NOTIFICATIONS.value}/{id}",
RequestsMethods.GET,
)
.json()
)
if api_call == dict() or api_call.get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
else:
logging.error("There is no uid defined.")
raise ValueError
def create_notification_channel(self, notification_channel: dict) -> dict:
"""The method includes a functionality to create an alerting notification channel specified by the notification channel dict
Args:
notification_channel (dict): Specify the channel of the notification
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (dict): Returns the newly created notification channel
"""
if notification_channel != dict():
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
APIEndpoints.ALERT_NOTIFICATIONS.value,
RequestsMethods.POST,
json.dumps(notification_channel),
)
.json()
)
if api_call == dict() or api_call.get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
else:
logging.error("There is no notification_channel defined.")
raise ValueError
def update_notification_channel_by_uid(
self, uid: str, notification_channel: dict
) -> dict:
"""The method includes a functionality to update an alerting notification channel specified by the notification channel dict and the uid
Args:
uid (str): Specify the uid of the notification channel
notification_channel (dict): Specify the channel of the notification
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (dict): Returns the updated notification channel
"""
if len(uid) != 0 and notification_channel != dict():
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.ALERT_NOTIFICATIONS.value}/uid/{uid}",
RequestsMethods.PUT,
json.dumps(notification_channel),
)
.json()
)
if api_call == dict() or api_call.get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
else:
logging.error("There is no uid or notification_channel defined.")
raise ValueError
def update_notification_channel_by_id(
self, id: int, notification_channel: dict
) -> dict:
"""The method includes a functionality to update an alerting notification channel specified by the notification channel dict and the id
Args:
id (int): Specify the id of the notification channel
notification_channel (dict): Specify the channel of the notification
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (dict): Returns the updated notification channel
"""
if id != 0 and notification_channel != dict():
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.ALERT_NOTIFICATIONS.value}/{id}",
RequestsMethods.PUT,
json.dumps(notification_channel),
)
.json()
)
if api_call == dict() or api_call.get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
else:
logging.error("There is no id or notification_channel defined.")
raise ValueError
def delete_notification_channel_by_uid(self, uid: str):
"""The method includes a functionality to delete an alerting notification channel specified by the uid
Args:
uid (uid): Specify the uid of the notification channel
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if len(uid) != 0:
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.ALERT_NOTIFICATIONS.value}/uid/{uid}",
RequestsMethods.DELETE,
)
.json()
)
if api_call.get("message") != "Notification deleted":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully destroyed the notification channel.")
else:
logging.error("There is no uid defined.")
raise ValueError
def delete_notification_channel_by_id(self, id: int):
"""The method includes a functionality to delete an alerting notification channel specified by the id
Args:
id (int): Specify the id of the notification channel
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if id != 0:
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.ALERT_NOTIFICATIONS.value}/{id}",
RequestsMethods.DELETE,
)
.json()
)
if api_call.get("message") != "Notification deleted":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully destroyed the notification channel.")
else:
logging.error("There is no id defined.")
raise ValueError
def test_notification_channel(self, notification_channel: dict):
"""The method includes a functionality to test an alerting notification channel specified by the notification_channel
Args:
notification_channel (dict): Specify the channel of the notification
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if notification_channel != dict():
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.ALERT_NOTIFICATIONS.value}/test",
RequestsMethods.POST,
json.dumps(notification_channel),
)
.json()
)
print(api_call)
if api_call.get("message") != "Test notification sent":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully tested the notification channel.")
else:
logging.error("There is no notification_channel defined.")
raise ValueError