3 #----------------------------------------------------------------------
4 # Copyright (c) 2008 Board of Trustees, Princeton University
6 # Permission is hereby granted, free of charge, to any person obtaining
7 # a copy of this software and/or hardware specification (the "Work") to
8 # deal in the Work without restriction, including without limitation the
9 # rights to use, copy, modify, merge, publish, distribute, sublicense,
10 # and/or sell copies of the Work, and to permit persons to whom the Work
11 # is furnished to do so, subject to the following conditions:
13 # The above copyright notice and this permission notice shall be
14 # included in all copies or substantial portions of the Work.
16 # THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 # OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
24 #----------------------------------------------------------------------
28 import logging, logging.handlers
30 CRITICAL=logging.CRITICAL
32 WARNING=logging.WARNING
36 # a logger that can handle tracebacks
38 def __init__ (self,logfile=None,loggername=None,level=logging.INFO):
39 # default is to locate loggername from the logfile if avail.
42 #handler=logging.StreamHandler()
43 #handler.setFormatter(logging.Formatter("%(levelname)s %(message)s"))
44 logfile = "/var/log/sfa.log"
47 loggername=os.path.basename(logfile)
49 handler=logging.handlers.RotatingFileHandler(logfile,maxBytes=1000000, backupCount=5)
51 # This is usually a permissions error becaue the file is
52 # owned by root, but httpd is trying to access it.
53 tmplogfile=os.getenv("TMPDIR", "/tmp") + os.path.sep + os.path.basename(logfile)
54 # In strange uses, 2 users on same machine might use same code,
55 # meaning they would clobber each others files
56 # We could (a) rename the tmplogfile, or (b)
57 # just log to the console in that case.
58 # Here we default to the console.
59 if os.path.exists(tmplogfile) and not os.access(tmplogfile,os.W_OK):
60 loggername = loggername + "-console"
61 handler = logging.StreamHandler()
63 handler=logging.handlers.RotatingFileHandler(tmplogfile,maxBytes=1000000, backupCount=5)
64 handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s"))
65 self.logger=logging.getLogger(loggername)
66 self.logger.setLevel(level)
67 # check if logger already has the handler we're about to add
68 handler_exists = False
69 for l_handler in self.logger.handlers:
70 if l_handler.baseFilename == handler.baseFilename and \
71 l_handler.level == handler.level:
74 if not handler_exists:
75 self.logger.addHandler(handler)
77 self.loggername=loggername
79 def setLevel(self,level):
80 self.logger.setLevel(level)
82 # shorthand to avoid having to import logging all over the place
83 def setLevelDebug(self):
84 self.logger.setLevel(logging.DEBUG)
86 # define a verbose option with s/t like
87 # parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0)
88 # and pass the coresponding options.verbose to this method to adjust level
89 def setLevelFromOptVerbose(self,verbose):
91 self.logger.setLevel(logging.WARNING)
93 self.logger.setLevel(logging.INFO)
95 self.logger.setLevel(logging.DEBUG)
96 # in case some other code needs a boolean
97 def getBoolVerboseFromOpt(self,verbose):
102 self.logger.info(msg)
104 def debug(self, msg):
105 self.logger.debug(msg)
108 self.logger.warn(msg)
110 # some code is using logger.warn(), some is using logger.warning()
111 def warning(self, msg):
112 self.logger.warning(msg)
114 def error(self, msg):
115 self.logger.error(msg)
117 def critical(self, msg):
118 self.logger.critical(msg)
120 # logs an exception - use in an except statement
121 def log_exc(self,message):
122 self.error("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
123 self.error("%s END TRACEBACK"%message)
125 def log_exc_critical(self,message):
126 self.critical("%s BEG TRACEBACK"%message+"\n"+traceback.format_exc().strip("\n"))
127 self.critical("%s END TRACEBACK"%message)
129 # for investigation purposes, can be placed anywhere
130 def log_stack(self,message):
131 to_log="".join(traceback.format_stack())
132 self.info("%s BEG STACK"%message+"\n"+to_log)
133 self.info("%s END STACK"%message)
135 def enable_console(self, stream=sys.stdout):
136 formatter = logging.Formatter("%(message)s")
137 handler = logging.StreamHandler(stream)
138 handler.setFormatter(formatter)
139 self.logger.addHandler(handler)
142 info_logger = _SfaLogger(loggername='info', level=logging.INFO)
143 debug_logger = _SfaLogger(loggername='debug', level=logging.DEBUG)
144 warn_logger = _SfaLogger(loggername='warning', level=logging.WARNING)
145 error_logger = _SfaLogger(loggername='error', level=logging.ERROR)
146 critical_logger = _SfaLogger(loggername='critical', level=logging.CRITICAL)
148 sfi_logger = _SfaLogger(logfile=os.path.expanduser("~/.sfi/")+'sfi.log',loggername='sfilog', level=logging.DEBUG)
149 ########################################
154 Prints the runtime of the specified callable. Use as a decorator, e.g.,
160 def logger_profile(callable):
161 def wrapper(*args, **kwds):
163 result = callable(*args, **kwds)
165 args = map(str, args)
166 args += ["%s = %s" % (name, str(value)) for (name, value) in kwds.iteritems()]
167 # should probably use debug, but then debug is not always enabled
168 logger.info("PROFILED %s (%s): %.02f s" % (callable.__name__, ", ".join(args), end - start))
171 return logger_profile
174 if __name__ == '__main__':
175 print 'testing sfalogging into logger.log'
176 logger1=_SfaLogger('logger.log', loggername='std(info)')
177 logger2=_SfaLogger('logger.log', loggername='error', level=logging.ERROR)
178 logger3=_SfaLogger('logger.log', loggername='debug', level=logging.DEBUG)
180 for (logger,msg) in [ (logger1,"std(info)"),(logger2,"error"),(logger3,"debug")]:
182 print "====================",msg, logger.logger.handlers
184 logger.enable_console()
185 logger.critical("logger.critical")
186 logger.error("logger.error")
187 logger.warn("logger.warning")
188 logger.info("logger.info")
189 logger.debug("logger.debug")
190 logger.setLevel(logging.DEBUG)
191 logger.debug("logger.debug again")
194 def sleep(seconds = 1):
197 logger.info('console.info')
199 logger.setLevel(logging.DEBUG)