Pipeline Monitoring API's at a Block Level

Overview

The following set of API's provide a mechanism to monitor the various parameters of the pipeline run related to a block

1. Get all blocks of a Pipeline

The following API, provides a mechanism to get all the blocks of the pipeline

prun.blocks()

2. Get a specific block from the pipeline run

The following API, shows how a specific block from the run can be accessed

blkrun = prun.blocks(name="HelloWorld_1")

The blocks API, takes name as an attribute and returns the block run object which has the monitoring API's associated with the block

3. Get run status of the block

The following API, provides the run status of the block

blkrun.run_status()

4. Get the logs of a specific block of a pipeline

The following API, provides the logs of the specific block in the pipeline

blkrun.logs()

5. Get the metrics of a specific block of a pipeline

The following API, shows how metrics of a specific block in the pipeline can be obtained

blkrun.metrics()

6. Get the queue status of the block waiting for execution

The following API, shows how the queue status of a specific block can be obtained

blkrun.queue()