sfa/util/sfalogging.py

   1 #!/usr/bin/python
   2
   3 import os, sys
   4 import traceback
   5 import logging, logging.handlers
   6
   7 CRITICAL=logging.CRITICAL
   8 ERROR=logging.ERROR
   9 WARNING=logging.WARNING
  10 INFO=logging.INFO
  11 DEBUG=logging.DEBUG
  12
  13 # a logger that can handle tracebacks
  14 class _SfaLogger:
  15     def __init__ (self,logfile=None,loggername=None,level=logging.INFO):
  16         # default is to locate loggername from the logfile if avail.
  17         if not logfile:
  18             #loggername='console'
  19             #handler=logging.StreamHandler()
  20             #handler.setFormatter(logging.Formatter("%(levelname)s %(message)s"))
  21             logfile = "/var/log/sfa.log"
  22
  23         if not loggername:
  24             loggername=os.path.basename(logfile)
  25         try:
  26             handler=logging.handlers.RotatingFileHandler(logfile,maxBytes=1000000, backupCount=5)
  27         except IOError:
  28             # This is usually a permissions error becaue the file is
  29             # owned by root, but httpd is trying to access it.
  30             tmplogfile=os.getenv("TMPDIR", "/tmp") + os.path.sep + os.path.basename(logfile)
  31             # In strange uses, 2 users on same machine might use same code,
  32             # meaning they would clobber each others files
  33             # We could (a) rename the tmplogfile, or (b)
  34             # just log to the console in that case.
  35             # Here we default to the console.
  36             if os.path.exists(tmplogfile) and not os.access(tmplogfile,os.W_OK):
  37                 loggername = loggername + "-console"
  38                 handler = logging.StreamHandler()
  39             else:
  40                 handler=logging.handlers.RotatingFileHandler(tmplogfile,maxBytes=1000000, backupCount=5)
  41         handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s"))
  42         self.logger=logging.getLogger(loggername)
  43         self.logger.setLevel(level)
  44         # check if logger already has the handler we're about to add
  45         handler_exists = False
  46         for l_handler in self.logger.handlers:
  47             if l_handler.baseFilename == handler.baseFilename and \
  48                l_handler.level == handler.level:
  49                 handler_exists = True
  50
  51         if not handler_exists:
  52             self.logger.addHandler(handler)
  53
  54         self.loggername=loggername
  55
  56     def setLevel(self,level):
  57         self.logger.setLevel(level)
  58
  59     # shorthand to avoid having to import logging all over the place
  60     def setLevelDebug(self):
  61         self.logger.setLevel(logging.DEBUG)
  62
  63     # define a verbose option with s/t like
  64     # parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0)
  65     # and pass the coresponding options.verbose to this method to adjust level
  66     def setLevelFromOptVerbose(self,verbose):
  67         if verbose==0:
  68             self.logger.setLevel(logging.WARNING)
  69         elif verbose==1:
  70             self.logger.setLevel(logging.INFO)
  71         elif verbose>=2:
  72             self.logger.setLevel(logging.DEBUG)
  73     # in case some other code needs a boolean
  74     def getBoolVerboseFromOpt(self,verbose):
  75         return verbose>=1
  76
  77     ####################
  78     def info(self, msg):
  79         self.logger.info(msg)
  80
  81     def debug(self, msg):
  82         self.logger.debug(msg)
  83
  84     def warn(self, msg):
  85         self.logger.warn(msg)
  86
  87     # some code is using logger.warn(), some is using logger.warning()
  88     def warning(self, msg):
  89         self.logger.warning(msg)
  90
  91     def error(self, msg):
  92         self.logger.error(msg)
  93
  94     def critical(self, msg):
  95         self.logger.critical(msg)
  96
  97     # logs an exception - use in an except statement
  98     def log_exc(self,message):
  99         self.error("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
 100         self.error("%s END TRACEBACK"%message)
 101
 102     def log_exc_critical(self,message):
 103         self.critical("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
 104         self.critical("%s END TRACEBACK"%message)
 105
 106     # for investigation purposes, can be placed anywhere
 107     def log_stack(self,message):
 108         to_log="".join(traceback.format_stack())
 109         self.info("%s BEG STACK"%message+"\n"+to_log)
 110         self.info("%s END STACK"%message)
 111
 112     def enable_console(self, stream=sys.stdout):
 113         formatter = logging.Formatter("%(message)s")
 114         handler = logging.StreamHandler(stream)
 115         handler.setFormatter(formatter)
 116         self.logger.addHandler(handler)
 117
 118
 119 info_logger = _SfaLogger(loggername='info', level=logging.INFO)
 120 debug_logger = _SfaLogger(loggername='debug', level=logging.DEBUG)
 121 warn_logger = _SfaLogger(loggername='warning', level=logging.WARNING)
 122 error_logger = _SfaLogger(loggername='error', level=logging.ERROR)
 123 critical_logger = _SfaLogger(loggername='critical', level=logging.CRITICAL)
 124 logger = info_logger
 125 sfi_logger = _SfaLogger(logfile=os.path.expanduser("~/.sfi/")+'sfi.log',loggername='sfilog', level=logging.DEBUG)
 126 ########################################
 127 import time
 128
 129 def profile(logger):
 130     """
 131     Prints the runtime of the specified callable. Use as a decorator, e.g.,
 132
 133     @profile(logger)
 134     def foo(...):
 135         ...
 136     """
 137     def logger_profile(callable):
 138         def wrapper(*args, **kwds):
 139             start = time.time()
 140             result = callable(*args, **kwds)
 141             end = time.time()
 142             args = map(str, args)
 143             args += ["%s = %s" % (name, str(value)) for (name, value) in kwds.iteritems()]
 144             # should probably use debug, but then debug is not always enabled
 145             logger.info("PROFILED %s (%s): %.02f s" % (callable.__name__, ", ".join(args), end - start))
 146             return result
 147         return wrapper
 148     return logger_profile
 149
 150
 151 if __name__ == '__main__':
 152     print 'testing sfalogging into logger.log'
 153     logger1=_SfaLogger('logger.log', loggername='std(info)')
 154     logger2=_SfaLogger('logger.log', loggername='error', level=logging.ERROR)
 155     logger3=_SfaLogger('logger.log', loggername='debug', level=logging.DEBUG)
 156
 157     for (logger,msg) in [ (logger1,"std(info)"),(logger2,"error"),(logger3,"debug")]:
 158
 159         print "====================",msg, logger.logger.handlers
 160
 161         logger.enable_console()
 162         logger.critical("logger.critical")
 163         logger.error("logger.error")
 164         logger.warn("logger.warning")
 165         logger.info("logger.info")
 166         logger.debug("logger.debug")
 167         logger.setLevel(logging.DEBUG)
 168         logger.debug("logger.debug again")
 169
 170         @profile(logger)
 171         def sleep(seconds = 1):
 172             time.sleep(seconds)
 173
 174         logger.info('console.info')
 175         sleep(0.5)
 176         logger.setLevel(logging.DEBUG)
 177         sleep(0.25)
 178