This topic describes the global inspection feature, including how to view and manage inspection rules and view inspection scripts.
Features
Inspection is an essential method to identify problems in a system and ensure its stable and effective operation. The global inspection feature of OceanBase Cloud Platform (OCP) checks performance of the OceanBase system and its environment based on programmable scripts, and generates reports to expose security risks that cannot be detected by the monitoring or alerting feature. It works in collaboration with the health inspection feature of the cluster.
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:
View the inspection scripts, and select the script as needed. For more information, see Inspection scripts.
Create an inspection rule: Specify the basic information, and select the script and scheduling information provided in Step 1. For more information, see Create an inspection rule.
View inspection rules: Click the rule name in the list of inspection rules. For more information, see View inspection rules.
For more information about other operations on the inspection rule, see Initiate inspection, Modify inspection scheduling, Modify an inspection rule, and Delete an inspection rule.
Inspection rules
An inspection rule defines the template for executing inspection tasks, and specifies the inspection objects, inspection parameters, risk levels, and scheduling types. An inspection task is executed on the basis of the inspection rules.
On the Inspection Rules tab, you can view the rule name, inspection parameter, inspection object, risk level, creator, scheduling type, and scheduling status. For more information, see View inspection rules, Create an inspection rule, initiate inspection, Modify inspection scheduling, Modify an inspection rule, and Delete an inspection rule.
| Parameter | Description |
|---|---|
| Inspection Rule Name | Click a rule name in the Rule Name column. The details page of the rule appears. For more information, see View inspection rules. |
| Objects | You can filter inspection rules by inspection object. |
| Risk Level | Valid values: High Risk, Medium Risk, and Low Risk. |
| Scheduling Type | Valid values: Regular Scheduling, Single Scheduling, and None |
Inspection scripts
An inspection script describes the general process of inspecting OceanBase objects. You can customize some parameters in a template inspection script to meet specific inspection requirements.
On the Inspection Script tab, you can view the name, type, parameters, and description of an inspection script. At present, OCP provides three default inspection scripts for you to select as needed.
| Script | Description |
|---|---|
| Check MySQL Auto-increment Columns | Check the auto-increment columns of MySQL tenants in the cluster. If values of auto-increment columns are less than {threshold} the check is passed. |
| Partition availability inspection based on the time column | Inspect all datetime-type partitions without subpartitions in the target cluster. The inspection passes when the allocated partitions are sufficient to store data for the next 40 days. |
| Sequence availability inspection | Inspects the sequences under all Oracle tenants in the target cluster. The inspection passes when the allocated values of all the sequences, including those in the cache, occupy no more than 80% the total allocatable values. |
| Routine cluster parameter inspection | Inspects the parameters in the target cluster. The inspection passes when the settings of all the parameters conform to the standard values. |
View inspection results
The inspection results are given in a report to indicate potential security risks of the inspection objects. You can choose System Management > Inspection in the left-side navigation pane to view the inspection results in the Inspection Tasks section on the Inspection Rules tab. For more information, see Step 6 in View inspection rules.