#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 upgrade from V2.3.x to V3.3.4, and finally from V3.3.4 to the current version. For OCP versions between V2.3.x and V3.2.4, you must first upgrade to V3.3.4, and then from V3.3.4 to the current version. For OCP versions V3.2.4 and later, you can directly upgrade to the current version.
Notice
MetaDB 1479 is a version of OCP. Therefore, you cannot 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 an increasing number of objects and provides more comprehensive features, important and frequently accessed information is scattered across various modules, requiring manual aggregation and organization. To address this, OCP introduces the Overview module, offering a global perspective of the resources managed by OCP. After logging in to the OCP console, you can quickly access information such as 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 tasks related to alerts, backups, O&M, and major compactions to understand global task information.
- Statistics on SQL, sessions, transactions, and security diagnostics to identify performance risks.
Resource Overview
- Displays the top 5 clusters' CPU, memory, and disk allocation, highlighting clusters with high resource allocation.
- Displays the top 5 tenants' CPU, memory, and data usage, highlighting tenants with high resource consumption.
Performance Overview
- Supports performance monitoring metrics for OceanBase clusters, tenants, OBProxy clusters, and hosts.
- Allows you to select cluster or tenant dimensions, or specify clusters, to view the top 5 performance metrics.

Diagnostics Center
The Safety Diagnostics module now includes two new submodules: High Risk SQL and New SQL statement.
- High-Risk SQL: Identifies high-risk SQL statements based on various rules, including DDL operations, updates, deletions, and queries that return excessive records. It also includes full-table updates and deletions that may compromise data security and system stability.
- New SQL: Aggregates and statistically analyzes SQL statements that have not been executed in the last 7 days, helping you identify potential performance risks early.
The SQL Diagnostics module now includes SQL comparison capabilities.
OCP already supports TopSQL analysis in the SQL diagnosis section. You can analyze SQL statements based on various dimensions such as total execution time, execution count, and average response time. This allows you to identify the most resource-intensive and critical SQL statements within a specific period. However, during routine data maintenance, changes in performance metrics may require your attention. For example, you may want to compare SQL performance at the same time point over different weeks or between different time periods. OCP now supports TopSQL comparison across different time periods, allowing you to view performance trends and identify SQL execution changes based on specific rules such as new TopSQL statements, execution count, returned rows, failure rate, and execution plan ratio. This helps you proactively detect and optimize performance issues.

Additionally, OCP connects the capabilities of alerts, monitoring, diagnostics, and logs along the Discovery > Diagnosis > Optimization > Emergency Response path.
- After receiving an alert, you can log in to the OCP console and view the alert details in the Alert Aggregation module on the homepage. You can click an alert to view its details in the Alert List page. The system displays the corresponding monitoring information for the alert period, and you can access the monitoring page of the specific resource for more details to troubleshoot issues.
- The SQL Diagnostics button is added to the monitoring page of a tenant. Clicking this button redirects you to the SQL diagnosis page. After selecting a time range and clicking Search, you can view the SQL statements executed during that period to identify and resolve issues.
Tenant Backup
OCP V4.0.0 supports setting backup strategies for tenants. You can configure different backup strategies, including backup cycles and methods, based on the importance level of each tenant. Additionally, you can set backup strategies at the cluster level, which apply only to tenants without individually configured backup strategies, to meet your diverse configuration needs.
- You can configure backup strategies for one or multiple tenants without setting a cluster-level backup strategy.
- You can configure backup strategies for specific tenants even if a cluster-level backup strategy is already set.

Alerts
OCP's alerting capabilities are a core enterprise-level feature that provides timely and secure early warning for clusters and related objects. To enhance the O&M experience, simplify alert configuration, and better support delivery personnel, OCP V4.0.1 has comprehensively optimized the alerting feature. This includes simplifying the original alert configuration process and enhancing alert capabilities, allowing you to configure alerts through the platform.
- Enhancements
- Added multi-metric alert configuration, supporting the combination of multiple different metrics using "AND" or "OR" logic.
- Added alert templates, allowing you to set multiple alert rules for alert objects and providing default templates for your use.
- Added tag-based alert suppression, allowing you to suppress alerts based on specific tags (such as SQLID or session ID) for more precise control.
- Added DingTalk, WeCom, Feishu, and email alert channels, with simple configuration requiring only two forms to complete setup.
- Configuration Optimizations
- Alert Events
- Removed the original alert message module, allowing you to view alert message records in the alert event module.
- Added the ability to link 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 the ability to adjust default alert rules for different alert objects.
- Alert Channels
- Added support for specifying users to be notified (via @) 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 alerts based on alert groups or alert templates. Alert group push supports specifying alert objects.
- Added the option to receive alert recovery notifications when configuring alert push.
- Other
- Added support for reverse filtering rules in alert object selection, allowing you to exclude specific objects from all alert objects.
- Alert Events
Inspection
OCP V4.0.1 redesigns the inspection feature for easier use and better understanding of resource risks. It combines the original health check and inspection capabilities and adds numerous inspection rules based on survey feedback. From the perspective of inspection objects, it supports different inspection features for various scenarios.
- Inspection Objects: Inspection operations start with objects, making the process simpler and clearer.
- Supports defining inspection items for each OceanBase cluster, tenant, and OBProxy cluster.
- Supports initiating inspections for a single object or all objects.
- Inspection Scenario: Predefined three inspection scenarios, matching different inspection items for different scenarios.
- Basic inspection: Basic health checks for resources managed by OCP, suitable for daily inspections.
- Performance inspection: Checks for performance fluctuations and anomalies in resources managed by OCP, suitable for performance analysis.
- Deep inspection: In-depth checks for resources managed by OCP to discover hidden risks, suitable for inspections before business peak hours.
- Scheduling Rules: Each object and corresponding inspection scenario supports different scheduling rules.
- Supports scheduling cycles in days, weeks, and months.
- Inspection report: Each inspection task generates a detailed inspection report for analysis.
- Inspection reports are set based on inspection item rules, highlighting low, medium, and high-risk items.
- Inspection reports support online viewing and downloading to local devices.

