OCP provides the management and viewing of tasks initiated through the OCP console, including O&M and management tasks for OceanBase clusters, tenants, and hosts, as well as O&M tasks for the OCP system.
This topic describes how to view the details of a task and how to handle a failed task.
Prerequisites
To view task details, locate the current progress, and download logs, the user logged in to OCP must have the following permissions:
- Cluster Read-Only, Tenant Read-Only, OBProxy Read-Only, Arbitration Service Read-Only, Binlog Service Read-Only, or Host Read-Only resource permission.
- All menu permission in the Task Center.
To skip a task, retry a failed task, or roll back a failed task, the user logged in to OCP must have the following permissions:
- Cluster Maintenance, Tenant Maintenance, OBProxy Maintenance, Arbitration Service Maintenance, Binlog Service Maintenance, or Host Maintenance resource permission.
- All menu permission in the Task Center.
View task details
If there are Executing or Failed tasks in OCP, the number of specific tasks will be displayed on the Task Center in the upper right corner of the OCP system page. You can view the details of a task in the following two ways:
Method 1: Hover the cursor over Task Center and click the number of the task in the bubble. The Tasks page will be displayed and will filter the tasks based on the status of the selected task, displaying only tasks with the same status.
Method 2: Click Task Center. The Tasks page will be displayed and will display all tasks.
The following steps are based on Method 2:
Log in to the OCP console.
Click Task Center in the upper part of the page to go to the Tasks page.
On the Tasks page, you can filter tasks based on their execution status and initiator, or search for tasks based on the operation object and task name.
All tasks that meet the specified conditions will be returned in the Tasks. You can click the links in the Object column to go to the overview page of the corresponding object.
Note
If the operation object of a task has been deleted, you can only view the object name and object type but cannot go to the Object overview page.
Click the name of the task you want to view to go to the task details page. By default, the task details page displays the logs of the task. You can click the view button to switch to the flow view.
In the log view, multiple task logs are displayed. You can click the subtask in the left area to switch to the subtask. The right area displays the execution information and all logs of the subtask. You can click the corresponding button in the following figure ① or ② to perform an operation on the subtask.
In the flow view, the page displays the upstream and downstream relationships of subtasks in a topology diagram. After you expand the collapse menu, a collapsed window displays the log information at the bottom of the screen. You can drag the window to zoom in on the window. You can click the operation item in the ... column on the right side of the specified subtask to perform an operation on the subtask.
Note
You can drag the mouse to move the topology diagram, use the mouse wheel to zoom in or out, or use the zoom control in the upper right corner to adjust the canvas size. The zooming is centered on the mouse pointer. For a long task process, you can first zoom in to quickly locate the step you are interested in and then zoom out to achieve the purpose of quick location.
The supported operations vary based on the status of the subtask. The supported operations are displayed in the ... column.
For a subtask with the status Completed, you can view the details of the subtask.
For a subtask with the status Failed, you can perform the following operations.
Download the log information.
Retry: Run the subtask again. The subtask is rolled back first and then executed. If the subtask is executed successfully, the downstream subtasks are executed.
Skip: Set the status of the subtask to succeeded and then execute the downstream subtasks. Skipping a subtask may cause exceptions in the subsequent steps. Therefore, you must be cautious when you skip a subtask.
For a subtask with the status Executing, you can download the log information or terminate the subtask. After the subtask is terminated, its status changes to Aborted, and the status of the main task changes to Failed. You can download the log information, skip, or retry a terminated subtask.
For a subtask with the status Warning, you can perform the following operations.
Download the log information.
Retry: Run the subtask again. The subtask is rolled back first and then executed.
For a subtask with the status Suspending, you can perform the following operations.
Download the log information.
Continue: Continue to execute the subtask.
Retry a failed task
You can retry a task that has been Failed or Rollback Failed. When you retry a failed task, all failed nodes in the current step are rolled back and then re-executed. If the retry is successful, the subsequent steps are executed.
You can retry a failed task in the following two ways:
- Method 1: On the Tasks page, select a failed task and click Retry.
- Method 2: On the task details page, click Retry in the upper-right corner.
The following example describes how to retry a failed task by using Method 1:
Log in to the OCP console.
In the upper-left corner of the page, click Task Center to go to the Tasks page.
Select a failed task and click Retry in the ① column.
You can also select multiple failed tasks and click ② to retry them in batches.
Roll back a failed task
You can roll back a failed task to recycle resources and modify the task status.
Log in to the OCP console.
In the upper-left corner of the page, click Task Center to go to the Tasks page.
Click the name of the task to go to its details page.
In the upper-right corner of the task details page, click Roll Back.
Locate the current progress
During task execution, you can click Locate Current Progress to quickly jump to the subtask that is being executed. This helps you monitor the task execution status and related logs. For a task that has been Failed, you can click Locate Current Progress to quickly locate the subtask that failed and the task execution exception.
Download logs
On the task details page, click Download Logs in the upper-right corner to download the execution logs of all subtasks under the task to your local device.