feat(logging): add customizable log formats for main and child logs

Author: smghasempour

supervisor/dispatchers.py

@@ -105,7 +105,13 @@ def __init__(self, process, event_type, fd):
         self.endtoken_data = (endtoken, len(endtoken))
         self.mainlog_level = loggers.LevelsByName.DEBG
         config = self.process.config
-        self.log_to_mainlog = config.options.loglevel <= self.mainlog_level
+        # Handle case where options haven't been realized yet
+        loglevel = getattr(config.options, 'loglevel', None)
+        if loglevel is None:
+            # Default loglevel when not set
+            from supervisor.loggers import LevelsByName
+            loglevel = LevelsByName.INFO
+        self.log_to_mainlog = loglevel <= self.mainlog_level
         self.stdout_events_enabled = config.stdout_events_enabled
         self.stderr_events_enabled = config.stderr_events_enabled
 
@@ -126,7 +132,9 @@ def _init_normallog(self):
             self.normallog = config.options.getLogger()
 
         if logfile:
-            fmt = config.options.childlog_format
+            fmt = getattr(config.options, 'childlog_format', None)
+            if fmt is None:
+                fmt = '%(message)s'  # Default format
             loggers.handle_file(
                 self.normallog,
                 filename=logfile,
@@ -137,7 +145,10 @@ def _init_normallog(self):
             )
 
         if to_syslog:
-            fmt = config.name + ' ' + config.options.childlog_format
+            childlog_format = getattr(config.options, 'childlog_format', None)
+            if childlog_format is None:
+                childlog_format = '%(message)s'  # Default format
+            fmt = config.name + ' ' + childlog_format
             loggers.handle_syslog(
                 self.normallog,
                 fmt=fmt

supervisor/loggers.py

@@ -153,9 +153,12 @@ class FileHandler(Handler):
     """File handler which supports reopening of logs.
     """
 
-    def __init__(self, filename, mode='ab'):
+    def __init__(self, filename, mode='ab', fmt=None):
         Handler.__init__(self)
 
+        if fmt is not None:
+            self.setFormat(fmt)
+
         try:
             self.stream = open(filename, mode)
         except OSError as e:
@@ -187,7 +190,7 @@ def remove(self):
 
 class RotatingFileHandler(FileHandler):
     def __init__(self, filename, mode='ab', maxBytes=512*1024*1024,
-                 backupCount=10):
+                 backupCount=10, fmt=None):
         """
         Open the specified file and use it as the stream for logging.
 
@@ -210,7 +213,7 @@ def __init__(self, filename, mode='ab', maxBytes=512*1024*1024,
         """
         if maxBytes > 0:
             mode = 'ab' # doesn't make sense otherwise!
-        FileHandler.__init__(self, filename, mode)
+        FileHandler.__init__(self, filename, mode, fmt)
         self.maxBytes = maxBytes
         self.backupCount = backupCount
         self.counter = 0
@@ -388,8 +391,18 @@ def emit(self, record):
         except:
             self.handleError()
 
-def getLogger(level=None):
-    return Logger(level)
+def getLogger(level=None, fmt=None):
+    logger = Logger(level)
+    if fmt is not None:
+        # Create a handler with the specified format
+        handler = StreamHandler()
+        handler.setFormat(fmt)
+        if level is not None:
+            handler.setLevel(level)
+        else:
+            handler.setLevel(logger.level)
+        logger.addHandler(handler)
+    return logger
 
 _2MB = 1<<21
 
@@ -409,6 +422,13 @@ def handle_stdout(logger, fmt):
     handler.setLevel(logger.level)
     logger.addHandler(handler)
 
+def handle_stderr(logger, fmt):
+    """Attach a new StreamHandler with stderr handler to an existing Logger"""
+    handler = StreamHandler(sys.stderr)
+    handler.setFormat(fmt)
+    handler.setLevel(logger.level)
+    logger.addHandler(handler)
+
 def handle_syslog(logger, fmt):
     """Attach a new Syslog handler to an existing Logger"""
     handler = SyslogHandler()

supervisor/options.py

@@ -544,10 +544,15 @@ def realize(self, *arg, **kw):
         # Configure the main logger
         self.logger = loggers.getLogger(loglevel)
 
+        if self.logfile:
+            logfile = self.logfile
+        else:
+            logfile = section.logfile
+
         if logfile:
             loggers.handle_file(
                 self.logger,
-                self.logfile,
+                logfile,
                 logfile_format,
                 rotating=True,
                 maxbytes=section.logfile_maxbytes,
@@ -677,8 +682,10 @@ def get(opt, default, **kwargs):
         section.identifier = get('identifier', 'supervisor')
         section.nodaemon = boolean(get('nodaemon', 'false'))
         section.logfile_format = get('logfile_format',
-                                '%(asctime)s %(levelname)s %(message)s')
-        section.childlog_format = get('childlog_format', '%(message)s')
+                                '%(asctime)s %(levelname)s %(message)s',
+                        do_expand=False)
+        section.childlog_format = get('childlog_format', '%(message)s',
+                        do_expand=False)
         section.silent = boolean(get('silent', 'false'))
 
         tempdir = tempfile.gettempdir()

supervisor/tests/base.py

@@ -89,6 +89,7 @@ def __init__(self):
         self.umaskset = None
         self.poller = DummyPoller(self)
         self.silent = False
+        self.childlog_format = '%(message)s'
 
     def getLogger(self, *args, **kw):
         logger = DummyLogger()

supervisor/tests/test_options.py

@@ -3411,7 +3411,12 @@ def test_daemonize_notifies_poller_before_and_after_fork(self):
 
     def test_default_log_format_options(self):
         """Test that default log format options are set correctly"""
+        text = lstrip('''
+        [supervisord]
+        logfile=/tmp/supervisord.log
+        ''')
         instance = self._makeOne()
+        instance.configfile = StringIO(text)
         instance.realize(args=[])
         options = instance.configroot.supervisord
         self.assertEqual(options.logfile_format, '%(asctime)s %(levelname)s %(message)s')