feat: add a configurable SECURE_LOGGER_LOG_LEVEL defaulted to logging.default()

Author: lpm0073

README.md

@@ -97,6 +97,7 @@ secure_logger accepts optional parameters which you can configure as either bash
 - **SECURE_LOGGER_SENSITIVE_KEYS**: a Python list of dictionary keys. Not case sensitive.
 - **SECURE_LOGGER_REDACTION_MESSAGE**: a string value that will replace the sensitive key values
 - **SECURE_LOGGER_INDENT**: number of characters to indent JSON string output when logging output
+- **SECURE_LOGGER_LOG_LEVEL**: the level at which secure_logger generates log entries. One of: 'CRITICAL', 'FATAL', 'ERROR', 'WARN', 'WARNING', 'INFO', 'DEBUG'
 
 Additionally, you can override individual invocations of the decorator by passing *sensitive_keys*, *message* and *indent*:
 
@@ -129,6 +130,7 @@ SECURE_LOGGER_SENSITIVE_KEYS = [
     "aws-access-key-id",
     "aws-secret-access-key",
 ]
+SECURE_LOGGER_LOG_LEVEL = 'DEBUG'
 ```
 
 ### Contributing

secure_logger/conf.py

@@ -3,11 +3,16 @@
 
 import logging
 
-from pydantic import BaseModel, Field, ValidationError
+from pydantic import BaseModel, Field, ValidationError, constr, validator
 
 from secure_logger.exceptions import SecureLoggerConfigurationError
 
 
+LOGGER_NAME = "decorator_logger"
+
+_logger = logging.getLogger(LOGGER_NAME)
+
+
 _SECURE_LOGGER_SENSITIVE_KEYS = [
     "password",
     "token",
@@ -26,6 +31,10 @@
 ]
 _SECURE_LOGGER_REDACTION_MESSAGE = "*** -- secure_logger() -- ***"
 _SECURE_LOGGER_INDENT = 4
+_SECURE_LOGGER_LOG_LEVEL = "DEBUG"
+
+# pylint: disable=protected-access
+_SECURE_LOGGER_LOG_LEVELS = [level for level in logging._nameToLevel if level != "NOTSET"]
 
 
 class Settings(BaseModel):
@@ -36,6 +45,35 @@ class Settings(BaseModel):
         _SECURE_LOGGER_REDACTION_MESSAGE, env="SECURE_LOGGER_REDACTION_MESSAGE"
     )
     secure_logger_indent: int = Field(_SECURE_LOGGER_INDENT, env="SECURE_LOGGER_INDENT")
+    secure_logger_logging_level: constr(min_length=4, max_length=8) = Field(
+        _SECURE_LOGGER_LOG_LEVEL, env="SECURE_LOGGER_LOG_LEVEL"
+    )
+
+    @validator("secure_logger_logging_level")
+    @classmethod
+    def must_be_valid_log_level(cls, v):
+        """Validate the log level"""
+        if v not in _SECURE_LOGGER_LOG_LEVELS:
+            raise ValueError("invalid log level")
+        return v
+
+    @property
+    def logger(self):
+        """Returns the logger function for the specified logging level"""
+        log_levels = {
+            "DEBUG": _logger.debug,
+            "INFO": _logger.info,
+            "WARNING": _logger.warning,
+            "ERROR": _logger.error,
+            "CRITICAL": _logger.critical,
+        }
+        return log_levels.get(self.secure_logger_logging_level, logging.debug)
+
+    @property
+    def logger_level(self) -> int:
+        """Returns the logger level for the specified logging level"""
+        # pylint: disable=protected-access
+        return logging._nameToLevel.get(self.secure_logger_logging_level, logging.DEBUG)
 
 
 settings = None
@@ -44,6 +82,7 @@ class Settings(BaseModel):
 except ValidationError as e:
     raise SecureLoggerConfigurationError("Invalid configuration: " + str(e)) from e
 
-logging.debug("SECURE_LOGGER_SENSITIVE_KEYS: %s", settings.secure_logger_sensitive_keys)
-logging.debug("SECURE_LOGGER_REDACTION_MESSAGE: %s", settings.secure_logger_redaction_message)
-logging.debug("SECURE_LOGGER_INDENT: %s", settings.secure_logger_indent)
+_logger.debug("SECURE_LOGGER_SENSITIVE_KEYS: %s", settings.secure_logger_sensitive_keys)
+_logger.debug("SECURE_LOGGER_REDACTION_MESSAGE: %s", settings.secure_logger_redaction_message)
+_logger.debug("SECURE_LOGGER_INDENT: %s", settings.secure_logger_indent)
+_logger.debug("SECURE_LOGGER_LOG_LEVEL: %s", settings.secure_logger_logging_level)

secure_logger/decorators.py

@@ -2,7 +2,6 @@
 """Python Secure Logger."""
 # python stuff
 import inspect
-import logging
 from functools import wraps
 
 # our stuff
@@ -11,7 +10,7 @@
 
 
 # module initializations
-logger = logging.getLogger(__name__)
+logger = settings.logger
 
 
 def secure_logger(
@@ -72,7 +71,7 @@ def wrapper(*args, **kwargs):
                     kwargs, sensitive_keys=sensitive_keys, indent=indent, message=message
                 )
 
-            logger.info(
+            logger(
                 "secure_logger: %s %s %s",
                 name_spec,
                 positional_args if positional_args else "",

secure_logger/tests/tests.py

@@ -2,7 +2,6 @@
 # pylint: disable=too-few-public-methods,C0413
 """Simple test bank."""
 import json
-import logging
 import sys
 import unittest
 
@@ -108,10 +107,10 @@ def test_decorator_output(self):
 
         # noqa: C0301
         expected_output = (
-            "INFO:secure_logger.decorators:secure_logger: tests.mock_decorated_def() "
+            settings.secure_logger_logging_level + ":decorator_logger:secure_logger: tests.mock_decorated_def() "
             "['<tests.TestModuleDefDecorator testMethod=test_decorator_output>', " + hello_world
         )
-        with self.assertLogs(level=logging.DEBUG) as cm:
+        with self.assertLogs(level=settings.logger_level) as cm:
             self.mock_decorated_def("hello world")
 
         self.assertEqual(cm.output[0][0:100], expected_output[0:100])
@@ -142,11 +141,11 @@ def decorator_with_custom_params(self, test_dict, test_list):
     def test_class_method_with_default_params(self):
         """Test class method with default parameters."""
         expected_output = (
-            "INFO:secure_logger.decorators:secure_logger: tests.decorator_with_defaults() "
+            settings.secure_logger_logging_level + ":decorator_logger:secure_logger: tests.decorator_with_defaults() "
             "['<tests.TestClassMethodDecorator.MockClass"
         )
 
-        with self.assertLogs(level=logging.DEBUG) as cm:
+        with self.assertLogs(level=settings.logger_level) as cm:
             self.mock_class.decorator_with_defaults(self.test_dict, self.test_list)
 
         self.assertEqual(cm.output[0][0:100], expected_output[0:100])
@@ -162,9 +161,11 @@ def test_class_with_default_params(self):
         class MockDecoratedClass:
             """Test 3: decorate a class."""
 
-        expected_output = "INFO:secure_logger.decorators:secure_logger: tests.MockDecoratedClass.  "
+        expected_output = (
+            settings.secure_logger_logging_level + ":decorator_logger:secure_logger: tests.MockDecoratedClass.  "
+        )
 
-        with self.assertLogs(level=logging.DEBUG) as cm:
+        with self.assertLogs(level=settings.logger_level) as cm:
             MockDecoratedClass()
 
         self.assertEqual(cm.output[0][0:100], expected_output[0:100])