improve logging

Author: arch

funscript_editor/algorithms/funscriptgenerator.py

@@ -11,16 +11,19 @@
 from queue import Queue
 from pynput.keyboard import Key, Listener
 from dataclasses import dataclass
-from funscript_editor.data.funscript import Funscript
-from funscript_editor.algorithms.videotracker import StaticVideoTracker
 from PyQt5 import QtGui, QtCore, QtWidgets
 from matplotlib.figure import Figure
-from funscript_editor.utils.config import HYPERPARAMETER, SETTINGS, PROJECTION
 from datetime import datetime
-from funscript_editor.data.ffmpegstream import FFmpegStream, VideoInfo
-from funscript_editor.algorithms.kalmanfilter import KalmanFilter2D
 from scipy.interpolate import interp1d
 
+from funscript_editor.algorithms.kalmanfilter import KalmanFilter2D
+from funscript_editor.algorithms.videotracker import StaticVideoTracker
+from funscript_editor.data.ffmpegstream import FFmpegStream, VideoInfo
+from funscript_editor.data.funscript import Funscript
+from funscript_editor.utils.config import HYPERPARAMETER, SETTINGS, PROJECTION
+from funscript_editor.utils.logging import get_logfiles_paths
+from funscript_editor.definitions import SETTINGS_CONFIG_FILE, HYPERPARAMETER_CONFIG_FILE
+
 import funscript_editor.algorithms.signalprocessing as sp
 import numpy as np
 import matplotlib.pyplot as plt
@@ -997,5 +1000,7 @@ def run(self) -> None:
             self.finished(status, True)
         except Exception as ex:
             self.logger.critical("The program crashed due to a fatal error. " \
-                    + "Please open an issue on github with the corresponding log file and application configuration", exc_info=ex)
+                    + "Please open an issue on github with the corresponding log file (" \
+                    + ','.join(get_logfiles_paths()) + ") and application configuration (" \
+                    + SETTINGS_CONFIG_FILE + ", " + HYPERPARAMETER_CONFIG_FILE + ")", exc_info=ex)
             self.finished("The program crashed due to a fatal error", False)

funscript_editor/utils/logging.py

@@ -21,6 +21,35 @@ def create_log_directories(config: dict) -> None:
             if k == 'filename':
                 os.makedirs(os.path.dirname(os.path.abspath(config[k])), exist_ok=True)
 
+
+def get_log_config_path() -> str:
+    """ Get the log config file path for current platfrom
+
+    Returns:
+        str: the log config file path
+    """
+    return WINDOWS_LOG_CONFIG_FILE if platform.system() == 'Windows' else LINUX_LOG_CONFIG_FILE
+
+
+def get_logfiles_paths() -> list:
+    """ Get the logfiles paths from log config
+
+    Returns:
+        list: all logiles paths
+    """
+    try:
+        result = []
+        config_path = get_log_config_path()
+        with open(config_path, 'rt') as f:
+            for line in f.readlines():
+                if "filename:" in line:
+                    result.append(line.split(':')[1].strip())
+
+        return result
+    except:
+        return []
+
+
 def setup_logging(
         default_level :int = logging.INFO,
         env_key :str = 'LOG_CFG') -> None:
@@ -30,7 +59,7 @@ def setup_logging(
         default_level (int): logging level e.g. `logging.INFO` (default is `logging.DEBUG`).
         env_key (str, optional): env variable name to load a configuration file via environment variable (default is `LOG_CFG`).
     """
-    config_path = WINDOWS_LOG_CONFIG_FILE if platform.system() == 'Windows' else LINUX_LOG_CONFIG_FILE
+    config_path = get_log_config_path()
     value = os.getenv(env_key, None)
     if value: config_path = value
     if os.path.exists(config_path):