This topic describes the inspection feature of OceanBase Cloud Platform (OCP), including how to configure inspection items, configure scheduling rules, initiate inspections, and view inspection history.
Applicability
This topic applies only to OceanBase Cloud Platform Enterprise Edition. OceanBase Cloud Platform Community Edition does not support the inspection service.
Features
Inspection is an essential method to identify problems in a system and ensure its stable and effective operation. The inspection feature of OCP checks performance of the OceanBase system and its environment, generates reports to expose security risks that cannot be detected by the monitoring or alerting feature, and allows you to download the reports.
You can configure inspection rules to enable regular or ad hoc inspections of the partition information, serial number, and parameters of the cluster, and troubleshoot the cluster based on the inspection results to ensure the normal operation of OCP clusters.
If this is your first time to use the inspection feature, take the following steps:
Configure inspection items. Select inspection items as needed.
Configure a scheduling rule. You can Configure a scheduling rule for a single object or Configure a global scheduling rule.
Perform other operations on the inspection objects. You can initiate an inspection for a single object or initiate a global inspection.
You can View an inspection task, view an inspection report, and download an inspection report.
Configure inspection items
Inspection items define the basis for identifying risks of resources managed in OCP. The inspection feature checks resources based on rules configured in the inspection items and returns the corresponding risk levels.
On the
|
|
|
|---|---|
| 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, for example, OceanBase cluster, OceanBase Database tenant, or OBServer. |
| Inspection Object Type | The type of the objects to which the inspection item applies. The inspection items vary with inspection objects. Inspection objects include OceanBase clusters, OceanBase Database tenants, and OBProxy clusters. |
| Inspection Scenario | The scenario to which the inspection item applies, including basic inspection, performance inspection, and in-depth inspection. |
| Description | The description of the inspection item. |
| Inspection Rule | The rule configured in the inspection item. |
For more information, see Configure inspection items.
Configure a scheduling rule
A scheduling rule defines a template for performing an inspection task. The inspection task runs based on the scheduling rule. You can configure a custom scheduling rule for a single object or configure a global scheduling rule for all objects.
You can specify the scheduling cycle, scheduling duration, scheduling end time, and whether to enable the scheduling rule.
|
|
|
|---|---|
| Scheduling Cycle | The scheduling cycle, which is on a monthly, weekly, or daily basis. |
| Scheduling Time | The time for starting inspection. |
| Scheduling End Time | The time for stopping scheduling. After the time expires, automatic inspection will not be performed. |
| Enable Scheduling Rule | Specify whether to enable the scheduling rule. The scheduling rule is disabled by default. If the scheduling rule is disabled, automatic inspection will not be performed. |
For more information, see Configure a scheduling rule for a single object and Configure a global scheduling rule.
Initiate an inspection
After you initiate an inspection, OCP immediately starts inspection based on the inspection items. Inspection items in OCP apply to the following scenarios:
- Basic inspection: checks the basic status of resources managed in OCP, including the status of clusters and replicas. This scenario is suitable for routine inspection.
- Performance inspection: checks the performance of resources managed in OCP, such as large transactions and slow queries. This scenario is suitable for performance analysis.
- In-depth inspection: performs in-depth inspection on resources managed in OCP to detect hidden risks. This scenario is suitable for pre-peak inspection.
You can initiate an inspection for a single object in a scenario or initiate a global inspection for all objects in a scenario. For more information, see Initiate an inspection for a single object and Initiate a global inspection.
Inspection history
The
On the
