@cryptotaxi247 / netdata-1 / commits / 920563d65

Alarms collector add alarm values (#10675)

* add alarm values option add an option to alarms collector to also chart calculated alarm values over time. * update README * give alarm values chart "..._value" named dims so as not to clash * try simplify update_charts() * small cleanup * fix update_charts() for values * spelling * add `self.collected_dims` to maintain list of dims in the 'alarms' and 'values' charts * lower case family names to be consistent * "collect_" is better naming than "show_" * "collect_" is better naming than "show_" * small typo in README * Update collectors/python.d.plugin/alarms/alarms.chart.py Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> * add ability to define alarm status chart type via config, default to line. * 'status' is a better family name than 'alarms' Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> * use 'value' instead of 'values' for naming Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> * remove 'variables' as not needed Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>

Andrew Maguire committed Mar 8, 2021 at 21:24 UTC 920563d65802a5552049a9f11aa018c0ce3242a9
3 files changed +34 -15
collectors/python.d.plugin/alarms/README.md
+2
@@ -51,6 +51,8 @@ local:
51 CLEAR: 0
52 WARNING: 1
53 CRITICAL: 2
54 + # set to true to include a chart with calculated alarm values over time
55 + collect_alarm_values: false
56 ```
57
58 It will default to pulling all alarms at each time step from the Netdata rest api at `http://127.0.0.1:19999/api/v1/alarms?all`
collectors/python.d.plugin/alarms/alarms.chart.py
+28 -15
@@ -11,36 +11,44 @@ update_every = 10
11 disabled_by_default = True
12
13
14 -def charts_template(sm):
14 +def charts_template(sm, alarm_status_chart_type='line'):
15 order = [
16 'alarms',
17 + 'values'
18 ]
19
20 mappings = ', '.join(['{0}={1}'.format(k, v) for k, v in sm.items()])
21 charts = {
22 'alarms': {
22 - 'options': [None, 'Alarms ({0})'.format(mappings), 'status', 'alarms', 'alarms.status', 'line'],
23 + 'options': [None, 'Alarms ({0})'.format(mappings), 'status', 'status', 'alarms.status', alarm_status_chart_type],
24 'lines': [],
25 'variables': [
26 ['alarms_num'],
27 ]
28 + },
29 + 'values': {
30 + 'options': [None, 'Alarm Values', 'value', 'value', 'alarms.value', 'line'],
31 + 'lines': [],
32 }
33 }
34 return order, charts
35
36
37 DEFAULT_STATUS_MAP = {'CLEAR': 0, 'WARNING': 1, 'CRITICAL': 2}
33 -
38 DEFAULT_URL = 'http://127.0.0.1:19999/api/v1/alarms?all'
39 +DEFAULT_COLLECT_ALARM_VALUES = False
40 +DEFAULT_ALARM_STATUS_CHART_TYPE = 'line'
41
42
43 class Service(UrlService):
44 def __init__(self, configuration=None, name=None):
45 UrlService.__init__(self, configuration=configuration, name=name)
46 self.sm = self.configuration.get('status_map', DEFAULT_STATUS_MAP)
41 - self.order, self.definitions = charts_template(self.sm)
47 + self.alarm_status_chart_type = self.configuration.get('alarm_status_chart_type', DEFAULT_ALARM_STATUS_CHART_TYPE)
48 + self.order, self.definitions = charts_template(self.sm, self.alarm_status_chart_type)
49 self.url = self.configuration.get('url', DEFAULT_URL)
43 - self.collected_alarms = set()
50 + self.collect_alarm_values = bool(self.configuration.get('collect_alarm_values', DEFAULT_COLLECT_ALARM_VALUES))
51 + self.collected_dims = {'alarms': set(), 'values': set()}
52
53 def _get_data(self):
54 raw_data = self._get_raw_data()
@@ -51,21 +59,26 @@ class Service(UrlService):
59 alarms = raw_data.get('alarms', {})
60
61 data = {a: self.sm[alarms[a]['status']] for a in alarms if alarms[a]['status'] in self.sm}
54 - self.update_charts(alarms, data)
62 + self.update_charts('alarms', data)
63 data['alarms_num'] = len(data)
64
65 + if self.collect_alarm_values:
66 + data_values = {'{}_value'.format(a): alarms[a]['value'] * 100 for a in alarms if 'value' in alarms[a] and alarms[a]['value'] is not None}
67 + self.update_charts('values', data_values, divisor=100)
68 + data.update(data_values)
69 +
70 return data
71
59 - def update_charts(self, alarms, data):
72 + def update_charts(self, chart, data, algorithm='absolute', multiplier=1, divisor=1):
73 if not self.charts:
74 return
75
63 - for a in data:
64 - if a not in self.collected_alarms:
65 - self.collected_alarms.add(a)
66 - self.charts['alarms'].add_dimension([a, a, 'absolute', '1', '1'])
76 + for dim in data:
77 + if dim not in self.collected_dims[chart]:
78 + self.collected_dims[chart].add(dim)
79 + self.charts[chart].add_dimension([dim, dim, algorithm, multiplier, divisor])
80
68 - for a in list(self.collected_alarms):
69 - if a not in alarms:
70 - self.collected_alarms.remove(a)
71 - self.charts['alarms'].del_dimension(a, hide=False)
81 + for dim in list(self.collected_dims[chart]):
82 + if dim not in data:
83 + self.collected_dims[chart].remove(dim)
84 + self.charts[chart].del_dimension(dim, hide=False)
collectors/python.d.plugin/alarms/alarms.conf
+4
@@ -48,3 +48,7 @@ local:
48 CLEAR: 0
49 WARNING: 1
50 CRITICAL: 2
51 + # set to true to include a chart with calculated alarm values over time
52 + collect_alarm_values: false
53 + # define the type of chart for plotting status over time e.g. 'line' or 'stacked'
54 + alarm_status_chart_type: 'line'