Class GathererService

source code

 twisted.application.service.Service --+        
                                       |        
twisted.application.service.MultiService --+    
                                           |    
                          object --+       |    
                                   |       |    
     referenceable.OnlyReferenceable --+   |    
                                       |   |    
             referenceable.Referenceable --+    
                                           |    
                               GatheringBase --+
                                               |
                                              GathererService

Run a service that gathers logs from multiple applications.

The LogGatherer sits in a corner and receives log events from many applications at once. At startup, it runs a Tub and emits the gatherer's long-term FURL. You can then configure your applications to connect to this FURL when they start and pass it a reference to their LogPublisher. The gatherer will subscribe to the publisher and save all the resulting messages in a logs.pickle file.

Applications can use code like the following to create a LogPublisher and pass it to the gatherer:

def tub_ready(self):
    # called when the Tub is available for registerReference
    lp = LogPublisher('logport.furl')
    lp.setServiceParent(self.tub)
    log_gatherer_furl = self.get_config('log_gatherer.furl')
    if log_gatherer_furl:
        self.tub.connectTo(log_gatherer_furl,
                           self._log_gatherer_connected, lp)

def _log_gatherer_connected(self, rref, lp):
    rref.callRemote('logport', self.nodeid, lp)

This LogGatherer class is meant to be run by twistd from a .tac file, but applications that want to provide the same functionality can just instantiate it with a distinct basedir= and call startService.