This topic describes the features of inspection, including how to configure inspection items, scheduling rules, initiate an inspection, and view inspection history.
Feature description
OCP inspection is an essential part of ensuring the stable and effective operation of the system. It aims to identify potential system risks in a timely manner. The OCP inspection feature checks whether the OceanBase system and its environment meet the expected standards and reports any security risks that cannot be covered by monitoring or alerting scenarios. It also provides the ability to download inspection reports.
Users can configure inspection rules to have the OCP system periodically or one-time check the partition information, sequence numbers, and parameters of the clusters. Through the inspection results, they can maintain the clusters and ensure their normal operation within OCP.
When you first use the inspection feature, follow these steps:
Configure inspection items. Confirm the inspection items needed based on the actual situation.
Configure inspection scheduling rules. This includes configuring scheduling rules for individual objects and configuring global object scheduling rules.
Perform other actions on the inspection objects. This includes initiating basic inspection for individual objects and initiating basic global inspection.
View an inspection task, and view inspection reports and download inspection reports.
Configure inspection items
Inspection Item define the criteria for assessing risks of resources managed by OCP. The inspection module checks resources based on the configured inspection items and returns the specified risk level.
On the Configure inspection items page, you can view information such as the inspection item name, type, scenario, description, and inspection rules. You can also enable or disable the inspection items. For more information, see Configure inspection items.
| Parameter | Description |
|---|---|
| Inspection item | The name of the inspection item configured in the system, which is globally unique. |
| Inspection item type | The type of the inspection item, such as OceanBase clusters, tenants, and hosts. |
| Inspection object type | The type of object on which the inspection item takes effect. Different inspection objects can have different inspection items. Inspection objects include OceanBase clusters, tenants, and OBProxy clusters. |
| Inspection item scenario | The scenario on which the inspection item takes effect. Valid values: Basic inspection, performance inspection, and in-depth inspection. |
| Description | The description of the inspection item. |
| Inspection rules | The configuration rules of the inspection item. |
Configure scheduling rules
Scheduling Rules define the execution template for an inspection task. The inspection task is executed based on the rules defined in the inspection scheduling rules.
You can customize the scheduling rules for individual objects or create unified scheduling rules for all objects, including the scheduling cycle, scheduling time, scheduling deadline, and whether to enable scheduling. For more information, see Configure scheduling rules for individual objects and Configure global scheduling rules.
| Parameter | Description |
|---|---|
| Scheduling Cycle | You can schedule inspections by month, week, or day. |
| Scheduling Time | Select the inspection execution time. |
| Scheduling Deadline | After this time, automatic inspections are no longer performed. By default, this option is disabled. |
| Enable Scheduling | By default, this option is disabled. After it is disabled, automatic inspections are no longer performed. |
Initiate an inspection
After you initiate an inspection, OCP immediately checks the cluster based on the inspection items. OCP inspection items are divided into the following scenarios:
- Basic inspection: Checks the basic status of resources managed by OCP, such as cluster status and replica status, and is suitable for routine inspections.
- Performance inspection: Checks the performance of resources managed by OCP, such as large transactions and slow queries, and is suitable for performance analysis.
- In-depth inspection: Conducts an in-depth inspection of resources managed by OCP to identify hidden risks and is suitable for inspections before business peaks.
You can initiate an inspection for a single object in a specific scenario or initiate a global inspection for all objects in a specific scenario. For more information, see Initiate a basic inspection for a single object and Initiate a global basic inspection.
Inspection history
Inspection History displays all initiated inspection tasks and shows the level and number of security threats of the inspection objects in summary.
On the Inspection History tab, you can view the inspection task ID, inspection object, inspection object type, inspection scenario, inspection start time, inspection end time, task status, and inspection result. You can also perform common operations, including View inspection task, View inspection report, and Download report.