Package Ganga :: Package Lib :: Package MonitoringServices :: Package JobExecutionMonitorMS :: Module JobExecutionMonitorMS' :: Class JobExecutionMonitorMS
[hide private]
[frames] | no frames]

Class JobExecutionMonitorMS

source code

GPIDev.Adapters.IMonitoringService.IMonitoringService --+
                                                        |
                                                       JobExecutionMonitorMS

Instance Methods [hide private]
 
__getJEMobject(self)
Get the JEMMonitoringServiceHandler object that implements the callbacks defined in IMonitoringService on a per-job basis
source code
 
__handleError(self) source code
 
__init__(self, job_info)
Initialize the monitoring service.
source code
 
complete(self, **opts)
Completion of a job.
source code
 
fail(self, **opts)
Failure of a job.
source code
 
getSandboxModules(self)
Get the list of module dependencies of this monitoring module.
source code
 
kill(self, **opts)
Killing of a job.
source code
 
prepare(self, **opts)
Preparation of a job.
source code
 
rollback(self, **opts)
Rollback of a job to new state (caused by error during submission).
source code
 
submit(self, **opts)
Submission of a job.
source code
 
submitting(self, **opts)
Just before the submission of a job.
source code

Inherited from GPIDev.Adapters.IMonitoringService.IMonitoringService: event, getJobInfo, getWrapperScriptConstructorText, progress, start, stop

Static Methods [hide private]

Inherited from GPIDev.Adapters.IMonitoringService.IMonitoringService: getConfig

Method Details [hide private]

__init__(self, job_info)
(Constructor)

source code 

Initialize the monitoring service.

If the monitoring service is created in the Ganga client then job_info is the original job object, and config_info is the original config object returned by getConfig().

If the monitoring service is created on the worker node then job_info is the return value of getJobInfo(), and config_info is the return value of getConfig().getEffectiveOptions(), i.e. a dictionary.

In order to support existing monitoring classes, which do not use config_info, if getConfig() returns None, the constructor is called with only the job_info argument.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.__init__
(inherited documentation)

complete(self, **opts)

source code 

Completion of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.complete
(inherited documentation)

fail(self, **opts)

source code 

Failure of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.fail
(inherited documentation)

getSandboxModules(self)

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

Returns a list of modules which are imported by this module and
therefore must be shipped automatically to the worker node. The list
should include the module where this class is defined plus all modules
which represent the parent packages. The module containing the
IMonitoringService class is added automatically by the call to the
base class sandBoxModule() method. An example for a class defined in
the module Ganga/Lib/MonitoringServices/DummyMS/DummyMS.py which does
not have any further dependencies:

import Ganga.Lib.MonitoringServices.DummyMS
return IMonitoringService.getSandboxModules(self) + [
         Ganga,
         Ganga.Lib,
         Ganga.Lib.MonitoringServices,
         Ganga.Lib.MonitoringServices.DummyMS,
         Ganga.Lib.MonitoringServices.DummyMS.DummyMS
        ]
Note, that it should be possible to import all parent modules without side effects (so without importing automatically their other children).

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.getSandboxModules
(inherited documentation)

kill(self, **opts)

source code 

Killing of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.kill
(inherited documentation)

prepare(self, **opts)

source code 

Preparation of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.prepare
(inherited documentation)

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
(inherited documentation)

submit(self, **opts)

source code 

Submission of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.submit
(inherited documentation)

submitting(self, **opts)

source code 

Just before the submission of a job. Called by: ganga client.

Overrides: GPIDev.Adapters.IMonitoringService.IMonitoringService.submitting
(inherited documentation)