Report Progress Of Task

Problem

You want to report progress from the task to the client for monitoring purposes.

Solution

First, to receive the progress messages sent from the task to the client, subscribe to the job’s task_progress_updated event or the task’s progress_updated event.

job.task_progress_updated = job_task_progress_updated   # add event handler

Then, on the task, call set_progress(). The values passed to set_progress() will be received on the client’s progress event handling method.

self.set_progress(40, 4)

from agiparallel.client import ClusterJobScheduler
from time import sleep


class ProgressTask():
    def __init__(self):
        self.name = "progress task"
        self.result = None

    def execute(self):
        self.set_progress(0, 1)
        sleep(1)
        self.set_progress(20, "B")
        sleep(1)
        self.set_progress(40, 4)
        sleep(1)
        self.set_progress(60, "D")
        sleep(1)
        self.set_progress(80, "E")
        sleep(1)


def job_task_progress_updated(task_id, task_progress_info):
    print(task_progress_info.progress, task_progress_info.additional_information)


def report_progress_of_task():
    with ClusterJobScheduler("localhost") as scheduler:
        scheduler.connect()
        job = scheduler.create_job()

        job.add_task(ProgressTask())
        job.task_progress_updated = job_task_progress_updated   # add event handler

        job.submit()
        job.wait_until_done()

        # The output should resemble:
        # 0 1
        # 20 B
        # 40 4
        # 60 D
        # 80 E


if __name__ == "__main__":
    report_progress_of_task()

Discussion

If a job could potentially take a long time to finish, reporting the progress of tasks while the task is running helps to notify the user how long the task could take. You can read more about working with task progress here.

To view the progress through the monitoring applications, open the task monitor (through the coordinator or agent tray application). Right click on the column headings and then click on “Status Description” on the drop down menu.

Once the Status Description column is visible, the value of the task progress description can be seen. This is shown in the example above.

See Also

Other Resources

• Reporting the Progress of Tasks