Table of Contents
- Asynchronous Task Processing - Developers Guide
- Simple ATP Application
- Executing ATP Task
This guide is intended to help with the creation of applications using the Asynchronous Task Processing subsystem of EOxServer.
The first part is guiding creation of the simple task producer, i.e., an application needing the asynchronous processing capabilities.
The second part helps with creation of a task consumer, i.e., the part of code pulling tasks from the work queue and executing them. The task consumer is part of Asynchronous Task Processing Daemon.
An overview of the ATP capabilities is presented in “atp_sum”. The
database model used in by the ATP subsystem is described in “Task Tracker Data Model”. The complete API reference can be found in
Here in this section we will prepare step-by-step a simple demo application making use of the ATP subsystem. The complete application is available at location:
The prerequisite of starting the application is that the correct
path to the EOxServer installation and instance is set together with the
Initially the application must import the right python objects
from eoxserver.resources.processes.tracker import \ registerTaskType, enqueueTask, QueueFull, \ getTaskStatusByIdentifier, getTaskResponse, deleteTaskByIdentifier
By this command we imported following objects: i) task type registration function, ii) the task creation (enqueue) subroutine, iii) an exception class risen in case of full task queue unable to accept (most likely temporarily) new tasks, iv) task’s status polling subroutine, v) the response getter function and finally vi) the subroutine deleting an existing task. These are the ATP Python objects needed by our little demo application.
Let’s start with preparation of an example of subroutine to be executed - handler subroutine. The example handler below sums sequence of numbers and stores the result:
def handler( taskStatus , input ) : """ example ATP handler subroutine """ sum = 0 # sum the values for val in input : try : sum += float( val ) except ValueError: # stop in case on ivalid input taskStatus.setFailure("Input must be a sequence of numbers!") return # store the response and terminate taskStatus.storeResponse( str(sum) )
Any handler subroutine (see also
receives two parameters: i) an instance of the
and an input parameter. The input parameter is set during the task creation and
can be any Python object serialisable by the
Once we have prepared the handler subroutine we can register the task type to be performed by this subroutine:
registerTaskType( "SequenceSum" , "tools.atp_demo.handler" , 60 , 600 , 3 )
registers a new task type named “SequenceSum”. Any task instance of this task
type will be processed by the
handler subroutine. The handler subroutine
is specified as importable module path. Any task instance not
processed by an ATPD within 60 seconds (measured from the moment the ATPD pulls
a task from the queue) is considered to be abandoned and it is automatically
re-enqueued for new processing. The number of the re-enqueue attempts is limited
to 3. Once a task instance is finished it will be stored for min. 10 minutes
(600 seconds) before it gets removed.
Once the task handler has been registered as a new task type we can create a task’s instance:
while True : try: enqueueTask( "SequenceSum" , "Task001" , (1,2,3,4,5) ) break except QueueFull : # retry if queue full print "QueueFull!" time.sleep( 5 )
enqueueTask() creates a new
task instance “Task001” of task type “SequenceSum”. The tuple
is the input to the handler subroutine. In case of full task queue
new task cannot be accepted and the
QueueFull() is risen.
Since we want the task to be enqueued a simple re-try loop must be employed.
After task has been created enqueued for processing its status can be polled:
while True : status = getTaskStatusByIdentifier( "SequenceSum" , "Task001" ) print time.asctime() , "Status: " , status if status in ( "FINISHED" , "FAILED" ) : break time.sleep( 5 )
The task status is polled until the final status (
reached. The task must be identified by unique pair of task type and task
NOTE: The task instance is guaranteed to be unique for given task type identifier, i.e., there might be two task with the same instance identifier but different type identifier.
The history of the task processing is logged and the log messages
can be extracted by
print "Processing history:" for rec in getTaskLog( "SequenceSum" , "Task001" ) : print "-" , rec , "Status: " , rec , "\t" , rec
This function returns list of log records sorted by time (older first).
Once the task has been finished the task response can be retrieved:
if status == "FINISHED" : print "Result: " , getTaskResponse( "SequenceSum" , "Task001" )
In this section we will briefly describe all the steps necessary to pull and execute task instance from the queue. As working example we encourage you the source Python code of the ATPD located at:
The invocation of the ATP server is described in “atp_sum”.
Initially the application must import the python objects
from eoxserver.resources.processes.tracker import *
For convenience we have made available whole content of the module.
The ATPD is expected to pull task from the queue repeatedly. For simplicity we avoid the loop definition and we will rather focus on the loop body. Following command pulls a list of tasks from queue:
try: # get a pending task from the queue taskIds = dequeueTask( SERVER_ID ) except QueueEmpty : # no task to be processed # wait some ammount of time time.sleep( QUEUE_EMPTY_QUERY_DELAY ) continue
This command tries to pull exactly one task at time from the DB queue but the
applied mechanism of pulling does not guaranties that none or more than one
task would be return. Thus the dequeuing function returns a list of tasks
and the implementation must take this fact into account. Further, the dequeue
function requires unique ATPD identifier (
changes automatically the status from
log the state transition. The optional logging message can be provided.
In case we have picked one of the pulled tasks and stored it to
variable we can proceed with the task execution:
# create instance of TaskStatus class pStatus = TaskStatus( taskId ) try: # get task parameters and change status to STARTED requestType , requestID , requestHandler , inputs = startTask( taskId ) # load the handler module , _ , funct = requestHandler.rpartition(".") handler = getattr( __import__(module,fromlist=[funct]) , funct ) # execute handler handler( pStatus , inputs ) # if no terminating status has been set do it right now stopTaskSuccessIfNotFinished( taskId ) except Exception as e : pStatus.setFailure( unicode(e) )
In order to execute the task couple of actions must be performed. First an
instance of the
must be created.
The parameters of the task (task type identifier, task instance identifier,
request handler and task inputs) must be retrieved by the
The function also changes the status of the task from
RUNNING and logs the state transition automatically.
The handler “dot-path” must be split to module and function name and loaded
dynamically by the
Once imported the handler function is executed passing the TaskStatus and inputs as the arguments.
The handler function is allowed but not required to set the successful terminal
state of the processing (
FINISHED) and if not set it is done by the
Obviously, the implementation must catch any possible Python exception and
record the failure (
In addition to the normal operation each ATPD implementation is responsible for
maintenance of the ATPD subsystem in a consistent state. Namely, i) the ATPD
must repeatedly check for the abandoned “zombie” tasks and restart them by
function and ii) the ATPD must remove DB records of the finished “retired”
tasks by calling