Get Engine API

Overview

The following set of API's provide a mechanism to monitor the various parameters of the engine.

1. Get resource allocations of containers running

The following API, shows the resource allocation of the containers running on the engine

import razor
razor.api.engines.allocations()

2. Get the active containers of the engine

The following API, shows the active containers that are running on the engine

import razor
razor.api.engines(name='Engine-name').containers()

Attributes

3. Get all runs of the engine

The following API, shows all the pipelines that have run on the engine. The pipeline runs will contain the historical data along with the status

import razor
razor.api.engines(name='Engine-name').runs()

Attributes

4. Get overall health status of the engine

The following API, shows the overall health status of the servers on the engine

import razor
razor.api.engines(name='Engine-name').health()

Attributes

5. Get the queue status of the engine

The following API, shows the status of the queue i.e. the number of blocks queued for execution at the engine level

import razor
razor.api.engines(name='Engine-name').queue()

Attributes