Skip to content

Monitor the Status and Runtime of the Workflow

The status indicates the Resource's lifecycle state, such as active, error, or deleted, and helps users quickly assess whether the Resource is available and functioning as expected. In contrast, the runtime reflects the Resource's execution state, such as running, failed, or pending, capturing what is actively happening behind the scenes, typically at the container or pod level. Together, these signals help users to detect configuration issues, operational failures, and disruptions that could impact downstream workflows.

Monitor the status and runtime of a Workflow using DataOS CLI

The status and runtime of a workflow can be monitored using the DataOS CLI by executing the following command.

dataos-ctl get -t workflow -w public

Example Usage:

dataos-ctl get -t workflow -w public -a    
INFO[0000] 🔍 get...                                     
INFO[0001] 🔍 get...complete                             

                 NAME                | VERSION |   TYPE   | WORKSPACE | STATUS |  RUNTIME  |      OWNER       
-------------------------------------|---------|----------|-----------|--------|-----------|------------------
    ingestion-delivery-events        | v1      | workflow | public    | active | succeeded | iamgroot          
    ingestion-shipment-orders        | v1      | workflow | public    | active | succeeded | iamgroot

The active state indicates that the Workflow is currently accessible and usable by other DataOS Resources, and a succeeded runtime indicates that the Workflow has completed successfully.

Monitor the status and runtime of a Workflow using Metis

To monitor the status and runtime of a Workflow on the Metis Catalog UI, follow the steps below:

  1. Open the Metis Catalog.

  2. Search for the Workflow by name.

  3. Click on the Workflow that needs to be monitored and check the status and runtime.

Monitor the status and runtime of a Workflow on Operations

To monitor the status and runtime of a Workflow on the Operations app, follow the steps below:

  1. Open the Operations app.

  2. Under the User space → type → Workflow, search for the Workflow that needs to be monitored.

  3. On clicking the Workflow, its detailed logs can also be monitored.

Configure Alerts for Status Changes

To proactively track critical state transitions, users can configure a Monitor and Pager to send alerts when the status of a Workflow changes to values like error or deleted. This enables teams to respond immediately to resource failures, misconfigurations, or unexpected deletions that may impact dependent components. Click here to view the steps to set up alerts for status changes.

Configure Alerts for Runtime Changes

To proactively detect execution issues, users can configure a Monitor and Pager to send alerts when the runtime of a Workflow enters a failure state, such as failed or remains stuck in pending. This ensures timely awareness of broken or stalled executions that may affect downstream processes. Click here to view the steps to set up alerts for runtime failures..