Changeset 06b07f in indico

Timestamp:

08/31/10 07:47:46 (3 years ago)

Author:

Jose Benito <jose.benito.gonzalez@…>

Branches:

master, burotel, hello-world-walkthrough, ipv6, new-webex, v0.97-series, v0.98-series, v0.98.2, v0.98.3, v0.98b1, v0.98b2, v0.99, 051b2622c51afb171a1dedb46a0df4fbb0cbd02e, d9941f8582b36b24821a11ea5ba16fda6a457fb1

Children:

b40a31

Parents:

e73bb6

git-author:

Ian Rolewicz <ian.rolewicz@…> (05/25/10 16:15:40)

git-committer:

Jose Benito <jose.benito.gonzalez@…> (08/31/10 07:47:46)

Message:

[IMP] Moved config of logging to separate file

• used the mechanism of the logging module
• added file logging.conf.sample
• All the logging parameters can now be modified from the logging.conf file.
• If logging.conf is not set by the user, default values taken from indico.conf are set by default for the available handlers.

Files:

• etc/logging.conf.sample (added)
• indico/MaKaC/common/logger.py (modified) (3 diffs)
• indico/MaKaC/common/mail.py (modified) (4 diffs)
• indico/MaKaC/consoleScripts/installBase.py (modified) (1 diff)
• indico/MaKaC/plugins/RoomBooking/default/dalManager.py (modified) (7 diffs)
• setup.py (modified) (1 diff)

indico/MaKaC/common/logger.py

@@ -1 @@
-import os, logging
+import os, logging.config
 import logging.handlers
 
 from MaKaC.common.Configuration import Config
+import ConfigParser
 
 class ExtraIndicoFilter(logging.Filter):
@@ -11 +12 @@
         return 1
 
