Merge pull request 'feature/ISEPOS-2280-mechanizm-raportowania-informacji-z-aplikacji-do-pliku-z-logami' (#1) from feature/ISEPOS-2280-mechanizm-raportowania-informacji-z-aplikacji-do-pliku-z-logami into main

Reviewed-on: #1

matlab/logging/base_logger.m

@@ -10,9 +10,6 @@
 % It follows the Singleton pattern to ensure that only one instance of the logger
 % exists throughout the application.
 %
-% The log file is specified by the environment variable 'APP_LOG_FILE'. If
-% the variable is not set, a default file 'base-logger-log.log' is used.
-%
 % Properties:
 %   fid - (private) The file identifier for the log file. This is used to write logs.
 %
@@ -20,20 +17,20 @@
 %
 %   getInstance() - Retrieves the singleton instance of the logger.
 %
-%   trace(varargin) - Logs one or more messages with TRACE level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   trace(message) - Logs a message with TRACE level.
+%     @param message The message to log.
 %
-%   debug(varargin) - Logs one or more messages with DEBUG level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   debug(message) - Logs a message with DEBUG level.
+%     @param message The message to log.
 %
-%   info(varargin) - Logs one or more messages with INFO level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   info(message) - Logs a message with INFO level.
+%     @param message The message to log.
 %
-%   warning(varargin) - Logs one or more messages with WARNING level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   warning(message) - Logs a message with WARNING level.
+%     @param message The message to log.
 %
-%   error(varargin) - Logs one or more messages with ERROR level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   error(message) - Logs a message with ERROR level.
+%     @param message The message to log.
 %
 %   delete() - Destructor method that closes the file identifier when the logger is deleted.
 %
@@ -66,11 +63,7 @@ classdef base_logger < handle
 
     methods(Access=private)
         function this = base_logger()
-            logFileName = getenv("APP_LOG_FILE");
-            if isempty(logFileName)
-                logFileName = 'base-logger-log.log';
-            end
-            this.fid = fopen(logFileName, 'a');
+            this.fid = fopen(getenv("APP_LOG_FILE"), 'a');
             if this.fid == -1
                 error('Failed to open log file');
             end

octave/logging/base_logger.m

@@ -10,9 +10,6 @@
 % It follows the Singleton pattern to ensure that only one instance of the logger
 % exists throughout the application.
 %
-% The log file is specified by the environment variable 'APP_LOG_FILE'. If
-% the variable is not set, a default file 'base-logger-log.log' is used.
-%
 % Properties:
 %   fid - (private) The file identifier for the log file. This is used to write logs.
 %
@@ -20,20 +17,20 @@
 %
 %   getInstance() - Retrieves the singleton instance of the logger.
 %
-%   trace(varargin) - Logs one or more messages with TRACE level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   trace(message) - Logs a message with TRACE level.
+%     @param message The message to log.
 %
-%   debug(varargin) - Logs one or more messages with DEBUG level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   debug(message) - Logs a message with DEBUG level.
+%     @param message The message to log.
 %
-%   info(varargin) - Logs one or more messages with INFO level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   info(message) - Logs a message with INFO level.
+%     @param message The message to log.
 %
-%   warning(varargin) - Logs one or more messages with WARNING level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   warning(message) - Logs a message with WARNING level.
+%     @param message The message to log.
 %
-%   error(varargin) - Logs one or more messages with ERROR level.
-%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
+%   error(message) - Logs a message with ERROR level.
+%     @param message The message to log.
 %
 %   delete() - Destructor method that closes the file identifier when the logger is deleted.
 %
@@ -66,11 +63,7 @@ classdef base_logger < handle
 
     methods
         function this = base_logger()
-            logFileName = getenv("APP_LOG_FILE");
-            if isempty(logFileName)
-                logFileName = 'base-logger-log.log';
-            end
-            this.fid = fopen(logFileName, 'a');
+            this.fid = fopen(getenv("APP_LOG_FILE"), 'a');
             if this.fid == -1
                 error('Failed to open log file');
             end

python/logging/base_logger.py

@@ -11,10 +11,8 @@ def getDefaultLogger(name):
     Retrieves or creates a logger with the specified name and sets it up with a file handler.
     
     The logger is configured to write log messages to the file path specified by the
-    'APP_LOG_FILE' environment variable. If the environment variable is not set,
-    the logger will write to the file 'base-logger-log.log' in the current
-    working directory. The logger uses the 'INFO' level as the default logging level
-    and writes log entries in the following format:
+    'DEFAULT_LOG_PATH' environment variable. It uses the 'INFO' level as the default
+    logging level and writes log entries in the following format:
     
     'YYYY-MM-DD HH:MM:SS,ms LEVEL logger_name message'
     
@@ -32,9 +30,13 @@ def getDefaultLogger(name):
     --------
     logger : logging.Logger
         A logger instance with the specified name. The logger is configured with a 
-        file handler that writes to the file specified by the 'APP_LOG_FILE' 
-        environment variable, or to 'base-logger-log.log' if the environment 
-        variable is not set.
+        file handler that writes to the file specified by the 'DEFAULT_LOG_PATH' 
+        environment variable.
+    
+    Raises:
+    -------
+    KeyError:
+        If the 'DEFAULT_LOG_PATH' environment variable is not set.
     
     Example:
     --------
@@ -45,15 +47,10 @@ def getDefaultLogger(name):
     except Exception:
         logger.exception('An error occurred')
 
-    Notes:
-    ------
-    - The 'APP_LOG_FILE' environment variable should specify the full path to the log file.
-    - If 'APP_LOG_FILE' is not set, logs will be written to 'base-logger-log.log'.
-
     """
     logger = logging.getLogger(name)
     if not logger.hasHandlers():
-        file_handler = logging.FileHandler(os.environ.get('APP_LOG_FILE', 'base-logger-log.log'), mode='a')
+        file_handler = logging.FileHandler(os.environ['APP_LOG_FILE'], mode='a')
         formatter = logging.Formatter('%(asctime)s,%(msecs)d %(levelname)s %(name)s %(message)s')
         file_handler.setFormatter(formatter)
         logger.addHandler(file_handler)