-
Notifications
You must be signed in to change notification settings - Fork 7
/
legacy_alerting.py
183 lines (148 loc) · 5.73 KB
/
legacy_alerting.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
import json
import logging
from .model import APIModel, APIEndpoints, RequestsMethods
from .api import Api
class Alerting:
"""The class includes all necessary methods to access the Grafana legacy alerting 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_alerts(
self,
custom_querystring: str = None,
) -> list:
"""The method includes a functionality to get the legacy alerts
Args:
custom_querystring (str): Specify the custom querystring (default None)
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (list): Returns a list of all alerts
"""
api_string: str = ""
if custom_querystring is not None and len(custom_querystring) != 0:
api_string = f"{APIEndpoints.LEGACY_ALERTS.value}/{custom_querystring}"
elif custom_querystring is None:
api_string = APIEndpoints.LEGACY_ALERTS.value
if len(api_string) != 0:
api_call: list = (
Api(self.grafana_api_model)
.call_the_api(
api_string,
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
else:
logging.error(
"Please, check the functionality. An unexpected error occurred."
)
raise ValueError
def get_alerts_by_dashboard_ids(
self,
dashboard_ids: list,
) -> list:
"""The method includes a functionality to get legacy alerts specified by the dashboard ids
Args:
dashboard_ids (list): Specify the list of dashboard ids
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (list): Returns a list of alerts
"""
if dashboard_ids != list():
dashboard_ids_string: str = "?"
for i in range(0, len(dashboard_ids)):
dashboard_ids_string = (
f"{dashboard_ids_string}dashboardId={dashboard_ids[i]}"
)
if i < len(dashboard_ids) - 1:
dashboard_ids_string = f"{dashboard_ids_string}&"
api_call: list = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.LEGACY_ALERTS.value}/{dashboard_ids_string}",
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
else:
logging.error("There is no dashboard_ids defined.")
raise ValueError
def get_alert_by_id(self, id: int) -> dict:
"""The method includes a functionality to get the legacy alert specified by the alert id
Args:
id (int): Specify the id of the legacy alert
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (dict): Returns an alert
"""
if id != 0:
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.LEGACY_ALERTS.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 id defined.")
raise ValueError
def pause_alert_by_id(self, id: int, paused: bool = True):
"""The method includes a functionality to pause/ unpause a legacy alert specified by the alert id
Args:
id (int): Specify the id of the legacy alert
paused (bool): Specify the pause/ unpause parameter (default True)
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if id != 0:
json_complete: dict = {
"paused": paused,
}
api_call: dict = (
Api(self.grafana_api_model)
.call_the_api(
f"{APIEndpoints.LEGACY_ALERTS.value}/{id}/pause",
RequestsMethods.POST,
json.dumps(json_complete),
)
.json()
)
if api_call.get(
"message"
) != "alert paused" or "alert unpause" in api_call.get("message"):
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info(api_call.get("message"))
else:
logging.error("There is no id defined.")
raise ValueError