logger.py

   1
   2 """A very simple logger that tries to be concurrency-safe."""
   3
   4 import os, sys
   5 import time
   6 import traceback
   7 import subprocess
   8 import select
   9
  10 LOG_FILE    = '/var/log/nodemanager'
  11 LOG_SLIVERS = '/var/lib/nodemanager/getslivers.txt'
  12 LOG_DATABASE = '/var/lib/nodemanager/database.txt'
  13
  14 # basically define 3 levels
  15 LOG_NONE=0
  16 LOG_NODE=1
  17 LOG_VERBOSE=2
  18 # default is to log a reasonable amount of stuff for when running on operational nodes
  19 LOG_LEVEL=LOG_NODE
  20
  21 def set_level(level):
  22     global LOG_LEVEL
  23     try:
  24         assert level in [LOG_NONE,LOG_NODE,LOG_VERBOSE]
  25         LOG_LEVEL=level
  26     except:
  27         logger.log("Failed to set LOG_LEVEL to %s"%level)
  28
  29 def verbose(msg):
  30     log('(v) '+msg,LOG_VERBOSE)
  31
  32 def log(msg,level=LOG_NODE):
  33     """Write <msg> to the log file if level >= current log level (default LOG_NODE)."""
  34     if (level > LOG_LEVEL):
  35         return
  36     try:
  37         fd = os.open(LOG_FILE, os.O_WRONLY | os.O_CREAT | os.O_APPEND, 0600)
  38         if not msg.endswith('\n'): msg += '\n'
  39         os.write(fd, '%s: %s' % (time.asctime(time.gmtime()), msg))
  40         os.close(fd)
  41     except OSError:
  42         sys.stderr.write(msg)
  43         sys.stderr.flush()
  44
  45 def log_exc(msg="",name=None):
  46     """Log the traceback resulting from an exception."""
  47     if name:
  48         log("%s: EXCEPTION caught <%s> \n %s" %(name, msg, traceback.format_exc()))
  49     else:
  50         log("EXCEPTION caught <%s> \n %s" %(msg, traceback.format_exc()))
  51
  52 ########## snapshot data to a file
  53 # for some reason the various modules are still triggered even when the
  54 # data from PLC cannot be reached
  55 # we show this message instead of the exception stack instead in this case
  56 def log_missing_data (msg,key):
  57     log("%s: could not find the %s key in data (PLC connection down?) - IGNORED"%(msg,key))
  58
  59 def log_data_in_file (data, file, message="",level=LOG_NODE):
  60     if (level > LOG_LEVEL):
  61         return
  62     import pprint, time
  63     try:
  64         f=open(file,'w')
  65         now=time.strftime("Last update: %Y.%m.%d at %H:%M:%S %Z", time.localtime())
  66         f.write(now+'\n')
  67         if message: f.write('Message:'+message+'\n')
  68         pp=pprint.PrettyPrinter(stream=f,indent=2)
  69         pp.pprint(data)
  70         f.close()
  71         verbose("logger:.log_data_in_file Owerwrote %s"%file)
  72     except:
  73         log_exc('logger.log_data_in_file failed - file=%s - message=%r'%(file,message))
  74
  75 def log_slivers (data):
  76     log_data_in_file (data, LOG_SLIVERS, "raw GetSlivers")
  77 def log_database (db):
  78     log_data_in_file (db, LOG_DATABASE, "raw database")
  79
  80 #################### child processes
  81 # avoid waiting until the process returns;
  82 # that makes debugging of hanging children hard
  83
  84 class Buffer:
  85     def __init__ (self,message='log_call: '):
  86         self.buffer=''
  87         self.message=message
  88
  89     def add (self,c):
  90         self.buffer += c
  91         if c=='\n': self.flush()
  92
  93     def flush (self):
  94         if self.buffer:
  95             log (self.message + self.buffer)
  96             self.buffer=''
  97
  98 # time out in seconds - avoid hanging subprocesses - default is 5 minutes
  99 default_timeout_minutes=5
 100
 101 # returns a bool that is True when everything goes fine and the retcod is 0
 102 def log_call(command,timeout=default_timeout_minutes*60,poll=1):
 103     message=" ".join(command)
 104     log("log_call: running command %s" % message)
 105     verbose("log_call: timeout=%r s" % timeout)
 106     verbose("log_call: poll=%r s" % poll)
 107     trigger=time.time()+timeout
 108     result = False
 109     try:
 110         child = subprocess.Popen(command, bufsize=1,
 111                                  stdout=subprocess.PIPE, stderr=subprocess.STDOUT, close_fds=True)
 112         buffer = Buffer()
 113         while True:
 114             # see if anything can be read within the poll interval
 115             (r,w,x)=select.select([child.stdout],[],[],poll)
 116             if r: buffer.add(child.stdout.read(1))
 117             # is process over ?
 118             returncode=child.poll()
 119             # yes
 120             if returncode != None:
 121                 buffer.flush()
 122                 # child is done and return 0
 123                 if returncode == 0:
 124                     log("log_call:end command (%s) completed" % message)
 125                     result=True
 126                     break
 127                 # child has failed
 128                 else:
 129                     log("log_call:end command (%s) returned with code %d" %(message,returncode))
 130                     break
 131             # no : still within timeout ?
 132             if time.time() >= trigger:
 133                 buffer.flush()
 134                 child.terminate()
 135                 log("log_call:end terminating command (%s) - exceeded timeout %d s"%(message,timeout))
 136                 break
 137     except: log_exc("failed to run command %s" % message)
 138     return result