+class LoggerUtils:
+
+    @classmethod
+    def configFromFile(self, fname, defaultArgs, filters):
+        """
+        Read the logging configuration from the logging.conf file.
+        Fetch default values if the logging.conf file is not set.
+        """
+
+        if not os.path.exists(fname):
+            return
+
+        cp = ConfigParser.ConfigParser()
+        if hasattr(cp, 'readfp') and hasattr(fname, 'readline'):
+            cp.readfp(fname)
+        else:
+            cp.read(fname)
+
+        formatters = logging.config._create_formatters(cp)
+
+        logging._acquireLock()
+        try:
+            logging._handlers.clear()
+            del logging._handlerList[:]
+            handlers = self._install_handlers(cp, defaultArgs, formatters, filters)
+            try:
+                logging.config._install_loggers(cp, handlers)
+            except TypeError:
+                logging.config._install_loggers(cp, handlers, False)
+
+        finally:
+            logging._releaseLock()
+
+    @classmethod
+    def _install_handlers(self, cp, defaultArgs, formatters, filters = None):
+        """
+        Install and return handlers. If a handler configuration
+        is missing its args, fetches the default values from the
+        indico.conf file
+        """
+        hlist = cp.get("handlers", "keys")
+        if not len(hlist):
+            return {}
+        hlist = hlist.split(",")
+        handlers = {}
+        fixups = [] #for inter-handler references
+
+        for hand in hlist:
+            sectname = "handler_%s" % hand.strip()
+            klass = cp.get(sectname, "class")
+            opts = cp.options(sectname)
+            if "formatter" in opts:
+                fmt = cp.get(sectname, "formatter")
+            else:
+                fmt = ""
+            klass = eval(klass, vars(logging))
+            if "args" in opts :
+                # if the args are not present in the file,
+                # take default values
+                args = cp.get(sectname, "args")
+            else :
+                try:
+                    args = defaultArgs[hand.strip()]
+                except KeyError:
+                    continue
+            args = eval(args, vars(logging))
+            h = apply(klass, args)
+            if "level" in opts:
+                level = cp.get(sectname, "level")
+                h.setLevel(logging._levelNames[level])
+            if len(fmt):
+                h.setFormatter(formatters[fmt])
+            if filters and hand.strip() in filters:
+                for fltr in filters[hand.strip()]:
+                    h.addFilter(fltr)
+            #temporary hack for FileHandler and MemoryHandler.
+            if klass == logging.handlers.MemoryHandler:
+                if "target" in opts:
+                    target = cp.get(sectname,"target")
+                else:
+                    target = ""
+                if len(target): #the target handler may not be loaded yet, so keep for later...
+                    fixups.append((h, target))
+            handlers[hand] = h
+        #now all handlers are loaded, fixup inter-handler references...
+        for h, t in fixups:
+            h.setTarget(handlers[t])
+        return handlers
+
 class Logger:
     """
@@ -18 +108 @@
     config = Config.getInstance()
 
-    __rootLogger = logging.getLogger('')
-
-    __indicoFileHandler = logging.FileHandler(os.path.join(config.getLogDir(), 'indico.log'),'a')
-    __otherFileHandler = logging.FileHandler(os.path.join(config.getLogDir(), 'other.log'),'a')
-
-    __formatter = logging.Formatter('%(asctime)s %(name)-16s: %(levelname)-8s %(message)s')
-    __indicoFileHandler.setFormatter(__formatter)
-    __otherFileHandler.setFormatter(__formatter)
-    __indicoFileHandler.addFilter(logging.Filter('indico'))
-    __otherFileHandler.addFilter(ExtraIndicoFilter())
-
+    configDir = config.getLogDir()
+    smtpServer = config.getSmtpServer()
     serverName = config.getWorkerName()
     if not serverName:
         serverName = config.getHostNameURL()
 
-    # TODO: add config option to disable this?
-    __smtpHandler = logging.handlers.SMTPHandler(config.getSmtpServer(),
-                                            'logger@%s' % serverName,
-                                            config.getSupportEmail(),
-                                            'Unexpected Exception occurred at %s' % serverName)
+    # Default arguments for the handlers, taken mostly for the configuration
+    defaultArgs = { 'indico' : "('%s', 'a')" %os.path.join(configDir, 'indico.log'),
+                    'other'  : "('%s', 'a')" %os.path.join(configDir, 'other.log'),
+                    'smtp'   : "('%s', 'logger@%s', ['%s'], 'Unexpected Exception occurred at %s')"
+                                %(smtpServer, serverName, config.getSupportEmail(), serverName)
+                    }
 
-    __smtpHandler.addFilter(logging.Filter('indico'))
-    __smtpHandler.setLevel(logging.ERROR)
-    __smtpHandler.setFormatter(logging.Formatter("%(asctime)s %(name)s - %(levelname)s %(filename)s:%(lineno)d\n\n%(message)s"))
+    # Lists of filters for each handler
+    filters = {'indico' : [logging.Filter('indico')],
+               'other'  : [ExtraIndicoFilter()],
+               'smtp'   : [logging.Filter('indico')]}
 
-    __rootLogger.addHandler(__indicoFileHandler)
-    __rootLogger.addHandler(__otherFileHandler)
-    __otherFileHandler.setLevel(logging.WARNING)
-    __rootLogger.addHandler(__smtpHandler)
+    logConfFilepath = os.path.join(config.getConfigurationDir(), "logging.conf")
 
-    # TODO: see savannah task
-    # if it's debug mode, be more exhaustive
-    #if DEBUG or HelperMaKaCInfo.getMaKaCInfoInstance().isDebugActive():
-    #    __rootLogger.setLevel(logging.DEBUG)
-    #else:
-    #    __rootLogger.setLevel(logging.WARNING)
-
-    __rootLogger.setLevel(logging.DEBUG)
+    #logging.config.fileConfig(logConfFilepath)
+    LoggerUtils.configFromFile(logConfFilepath, defaultArgs, filters)
 
     @classmethod

indico/MaKaC/common/mail.py

@@ -26 +26 @@
 from MaKaC.common.logger import Logger
 
-from MaKaC.common.logger import Logger
-
 class GenericMailer:
 
@@ -51 +49 @@
             if len(cc) == 0 :
                 notification.getCCList().remove(cc)
-        
+
         to=", ".join(notification.getToList())
 #        raise to
@@ -74 +72 @@
 
         Logger.get('mail').debug('Mail sent to %s' % to)
-        
+
     def sendAndLog(notification, conference, module="", user = None):
         GenericMailer.send(notification)
@@ -86 +84 @@
         except:
             logData["toList"] = notification.getToList()
-        logData["ccList"] = notification._ccList 
+        logData["ccList"] = notification._ccList
         try:
             logData["subject"] = notification._subject

indico/MaKaC/consoleScripts/installBase.py

@@ -514 +514 @@
     # copy the db config files
     for f in [xx for xx in ('%s/zdctl.conf' % targetDirs['etc'],
-                            '%s/zodb.conf' % targetDirs['etc']) if not os.path.exists(xx)]:
+                            '%s/zodb.conf' % targetDirs['etc'],
+                            '%s/logging.conf' %targetDirs['etc']) if not os.path.exists(xx)]:
         shutil.copy('%s.sample' % f, f)
 

indico/MaKaC/plugins/RoomBooking/default/dalManager.py

@@ -50 +50 @@
         else:
             return False
-         
+
     @staticmethod
     def theInstance():
@@ -73 +73 @@
     @staticmethod
     def getRoot(name=""):
+
         if name == "":
             return DALManager.root
@@ -91 +92 @@
         else:
             raise MaKaCError("Cannot connect to the room booking database")
-            
+
     @staticmethod
     def connect():
@@ -100 +101 @@
                 DALManager.connection = DALManager.theInstance().db.open()
             DALManager.root = DALManager.connection.root()
-        
+
     @staticmethod
     def disconnect():
@@ -109 +110 @@
         DALManager.root = None
         DALManager.connection = None
-    
+
     @staticmethod
     def commit():
@@ -116 +117 @@
         if DALManager.isConnected():
             DALManager.connection.transaction_manager.get().commit()
-        
+
     @staticmethod
     def rollback():
@@ -136 +137 @@
             return
         DALManager.theInstance().db.pack(days=days)
-        
+

setup.py

@@ -245 +245 @@
             shutil.copy('etc/indico.conf.sample', local)
 
-        for f in [x for x in ('etc/zdctl.conf', 'etc/zodb.conf') if not os.path.exists(x)]:
+        for f in [x for x in ('etc/zdctl.conf', 'etc/zodb.conf', 'etc/logging.conf') if not os.path.exists(x)]:
             shutil.copy('%s.sample' % f, f)