Maximum Expected Uptime

Spec

This is a top-level attribute of the pipeline spec.

"pipeline": {...},
"transform": {...},
"maximumExpectedUptime": "10s",
...

Behavior

The maximumExpectedUptime attribute is used to define how long a pipeline should typically run. If the pipeline runs longer than the specified time, the pipeline will be marked as having exceeded its maximum expected uptime. This alert can be seen when running the following commands:

  • pachctl check status
  • pachctl list pipelines

Examples

pachctl check status --all-projects
PROJECT PIPELINE      ALERT
        default/edges default/edges: Started running at 2023-11-01 21:58:34.412588514 +0000 UTC, exceeded maximum uptime by 40.386238412s
pachctl list pipeline -A
PROJECT NAME  VERSION INPUT             CREATED       STATE / LAST JOB  ALERTS DESCRIPTION
default edges 1       default/images:/* 4 minutes ago running / running *      A pipeline that performs image edge detection by using the OpenCV library.

Once a pipeline completes, the alert will be removed.

When to Use

You should use the maximumExpectedUptime attribute when you want to monitor the duration of a pipeline run. This can be useful for debugging or monitoring purposes.