fix: include stacktrace for non-error logs (#69)

The Python logging framework allows users to pass an exc_info kwarg to the logging methods, in which case the stacktrace is included even if loggers other than Logger.exception() is used.

Author: mhaas

CHANGELOG.md

@@ -5,6 +5,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## 4.2.5 - 2023-07-28
+
+### Fixed
+
+- Include stacktrace also for non-error log level if exc_info is present
+
 ## 4.2.4 - 2022-04-26
 
 ### Update

sap/cf_logging/__init__.py

@@ -10,7 +10,7 @@
 from sap.cf_logging.record.request_log_record import RequestWebRecord
 from sap.cf_logging.record.simple_log_record import SimpleLogRecord
 
-__version__ = '4.2.4'
+__version__ = '4.2.5'
 
 _SETUP_DONE = False
 FRAMEWORK = None

sap/cf_logging/record/simple_log_record.py

@@ -75,7 +75,7 @@ def format(self):
             'msg': self.getMessage(),
         })
 
-        if self.levelno == logging.ERROR and self.exc_info:
+        if self.exc_info:
             stacktrace = ''.join(traceback.format_exception(*self.exc_info))
             stacktrace = format_stacktrace(stacktrace)
             record['stacktrace'] = stacktrace.split('\n')

setup.py

@@ -38,6 +38,9 @@
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'Topic :: Software Development :: Libraries :: Python Modules',
         'Topic :: Software Development',
         'Topic :: System :: Logging',

tests/test_job_logging.py

@@ -68,6 +68,25 @@ def test_exception_stacktrace():
 
         assert error == {}
         assert 'ZeroDivisionError' in str(log_json['stacktrace'])
+        assert 'ZeroDivisionError' in log_json["msg"]
+
+
+def test_exception_stacktrace_info_level():
+    """ Test exception stacktrace is logged """
+    cf_logging.init(level=logging.DEBUG)
+    logger, stream = config_logger('cli.test')
+
+    try:
+        return 1 / 0
+    except ZeroDivisionError as exc:
+        logger.info('zero division error', exc_info=exc)
+        log_json = JSONDecoder().decode(stream.getvalue())
+        _, error = JsonValidator(JOB_LOG_SCHEMA).validate(log_json)
+
+        assert error == {}
+        assert 'ZeroDivisionError' in str(log_json['stacktrace'])
+        assert 'ZeroDivisionError' in log_json["msg"]
+
 
 def test_custom_fields_set():
     """ Test custom fields are set up """