Feature improvements
Cluster management
- When you create a cluster, you can specify the SQL port and RPC port.
- When you create a cluster of V2.2.77, you can use a recommended parameter template.
- When you create a cluster, you can check the IOPS of 16 KB I/O blocks. If the IOPS is less than 1000, an exception is thrown.
- You can deploy a cluster with heterogeneous nodes in different zones. For example, you can deploy x86 nodes and ARM nodes in different zones.
- You can Reinstall an OBServer node. You can choose to reinstall the node in place.
- You can Replace an OBServer node. You can skip the offline host cleanup operation.
- You can Replace an OBServer node or Add an OBServer node. In this case, you can select only OBServer nodes in the same IDC.
- You can query the names of multiple clusters at a time.
- The primary and standby clusters are displayed in a flat list.
- 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, you can view the minimum resource specifications that can be used for a unit.
- When you create a tenant, you can view a risk warning if the unit specifications and numbers in different zones are inconsistent.
- The concept of over-subscription is removed from the tenant unit management. You do not need to set the minimum and maximum values of CPU and memory.
- You can query the names of multiple tenants at a time.
- 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 the
lower_case_table_namesparameter cannot be set when you create a MySQL tenant is fixed.
Host management
- You can query the IP addresses of multiple hosts at a time. You can filter the hosts by host type, IDC, and service.
- You can view the CPU chip name, number of CPU cores, and total memory size of a host.
- Clock offset checks are enabled by default when you add a host.
OBProxy
- You can specify the password for a proxyro in 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 heterogeneous hardware architecture is removed.
- The Request Analysis menu is added. You can view the number of requests from clusters, tenants, and clients.
- The best practices parameters are enabled by default when you deploy an OBProxy cluster.
Monitoring
- The default sampling frequency of OCP monitoring is adjusted from 1 second to 5 seconds.
- The CPU Utilization chart of a tenant is renamed to CPU Consumption of Tenant.
- The I/O usage rate and I/O 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 to meet the requirements of Level 3 of the equal 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 and generate snapshots for specified clusters by using the
ocp.perf.snapshot.generation.enableandocp.perf.snapshot.generation.white-listparameters.
Fixed issues
OCP V4.0.1 fixes the following issues:
Fixed the issue where tenant allowlists fail to synchronize during an upgrade from an earlier version to V3.3.3 in some 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 after the RS changes in some scenarios.
Fixed the issue where the manual and automatic refresh operations for replica views in the cluster resource management module call different interfaces.
Fixed the issue where an error "Error writing JSON output" occurs when the trace details of a SlowSQL query are bound to a schema index.
Fixed the issue where the password for the proxyro@sys user of the Meta cluster stored in the password vault is incorrect when deploying OCP with Antman.
Fixed the issue where the installation template fails to find the
sysctlcommand due to a limited PATH directory inherited by the agent started via SSH.Fixed the issue where an OBProxy cluster can be permanently locked and become unmanageable in some scenarios.
Fixed the issue where the upgrade path cannot be found when OCP uploads the debuginfo package of the target version.
Known issues
Number |
Description |
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 a physical server or in a Docker container. 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 available memory |
| NIC | 10 GbE |
OCP-Agent consumes very little resources and does not have special requirements for the hardware resources of the installation node.
Operating system requirements
The following table lists the operating system requirements for installing OCP-Server (including OCP-Agent).
Server type |
Operating system |
Supported version |
|---|---|---|
| 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 a web browser. The following table lists the client requirements.
Browser |
Minimum version |
|---|---|
| Chrome | 81 |
| Firefox | 64 |
| Safari | 10 |
| Edge | 13 |
If you need to access OCP services on an iOS device, the minimum version is as follows:
Operating system |
Minimum version |
|---|---|
| iOS | 10 |
For the best user experience, we recommend that you use a display with a resolution of 1440 x 810 or higher.
