Skip to main content

monitoring

Contains functionality for interacting with the task monitoring service.

A monitor module is available globally when running within a task's context (created by task_monitor_context()); outside of this context calls to the monitor module will fail as no task is in progress and hence no task ID is available.

Attempting to instantiate a second monitor module (i.e. running a second task context) will raise an exception.

Interacting with the monitor module is achieved by utilising the appropriate functions to send a desired update. These will only work within a task context.

Decorator versions of stateless functions are available in monitoring.decorators; these can be applied to functions/methods and will make the appropriate monitor service update when those functions or methods are called.

Module​

Submodules​