Package Ganga :: Package Lib :: Package MonitoringServices :: Module Composite :: Class CompositeMonitoringService
[hide private]
[frames] | no frames]

Class CompositeMonitoringService

source code

GPIDev.Adapters.IMonitoringService.IMonitoringService --+
                                                        |
                                                       CompositeMonitoringService

IMonitoringService container: Wrapper object containing a list of IMonitoringService(s) inside and delegating the interface methods to each of them. (composite design pattern) This object is used automatically to transparently wrap the list of monitoring services set in the configuration

Instance Methods [hide private]
 
__init__(self, monClasses, jobInfos, configInfos)
Create a new composite monitoring service based on the lists of monitoring classes, jobs and configs (all the same length).
source code
 
start(self, **opts)
Application is about to start on the worker node.
source code
 
progress(self, **opts)
Application execution is in progress (called periodically, several times a second).
source code
 
stop(self, exitcode, **opts)
Application execution finished.
source code
 
prepare(self, **opts)
Preparation of a job.
source code
 
submitting(self, **opts)
Submission of a job.
source code
 
submit(self, **opts)
Submission of a job.
source code
 
complete(self, **opts)
Completion of a job.
source code
 
fail(self, **opts)
Failure of a job.
source code
 
kill(self, **opts)
Killing of a job.
source code
 
rollback(self, **opts)
Rollback of a job to new state (caused by error during submission).
source code
 
getSandboxModules(self)
Get the list of module dependencies of this monitoring module.
source code
 
getJobInfo(self)
Return a static info object which static information about the job at submission time.
source code
 
getWrapperScriptConstructorText(self)
Return a line of python source code which creates the instance of the monitoring service object to be used in the job wrapper script.
source code
 
_log(self, level='info', msg='') source code

Inherited from GPIDev.Adapters.IMonitoringService.IMonitoringService: event

Static Methods [hide private]

Inherited from GPIDev.Adapters.IMonitoringService.IMonitoringService: getConfig

Method Details [hide private]

__init__(self, monClasses, jobInfos, configInfos)
(Constructor)

source code 

Create a new composite monitoring service based on the lists of monitoring classes, jobs and configs (all the same length).

If this is called in the Ganga client, i.e. from Ganga/GPIDev/MonitoringServices, then jobInfos is a list of Job (all the same), configInfos is a list of Config (specific to each monitoring class).

If this is called on the worker node, i.e. from the text generated by getWrapperScriptConstructorText(), the jobInfos are dictionaries (specific to each monitoring class) and configInfos are dictionaries of effective config options (specific to each monitoring class).

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.__init__

start(self, **opts)

source code 

Application is about to start on the worker node. Called by: job wrapper.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.start

progress(self, **opts)

source code 

Application execution is in progress (called periodically, several times a second). Called by: job wrapper.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.progress

stop(self, exitcode, **opts)

source code 

Application execution finished. Called by: job wrapper.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.stop

prepare(self, **opts)

source code 

Preparation of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.prepare

submitting(self, **opts)

source code 

Submission of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.submitting

submit(self, **opts)

source code 

Submission of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.submit

complete(self, **opts)

source code 

Completion of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.complete

fail(self, **opts)

source code 

Failure of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.fail

kill(self, **opts)

source code 

Killing of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.kill

rollback(self, **opts)

source code 

Rollback of a job to new state (caused by error during submission). Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.rollback

getSandboxModules(self)

source code 

Get the list of module dependencies of this monitoring module. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.getSandboxModules

getJobInfo(self)

source code 
Return a static info object which static information about the job
at submission time. Called by: ganga client.

The info object is passed to the contructor. Info
object may only contain the standard python types (such as lists,
dictionaries, int, strings). 
Implementation details:
 return the job info objects as a map for each compound Monitoring Service
 @see getWrapperScriptConstructorText() method

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.getJobInfo

getWrapperScriptConstructorText(self)

source code 

Return a line of python source code which creates the instance of the monitoring service object to be used in the job wrapper script. This method should not be overriden.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.getWrapperScriptConstructorText