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
|
import json
import re
from pathlib import Path
from typing import Any, Dict, Tuple, Union
from termcolor import cprint
UNITS = ['ms', 's', 'm', 'h', 'd', 'w', 'y']
def resolve_time_and_unit(time: str) -> Union[Tuple[int, str], Tuple[None, None]]:
"""
Divide time with its unit and return a tuple like (10, 'm')
Return None if its and invalid prometheus time
Valid units are inside UNITS.
"""
if time[-1] in UNITS:
return int(time[:-1]), time[-1]
if time[-2:] in UNITS:
return int(time[:-2]), time[-2:]
return None, None
def get_dashboards_data() -> Dict[str, Any]:
data: Dict[str, Any] = {'queries': {}, 'variables': {}, 'stats': {}}
for file in Path(__file__).parent.parent \
.joinpath('dashboards_out').glob('*.json'):
with open(file, 'r') as f:
dashboard_data = json.load(f)
data['stats'][str(file)] = {'total': 0, 'tested': 0}
add_dashboard_queries(data, dashboard_data, str(file))
add_dashboard_variables(data, dashboard_data)
add_default_dashboards_variables(data)
return data
def add_dashboard_queries(data: Dict[str, Any], dashboard_data: Dict[str, Any], path: str) -> None:
"""
Grafana panels can have more than one target/query, in order to identify each
query in the panel we append the "legendFormat" of the target to the panel name.
format: panel_name-legendFormat
"""
if 'panels' not in dashboard_data:
return
error = 0
for panel in dashboard_data['panels']:
if (
'title' in panel
and 'targets' in panel
and len(panel['targets']) > 0
and 'expr' in panel['targets'][0]
):
for target in panel['targets']:
title = panel['title']
legend_format = target['legendFormat'] if 'legendFormat' in target else ""
query_id = f'{title}-{legend_format}'
if query_id in data['queries']:
# NOTE: If two or more panels have the same name and legend it
# might suggest a refactoring is needed or add something else
# to identify each query.
conflict_file = Path(data['queries'][query_id]['path']).name
file = Path(path).name
cprint((f'ERROR: Query in panel "{title}" with legend "{legend_format}"'
f' already exists. Conflict "{conflict_file}" '
f'with: "{file}"'), 'red')
error = 1
data['queries'][query_id] = {'query': target['expr'], 'path': path}
data['stats'][path]['total'] += 1
if error:
raise ValueError('Missing legend_format in queries, please add a proper value.')
def add_dashboard_variables(data: Dict[str, Any], dashboard_data: Dict[str, Any]) -> None:
if 'templating' not in dashboard_data or 'list' not in dashboard_data['templating']:
return
for variable in dashboard_data['templating']['list']:
if 'name' in variable:
data['variables'][variable['name']] = 'UNSET VARIABLE'
def add_default_dashboards_variables(data: Dict[str, Any]) -> None:
data['variables']['job'] = 'ceph'
data['variables']['job_haproxy'] = 'haproxy'
data['variables']['__rate_interval'] = '1m'
def replace_grafana_expr_variables(expr: str, variable: str, value: Any) -> str:
""" Replace grafana variables in expression with a value
It should match the whole word, 'osd' musn't match with the 'osd' prefix in 'osd_hosts'
>>> replace_grafana_expr_variables('metric{name~="$osd_hosts|$other|$osd"}', \
'osd', 'replacement')
'metric{name~="$osd_hosts|$other|replacement"}'
>>> replace_grafana_expr_variables('metric{name~="$osd_hosts|$other|$osd"}', \
'other', 'replacement')
'metric{name~="$osd_hosts|replacement|$osd"}'
It replaces words with dollar prefix
>>> replace_grafana_expr_variables('metric{name~="no_dollar|$other|$osd"}', \
'no_dollar', 'replacement')
'metric{name~="no_dollar|$other|$osd"}'
It shouldn't replace the next char after the variable (positive lookahead test).
>>> replace_grafana_expr_variables('metric{name~="$osd"}', \
'osd', 'replacement')
'metric{name~="replacement"}'
"""
regex = fr'\${variable}(?=\W)'
new_expr = re.sub(regex, fr'{value}', expr)
return new_expr
|
