#RNDate#2022-12-28
Version information
Version: V4.0.1
Previous version: V4.0.0
Version release date: December 28, 2022
Supported upgrade path: For OCP versions earlier than V2.3.0, you must first upgrade to V2.3.x, then to V3.3.4, and finally to the current version. For OCP versions from V2.3.x to V3.2.4, you must first upgrade to V3.3.4, and then to the current version. For OCP versions V3.2.4 and later, you can directly upgrade to the current version.
Notice
MetaDB is version 1479 of OCP. We recommend that you do not upgrade to OCP V4.0.1. If you need to upgrade, contact Technical Support.
Supported OceanBase Database versions
OCP V4.0.1 supports the following OceanBase Database versions:
OceanBase V1.4.x
OceanBase V2.1.x
OceanBase V2.2.x
OceanBase V3.1.x
OceanBase V3.2.x
OceanBase V4.x
New features
Overview
As OCP manages more objects and offers more features, many important and frequently accessed information is scattered across different modules, requiring manual aggregation. To address this, OCP introduces the Overview module, providing a global view of the resources managed by OCP. After opening the OCP homepage, you can quickly access information about resource status, consumption, and performance.
Status Overview
- Monitors the status of OceanBase clusters, tenants, OBProxy clusters, and hosts, and marks abnormal resources.
- Monitors the status of alert, backup, O&M, and major compaction tasks to understand global task information.
- Statistics SQL, session, transaction, and security diagnostic information to identify performance risks.
Resource Overview
- Displays the CPU, memory, and disk allocation of the top 5 clusters, highlighting clusters with high resource allocation.
- Displays the CPU, memory, and data usage of the top 5 tenants, highlighting tenants with high resource consumption.
Performance Overview
- Supports performance monitoring metrics for OceanBase clusters, tenants, OBProxy clusters, and hosts.
- Supports viewing the top 5 performance metrics by cluster or tenant, and by all clusters or specified clusters.

Diagnostics Center
The Safety Diagnostics module now includes two new sections: High Risk SQL and New SQL statement.
- High-Risk SQL: Helps identify high-risk SQL statements based on various rules, including DDL operations, updates, deletes, and queries that return excessive records. These operations can pose risks to data security and system stability.
- New SQL: Aggregates statistics for SQL statements that have not been executed in the last 7 days, enabling early detection of performance risks.
The SQL Diagnostics module now includes SQL comparison capabilities.
OCP already supports TopSQL in the SQL diagnostics section. You can analyze SQL statements based on various dimensions such as total execution time, number of executions, and average response time. This helps identify the most resource-intensive and critical SQL statements within a specified period. However, during routine operations, changes in data can be significant. For example, SQL statements executed at the same time point over a week or between different periods may vary. OCP now supports comparing TopSQL statements across different time periods. You can view performance trends during the comparison periods and identify SQL statements that require attention based on specific rules, such as new TopSQL statements, execution frequency, number of returned rows, failure rate, and execution plan changes. This allows you to proactively detect and optimize performance issues.

Additionally, along the Discovery > Diagnostics > Optimization > Emergency path, OCP integrates the capabilities of alerts, monitoring, diagnostics, and logs.
- After receiving an alert, you can open OCP and navigate to the alert summary section on the homepage. Clicking an alert entry will take you to the alert list page, where you can view detailed alert information. The system will display monitoring data for the corresponding period, and you can access the specific resource's monitoring page for more detailed information to troubleshoot issues.
- The monitoring page for a tenant now includes a SQL Diagnostics button. Clicking this button will take you to the SQL diagnostics page. Selecting a time range and clicking Search will allow you to view SQL execution details for the selected period.
Tenant Backup
OCP V4.0.0 supports setting backup strategies for tenants. You can define different backup strategies based on the importance level of each tenant, including backup frequency and method. Additionally, you can set backup strategies at the cluster level, which will apply only to tenants that do not have individual tenant-level backup strategies.
- You can set backup strategies for individual or multiple tenants without defining a cluster-level backup strategy.
- You can set backup strategies for specific tenants even if a cluster-level backup strategy is already defined.

