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         self.logger.addHandler(handler)
  36         self.loggername=loggername
  37
  38     def setLevel(self,level):
  39         self.logger.setLevel(level)
  40
  41     # shorthand to avoid having to import logging all over the place
  42     def setLevelDebug(self):
  43         self.logger.setLevel(logging.DEBUG)
  44
  45     # define a verbose option with s/t like
  46     # parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0)
  47     # and pass the coresponding options.verbose to this method to adjust level
  48     def setLevelFromOptVerbose(self,verbose):
  49         if verbose==0:
  50             self.logger.setLevel(logging.WARNING)
  51         elif verbose==1:
  52             self.logger.setLevel(logging.INFO)
  53         elif verbose==2:
  54             self.logger.setLevel(logging.DEBUG)
  55
  56     ####################
  57     def info(self, msg):
  58         self.logger.info(msg)
  59
  60     def debug(self, msg):
  61         self.logger.debug(msg)
  62
  63     def warn(self, msg):
  64         self.logger.warn(msg)
  65
  66     def error(self, msg):
  67         self.logger.error(msg)
  68
  69     def critical(self, msg):
  70         self.logger.critical(msg)
  71
  72     # logs an exception - use in an except statement
  73     def log_exc(self,message):
  74         self.error("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
  75         self.error("%s END TRACEBACK"%message)
  76
  77     def log_exc_critical(self,message):
  78         self.critical("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
  79         self.critical("%s END TRACEBACK"%message)
  80
  81     # for investigation purposes, can be placed anywhere
  82     def log_stack(self,message):
  83         to_log="".join(traceback.format_stack())
  84         self.debug("%s BEG STACK"%message+"\n"+to_log)
  85         self.debug("%s END STACK"%message)
  86
  87
  88 info_logger = _SfaLogger(loggername='info', level=logging.INFO)
  89 debug_logger = _SfaLogger(loggername='debug', level=logging.DEBUG)
  90 warn_logger = _SfaLogger(loggername='warning', level=logging.WARNING)
  91 error_logger = _SfaLogger(loggername='error', level=logging.ERROR)
  92 critical_logger = _SfaLogger(loggername='critical', level=logging.CRITICAL)
  93 logger = info_logger
  94
  95 ########################################
  96 import time
  97
  98 def profile(logger):
  99     """
 100     Prints the runtime of the specified callable. Use as a decorator, e.g.,
 101
 102     @profile(logger)
 103     def foo(...):
 104         ...
 105     """
 106     def logger_profile(callable):
 107         def wrapper(*args, **kwds):
 108             start = time.time()
 109             result = callable(*args, **kwds)
 110             end = time.time()
 111             args = map(str, args)
 112             args += ["%s = %s" % (name, str(value)) for (name, value) in kwds.iteritems()]
 113             # should probably use debug, but then debug is not always enabled
 114             logger.info("PROFILED %s (%s): %.02f s" % (callable.__name__, ", ".join(args), end - start))
 115             return result
 116         return wrapper
 117     return logger_profile
 118
 119
 120 if __name__ == '__main__':
 121     print 'testing sfalogging into logger.log'
 122     logger=_SfaLogger('logger.log')
 123     logger.critical("logger.critical")
 124     logger.error("logger.error")
 125     logger.warning("logger.warning")
 126     logger.info("logger.info")
 127     logger.debug("logger.debug")
 128     logger.setLevel(logging.DEBUG)
 129     logger.debug("logger.debug again")
 130
 131
 132     @profile(my_logger)
 133     def sleep(seconds = 1):
 134         time.sleep(seconds)
 135
 136     my_logger.info('console.info')
 137     sleep(0.5)
 138     my_logger.setLevel(logging.DEBUG)
 139     sleep(0.25)
 140