Support logging configuration through the python logger

Signed-off-by: Ivan Kanakarakis <[email protected]>

Author: c00kiemon5ter

docs/howto/config.rst

@@ -64,6 +64,55 @@ Configuration directives
 General directives
 ------------------
 
+logging
+^^^^^^^
+
+The logging configuration format is the python logging format.
+The configuration is passed to the python logging dictionary configuration handler,
+directly.
+
+Example::
+
+    "logging": {
+        "version": 1,
+        "formatters": {
+            "simple": {
+                "format": "[%(asctime)s] [%(levelname)s] [%(name)s.%(funcName)s] %(message)s",
+            },
+        },
+        "handlers": {
+            "stdout": {
+                "class": "logging.StreamHandler",
+                "stream": "ext://sys.stdout",
+                "level": "DEBUG",
+                "formatter": "simple",
+            },
+        },
+        "loggers": {
+            "saml2": {
+                "level": "DEBUG"
+            },
+        },
+        "root": {
+            "level": "DEBUG",
+            "handlers": [
+                "stdout",
+            ],
+        },
+    },
+
+The exapmle configuration above will enable DEBUG logging to stdout.
+
+
+debug
+^^^^^
+
+Example::
+
+    debug: 1
+
+Whether debug information should be sent to the log file.
+
 additional_cert_files
 ^^^^^^^^^^^^^^^^^^^^^
 
@@ -186,15 +235,6 @@ and **other**.::
         },
     ]
 
-debug
-^^^^^
-
-Example::
-
-    debug: 1
-
-Whether debug information should be sent to the log file.
-
 entityid
 ^^^^^^^^
 

example/idp2/idp_conf.py.example

@@ -137,14 +137,33 @@ CONFIG = {
     # the identifier returned to a SP
     "xmlsec_binary": xmlsec_path,
     #"attribute_map_dir": "../attributemaps",
-    "logger": {
-        "rotating": {
-            "filename": "idp.log",
-            "maxBytes": 500000,
-            "backupCount": 5,
+    "logging": {
+        "version": 1,
+        "formatters": {
+            "simple": {
+                "format": "[%(asctime)s] [%(levelname)s] [%(name)s.%(funcName)s] %(message)s",
+            },
+        },
+        "handlers": {
+            "stdout": {
+                "class": "logging.StreamHandler",
+                "stream": "ext://sys.stdout",
+                "level": "DEBUG",
+                "formatter": "simple",
+            },
         },
-        "loglevel": "debug",
-    }
+        "loggers": {
+            "saml2": {
+                "level": "DEBUG"
+            },
+        },
+        "root": {
+            "level": "DEBUG",
+            "handlers": [
+                "stdout",
+            ],
+        },
+    },
 }
 
 # Authentication contexts

src/saml2/config.py

@@ -7,6 +7,7 @@
 import os
 import re
 import sys
+from logging.config import dictConfig as configure_logging_by_dict
 
 import six
 
@@ -30,6 +31,7 @@
 
 
 COMMON_ARGS = [
+    "logging",
     "debug",
     "entityid",
     "xmlsec_binary",
@@ -141,24 +143,6 @@
     "aq": COMMON_ARGS + COMPLEX_ARGS + AQ_ARGS,
 }
 
-# --------------- Logging stuff ---------------
-
-LOG_LEVEL = {
-    'debug': logging.DEBUG,
-    'info': logging.INFO,
-    'warning': logging.WARNING,
-    'error': logging.ERROR,
-    'critical': logging.CRITICAL}
-
-LOG_HANDLER = {
-    "rotating": logging.handlers.RotatingFileHandler,
-    "syslog": logging.handlers.SysLogHandler,
-    "timerotate": logging.handlers.TimedRotatingFileHandler,
-    "memory": logging.handlers.MemoryHandler,
-}
-
-LOG_FORMAT = "%(asctime)s %(name)s:%(levelname)s %(message)s"
-
 _RPA = [BINDING_HTTP_REDIRECT, BINDING_HTTP_POST, BINDING_HTTP_ARTIFACT]
 _PRA = [BINDING_HTTP_POST, BINDING_HTTP_REDIRECT, BINDING_HTTP_ARTIFACT]
 _SRPA = [BINDING_SOAP, BINDING_HTTP_REDIRECT, BINDING_HTTP_POST,
@@ -190,6 +174,7 @@ class Config(object):
     def_context = ""
 
     def __init__(self, homedir="."):
+        self.logging = None
         self._homedir = homedir
         self.entityid = None
         self.xmlsec_binary = None
@@ -362,6 +347,9 @@ def load(self, cnf, metadata_construction=False):
             except TypeError:  # Something that can't be a string
                 setattr(self, arg, cnf[arg])
 
+        if self.logging is not None:
+            configure_logging_by_dict(self.logging)
+
         if not self.delete_tmpfiles:
             logger.warning(
                 "delete_tmpfiles is set to False; "