Alerts
OCP's alerting capabilities are a core enterprise-level feature, providing timely and secure alerts for clusters and related objects. To enhance the alerting experience, simplify configuration, and better support delivery services, OCP V4.0.1 has comprehensively optimized the alerting feature, simplified the original alerting configuration process, and enhanced alerting capabilities, allowing you to configure alerts through the platform.
- Enhancements
- Added support for multi-metric alerting, allowing you to configure alert rules by combining multiple different metrics using "AND" or "OR".
- Introduced alert templates, enabling you to set batch alert rules for alert objects and providing default alert templates for your use.
- Added support for alert suppression by tag, allowing you to suppress alerts based on specific tags (such as SQLID or session ID) for more precise alert management.
- Added DingTalk, WeCom, Feishu, and email alert channels, which can be configured with minimal effort, requiring only two forms for setup.
- Configuration Optimizations
- Alert Events
- Removed the original alert message module, allowing you to view alert message records directly within alert events.
- Added support for linking SQLID in alert events to the diagnostics page.
- Alert Rules
- Added support for keyword alerts for more log types, such as OceanBase logs, OBProxy logs, and host logs.
- Added support for adjusting alert objects in default alert rule configurations.
- Alert Channels
- Added support for configuring notifications (mentioning) specific users in DingTalk and WeCom alert channels.
- Added support for configuring alert message templates in different languages and selecting the language for alert messages.
- Added support for configuring JSON-formatted alert messages.
- Alert Push
- Renamed the original Alert Subscription feature to Alert Push, allowing you to push alert information by alert group or alert template. Alert group push supports specifying alert objects.
- Added support for configuring whether to receive alert recovery notifications during alert push.
- Other
- Added support for reverse filtering rules for alert object selection, allowing you to specify which specific objects do not apply to all alert objects.
- Alert Events
Inspection
OCP V4.0.1 redesigns the inspection feature to make it more convenient to use and to provide a clearer understanding of the risks of the managed resources. It integrates the original health check and inspection capabilities and adds a large number of inspection rules based on survey feedback. From the perspective of inspection objects, it supports different inspection features for different scenarios.
- Inspection Objects: The inspection operation starts with an object, making the operation simpler and clearer.
- You can define inspection items for each OceanBase cluster, tenant, and OBProxy cluster.
- You can initiate an inspection for a single object or for all objects.
- Inspection Scenario: Three inspection scenarios are predefined. Different inspection items are matched to different scenarios.
- Basic inspection: A basic health check for resources managed by OCP. It is suitable for daily inspection tasks.
- Performance inspection: A performance check for resources managed by OCP. It is suitable for performance analysis tasks.
- Deep inspection: A comprehensive check for resources managed by OCP. It is suitable for inspection tasks before a business peak.
- Scheduling Rules: Different scheduling rules are supported for each object and corresponding inspection scenario.
- You can configure the scheduling cycle for an object in terms of day, week, or month.
- Inspection report: Each inspection task generates a detailed inspection report for you to analyze.
- The inspection report is generated based on the inspection item rules. It checks and highlights low-, medium-, and high-risk items.
- You can view and download the inspection report online.

