sfa/util/sfalogging.py

   1 #!/usr/bin/python
   2
   3 import os
   4 import traceback
   5 import logging, logging.handlers
   6
   7 # a logger that can handle tracebacks
   8 class _SfaLogger:
   9     def __init__ (self,logfile=None,loggername=None,level=logging.INFO):
  10         # default is to locate loggername from the logfile if avail.
  11         if not logfile:
  12             loggername='console'
  13             handler=logging.StreamHandler()
  14         else:
  15             if not loggername:
  16                 loggername=os.path.basename(logfile)
  17             try:
  18                 handler=logging.handlers.RotatingFileHandler(logfile,maxBytes=1000000, backupCount=5)
  19             except IOError:
  20                 # This is usually a permissions error becaue the file is
  21                 # owned by root, but httpd is trying to access it.
  22                 tmplogfile=os.getenv("TMPDIR", "/tmp") + os.path.sep + os.path.basename(logfile)
  23                 handler=logging.handlers.RotatingFileHandler(tmplogfile,maxBytes=1000000, backupCount=5)
  24
  25         self.logger=logging.getLogger(loggername)
  26         handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s"))
  27         self.logger.setLevel(level)
  28         self.logger.addHandler(handler)
  29
  30     def setLevel(self,level):
  31         self.logger.setLevel(level)
  32
  33     ####################
  34     def wrap(fun):
  35         def wrapped(self,msg,*args,**kwds):
  36             native=getattr(self.logger,fun.__name__)
  37             return native(msg,*args,**kwds)
  38         #wrapped.__doc__=native.__doc__
  39         return wrapped
  40
  41     @wrap
  42     def critical(): pass
  43     @wrap
  44     def error(): pass
  45     @wrap
  46     def warning(): pass
  47     @wrap
  48     def info(): pass
  49     @wrap
  50     def debug(): pass
  51
  52     # logs an exception - use in an except statement
  53     def log_exc(self,message):
  54         self.error("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
  55         self.error("%s END TRACEBACK"%message)
  56
  57     def log_exc_critical(self,message):
  58         self.critical("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
  59         self.critical("%s END TRACEBACK"%message)
  60
  61     # for investigation purposes, can be placed anywhere
  62     def log_stack(self,message):
  63         to_log="".join(traceback.format_stack())
  64         self.debug("%s BEG STACK"%message+"\n"+to_log)
  65         self.debug("%s END STACK"%message)
  66
  67 sfa_logger=_SfaLogger(logfile='/var/log/sfa.log')
  68 sfa_import_logger=_SfaLogger(logfile='/var/log/sfa_import.log')
  69 console_logger=_SfaLogger()
  70
  71 ########################################
  72 import time
  73
  74 def profile(logger):
  75     """
  76     Prints the runtime of the specified callable. Use as a decorator, e.g.,
  77
  78     @profile(logger)
  79     def foo(...):
  80         ...
  81     """
  82     def logger_profile(callable):
  83         def wrapper(*args, **kwds):
  84             start = time.time()
  85             result = callable(*args, **kwds)
  86             end = time.time()
  87             args = map(str, args)
  88             args += ["%s = %s" % (name, str(value)) for (name, value) in kwds.items()]
  89             # should probably use debug, but then debug is not always enabled
  90             logger.info("PROFILED %s (%s): %.02f s" % (callable.__name__, ", ".join(args), end - start))
  91             return result
  92         return wrapper
  93     return logger_profile
  94
  95
  96 if __name__ == '__main__':
  97     print 'testing sfalogging into logger.log'
  98     logger=_SfaLogger('logger.log')
  99     logger.critical("logger.critical")
 100     logger.error("logger.error")
 101     logger.warning("logger.warning")
 102     logger.info("logger.info")
 103     logger.debug("logger.debug")
 104     logger.setLevel(logging.DEBUG)
 105     logger.debug("logger.debug again")
 106
 107     @profile(console_logger)
 108     def sleep(seconds = 1):
 109         time.sleep(seconds)
 110
 111
 112     console_logger.info('console.info')
 113     sleep(0.5)
 114     console_logger.setLevel(logging.DEBUG)
 115     sleep(0.25)