-
Notifications
You must be signed in to change notification settings - Fork 0
/
create_status_page.py
323 lines (257 loc) · 10.2 KB
/
create_status_page.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
#!/usr/bin/env python3
import configparser
import logging
import sys
from datetime import datetime, timezone
from typing import Any, Dict, List, Union
from cvmfsscraper import scrape, set_log_level
from jinja2 import Environment, FileSystemLoader
def read_config(file_path: str) -> Dict[str, List[str]]:
"""
Reads configuration from an ini file, sets a valid logging level,
and raises an exception if an invalid logging level is provided.
:param file_path: Path to the configuration file.
:returns: Dictionary with configuration parameters and logging level.
:raises ValueError: If an invalid logging level is provided.
"""
config = configparser.ConfigParser(allow_no_value=True)
config.read(file_path)
CONFIG_SECTIONS_THAT_MUST_HAVE_VALUES = ["stratum0", "stratum1"]
def get_section_keys(section: str) -> List[str]:
if section not in config:
raise ValueError(f"Section {section} not found in configuration file")
return [key for key in config[section]]
# Retrieve and validate logging level
logging_level_str = config.get("config", "logging_level", fallback="INFO").upper()
if logging_level_str not in logging._nameToLevel:
raise ValueError(f"Invalid logging level: {logging_level_str}")
logging_level = logging.getLevelName(logging_level_str)
conf: Dict[str, Union[List[str], int]] = {
"stratum0_servers": get_section_keys("stratum0"),
"stratum1_servers": get_section_keys("stratum1"),
"repos": get_section_keys("repositories"),
"ignore_repos": get_section_keys("ignored_repositories"),
"logging_level": logging_level,
"min_ok_stratum1": config.getint("config", "min_ok_stratum1", fallback=2),
"contact_email": config.get("config", "contact_email", fallback=""),
"title": config.get("config", "title", fallback="EESSI :: Status"),
"repo_url": config.get("config", "repo_url", fallback=""),
"repo_url_text": config.get(
"config", "repo_url_text", fallback="Repository documentation"
),
}
for section in CONFIG_SECTIONS_THAT_MUST_HAVE_VALUES:
if not config[section]:
raise ValueError(f"Section {section} must have at least one value")
return conf
config_path = "config.ini"
try:
config = read_config(config_path)
except ValueError as e:
print(f"Error in configuration: {e}")
sys.exit(1)
set_log_level(config["logging_level"])
env = Environment(loader=FileSystemLoader("templates/"))
template = env.get_template("status.html.j2")
NOW = datetime.now()
ACCEPTED_TIME_SINCE_SNAPSHOT_IN_SECONDS = 60 * 60 * 3 # Three hours.
LEGEND = {
"OK": {
"class": "status-ok fas fa-check",
"text": "Normal service",
"description": "EESSI services operating without issues.",
},
"DEGRADED": {
"class": "status-degraded fas fa-minus-square",
"text": "Degraded",
"description": "EESSI services are operational and may be used as expected, but performance may be affected.",
},
"WARNING": {
"class": "status-warning fas fa-exclamation-triangle",
"text": "Warning",
"description": "EESSI services are operational, but some systems may be unavailable or out of sync.",
},
"FAILED": {
"class": "status-failed fas fa-times-circle",
"text": "Failed",
"description": "EESSI services have failed.",
},
"MAINTENANCE": {
"class": "status-maintenance fas fa-hammer",
"text": "Maintenance",
"description": "EESSI services are unavailable due to scheduled maintenance.",
},
}
def get_class(status: str):
return LEGEND[status]["class"]
def get_text(status: str):
return LEGEND[status]["text"]
def get_desc(status: str):
return LEGEND[status]["description"]
def ok_class():
return get_class("OK")
def degraded_class():
return get_class("DEGRADED")
def warning_class():
return get_class("WARNING")
def failed_class():
return get_class("FAILED")
def maintenance_class():
return get_class("MAINTENANCE")
servers = scrape(
stratum0_servers=config["stratum0_servers"],
stratum1_servers=config["stratum1_servers"],
repos=config["repos"],
ignore_repos=config["ignore_repos"],
)
# Contains events that are bad. 1 is degraded, 2 warning, 3 failure
eessi_not_ok_events = []
stratum1_not_ok_events = []
repositories_not_ok_events = []
stratum1_count = 0
repo_rev_status = {}
repo_snap_status = {}
known_repos = {}
eessi_status = "OK"
eessi_status_class = get_class(eessi_status)
eessi_status_text = get_text(eessi_status)
eessi_status_description = get_desc(eessi_status)
stratum0_repo_versions = {}
stratum0_status_class = ok_class()
stratum0_details = []
stratum1_status_class = ok_class()
stratum1_servers = [
# {
# "name": "bgo-no",
# "update_class": get_class("OK"),
# "geoapi_class": get_class("DEGRADED"),
# },
#
# {
# "name": "rug-nl",
# "update_class": get_class("DEGRADED"),
# "geoapi_class": get_class("FAILED"),
# },
]
repositories_status_class = ok_class()
repositories = [
# {
# "name": "pilot",
# "revision_class": get_class("OK"),
# "snapshot_class": get_class("OK"),
# },
#
# {
# "name": "ci",
# "revision_class": get_class("FAILED"),
# "snapshot_class": get_class("FAILED"),
# },
]
# First get reference data from stratum0
for server in servers:
if server.server_type == 0:
for repo in server.repositories:
stratum0_repo_versions[repo.name] = repo.revision
for server in servers:
if server.server_type == 1:
stratum1_count = stratum1_count + 1
default_class = ok_class()
if server.is_down():
default_class = failed_class()
stratum1_not_ok_events.append(3)
updates = default_class
for repo in stratum0_repo_versions:
repo_rev_status[repo] = failed_class()
repo_snap_status[repo] = failed_class()
known_repos[repo] = 1
for repo in server.repositories:
# Pure initialization, we'll find problems later.
repo_rev_status[repo.name] = default_class
repo_snap_status[repo.name] = default_class
known_repos[repo.name] = 1
if repo.name not in stratum0_repo_versions:
stratum0_name = config["stratum0_servers"][0]
# We did not get a repo from stratum0, this is bad.
repo_rev_status[repo.name] = warning_class()
eessi_status_text = "Stratum0 not responding!"
eessi_status_class = get_class("WARNING")
eessi_status_description = f"Due to stratum0 ({stratum0_name}) not responding, status for repositories and their versions cannot be validated."
continue
if repo.revision != stratum0_repo_versions[repo.name]:
updates = warning_class()
eessi_not_ok_events.append(2)
stratum1_not_ok_events.append(2)
repositories_not_ok_events.append(2)
rs = repo_rev_status[repo.name]
# Escalate, this is ugly, should keep track of all the issues and pick the worst.
if rs == ok_class() or rs == degraded_class() or rs == failed_class():
repo_rev_status[repo.name] = warning_class()
if repo.last_snapshot:
# Calculate the time difference as a timedelta and get the total seconds
time_difference = NOW - repo.last_snapshot
if (
time_difference.total_seconds()
> ACCEPTED_TIME_SINCE_SNAPSHOT_IN_SECONDS
):
rs = repo_snap_status[repo.last_snapshot]
if rs == ok_class():
repo_snap_status[repo.name] = degraded_class()
else:
repo_snap_status[repo.name] = failed_class()
repositories_not_ok_events.append(2)
shortname = server.name.split(".")
geoapi_class = default_class
# 0 ok, 1 wrong answer, 2 failing, 9 unable to test
if server.geoapi_status == 0:
geoapi_class = ok_class()
elif server.geoapi_status == 1:
geoapi_class = degraded_class()
elif server.geoapi_status == 2:
geoapi_class = failed_class()
else:
server.geoapi_status = warning_class()
stratum1_servers.append(
{
"name": shortname[0],
"update_class": updates,
"geoapi_class": geoapi_class,
},
)
for repo in known_repos:
repositories.append(
{
"name": repo,
"revision_class": repo_rev_status[repo],
"snapshot_class": repo_snap_status[repo],
}
)
for repo in stratum0_repo_versions:
stratum0_details.append(repo + " : " + str(stratum0_repo_versions[repo]))
if len(stratum1_not_ok_events) >= stratum1_count:
# More errors than nodes (errors are one per node)
stratum1_status_class = failed_class()
elif len(stratum1_not_ok_events) > stratum1_count - config["min_ok_stratum1"]:
# We have at most two error free nodes
stratum1_status_class = warning_class()
elif stratum1_not_ok_events:
stratum1_status_class = degraded_class()
data: Dict[str, Any] = {
"legend": LEGEND,
"eessi_status_class": eessi_status_class,
"eessi_status_text": eessi_status_text,
"eessi_status_description": eessi_status_description,
"stratum0_status_class": stratum0_status_class,
"stratum0_details": stratum0_details,
"stratum1_status_class": stratum1_status_class,
"stratum1s": stratum1_servers,
"repositories_status_class": repositories_status_class,
"repositories": repositories,
"last_update": datetime.now(tz=timezone.utc).strftime("%Y-%m-%d %H:%M:%S %Z"),
"contact_email": config["contact_email"],
"title": config["title"],
"repo_url": config["repo_url"],
"repo_url_text": config["repo_url_text"],
}
output = template.render(data)
with open("status-generated.html", "w") as fh:
fh.write(output)