X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=sfa%2Futil%2Fsfalogging.py;h=9afc334b4d94e4bcf991a3b14857f4363f0192d7;hb=0a187639a1d00549ccc45fe0436fa972955207fe;hp=e2aaaeeb2b074aeb61f2422034b6dfcade1cde14;hpb=db84b3ddccc2a04da661a384734c510eb55729c6;p=sfa.git diff --git a/sfa/util/sfalogging.py b/sfa/util/sfalogging.py index e2aaaeeb..9afc334b 100644 --- a/sfa/util/sfalogging.py +++ b/sfa/util/sfalogging.py @@ -1,14 +1,197 @@ +#!/usr/bin/env python3 + +""" +A reroutable logger that can handle deep tracebacks + +Requirements: + +* for legacy, we want all our code to just do: + + from sfa.util.sfalogging import logger + ... + logger.info('blabla') + +* depending on whether the code runs (a) inside the server, + (b) as part of sfa-import, or (c) as part of the sfi CLI, + we want these messages to be directed in different places + +* also because troubleshooting is very painful, we need a better way + to report stacks when an exception occurs. + +Implementation: + +* we use a single unique logger name 'sfa' (wrt getLogger()), + and provide an auxiliary function `init_logger()` that + accepts for its `context` parameter one of : + `server`, `import` `sfi` or `console` + It will then reconfigure the 'sfa' logger to do the right thing + +* also we create our own subclass of loggers, and install it + with logging.setLoggerClass(), so we can add our own customized + `log_exc()` method + +""" + +# pylint: disable=c0111, c0103, w1201 + + + +import os +import os.path +import sys +import traceback import logging +import logging.handlers +import logging.config + +# so that users of this module don't need to import logging +from logging import (CRITICAL, ERROR, WARNING, INFO, DEBUG) + + +class SfaLogger(logging.getLoggerClass()): + """ + a rewrite of old _SfaLogger class that was way too cumbersome + keep this as much as possible though + """ + + # shorthand to avoid having to import logging all over the place + def setLevelDebug(self): + self.setLevel(DEBUG) + + def debugEnabled(self): + return self.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: + self.setLevel(logging.WARNING) + elif verbose == 1: + self.setLevel(logging.INFO) + elif verbose >= 2: + self.setLevel(logging.DEBUG) + + # in case some other code needs a boolean + @staticmethod + def getBoolVerboseFromOpt(verbose): + return verbose >= 1 + + @staticmethod + def getBoolDebugFromOpt(verbose): + return verbose >= 2 + + def log_exc(self, message, limit=100): + """ + standard logger has an exception() method but this will + dump the stack only between the frames + (1) that does `raise` and (2) the one that does `except` + + log_exc() has a limit argument that allows to see deeper than that + + use limit=None to get the same behaviour as exception() + """ + self.error("%s BEG TRACEBACK" % message + "\n" + + traceback.format_exc(limit=limit).strip("\n")) + self.error("%s END TRACEBACK" % message) + + # for investigation purposes, can be placed anywhere + def log_stack(self, message, limit=100): + to_log = "".join(traceback.format_stack(limit=limit)) + self.info("%s BEG STACK" % message + "\n" + to_log) + self.info("%s END STACK" % message) + + def enable_console(self): + formatter = logging.Formatter("%(message)s") + handler = logging.StreamHandler(sys.stdout) + handler.setFormatter(formatter) + self.addHandler(handler) + + +# install our class as the default +logging.setLoggerClass(SfaLogger) + + +# configure +# this is *NOT* passed to dictConfig as-is +# instead we filter 'handlers' and 'loggers' +# to contain just one entry +# so make sure that 'handlers' and 'loggers' +# have the same set of keys +def logging_config(context): + if context == 'server': + # use stdout and let journalctl do the heavy lifting + handlername = 'stdout' + #filename = '/var/log/sfa.log' + level = 'DEBUG' + elif context == 'import': + handlername = 'file' + filename = '/var/log/sfa-import.log' + level = 'INFO' + elif context == 'cli': + handlername = 'file' + filename = os.path.expanduser("~/.sfi.log") + level = 'DEBUG' + elif context == 'console': + handlername = 'stdout' + #filename = 'ignored' + level = 'INFO' + else: + print("Cannot configure logging - exiting") + exit(1) + + config = { + 'version': 1, + # IMPORTANT: we may be imported by something else, so: + 'disable_existing_loggers': False, + 'formatters': { + 'standard': { + 'datefmt': '%m-%d %H:%M:%S', + 'format': ('%(asctime)s %(levelname)s ' + '%(filename)s:%(lineno)d %(message)s'), + }, + }, + # fill in later with just the one needed + # otherwise a dummy 'ignored' file gets created + 'handlers': { + }, + 'loggers': { + 'sfa': { + 'handlers': [handlername], + 'level': level, + 'propagate': False, + }, + }, + } + if handlername == 'stdout': + config['handlers']['stdout'] = { + 'level': level, + 'formatter': 'standard', + 'class': 'logging.StreamHandler', + } + else: + config['handlers']['file'] = { + 'filename': filename, + 'level': level, + 'formatter': 'standard', + 'class': 'logging.handlers.TimedRotatingFileHandler', + # every monday and during 3 months + 'when': 'w0', + 'interval': 1, + 'backupCount': 12, + } + return config + + +logger = logging.getLogger('sfa') + -#SFA access log initialization +def init_logger(context): + logging.config.dictConfig(logging_config(context)) -SFA_ACCESS_LOGFILE='/var/log/sfa_access.log' -logger=logging.getLogger() -logger.setLevel(logging.INFO) -logfile=logging.FileHandler(SFA_ACCESS_LOGFILE) -formatter = logging.Formatter("%(asctime)s - %(message)s") -logfile.setFormatter(formatter) -logger.addHandler(logfile) -def get_sfa_logger(): - return logger +# if the user process does not do anything +# like for the miscell testers and other certificate +# probing/dumping utilities +init_logger('console')