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             handler=logging.handlers.RotatingFileHandler(tmplogfile,maxBytes=1000000, backupCount=5)
  32         handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s"))
  33         self.logger=logging.getLogger(loggername)
  34         self.logger.setLevel(level)
  35         # check if logger already has the handler we're about to add
  36         handler_exists = False
  37         for l_handler in self.logger.handlers:
  38             if l_handler.baseFilename == handler.baseFilename and \
  39                l_handler.level == handler.level:
  40                 handler_exists = True
  41
  42         if not handler_exists:
  43             self.logger.addHandler(handler)
  44
  45         self.loggername=loggername
  46
  47     def setLevel(self,level):
  48         self.logger.setLevel(level)
  49
  50     # shorthand to avoid having to import logging all over the place
  51     def setLevelDebug(self):
  52         self.logger.setLevel(logging.DEBUG)
  53
  54     # define a verbose option with s/t like
  55     # parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0)
  56     # and pass the coresponding options.verbose to this method to adjust level
  57     def setLevelFromOptVerbose(self,verbose):
  58         if verbose==0:
  59             self.logger.setLevel(logging.WARNING)
  60         elif verbose==1:
  61             self.logger.setLevel(logging.INFO)
  62         elif verbose==2:
  63             self.logger.setLevel(logging.DEBUG)
  64
  65     ####################
  66     def info(self, msg):
  67         self.logger.info(msg)
  68
  69     def debug(self, msg):
  70         self.logger.debug(msg)
  71
  72     def warn(self, msg):
  73         self.logger.warn(msg)
  74
  75     # some code is using logger.warn(), some is using logger.warning()
  76     def warning(self, msg):
  77         self.logger.warning(msg)
  78
  79     def error(self, msg):
  80         self.logger.error(msg)
  81
  82     def critical(self, msg):
  83         self.logger.critical(msg)
  84
  85     # logs an exception - use in an except statement
  86     def log_exc(self,message):
  87         self.error("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
  88         self.error("%s END TRACEBACK"%message)
  89
  90     def log_exc_critical(self,message):
  91         self.critical("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
  92         self.critical("%s END TRACEBACK"%message)
  93
  94     # for investigation purposes, can be placed anywhere
  95     def log_stack(self,message):
  96         to_log="".join(traceback.format_stack())
  97         self.debug("%s BEG STACK"%message+"\n"+to_log)
  98         self.debug("%s END STACK"%message)
  99
 100     def enable_console(self, stream=sys.stdout):
 101         formatter = logging.Formatter("%(message)s")
 102         handler = logging.StreamHandler(stream)
 103         handler.setFormatter(formatter)
 104         self.logger.addHandler(handler)
 105
 106
 107 info_logger = _SfaLogger(loggername='info', level=logging.INFO)
 108 debug_logger = _SfaLogger(loggername='debug', level=logging.DEBUG)
 109 warn_logger = _SfaLogger(loggername='warning', level=logging.WARNING)
 110 error_logger = _SfaLogger(loggername='error', level=logging.ERROR)
 111 critical_logger = _SfaLogger(loggername='critical', level=logging.CRITICAL)
 112 logger = info_logger
 113 sfi_logger = _SfaLogger(logfile=os.path.expanduser("~/.sfi/")+'sfi.log',loggername='sfilog', level=logging.DEBUG)
 114 ########################################
 115 import time
 116
 117 def profile(logger):
 118     """
 119     Prints the runtime of the specified callable. Use as a decorator, e.g.,
 120
 121     @profile(logger)
 122     def foo(...):
 123         ...
 124     """
 125     def logger_profile(callable):
 126         def wrapper(*args, **kwds):
 127             start = time.time()
 128             result = callable(*args, **kwds)
 129             end = time.time()
 130             args = map(str, args)
 131             args += ["%s = %s" % (name, str(value)) for (name, value) in kwds.iteritems()]
 132             # should probably use debug, but then debug is not always enabled
 133             logger.info("PROFILED %s (%s): %.02f s" % (callable.__name__, ", ".join(args), end - start))
 134             return result
 135         return wrapper
 136     return logger_profile
 137
 138
 139 if __name__ == '__main__':
 140     print 'testing sfalogging into logger.log'
 141     logger=_SfaLogger('logger.log')
 142     logger2=_SfaLogger('logger.log', level=logging.DEBUG)
 143     logger3=_SfaLogger('logger.log', level=logging.ERROR)
 144     print logger.logger.handlers
 145
 146     logger.critical("logger.critical")
 147     logger.error("logger.error")
 148     logger.warn("logger.warning")
 149     logger.info("logger.info")
 150     logger.debug("logger.debug")
 151     logger.setLevel(logging.DEBUG)
 152     logger.debug("logger.debug again")
 153
 154
 155     @profile(logger)
 156     def sleep(seconds = 1):
 157         time.sleep(seconds)
 158
 159     logger.info('console.info')
 160     sleep(0.5)
 161     logger.setLevel(logging.DEBUG)
 162     sleep(0.25)
 163