Instance management
Overview
After a Flow is released to the production environment, it can run manually or on a schedule. When a Flow runs, a Flow instance is created, and each node in the Flow also creates its own task node instance when it runs. To view or manage these instances, go to the Instance Management page of the Ops module.
For Flow instances and task node instances, Base Date is a very important parameter. Base Date is equivalent to the business time and defaults to the day before the execution time. Instances carry this parameter whether or not the base date parameter is used in the Flow or task node. On the instance list pages, Execution Time is a required filter (defaults to the last 7 days), and the list only shows instances whose execution time falls within the given range. Keep this in mind when you use the lists.
Flow instance list
The Flow instance list page shows all Flow instances within the execution time range. On the list page, you can also rerun failed Flow instances, manually terminate running instances, and more. The list is filtered by execution time. If the Flow instance you want to view isn't within the given time range, adjust the range with the time picker.
The columns of the Flow instance list are as follows:
| Column Name | Description |
|---|---|
| Instance ID | The unique ID of the Flow instance. Click it to view the Flow instance details |
| Flow Name | The name of the Flow the instance belongs to. Click it to go to the Flow detail page |
| Status | The status of the Flow instance, including Finished, Failed, Running, Waiting, Terminated, and more. To view instances in a specific status, use the status filter above the list |
| Time Cost | The total time cost of the Flow instance |
| Base Date | The base date of the Flow instance |
| Execution Time | The time the Flow actually started running, and its scheduled run time |
| End Time | The time the Flow instance finished running |
| Trigger | The reason the Flow instance ran, including Scheduled and Manual Execution |
| Remarks | Remarks on the Flow |
| Owner | The owner of the Flow |
| Actions - Terminate | Available only when the Flow is running. Click it to terminate the Flow run: nodes that are running in the Flow are terminated, nodes that haven't run yet won't run, and nodes that have already run aren't affected. |
| Actions - Rerun | Available only when the Flow has failed. Click it to rerun the Flow: task nodes in the Flow that failed, were terminated, or didn't run are run again, and task nodes that finished aren't rerun. |
The Flow instance list page also provides some batch operations. Click Batch Operation in the upper-right corner of the list to view the batch operations currently supported. Currently, the only supported batch operation is Batch terminate.
Note that the batch operation list only shows instances that the operation can be applied to, so the list is empty when no instance qualifies. For example, if no instances are running, you won't see any instances in the batch terminate list.
Task node instance list
Use the tab at the top of the list to switch to the task node instance list page, which mainly shows all task node instances within the execution time range. Note that when a Flow runs, task nodes that don't run don't create node instances. An instance is created only when a task node runs.
The columns of the task node instance list are as follows:
| Column Name | Description |
|---|---|
| Instance ID | The unique ID of the task node instance. Click it to go to the Flow instance detail page and view the details of the task node instance |
| Task Node Name | The name of the task node the instance belongs to. Click it to go to the Flow detail page and view the details of the task node |
| Status | The status of the task node instance, including Finished, Failed, Running, Terminated, and more. To view instances in a specific status, use the status filter above the list |
| Time Cost | The total time cost of the task node instance |
| Node Type | The node type of the task node the instance belongs to |
| Belonging Flow | The name of the Flow the task node belongs to. Click it to go to the Flow detail page |
| Flow Instance | The ID of the Flow instance that the task node instance belongs to. Click it to view the Flow instance details |
| Base Date | The base date of the Flow instance that the task node instance belongs to |
| Execution Time | The time the task node actually started running |
| End Time | The time the task node instance finished running |
| Remarks | Remarks on the task node |
| Owner | The owner of the task node |
Flow instance detail page
Click a Flow instance ID or task instance ID to open the Flow instance detail page and view how the instance ran. The Flow instance detail page looks like this:
The left side of the detail page shows the basic information of the Flow instance. The chart area on the right offers three chart types: Gantt chart, DAG, and list. The DAG and the list are shown below:
In any view, click the task node you want to view to expand its task node instance detail page
On the task node instance detail page, you can view the instance's execution log, the script that was actually run (for Shell nodes, SQL nodes, and so on), and the task node configuration.