From 039cfe081e3a5f4d7266cc4dd9e178679cbe347e Mon Sep 17 00:00:00 2001 From: plgmlesniak Date: Mon, 30 Sep 2024 23:46:26 +0200 Subject: [PATCH] ISEPOS-2280 Enchanced and adjusted base loggers --- matlab/logging/base_logger.m | 64 ++++++++++++++++++++++++------------- octave/logging/base_logger.m | 73 +++++++++++++++++++++++++++---------------- python/logging/base_logger.py | 2 +- 3 files changed, 89 insertions(+), 50 deletions(-) diff --git a/matlab/logging/base_logger.m b/matlab/logging/base_logger.m index 75b6e58..1468182 100644 --- a/matlab/logging/base_logger.m +++ b/matlab/logging/base_logger.m @@ -34,10 +34,15 @@ % % delete() - Destructor method that closes the file identifier when the logger is deleted. % -% Example usage: +% Example Usage: % logger = base_logger.getInstance(); -% logger.info('This is an info message'); -% logger.error('This is an error message'); +% logger.info('Some info') +% +% try +% error('Simulated error for stack trace logging'); +% catch err +% logger.error('An error occurred:', err); +% end % % See also: fopen, fclose, dbstack, fprintf @@ -58,48 +63,63 @@ classdef base_logger < handle methods(Access=private) function this = base_logger() - this.fid = fopen(getenv("DEFAULT_LOG_PATH"), 'a'); + this.fid = fopen(getenv("APP_LOG_FILE"), 'a'); if this.fid == -1 - error('Failed to open log file: application.log'); + error('Failed to open log file'); end end - function log(this, level, message) - current_time = datetime('now', 'Format', 'yyyy-MM-dd HH:mm:ss'); + function log(this, level, varargin) + current_time = datestr(now, 'yyyy-mm-dd HH:MM:SS'); stack = dbstack('-completenames'); if length(stack) > 2 script_name = stack(3).name; else script_name = 'Unknown'; end - - if this.fid ~= -1 - fprintf(this.fid, '%s %s %s %s\n', char(current_time), level, script_name, message); - else - error('File identifier is invalid. Cannot write to log.'); + + message = ""; + for i = 1:numel(varargin) + if isa(varargin{i}, 'MException') + message = sprintf('%sError: %s\n', message, varargin{i}.message); + for j = 1:length(varargin{i}.stack) + message = sprintf('%s at %s (line %d)\n', message, varargin{i}.stack(j).name, varargin{i}.stack(j).line); + end + elseif isnumeric(varargin{i}) || isenum(varargin{i}) || islogical(varargin{i}) + message = strcat(message, string(varargin{i})); + elseif ischar(varargin{i}) || isstring(varargin{i}) + message = strcat(message, varargin{i}); + else + message = strcat(message, 'Unsupported data type'); + end + if i < numel(varargin) + message = strcat(message, ", "); + end end + + fprintf(this.fid, '%s %s %s %s\n', current_time, level, script_name, message); end end methods(Access=public) - function trace(this, message) - this.log("TRACE", message); + function trace(this, varargin) + this.log('TRACE', varargin{:}); end - function debug(this, message) - this.log("DEBUG", message); + function debug(this, varargin) + this.log('DEBUG', varargin{:}); end - function info(this, message) - this.log("INFO", message); + function info(this, varargin) + this.log('INFO', varargin{:}); end - function warning(this, message) - this.log("WARNING", message); + function warning(this, varargin) + this.log('WARNING', varargin{:}); end - function error(this, message) - this.log("ERROR", message); + function error(this, varargin) + this.log('ERROR', varargin{:}); end function delete(this) diff --git a/octave/logging/base_logger.m b/octave/logging/base_logger.m index 101ee18..a399833 100644 --- a/octave/logging/base_logger.m +++ b/octave/logging/base_logger.m @@ -34,19 +34,24 @@ % % delete() - Destructor method that closes the file identifier when the logger is deleted. % -% Example usage: +% Example Usage: % logger = base_logger.getInstance(); -% logger.info('This is an info message'); -% logger.error('This is an error message'); +% logger.info('Some info') +% +% try +% error('Simulated error for stack trace logging'); +% catch err +% logger.error('An error occurred:', err); +% end % % See also: fopen, fclose, dbstack, fprintf classdef base_logger < handle - properties(Access=private) + properties fid; end - - methods(Static, Access = public) + + methods(Static) function obj = getInstance() persistent instance; if isempty(instance) @@ -56,15 +61,15 @@ classdef base_logger < handle end end - methods(Access=private) + methods function this = base_logger() - this.fid = fopen(getenv("DEFAULT_LOG_PATH"), 'a'); + this.fid = fopen(getenv("APP_LOG_FILE"), 'a'); if this.fid == -1 - error('Failed to open log file: application.log'); + error('Failed to open log file'); end end - function log(this, level, message) + function log(this, level, varargin) current_time = strftime('%Y-%m-%d %H:%M:%S', localtime(time())); stack = dbstack('-completenames'); if length(stack) > 2 @@ -73,33 +78,47 @@ classdef base_logger < handle script_name = 'Unknown'; end - if this.fid ~= -1 - fprintf(this.fid, '%s %s %s %s\n', char(current_time), level, script_name, message); - else - error('File identifier is invalid. Cannot write to log.'); + message = sprintf(''); + for i = 1:numel(varargin) + if isstruct(varargin{i}) && isfield(varargin{i}, 'message') && isfield(varargin{i}, 'stack') + error_info = varargin{i}; + message = sprintf('%sError: %s\n', message, error_info.message); + for j = 1:length(error_info.stack) + message = sprintf('%s at %s (line %d)\n', message, error_info.stack(j).name, error_info.stack(j).line); + end + elseif isnumeric(varargin{i}) || islogical(varargin{i}) + message = sprintf('%s%s', message, num2str(varargin{i})); + elseif ischar(varargin{i}) || isstring(varargin{i}) + message = sprintf('%s%s', message, varargin{i}); + else + message = sprintf('%sUnsupported data type', message); + end + if i < numel(varargin) + message = sprintf('%s, ', message); + end end - end - end - methods(Access=public) - function trace(this, message) - this.log("TRACE", message); + fprintf(this.fid, '%s %s %s %s\n', current_time, level, script_name, message); end - function debug(this, message) - this.log("DEBUG", message); + function trace(this, varargin) + this.log('TRACE', varargin{:}); end - function info(this, message) - this.log("INFO", message); + function debug(this, varargin) + this.log('DEBUG', varargin{:}); end - function warning(this, message) - this.log("WARNING", message); + function info(this, varargin) + this.log('INFO', varargin{:}); end - function error(this, message) - this.log("ERROR", message); + function warning(this, varargin) + this.log('WARNING', varargin{:}); + end + + function error(this, varargin) + this.log('ERROR', varargin{:}); end function delete(this) diff --git a/python/logging/base_logger.py b/python/logging/base_logger.py index e4af80b..53c229a 100644 --- a/python/logging/base_logger.py +++ b/python/logging/base_logger.py @@ -46,7 +46,7 @@ def getDefaultLogger(name): """ logger = logging.getLogger(name) if not logger.hasHandlers(): - file_handler = logging.FileHandler(os.environ['DEFAULT_LOG_PATH'], 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)