Merge pull request binarymatt#75 from joeshaw/joeshaw-syslog

add support for logging to syslog

Author: binarymatt

pyres/__init__.py

@@ -8,21 +8,49 @@
 import sys
 import logging
 
-def setup_logging(log_level=logging.INFO, filename=None, stream=sys.stderr):
-    if log_level == logging.NOTSET:
-        return
-    logger = logging.getLogger()
-    logger.setLevel(log_level)
-    if filename:
+def special_log_file(filename):
+    if filename in ("stderr", "stdout"):
+        return True
+    if filename.startswith("syslog"):
+        return True
+    return False
+
+def get_logging_handler(filename):
+    if not filename:
+        filename = "stderr"
+    if filename == "stderr":
+        handler = logging.StreamHandler(sys.stderr)
+    elif filename == "stdout":
+        handler = logging.StreamHandler(sys.stdout)
+    elif filename.startswith("syslog"): # "syslog:local0"
+        from logging.handlers import SysLogHandler
+        facility_name = filename[7:] or 'user'
+        facility = SysLogHandler.facility_names[facility_name]
+
+        if os.path.exists("/dev/log"):
+            syslog_path = "/dev/log"
+        elif os.path.exists("/var/run/syslog"):
+            syslog_path = "/var/run/syslog"
+        else:
+            raise Exception("Unable to figure out the syslog socket path")
+
+        handler = SysLogHandler(syslog_path, facility)
+    else:
         try:
             from logging.handlers import WatchedFileHandler
             handler = WatchedFileHandler(filename)
         except:
             from logging.handlers import RotatingFileHandler
             handler = RotatingFileHandler(filename,maxBytes=52428800,
                                           backupCount=7)
-    else:
-        handler = logging.StreamHandler(stream)
+    return handler
+
+def setup_logging(log_level=logging.INFO, filename=None):
+    if log_level == logging.NOTSET:
+        return
+    logger = logging.getLogger()
+    logger.setLevel(log_level)
+    handler = get_logging_handler(filename)
     handler.setFormatter(logging.Formatter(
         '%(asctime)s %(levelname)-8s %(message)s', '%Y-%m-%d %H:%M:%S'))
     logger.addHandler(handler)

pyres/horde.py

@@ -8,7 +8,7 @@
 import datetime
 import logging
 import logging.handlers
-from pyres import ResQ, Stat
+from pyres import ResQ, Stat, get_logging_handler, special_log_file
 from pyres.exceptions import NoQueueError
 from pyres.utils import OrderedDict
 from pyres.job import Job
@@ -25,10 +25,7 @@ def setup_logging(namespace='', log_level=logging.INFO, log_file=None):
     #logger = multiprocessing.log_to_stderr()
     logger.setLevel(log_level)
     format = '%(asctime)s %(levelname)s '+namespace+': %(message)s'
-    if log_file:
-        handler = logging.handlers.RotatingFileHandler(log_file, maxBytes=104857600, backupCount=5)
-    else:
-        handler = logging.StreamHandler()
+    handler = get_logging_handler(log_file)
     handler.setFormatter(logging.Formatter((format)))
     logger.addHandler(handler)
     return logger
@@ -154,7 +151,10 @@ def clear_logger(self):
     def run(self):
         setproctitle('pyres_minion:%s: Starting' % (os.getppid(),))
         if self.log_path:
-            self.log_file = os.path.join(self.log_path, 'minion-%s.log' % self.pid)
+            if special_log_file(self.log_path):
+                self.log_file = self.log_path
+            else:
+                self.log_file = os.path.join(self.log_path, 'minion-%s.log' % self.pid)
         namespace = 'minion:%s' % self.pid
         self.logger = setup_logging(namespace, self.log_level, self.log_file)
         #self.clear_logger()
@@ -268,7 +268,10 @@ def _add_minion(self):
         if hasattr(self,'logger'):
             self.logger.info('Adding minion')
         if self.log_file:
-            log_path = os.path.dirname(self.log_file)
+            if special_log_file(self.log_file):
+                log_path = self.log_file
+            else:
+                log_path = os.path.dirname(self.log_file)
         else:
             log_path = None
         m = Minion(self.queues, self.server, self.password, log_level=self.logging_level, log_path=log_path)

pyres/scripts.py

@@ -20,7 +20,7 @@ def pyres_manager():
     parser.add_option("-i", '--interval', dest='interval', default=None, help='the default time interval to sleep between runs')
     parser.add_option('-l', '--log-level', dest='log_level', default='info', help='log level.  Valid values are "debug", "info", "warning", "error", "critical", in decreasing order of verbosity. Defaults to "info" if parameter not specified.')
     parser.add_option("--pool", type="int", dest="pool_size", default=1, help="Number of minions to spawn under the manager.")
-    parser.add_option('-f', dest='logfile', help='If present, a logfile will be used.')
+    parser.add_option('-f', dest='logfile', help='If present, a logfile will be used.  "stderr", "stdout", and "syslog" are all special values.')
     parser.add_option('-p', dest='pidfile', help='If present, a pidfile will be used.')
     (options,args) = parser.parse_args()
 
@@ -49,7 +49,7 @@ def pyres_scheduler():
     parser.add_option("--host", dest="host", default="localhost")
     parser.add_option("--port",dest="port",type="int", default=6379)
     parser.add_option('-l', '--log-level', dest='log_level', default='info', help='log level.  Valid values are "debug", "info", "warning", "error", "critical", in decreasing order of verbosity. Defaults to "info" if parameter not specified.')
-    parser.add_option('-f', dest='logfile', help='If present, a logfile will be used.')
+    parser.add_option('-f', dest='logfile', help='If present, a logfile will be used.  "stderr", "stdout", and "syslog" are all special values.')
     parser.add_option('-p', dest='pidfile', help='If present, a pidfile will be used.')
     (options,args) = parser.parse_args()
     log_level = getattr(logging, options.log_level.upper(),'INFO')
@@ -94,7 +94,7 @@ def pyres_worker():
     parser.add_option("--port",dest="port",type="int", default=6379)
     parser.add_option("-i", '--interval', dest='interval', default=None, help='the default time interval to sleep between runs')
     parser.add_option('-l', '--log-level', dest='log_level', default='info', help='log level.  Valid values are "debug", "info", "warning", "error", "critical", in decreasing order of verbosity. Defaults to "info" if parameter not specified.')
-    parser.add_option('-f', dest='logfile', help='If present, a logfile will be used.')
+    parser.add_option('-f', dest='logfile', help='If present, a logfile will be used.  "stderr", "stdout", and "syslog" are all special values.')
     parser.add_option('-p', dest='pidfile', help='If present, a pidfile will be used.')
     (options,args) = parser.parse_args()