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