X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=sfa%2Futil%2Fsfalogging.py;h=2b7d78232a7479687c0bd84d838f63055513fe6b;hb=04a3f20dc71bf8b3f96b1e3172623aa346a638a7;hp=9d43d91d7c6f52d810dd977b3ae4f14f49323096;hpb=99e9f96209b9ebfd1853e7b8902a1a0fe893eaa2;p=sfa.git diff --git a/sfa/util/sfalogging.py b/sfa/util/sfalogging.py old mode 100755 new mode 100644 index 9d43d91d..2b7d7823 --- a/sfa/util/sfalogging.py +++ b/sfa/util/sfalogging.py @@ -1,124 +1,187 @@ #!/usr/bin/python -import os, sys +#---------------------------------------------------------------------- +# Copyright (c) 2008 Board of Trustees, Princeton University +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and/or hardware specification (the "Work") to +# deal in the Work without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Work, and to permit persons to whom the Work +# is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be +# included in all copies or substantial portions of the Work. +# +# THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS +# IN THE WORK. +#---------------------------------------------------------------------- + +from __future__ import print_function + +import os +import sys import traceback -import logging, logging.handlers +import logging +import logging.handlers + +CRITICAL = logging.CRITICAL +ERROR = logging.ERROR +WARNING = logging.WARNING +INFO = logging.INFO +DEBUG = logging.DEBUG + +# a logger that can handle tracebacks -CRITICAL=logging.CRITICAL -ERROR=logging.ERROR -WARNING=logging.WARNING -INFO=logging.INFO -DEBUG=logging.DEBUG -# a logger that can handle tracebacks class _SfaLogger: - def __init__ (self,logfile=None,loggername=None,level=logging.INFO): + + def __init__(self, logfile=None, loggername=None, level=logging.INFO): # default is to locate loggername from the logfile if avail. if not logfile: - loggername='console' - handler=logging.StreamHandler() - handler.setFormatter(logging.Formatter("%(levelname)s %(message)s")) - else: - if not loggername: - loggername=os.path.basename(logfile) - try: - handler=logging.handlers.RotatingFileHandler(logfile,maxBytes=1000000, backupCount=5) - except IOError: - # This is usually a permissions error becaue the file is - # owned by root, but httpd is trying to access it. - tmplogfile=os.getenv("TMPDIR", "/tmp") + os.path.sep + os.path.basename(logfile) - handler=logging.handlers.RotatingFileHandler(tmplogfile,maxBytes=1000000, backupCount=5) - handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")) - - self.logger=logging.getLogger(loggername) + # loggername='console' + # handler=logging.StreamHandler() + #handler.setFormatter(logging.Formatter("%(levelname)s %(message)s")) + logfile = "/var/log/sfa.log" + + if not loggername: + loggername = os.path.basename(logfile) + try: + handler = logging.handlers.RotatingFileHandler( + logfile, maxBytes=1000000, backupCount=5) + except IOError: + # This is usually a permissions error because the file is + # owned by root, but httpd is trying to access it. + tmplogfile = os.path.join(os.getenv("TMPDIR", + os.getenv("TMP", os.path.normpath("/tmp"))), + os.path.basename(logfile)) + tmplogfile = os.path.normpath(tmplogfile) + + tmpdir = os.path.dirname(tmplogfile) + if tmpdir and tmpdir != "" and not os.path.exists(tmpdir): + os.makedirs(tmpdir) + + # In strange uses, 2 users on same machine might use same code, + # meaning they would clobber each others files + # We could (a) rename the tmplogfile, or (b) + # just log to the console in that case. + # Here we default to the console. + if os.path.exists(tmplogfile) and not os.access(tmplogfile, os.W_OK): + loggername = loggername + "-console" + handler = logging.StreamHandler() + else: + handler = logging.handlers.RotatingFileHandler( + tmplogfile, maxBytes=1000000, backupCount=5) + handler.setFormatter(logging.Formatter( + "%(asctime)s - %(levelname)s - %(message)s")) + self.logger = logging.getLogger(loggername) self.logger.setLevel(level) - self.logger.addHandler(handler) - self.loggername=loggername + # check if logger already has the handler we're about to add + handler_exists = False + for l_handler in self.logger.handlers: + if l_handler.baseFilename == handler.baseFilename and \ + l_handler.level == handler.level: + handler_exists = True - def setLevel(self,level): + if not handler_exists: + self.logger.addHandler(handler) + + self.loggername = loggername + + def setLevel(self, level): self.logger.setLevel(level) # shorthand to avoid having to import logging all over the place def setLevelDebug(self): self.logger.setLevel(logging.DEBUG) + def debugEnabled(self): + return self.logger.getEffectiveLevel() == logging.DEBUG + # define a verbose option with s/t like # parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0) # and pass the coresponding options.verbose to this method to adjust level - def setLevelFromOptVerbose(self,verbose): - if verbose==0: + def setLevelFromOptVerbose(self, verbose): + if verbose == 0: self.logger.setLevel(logging.WARNING) - elif verbose==1: + elif verbose == 1: self.logger.setLevel(logging.INFO) - elif verbose==2: + elif verbose >= 2: self.logger.setLevel(logging.DEBUG) + # in case some other code needs a boolean + + def getBoolVerboseFromOpt(self, verbose): + return verbose >= 1 + + def getBoolDebugFromOpt(self, verbose): + return verbose >= 2 #################### - def wrap(fun): - def wrapped(self,msg,*args,**kwds): - native=getattr(self.logger,fun.__name__) - return native(msg,*args,**kwds) - #wrapped.__doc__=native.__doc__ - return wrapped - - @wrap - def critical(): pass - @wrap - def error(): pass - @wrap - def warning(): pass - @wrap - def info(): pass - @wrap - def debug(): pass - + def info(self, msg): + self.logger.info(msg) + + def debug(self, msg): + self.logger.debug(msg) + + def warn(self, msg): + self.logger.warn(msg) + + # some code is using logger.warn(), some is using logger.warning() + def warning(self, msg): + self.logger.warning(msg) + + def error(self, msg): + self.logger.error(msg) + + def critical(self, msg): + self.logger.critical(msg) + # logs an exception - use in an except statement - def log_exc(self,message): - self.error("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n")) - self.error("%s END TRACEBACK"%message) - - def log_exc_critical(self,message): - self.critical("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n")) - self.critical("%s END TRACEBACK"%message) - + def log_exc(self, message): + self.error("%s BEG TRACEBACK" % message + "\n" + + traceback.format_exc().strip("\n")) + self.error("%s END TRACEBACK" % message) + + def log_exc_critical(self, message): + self.critical("%s BEG TRACEBACK" % message + "\n" + + traceback.format_exc().strip("\n")) + self.critical("%s END TRACEBACK" % message) + # for investigation purposes, can be placed anywhere - def log_stack(self,message): - to_log="".join(traceback.format_stack()) - self.debug("%s BEG STACK"%message+"\n"+to_log) - self.debug("%s END STACK"%message) - -#################### -# import-related operations go in this file -_import_logger=_SfaLogger(logfile='/var/log/sfa_import.log') -# servers log into /var/log/sfa.log -_server_logger=_SfaLogger(logfile='/var/log/sfa.log') -# clients use the console -_console_logger=_SfaLogger() - -# default is to use the server-side logger -_the_logger=_server_logger - -# clients would change the default by issuing one of these call -def sfa_logger_goes_to_console(): - current_module=sys.modules[globals()['__name__']] - current_module._the_logger=_console_logger - -# clients would change the default by issuing one of these call -def sfa_logger_goes_to_import(): - current_module=sys.modules[globals()['__name__']] - current_module._logger=_import_logger - -# this is how to retrieve the 'right' logger -def sfa_logger(): - return _the_logger + def log_stack(self, message): + to_log = "".join(traceback.format_stack()) + self.info("%s BEG STACK" % message + "\n" + to_log) + self.info("%s END STACK" % message) + + def enable_console(self, stream=sys.stdout): + formatter = logging.Formatter("%(message)s") + handler = logging.StreamHandler(stream) + handler.setFormatter(formatter) + self.logger.addHandler(handler) + +info_logger = _SfaLogger(loggername='info', level=logging.INFO) +debug_logger = _SfaLogger(loggername='debug', level=logging.DEBUG) +warn_logger = _SfaLogger(loggername='warning', level=logging.WARNING) +error_logger = _SfaLogger(loggername='error', level=logging.ERROR) +critical_logger = _SfaLogger(loggername='critical', level=logging.CRITICAL) +logger = info_logger +sfi_logger = _SfaLogger(logfile=os.path.expanduser("~/.sfi/") + 'sfi.log', + loggername='sfilog', level=logging.DEBUG) ######################################## import time + def profile(logger): """ Prints the runtime of the specified callable. Use as a decorator, e.g., - + @profile(logger) def foo(...): ... @@ -129,35 +192,40 @@ def profile(logger): result = callable(*args, **kwds) end = time.time() args = map(str, args) - args += ["%s = %s" % (name, str(value)) for (name, value) in kwds.items()] + args += ["%s = %s" % (name, str(value)) + for (name, value) in kwds.iteritems()] # should probably use debug, but then debug is not always enabled - logger.info("PROFILED %s (%s): %.02f s" % (callable.__name__, ", ".join(args), end - start)) + logger.info("PROFILED %s (%s): %.02f s" % + (callable.__name__, ", ".join(args), end - start)) return result return wrapper return logger_profile -if __name__ == '__main__': - print 'testing sfalogging into logger.log' - logger=_SfaLogger('logger.log') - logger.critical("logger.critical") - logger.error("logger.error") - logger.warning("logger.warning") - logger.info("logger.info") - logger.debug("logger.debug") - logger.setLevel(logging.DEBUG) - logger.debug("logger.debug again") - - sfa_logger_goes_to_console() - my_logger=sfa_logger() - my_logger.info("redirected to console") - - @profile(my_logger) - def sleep(seconds = 1): - time.sleep(seconds) - - my_logger.info('console.info') - sleep(0.5) - my_logger.setLevel(logging.DEBUG) - sleep(0.25) +if __name__ == '__main__': + print('testing sfalogging into logger.log') + logger1 = _SfaLogger('logger.log', loggername='std(info)') + logger2 = _SfaLogger('logger.log', loggername='error', level=logging.ERROR) + logger3 = _SfaLogger('logger.log', loggername='debug', level=logging.DEBUG) + + for logger, msg in ((logger1, "std(info)"), (logger2, "error"), (logger3, "debug")): + + print("====================", msg, logger.logger.handlers) + + logger.enable_console() + logger.critical("logger.critical") + logger.error("logger.error") + logger.warn("logger.warning") + logger.info("logger.info") + logger.debug("logger.debug") + logger.setLevel(logging.DEBUG) + logger.debug("logger.debug again") + + @profile(logger) + def sleep(seconds=1): + time.sleep(seconds) + logger.info('console.info') + sleep(0.5) + logger.setLevel(logging.DEBUG) + sleep(0.25)