GBSLogger.py

Go to the documentation of this file.

import os
import re

import GBSConfig 
import GBSTimeStamp

class GBSLogger :
    """Internal logger - for reporting information about GBS itself"""

    def __init__(self):
        self.FATAL     = 6   # Crash and burn
        self.ERROR     = 5   # Something is definitely wrong but can continue
        self.WARNING   = 4   # Something is unusual but not definitely wrong 
        self.INFO      = 3   # Normal stuff user expects to see
        self.SYNOPSIS  = 2   # A bit more detail so user can see a what going on behind the scenes
                             #  includes object construction.
        self.DEBUG     = 1   # In depth debug level

        self.__loggerThresholdTerminal  = int(GBSConfig.GetConfigValue('LoggerThresholdTerminal'))
        self.__LoggerThresholdPermanent = int(GBSConfig.GetConfigValue('LoggerThresholdPermanent'))

    def GetLevelAsChar(self,level):
        """Return supplied level as a single char"""
        char = "?"
        if level == self.FATAL     : char = "F"
        if level == self.ERROR     : char = "E"
        if level == self.WARNING   : char = "W"
        if level == self.INFO      : char = "I"
        if level == self.SYNOPSIS  : char = "S"
        if level == self.DEBUG     : char = "D"
        return char

    def GetLoggerThreshold(self,stream = "Terminal"):
        """Return the current threshold level for the stream."""
        if stream != "Permanent": return self.__loggerThresholdTerminal 
        return self.__LoggerThresholdPermanent
     
    def SetLoggerThreshold(self,level,stream = "Terminal"):
        """Set new level threshold for the stream."""
        old_level = self.__loggerThresholdTerminal
        if stream != "Permanent":
            stream = "Terminal"
            if self.__loggerThresholdTerminal == level: return
            self.__loggerThresholdTerminal = level
        else:
            if self.__LoggerThresholdPermanent == level: return
            old_level = self.__LoggerThresholdPermanent
            self.__LoggerThresholdPermanent = level
        print "Changing %s loggerThreshold: %d -> %d" % (stream,old_level,level)

    def Log(self,caller,level,message) :
        """Send message to logger streams."""
        if level >= self.__loggerThresholdTerminal: print message
        if level < self.__LoggerThresholdPermanent: return

        # Logging to permanent stream
        time_stamp = GBSTimeStamp.GBSTimeStamp()
        task_name  = ""
        try:
            caller_type = caller.GetType()
            if caller_type == "GBSLogger": return  
            # So long as object type ends Task or Job assume it is one
            if re.search(r"Task$",caller_type): task_name = caller.GetName()
            if re.search(r"Job$",caller_type):  task_name = caller.GetParent().GetName()
        except: pass
        log_file = ""
        if task_name: log_file = GBSConfig.GetConfigValue('Logger-' + task_name + '-Directory')
        if log_file:
            log_file += "/gbs_global_" + task_name + "_" + time_stamp[0:10] + ".log"
        else:
            log_file = GBSConfig.GetConfigValue('LoggerGlobalDirectory')
            log_file += "/gbs_global_summary_" + time_stamp[0:10] + ".log"
        msg_prefx = time_stamp + " -" + self.GetLevelAsChar(level) + "-"\
                    + str(os.getpid()).rjust(7)  + " " + task_name.ljust(20)
        # Change any double quote in message to single quote so that we can use 'echo'
        message = re.compile(r'"').sub("'",message)
        os.system("echo \"%s %s\"  >> %s" % (msg_prefx,message,log_file))
        return

#  Singleton object and access methods

logger = GBSLogger()
def Log(caller,level,message):                     logger.Log(caller,level,message)
def GetLoggerThreshold(stream = "Terminal"):       return logger.GetLoggerThreshold(stream)
def SetLoggerThreshold(level,stream = "Terminal"): logger.SetLoggerThreshold(level,stream)

---