Feature enhancements
Cluster management
- You can specify the SQL port and RPC port when you create a cluster.
- When you create a cluster of V2.2.77, you can use the recommended parameter template.
- When you create a cluster, the system checks the IOPS of 16 KB I/O blocks and throws an exception if the IOPS is less than 1000.
- You can deploy heterogeneous nodes at the zone level. That is, you can deploy x86 and ARM nodes in the same zone.
- You can reinstall an OBServer node. You can choose to reinstall the OBServer node in place.
- When you replace an OBServer node, you can skip the offline host cleanup operation.
- When you replace or add an OBServer node, you can select only the same IDC.
- You can query the names of multiple clusters at a time in the cluster list.
- The primary/standby cluster display mode in the cluster list is changed to a flat display mode.
- You can view the Modified parameters and filter the Read-only parameters in the cluster parameter management page.
Tenant management
- When you create or manage a tenant, the system displays the minimum resource specifications that can be used when you select a unit.
- When you create a tenant, the system displays a risk warning if the unit specifications and numbers are inconsistent across zones.
- The concept of overselling is removed from the tenant unit management. You no longer need to set the minimum and maximum values of CPU and memory.
- You can query the names of multiple tenants at a time in the tenant list.
- The Tenant ID column is added to the tenant management list.
- You can view the Modified parameters and filter the Read-only parameters in the tenant parameter management page.
- The issue that you cannot set the
lower_case_table_namesparameter when you create a MySQL tenant is fixed.
Host management
- You can query the IP addresses of multiple hosts at a time in the host list. You can also filter the hosts by host type, IDC, or service.
- The host information management page displays the CPU chip name, number of CPU cores, and total memory.
- Clock offset check is enabled by default when you add a host.
OBProxy
- You can specify the password of a Proxyro node when you create an OBProxy cluster.
- The status column is added to the OBProxy cluster list to display the cluster status.
- The restriction that you cannot upgrade an OBProxy cluster with an inconsistent hardware architecture is removed.
- The Request Analysis menu is added. You can use this menu to count the number of requests of a cluster, a tenant, or a client.
- The best practices are used as the default parameters when you deploy an OBProxy cluster.
Monitoring
- The default sampling interval of OCP monitoring is changed from 1 second to 5 seconds.
- The CPU Utilization chart is changed to the CPU Consumption of Tenant chart.
- The IO usage rate and IO queue length charts are added to the host monitoring page. The system, user, and iowait dimensions are added to the CPU usage rate chart.
Others
- OCP supports the HTTPS authentication protocol, which meets the requirements of the Level 3 information security protection standard.
- The Initiated By filter is added to the task list. You can search for tasks by Task Name.
- The Restart to Apply Changes column is added to the OCP system parameter management list.
- You can specify the installation directory of the Agent by using the
ocp.agent.home.path.prefixparameter. - You can modify the TopN configuration by using the
ocp.perf.workload.report.tenant-top-sql-limitparameter. - You can enable or disable the automatic snapshot feature by using the
ocp.perf.snapshot.generation.enableparameter. You can also generate snapshots for specified clusters by using theocp.perf.snapshot.generation.white-listparameter.
Fixed issues
OCP V4.0.1 fixes the following issues:
Fixed the issue where tenant allowlists fail to synchronize when OCP is upgraded from a previous version to V3.3.3 in certain scenarios.
Fixed the issue where the units of the io_util and io_qusize metrics in OCP alerts are incorrect.
Fixed the issue where OCP continues to use the original RS to execute the upgrade script even after the RS changes in certain scenarios.
Fixed the issue where manual and automatic refreshes of replica views in cluster resource management call different interfaces.
Fixed the issue where a server error "Error writing JSON output" occurs when the Trace details of SlowSQL are bound to a schema index.
Fixed the issue where the password for the proxyro@sys user in the Meta cluster stored in the password vault is incorrect when OCP is deployed by using Antman.
Fixed the issue where the installation template cannot find the
sysctlcommand because the PATH directory inherited by the agent started by using SSH is too small.Fixed the issue where an OBProxy cluster is permanently locked and cannot be maintained in certain scenarios.
Fixed the issue where the upgrade path cannot be found when OCP uploads the debuginfo package of the target version.
Known issues
ID |
Known issue |
Workaround |
|---|---|---|
| 1 | After a tenant is deleted, the backup information of the tenant cannot be displayed. | N/A |
| 2 | In an empty OBProxy cluster, you cannot add an OBProxy server of the 4.0.0 version. | When you create an OBProxy cluster of the 4.0.0 version, add an OBProxy server at the same time. |
Limitations
Hardware requirements
OCP-Server can be installed on physical servers or Docker containers. OCP-Server supports multi-node high availability deployment.
The minimum hardware requirements for OCP-Server nodes are as follows:
Hardware |
Requirement |
|---|---|
| CPU | |
| Memory | 16 GB of available memory |
| NIC | 10 GbE NIC |
OCP-Agent consumes very few resources and has no special hardware requirements for the installation node.
Operating system requirements
The operating system requirements for installing OCP Server (including OCP-Agent) are as follows:
Server type |
Operating system |
Supported versions |
|---|---|---|
| x86_64 | RHEL | 7.2 and later |
| x86_64 | CentOS | 7.2 and later |
| x86_64 | AliOS | 7.2 and later |
| x86_64 | openSUSE | 12SP3 and later |
| ARM aarch64 | AliOS | 7.2 and later |
| ARM aarch64 | NeoKylin | 7.6 |
| ARM aarch64 | Huawei EulerOS | 2.0 SP8 |
| x86_64 | Debian | Debian GNU/Linux 11 (bullseye) |
| x86_64 | Ubuntu | Ubuntu 18.04.6 LTS |
Client requirements
General users access OCP services through web browsers, so the client requirements are as follows:
Browser |
Minimum version |
|---|---|
| Chrome | 81 |
| Firefox | 64 |
| Safari | 10 |
| Edge | 13 |
If you need to access OCP services from an iOS device, the minimum operating system version is as follows:
Operating system |
Minimum version |
|---|---|
| iOS | 10 |
For the best user experience, we recommend using a display with a resolution of 1440 x 810 or higher.
