Merge pull request 'dev to main' (#8) from dev into main

Reviewed-on: #8

README.md

@@ -181,6 +181,10 @@ From version 2.0 the Application supports internal metrics to collect time. See
 - `result_path` - path to result value in response JSON separated by `app_config.RESPONSE_PATH_SEPARATOR` character. Could be configured in [Application config](#AppConfig).
 - `timeout` - timeout to wait for response
 
+#### REST value Binary Metrics
+**_Gets the responses value from http request to REST service_**
+THe same as [REST value Metrics] but works with 'ON/OFF' and 'TRUE/FALSE' values
+
 #### Shell value Metrics
 **_Gets the shell command executed result value_**
 ```json
@@ -203,13 +207,12 @@ From version 2.0 there are following metric names used
 - `das_rest_value` - Remote REST API Value; Labels **name, url, method, server**
 - `das_shell_value` - Shell Value; Labels: **name, command, server**
 - `das_host_available` - Host availability; Labels **name, ip, server**
-- `das_net_interface_bytes` - Network Interface bytes; Labels: **name, server, metric**=(sent|receive)
+- `das_net_interface_bytes` - Network Interface bytes; Labels: **name, server, metric=(sent|receive)**
 - `das_exporter` - Exporter Uptime for **server** in seconds
 - `das_uptime_seconds` - System uptime on **server**
 - `das_cpu_percent` - CPU used percent on **server**
 - `das_memory_percent` - Memory used percent on **server**
-- `das_ChassisTemperature_current` - Current Chassis Temperature overall on **server** 
+- `das_temperature` - Temperature overall; Labels **server**, **metric=(CPU|Chassis)**;
-- `das_CpuTemperature_current` - Current CPU Temperature overall on **server**
 **Note:** there are no doubles in metrics names supported by Prometheus. If so the exception occurs ant the application will be stopped.
 
 ### 🚀 Launching the application

app_config.py

@@ -1,6 +1,6 @@
 import os
 
-APP_VERSION="2.0"
+APP_VERSION="2.4"
 SCRIPT_PATH = os.path.dirname(__file__)
 CONFIGS_DIR = SCRIPT_PATH + "/configs"
 CONFIG_FILE_NAME = CONFIGS_DIR + "/config.json"

main.py

@@ -44,12 +44,13 @@ def parse_config(cfg):
 
 def init_metric_entities(data):
     return {
-        M.DiskMetric(data, app_config.INSTANCE_PREFIX),
+        M.DiskMetric(data),
-        M.HealthMetric(data, app_config.INSTANCE_PREFIX),
+        M.HealthMetric(data),
-        M.IcmpMetric(data, app_config.INSTANCE_PREFIX),
+        M.IcmpMetric(data),
-        M.InterfaceMetric(data, app_config.INSTANCE_PREFIX),
+        M.InterfaceMetric(data),
-        M.RestValueMetric(data, app_config.INSTANCE_PREFIX),
+        M.RestValueMetric(data),
-        M.ShellValueMetric(data, app_config.INSTANCE_PREFIX),
+        M.RestValueBMetric(data),
+        M.ShellValueMetric(data),
         M.UptimeMetric(app_config.UPTIME_UPDATE_SECONDS),
         M.SystemMetric(app_config.SYSTEM_UPDATE_SECONDS)
     }

metrics/DataStructures.py

@@ -122,13 +122,16 @@ class HealthData(AbstractData):
         self.e_state.labels(name=name, url=url, method=method, server=self.instance_prefix)
         self.set_data(is_up)
 
-    def set_data(self, is_up):
+    def set_data(self, is_up, working_time = None):
         time_ms = get_time_millis()
         self.is_up = is_up
         self.e_state.labels(name=self.name, url=self.url, method=self.method, server=self.instance_prefix).state(ENUM_UP_DN_STATES[0] if is_up else ENUM_UP_DN_STATES[1])
-        self.set_collect_time(get_time_millis() - time_ms)
         self.set_update_time()
         self.print_trigger_info()
+        if working_time:
+            self.set_collect_time(working_time)
+        else:
+            self.set_collect_time(get_time_millis() - time_ms)
 
 
 class RestValueData(AbstractData):
@@ -153,7 +156,7 @@ class RestValueData(AbstractData):
         self.g_value.labels(name=name, url=url, method=method, server=self.instance_prefix)
         self.set_data(value)
 
-    def set_data(self, value):
+    def set_data(self, value, working_time = None):
         time_ms = get_time_millis()
         self.value = value
         try:
@@ -161,9 +164,50 @@ class RestValueData(AbstractData):
         except:
             self.g_value.labels(name=self.name, url=self.url, method=self.method, server=self.instance_prefix).set(0)
 
-        self.set_collect_time(get_time_millis() - time_ms)
         self.set_update_time()
         self.print_trigger_info()
+        if working_time:
+            self.set_collect_time(working_time)
+        else:
+            self.set_collect_time(get_time_millis() - time_ms)
+
+
+class RestValueBData(AbstractData):
+    g_value: Gauge
+    def __init__(self, name, url, interval, timeout, value=None, method='GET', user=None, password=None, headers=None, prefix='',
+                 result_type='single', result_path=''):
+        super().__init__(name, interval, prefix)
+        if headers is None:
+            headers = {}
+        self.url = url
+        self.timeout = timeout
+        self.method = method.upper()
+        self.user = user
+        self.password = password
+        self.headers = headers
+        self.value = value
+        self.type = result_type
+        self.path = result_path
+        self.g_value = get_gauge_metric('das_rest_value_b',
+                                        'Remote REST API [name, url, method, server] Binary Value',
+                                        ['name', 'url', 'method', 'server'])
+        self.g_value.labels(name=name, url=url, method=method, server=self.instance_prefix)
+        self.set_data(value)
+
+    def set_data(self, value, working_time = None):
+        time_ms = get_time_millis()
+        self.value = value
+        try:
+            self.g_value.labels(name=self.name, url=self.url, method=self.method, server=self.instance_prefix).set(1 if str(value).upper() in ['ON', 'TRUE'] else 0)
+        except:
+            self.g_value.labels(name=self.name, url=self.url, method=self.method, server=self.instance_prefix).set(-1)
+
+        self.set_update_time()
+        self.print_trigger_info()
+        if working_time:
+            self.set_collect_time(working_time)
+        else:
+            self.set_collect_time(get_time_millis() - time_ms)
 
 
 class ShellValueData(AbstractData):
@@ -181,7 +225,7 @@ class ShellValueData(AbstractData):
         self.g_value.labels(name=name, command=command, server=self.instance_prefix)
         self.set_data(value)
 
-    def set_data(self, value):
+    def set_data(self, value, working_time = None):
         time_ms = get_time_millis()
         self.value = value
         try:
@@ -189,9 +233,12 @@ class ShellValueData(AbstractData):
         except:
             self.g_value.labels(name=self.name, command=self.command, server=self.instance_prefix).set(0)
 
-        self.set_collect_time(get_time_millis() - time_ms)
         self.set_update_time()
         self.print_trigger_info()
+        if working_time:
+            self.set_collect_time(working_time)
+        else:
+            self.set_collect_time(get_time_millis() - time_ms)
 
 
 class IcmpData(AbstractData):
@@ -207,13 +254,16 @@ class IcmpData(AbstractData):
         self.e_state.labels(name=name, ip=ip, server=self.instance_prefix)
         self.set_data(is_up)
 
-    def set_data(self, is_up):
+    def set_data(self, is_up, working_time = None):
         time_ms = get_time_millis()
         self.is_up = is_up
         self.e_state.labels(name=self.name, ip=self.ip, server=self.instance_prefix).state(ENUM_UP_DN_STATES[0] if is_up else ENUM_UP_DN_STATES[1])
-        self.set_collect_time(get_time_millis() - time_ms)
         self.set_update_time()
         self.print_trigger_info()
+        if working_time:
+            self.set_collect_time(working_time)
+        else:
+            self.set_collect_time(get_time_millis() - time_ms)
 
 
 class InterfaceData(AbstractData):
@@ -249,7 +299,7 @@ class UptimeData(AbstractData):
     def __init__(self, interval, prefix=''):
         super().__init__('uptime', interval, prefix)
         self.uptime = 0
-        self.c_uptime = get_counter_metric('das_exporter',
+        self.c_uptime = get_counter_metric('das_exporter_uptime',
                                            'Exporter Uptime for [server] in seconds',
                                            ['server'])
         self.c_uptime.labels(server=self.instance_prefix)
@@ -270,7 +320,7 @@ class SystemData(AbstractData):
     c_uptime: Counter
     g_cpu: Gauge
     g_memory: Gauge
-    g_chassis_temp: Gauge
+    g_tempr: Gauge
     g_cpu_temp: Gauge
     def __init__(self, interval, prefix=''):
         super().__init__('system', interval, prefix)
@@ -285,10 +335,9 @@ class SystemData(AbstractData):
         self.g_cpu.labels(server=self.instance_prefix)
         self.g_memory = get_gauge_metric('das_memory_percent', 'Memory used percent on [server]', ['server'])
         self.g_memory.labels(server=self.instance_prefix)
-        self.g_chassis_temp = get_gauge_metric('das_ChassisTemperature_current', 'Current Chassis Temperature overall on [server]', ['server'])
+        self.g_tempr = get_gauge_metric('das_temperature', 'Temperature of [type] overall on [server]', ['metric', 'server'])
-        self.g_chassis_temp.labels(server=self.instance_prefix)
+        self.g_tempr.labels(server=self.instance_prefix, metric='CPU')
-        self.g_cpu_temp = get_gauge_metric('das_CpuTemperature_current', 'Current CPU Temperature overall on [server]', ['server'])
+        self.g_tempr.labels(server=self.instance_prefix, metric='Chassis')
-        self.g_cpu_temp.labels(server=self.instance_prefix)
 
     def set_data(self):
         time_ms = get_time_millis()
@@ -320,13 +369,13 @@ class SystemData(AbstractData):
             else:
                 self.ch_temp = self.cpu_temp
 
-            self.g_chassis_temp.labels(server=self.instance_prefix).set(self.ch_temp)
+            self.g_tempr.labels(server=self.instance_prefix, metric='Chassis').set(self.ch_temp)
-            self.g_cpu_temp.labels(server=self.instance_prefix).set(self.cpu_temp)
+            self.g_tempr.labels(server=self.instance_prefix, metric='CPU').set(self.cpu_temp)
         except:
             self.ch_temp = -500
             self.cpu_temp = -500
-            self.g_chassis_temp.labels(server=self.instance_prefix).set(self.ch_temp)
+            self.g_tempr.labels(server=self.instance_prefix, metric='Chassis').set(self.ch_temp)
-            self.g_cpu_temp.labels(server=self.instance_prefix).set(self.cpu_temp)
+            self.g_tempr.labels(server=self.instance_prefix, metric='CPU').set(self.cpu_temp)
 
         self.set_collect_time(get_time_millis() - time_ms)
         self.set_update_time()

metrics/MetricClasses.py

@@ -12,14 +12,16 @@ import app_config
 
 from threading import Thread
 from metrics.DataStructures import DiskData, HealthData, IcmpData, ENUM_UP_DN_STATES, InterfaceData, UptimeData, \
-    SystemData, RestValueData, ShellValueData
+    SystemData, RestValueData, ShellValueData, RestValueBData
 
 
 class AbstractMetric:
     metric_key = ""
     config = {}
+    prefix = ""
     def __init__(self, key, config):
         self.metric_key = key
+        self.prefix = app_config.INSTANCE_PREFIX
         if key and key in config:
             self.config = config[key]
         self.data_array = []
@@ -34,6 +36,7 @@ class AbstractMetric:
 
 
 def is_health_check(url, timeout, method, user, pwd, headers, callback=None):
+    time_ms = get_time_millis()
     session = requests.Session()
     if user and pwd:
         session.auth = (user, pwd)
@@ -46,13 +49,15 @@ def is_health_check(url, timeout, method, user, pwd, headers, callback=None):
         )
         result = response.status_code == 200
         if callback is not None:
-            callback(result)
+            working_time = get_time_millis() - time_ms
+            callback(result, working_time)
         else:
             return result
     except (requests.ConnectTimeout, requests.exceptions.ConnectionError) as e:
         return False
 
 def get_rest_value(url, timeout, method, user, pwd, headers, callback=None, result_type='single', path=''):
+    time_ms = get_time_millis()
     session = requests.Session()
     if user and pwd:
         session.auth = (user, pwd)
@@ -65,10 +70,11 @@ def get_rest_value(url, timeout, method, user, pwd, headers, callback=None, resu
         )
         resp = json.loads(response.content.decode().replace("'", '"'))
         result = parse_response(resp, path)
-        if not result.isalnum():
+        if not str(result).isalnum():
             result = 0
         if callback is not None:
-            callback(result)
+            working_time = get_time_millis() - time_ms
+            callback(result, working_time)
         else:
             return result
     except (requests.ConnectTimeout, requests.exceptions.ConnectionError) as e:
@@ -96,6 +102,7 @@ def parse_response(resp, path):
             return ''
 
 def get_shell_value(command, args, callback=None):
+    time_ms = get_time_millis()
     cmd = [command, ' '.join(str(s) for s in args)]
     try:
         output = subprocess.check_output(cmd)
@@ -107,11 +114,13 @@ def get_shell_value(command, args, callback=None):
         result = 0
 
     if callback is not None:
-        callback(result)
+        working_time = get_time_millis() - time_ms
+        callback(result, working_time)
     else:
         return result
 
 def is_ping(ip, count, callback=None):
+    time_ms = get_time_millis()
     param = '-n' if platform.system().lower() == 'windows' else '-c'
     command = ['ping', param, str(count), ip]
     try:
@@ -121,8 +130,10 @@ def is_ping(ip, count, callback=None):
                   'time out'.upper() not in str(output).upper())
     except:
         result = False
+
     if callback is not None:
-        callback(result)
+        working_time = get_time_millis() - time_ms
+        callback(result, working_time)
     else:
         return result
 
@@ -132,14 +143,16 @@ def get_net_iface_stat(name):
 def get_next_update_time(d):
     return time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(d.updated_at + d.interval))
 
+def get_time_millis():
+    return round(time.time() * 1000)
 
 class DiskMetric(AbstractMetric):
-    def __init__(self, config, prefix=''):
+    def __init__(self, config):
         super().__init__('disk', config)
         for d in self.config:
             mount_point, interval, name = d['path'], d['interval'], d['name']
             total, used, free = shutil.disk_usage(mount_point)
-            self.data_array.append(DiskData(mount_point, total, used, free, interval, name, prefix))
+            self.data_array.append(DiskData(mount_point, total, used, free, interval, name, self.prefix))
 
     def proceed_metric(self):
         for d in self.data_array:
@@ -154,7 +167,7 @@ class DiskMetric(AbstractMetric):
 
 
 class HealthMetric(AbstractMetric):
-    def __init__(self, config, prefix=''):
+    def __init__(self, config):
         super().__init__('health', config)
         for d in self.config:
             name, url, interval, timeout, method = d['name'], d['url'], d['interval'], d['timeout'], d['method']
@@ -169,7 +182,7 @@ class HealthMetric(AbstractMetric):
             else:
                 headers = ''
             result = is_health_check(url, timeout, method, user, pwd, headers)
-            self.data_array.append(HealthData(name, url, interval, timeout, result, method, user, pwd, headers, prefix))
+            self.data_array.append(HealthData(name, url, interval, timeout, result, method, user, pwd, headers, self.prefix))
 
     def proceed_metric(self):
         for d in self.data_array:
@@ -183,12 +196,12 @@ class HealthMetric(AbstractMetric):
 
 
 class IcmpMetric(AbstractMetric):
-    def __init__(self, config, prefix=''):
+    def __init__(self, config):
         super().__init__('ping', config)
         for d in self.config:
             name, ip, count, interval = d['name'], d['ip'], d['count'], d['interval']
             result = is_ping(ip, count)
-            self.data_array.append(IcmpData(name, ip, count, interval, result, prefix))
+            self.data_array.append(IcmpData(name, ip, count, interval, result, self.prefix))
 
     def proceed_metric(self):
         for d in self.data_array:
@@ -202,12 +215,12 @@ class IcmpMetric(AbstractMetric):
 
 
 class InterfaceMetric(AbstractMetric):
-    def __init__(self, config, prefix=''):
+    def __init__(self, config):
         super().__init__('iface', config)
         for d in self.config:
             name, iface, interval = d['name'], d['iface'], d['interval']
             result = get_net_iface_stat(iface)
-            self.data_array.append(InterfaceData(name, iface, interval, result.bytes_sent, result.bytes_recv, prefix))
+            self.data_array.append(InterfaceData(name, iface, interval, result.bytes_sent, result.bytes_recv, self.prefix))
 
     def proceed_metric(self):
         for d in self.data_array:
@@ -221,7 +234,7 @@ class InterfaceMetric(AbstractMetric):
 
 
 class RestValueMetric(AbstractMetric):
-    def __init__(self, config, prefix=''):
+    def __init__(self, config):
         super().__init__('rest_value', config)
         for d in self.config:
             name, url, interval, timeout, method = d['name'], d['url'], d['interval'], d['timeout'], d['method']
@@ -238,7 +251,39 @@ class RestValueMetric(AbstractMetric):
             result_type, result_path = d['result_type'], d['result_path']
             result = get_rest_value(url=url, timeout=timeout, method=method, user=user, pwd=pwd, headers=headers,
                                     result_type=result_type, path=result_path)
-            self.data_array.append(RestValueData(name, url, interval, timeout, result, method, user, pwd, headers, prefix, result_type, result_path))
+            self.data_array.append(RestValueData(name, url, interval, timeout, result, method, user, pwd, headers, self.prefix, result_type, result_path))
+
+    def proceed_metric(self):
+        for d in self.data_array:
+            if d.is_need_to_update():
+                thread = Thread(target=get_rest_value, args=(d.url, d.timeout, d.method, d.user, d.password, d.headers,
+                                                             d.set_data, d.type, d.path))
+                thread.start()
+
+    def print_debug_info(self):
+        for d in self.data_array:
+            print(f'[DEBUG] (next update at {get_next_update_time(d)}) on {d.url}: by {d.method} in {d.path} got value="{d.value}"')
+
+
+class RestValueBMetric(AbstractMetric):
+    def __init__(self, config):
+        super().__init__('rest_value_b', config)
+        for d in self.config:
+            name, url, interval, timeout, method = d['name'], d['url'], d['interval'], d['timeout'], d['method']
+            if 'auth' in self.config:
+                user = d['auth']['user']
+                pwd = d['auth']['pass']
+            else:
+                user = ''
+                pwd = ''
+            if 'headers' in self.config:
+                headers = d['headers']
+            else:
+                headers = ''
+            result_type, result_path = d['result_type'], d['result_path']
+            result = get_rest_value(url=url, timeout=timeout, method=method, user=user, pwd=pwd, headers=headers,
+                                    result_type=result_type, path=result_path)
+            self.data_array.append(RestValueBData(name, url, interval, timeout, result, method, user, pwd, headers, self.prefix, result_type, result_path))
 
     def proceed_metric(self):
         for d in self.data_array:
@@ -253,12 +298,12 @@ class RestValueMetric(AbstractMetric):
 
 
 class ShellValueMetric(AbstractMetric):
-    def __init__(self, config, prefix=''):
+    def __init__(self, config):
         super().__init__('shell_value', config)
         for d in self.config:
             name, command, interval, args = d['name'], d['command'], d['interval'], d['args']
             result = get_shell_value(command, args)
-            self.data_array.append(ShellValueData(name, interval, command, result, args, prefix))
+            self.data_array.append(ShellValueData(name, interval, command, result, args, self.prefix))
 
     def proceed_metric(self):
         for d in self.data_array:
@@ -274,7 +319,7 @@ class ShellValueMetric(AbstractMetric):
 class UptimeMetric(AbstractMetric):
     def __init__(self, interval):
         super().__init__(None, {})
-        self.data_array.append(UptimeData(interval))
+        self.data_array.append(UptimeData(interval, self.prefix))
 
     def proceed_metric(self):
         for d in self.data_array:
@@ -289,7 +334,7 @@ class UptimeMetric(AbstractMetric):
 class SystemMetric(AbstractMetric):
     def __init__(self, interval):
         super().__init__(None, {})
-        self.data_array.append(SystemData(interval, app_config.INSTANCE_PREFIX))
+        self.data_array.append(SystemData(interval, self.prefix))
 
     def proceed_metric(self):
         for d in self.data_array: