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