Add logging support to procman module.

[software/pymin.git] / pymin / procman.py

diff --git a/pymin/procman.py b/pymin/procman.py
index 810481d3a2c9c8ada37f2515aae06a8a53190305..dfa7873a1c2d840184e2ac84e54ca8d5a527f103 100644 (file)
--- a/pymin/procman.py
+++ b/pymin/procman.py
@@ -4,6 +4,10 @@ import os
 import errno
 import signal
 import subprocess
 import errno
 import signal
 import subprocess

+import logging ; log = logging.getLogger('pymin.procman')
+
+__ALL__ = ('ProcessManager', 'manager', 'register', 'unregister', 'call',
+           'start', 'stop', 'kill', 'get', 'has', 'sigchild_handler')

 
 class ProcessInfo:
     def __init__(self, name, command, callback=None, persist=False,
 
 class ProcessInfo:
     def __init__(self, name, command, callback=None, persist=False,


@@ -23,13 +27,13 @@ class ProcessInfo:
         self.signal = None
         self.process = None
         self.error_count = 0
         self.signal = None
         self.process = None
         self.error_count = 0

-        self.last_return = None

         self.running = False
     def start(self):
         assert self.process is None
         self.restart()
     def restart(self):
         self.clear()
         self.running = False
     def start(self):
         assert self.process is None
         self.restart()
     def restart(self):
         self.clear()

+        log.debug(u'ProcessInfo.restart(): executing %s', self.command)

         self.process = subprocess.Popen(self.command, *self.args, **self.kw)
         self.running = True
     def stop(self):
         self.process = subprocess.Popen(self.command, *self.args, **self.kw)
         self.running = True
     def stop(self):


@@ -42,8 +46,10 @@ class ProcessInfo:
             # Stop it
             self.kill(signal.SIGTERM)
     def kill(self, signum):
             # Stop it
             self.kill(signal.SIGTERM)
     def kill(self, signum):

+        log.debug(u'ProcessInfo.kill(): killing pid %s with signal %s',
+                      self.process.pid, signum)

         assert self.process is not None
         assert self.process is not None

-        os.kill(pi.process.pid, signum)
+        os.kill(self.process.pid, signum)

         self.signal = signum
     def __repr__(self):
         pid = None
         self.signal = signum
     def __repr__(self):
         pid = None


@@ -59,13 +65,17 @@ class ProcessManager:
         self.services = dict()
         self.namemap = dict()
         self.pidmap = dict()
         self.services = dict()
         self.namemap = dict()
         self.pidmap = dict()

+        log.debug(u'ProcessManager()')

 
     def register(self, name, command, callback=None, persist=False,
                        *args, **kw):
 
     def register(self, name, command, callback=None, persist=False,
                        *args, **kw):

+        log.debug(u'ProcessManager.register(%s, %s, %s, %s, %s, %s)',
+                      name, command, callback, persist, args, kw)

         self.services[name] = ProcessInfo(name, command, callback, persist,
                                           args, kw)
 
     def unregister(self, name):
         self.services[name] = ProcessInfo(name, command, callback, persist,
                                           args, kw)
 
     def unregister(self, name):

+        log.debug(u'ProcessManager.unregister(%s)', name)

         del self.services[name]
 
     def _call(self, pi):
         del self.services[name]
 
     def _call(self, pi):


@@ -73,42 +83,73 @@ class ProcessManager:
         self.namemap[pi.name] = self.pidmap[pi.process.pid] = pi
 
     def call(self, name, command, callback=None, persist=False, *args, **kw):
         self.namemap[pi.name] = self.pidmap[pi.process.pid] = pi
 
     def call(self, name, command, callback=None, persist=False, *args, **kw):

+        log.debug(u'ProcessManager.call(%s, %s, %s, %s, %s, %s)',
+                      name, command, callback, persist, args, kw)

         pi = ProcessInfo(name, command, callback, persist, args, kw)
         self._call(pi)
 
     def start(self, name):
         pi = ProcessInfo(name, command, callback, persist, args, kw)
         self._call(pi)
 
     def start(self, name):

+        log.debug(u'ProcessManager.start(%s)', name)

         assert name not in self.namemap
         self._call(self.services[name])
 
     def stop(self, name):
         assert name not in self.namemap
         self._call(self.services[name])
 
     def stop(self, name):

+        log.debug(u'ProcessManager.stop(%s)', name)

         assert name in self.namemap
         assert name in self.namemap

-        self.namemap[name].stop(name)
+        self.namemap[name].stop()
+
+    def restart(self, name):
+        log.debug(u'ProcessManager.restart(%s)', name)
+        if name in self.namemap:
+            self.namemap[name].stop()
+            self.namemap[name].wait()
+            self.namemap[name].restart()
+        else:
+            self.namemap[name].start()

 
     def kill(self, name, signum):
 
     def kill(self, name, signum):

+        log.debug(u'ProcessManager.kill(%s, %s)', name, signum)

         assert name in self.namemap
         self.namemap[name].kill(name, stop)
 
         assert name in self.namemap
         self.namemap[name].kill(name, stop)
 

-    def sigchild_handler(self, signum):
+    def sigchild_handler(self, signum, stack_frame=None):
+        log.debug(u'ProcessManager.sigchild_handler(%s)', signum)

         try:
             (pid, status) = os.waitpid(-1, os.WNOHANG)
         except OSError, e:
         try:
             (pid, status) = os.waitpid(-1, os.WNOHANG)
         except OSError, e:

-            if e.errno is e.ECHILD:
+            log.debug(u'ProcessManager.sigchild_handler(): OSError')
+            if e.errno is errno.ECHILD:
+                log.debug(u'ProcessManager.sigchild_handler(): OSError ECHILD')

                 return
             raise
                 return
             raise

+        log.debug(u'ProcessManager.sigchild_handler: pid=%s, status=%s',
+                      pid, status)

         while pid:
             if pid in self.pidmap:
                 p = self.pidmap[pid]
         while pid:
             if pid in self.pidmap:
                 p = self.pidmap[pid]

+                p.process.returncode = status

                 if p.callback is not None:
                 if p.callback is not None:

+                    log.debug(u'ProcessManager.sigchild_handler: '
+                                  u'calling %s(%s)', p.callback.__name__, p)

                     p.callback(self, p)
                 if p.dont_run or not p.persist or p.error_count >= p.max_errors:
                     p.callback(self, p)
                 if p.dont_run or not p.persist or p.error_count >= p.max_errors:

+                    log.debug(u"ProcessManager.sigchild_handler: can't "
+                            u'persist, dont_run=%s, persist=%s, error_cout=%s, '
+                            u'max_errors=%s', p.dont_run, p.persist,
+                            p.error_count, p.max_errors)

                     del self.namemap[p.name]
                     del self.pidmap[pid]
                     p.clear()
                 else:
                     del self.namemap[p.name]
                     del self.pidmap[pid]
                     p.clear()
                 else:

+                    log.debug(u'ProcessManager.sigchild_handler: persist')

                     if p.process.returncode == 0:
                         p.error_count = 0
                     if p.process.returncode == 0:
                         p.error_count = 0

+                        log.debug(u'ProcessManager.sigchild_handler: '
+                                u'return OK, resetting error_count')

                     else:
                         p.error_count += 1
                     else:
                         p.error_count += 1

+                        log.debug(u'ProcessManager.sigchild_handler: return'
+                                u'not 0, error_count + 1 = %s', p.error_count)

                     del self.pidmap[pid]
                     p.restart()
                     self.pidmap[p.process.pid] = p
                     del self.pidmap[pid]
                     p.restart()
                     self.pidmap[p.process.pid] = p


@@ -119,7 +160,7 @@ class ProcessManager:
                     return
                 raise
 
                     return
                 raise
 

-    def __getitem__(self, name):
+    def get(self, name):

         if isinstance(name, basestring): # is a name
             if name in self.namemap:
                 return self.namemap[name]
         if isinstance(name, basestring): # is a name
             if name in self.namemap:
                 return self.namemap[name]


@@ -128,9 +169,9 @@ class ProcessManager:
         else: # is a pid
             if name in self.pidmap:
                 return self.pidmap[name]
         else: # is a pid
             if name in self.pidmap:
                 return self.pidmap[name]

-        return KeyError, name
+        raise KeyError, name

 
 

-    def __contains__(self, name):
+    def has(self, name):

         if isinstance(name, basestring): # is a name
             if name in self.namemap:
                 return True
         if isinstance(name, basestring): # is a name
             if name in self.namemap:
                 return True


@@ -141,6 +182,33 @@ class ProcessManager:
                 return True
         return False
 
                 return True
         return False
 

+    def __getitem__(self, name):
+        return self.get(name)
+
+    def __contains__(self, name):
+        return self.has(name)
+
+
+if __name__ == '__main__':
+    logging.basicConfig(
+        level   = logging.DEBUG,
+        format  = '%(asctime)s %(levelname)-8s %(message)s',
+        datefmt = '%H:%M:%S',
+    )
+
+
+# Globals
+manager = ProcessManager()
+register = manager.register
+unregister = manager.unregister
+call = manager.call
+start = manager.start
+stop = manager.stop
+kill = manager.kill
+get = manager.get
+has = manager.has
+sigchild_handler = manager.sigchild_handler
+

 
 if __name__ == '__main__':
 
 
 if __name__ == '__main__':
 


@@ -150,7 +218,7 @@ if __name__ == '__main__':
     sig = None
     count = 0
 
     sig = None
     count = 0
 

-    def sigchild_handler(signum, stacktrace):
+    def SIGCHLD_handler(signum, stacktrace):

         global sig
         sig = signum
         print 'SIGCHLD', signum
         global sig
         sig = signum
         print 'SIGCHLD', signum


@@ -166,21 +234,19 @@ if __name__ == '__main__':
                 pm.start('test2')
         print 'died:', pi.name, pi.command
 
                 pm.start('test2')
         print 'died:', pi.name, pi.command
 

-    procman = ProcessManager()
-
-    procman.register('test-service', ('sleep', '2'), notify, True)
-    procman.register('test2', ('sleep', '3'), notify, False)
+    register('test-service', ('sleep', '2'), notify, True)
+    register('test2', ('sleep', '3'), notify, False)

 
 

-    signal.signal(signal.SIGCHLD, sigchild_handler)
+    signal.signal(signal.SIGCHLD, SIGCHLD_handler)

 
 

-    procman.call('test', ('sleep', '5'), notify)
-    procman.start('test-service')
+    call('test', ('sleep', '5'), notify)
+    start('test-service')

 
 

-    print "Esperando...", [pi.name for pi in procman.namemap.values()]
-    while procman.pidmap:
+    print "Esperando...", [pi.name for pi in manager.namemap.values()]
+    while manager.pidmap:

         signal.pause()
         if sig == signal.SIGCHLD:
         signal.pause()
         if sig == signal.SIGCHLD:

+            sigchild_handler(sig)

             sig = None
             sig = None

-            procman.sigchild_handler(sig)
-        print "Esperando...", [pi.name for pi in procman.namemap.values()]
+        print "Esperando...", [pi.name for pi in manager.namemap.values()]