Revize 0b96f10c

re #9360 Added logging system -> log config, logging messages

client/config.ini

@@ -8 +8 @@
 end_point = /api/v1/usb-logs
 
 [logger]
+file = logger.conf
 format = %(asctime)s %(levelname)s : %(message)s
 level = INFO
 

client/config_manager.py

@@ -18 +18 @@
 server_port = config[server_section]["port"]
 server_endpoint = config[server_section]["end_point"]
 
+logger_config = config[logger_section]["file"]
 logger_format = config[logger_section]["format"]
 logger_level_str = config[logger_section]["level"]
 logger_level = 0

client/logger.conf

@@ +1 @@
+[loggers]
+keys=root
+
+[handlers]
+keys=consoleHandler,logFileHandler
+
+[formatters]
+keys=simpleFormatter
+
+[logger_root]
+level=DEBUG
+handlers=consoleHandler
+
+[handler_consoleHandler]
+class=StreamHandler
+level=DEBUG
+formatter=simpleFormatter
+args=(sys.stdout,)
+
+[handler_logFileHandler]
+class=handlers.RotatingFileHandler
+level=NOTSET
+args=('app_info.log','a',10000,1)
+formatter=simpleFormatter
+
+[formatter_simpleFormatter]
+format=%(asctime)s - %(levelname)s - %(message)s

client/main.py

@@ -1 +1 @@
 import logging
+import logging.config
+from os.path import exists
 from threading import Thread
 from tendo import singleton
 
-from config_manager import logger_format, logger_level
+from config_manager import logger_format, logger_level, logger_config
 from usb_detector.detector import register_listener, usb_detector_run
 from usb_detector.event_listener import usb_connected_callback, usb_disconnected_callback
 from api_client import api_client_run
 
+def init_logging():
+    if exists(logger_config):
+        logging.config.fileConfig(fname=logger_config)
+    else:
+        print(f"Cant find logger configuration \"{logger_config}\"! Please specify valid path or define new.")
+        exit(1)
+
 
 if __name__ == "__main__":
     app_instance = singleton.SingleInstance()
-
-    logging.basicConfig(format=logger_format, level=logger_level)
+    init_logging()
 
     register_listener(callback=usb_connected_callback, connected=True)
     register_listener(callback=usb_disconnected_callback, connected=False)
@@ -22 +30 @@
     api_thread = Thread(target=api_client_run)
     api_thread.setDaemon(True)
 
+    logging.info('starting USB detector.')
     usb_detector_thread.start()
+
+    logging.info('starting API communication manager.')
     api_thread.start()
 
     usb_detector_thread.join()
     api_thread.join()
+
+    logging.info('application exit.')

client/usb_detector/detector.py

@@ -11 +11 @@
 
 
 def register_listener(callback, connected: bool = True):
+    logging.info(f'Registering callback: {callback}.')
+
     if connected is True:
         _listeners_connected.append(callback)
     else:
@@ -24 +26 @@
 
 
 def _store_connected_devices(devices: list):
+    logging.debug('storing newly connected devices')
     with open(connected_devices_filename, "w") as file:
         json.dump(devices, file)
 
 
 def _load_last_connected_devices() -> list:
+    logging.debug('loading last connected devices')
     try:
         with open(connected_devices_filename, "r") as file:
             return json.loads(file.read())
     except IOError:
+        logging.error('loading of last connected devices failed')
         return []
 
 

client/usb_detector/event_listener.py

@@ -7 +7 @@
 
 
 def _get_metadata() -> dict:
+    logging.debug('getting computer metadata')
     return {
         "username": getpass.getuser(),
         "hostname": platform.uname().node,
@@ -15 +16 @@
 
 
 def _send_payload_to_server(device: dict, status: str):
+    logging.debug('payload send preparation')
     payload = _get_metadata()
     payload["device"] = device
     payload["status"] = status

client/usb_detector/usb_reader.py

@@ +1 @@
+import logging
+
 import usb.core
 import usb.util
 
 
 def read_connected_devices():
+    logging.debug(f'reading all currently connected devices')
     detected_devices = []
 
     busses = usb.busses()
@@ -16 +19 @@
                 serial_number = usb.util.get_string(device_info, device_info.iSerialNumber)
             except:
                 # Failed to retrieve information from device
+                logging.info(f"device idVendor:{dev.idVendor} idProduct:{dev.idProduct} has invalid format")
                 pass
 
             if serial_number is not None: