OCP V4.0.1

Version information

• Version: V4.0.1

• Previous version: V4.0.0

• Release date: December 28, 2022

• Supported upgrade path: For versions earlier than OCP V2.3.0, you must first upgrade to V2.3.x, then from V2.3.x to V3.3.4, and finally from V3.3.4 to the current version. For OCP V2.3.x and later, but earlier than V3.2.4, you need to first upgrade to V3.3.4, then from V3.3.4 to the current version. For OCP V3.2.4 and later, you can directly upgrade to the current version.

Supported OceanBase Database versions

OCP V4.0.1 supports the following versions of OceanBase Database:

• 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 increasingly diverse range of objects and provides more comprehensive features, many high-frequency and critical pieces of information are scattered across different modules, requiring manual aggregation and organization. To address this issue, OCP introduces a new global Overview feature module, providing a holistic view of resources managed by OCP. After opening the OCP homepage, information such as resource status, consumption, and performance is readily accessible.

• Status overview

  • Monitor the status of OceanBase clusters, tenants, OBProxy clusters, and hosts, and mark abnormal resources.
  • Monitor the task status of alerts, backups, operations, and major compactions to understand global task information.
  • Statistically analyze SQL, session, transaction, and security diagnostic information to grasp performance risks.

• Resource overview

  • Display the CPU, memory, and disk usage of the top 5 clusters, highlighting clusters with high resource allocation.
  • Display 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 performances at the cluster or tenant level, for all clusters, or for specified clusters.

Diagnostic Center

In the Security module, two new modules have been added: High Risk SQLs and New SQLs.

• High-Risk SQL: Helps customers identify high-risk SQL statements determined by multiple rules, including some DDL operations, as well as updates, deletions, and returns of excessive records; or full-table updates and deletions that pose a threat to data security and the stable operation of the system.
• New SQL: Summarizes newly appeared SQL statements that have not been executed within 7 days to detect performance risks in advance.

In the SQL Diagnosis module, SQL comparison capability has been added.

OCP already supports the TopSQL capability in SQL diagnosis. It can statistically analyze SQL information over a period of time from various dimensions such as total time consumed, execution count, and average response time, and sort it to identify the SQL statements that consume the most resources and require the most attention during that period. However, in daily data operations, changes that occur may be what we need to focus on, such as whether there are differences at the same point in time within a week, or between different time periods. This iteration of OCP supports comparing TopSQL across different time periods, allowing you to view the performance trend within the comparison period. It will also indicate the operational change points of SQL statements that require your attention based on certain rules (new TopSQL, execution count, number of rows returned, failure rate of execution attempts, execution plan ratio, etc.), helping you identify issues early and optimize them.

Meanwhile, in the Discovery > Diagnosis > Optimization > Emergency workflow, OCP has chained capabilities from modules such as alerts, monitoring, diagnostics, and logs.

1. After receiving an alert, open OCP and go to the alert summary module on the homepage. You can click the alert information to enter the alert list page and view specific alert details. For alert details, the system displays monitoring information for the corresponding period. You can also go to the monitoring page of the specific resource to view more monitoring information for troubleshooting.
2. On the tenant's monitoring page, a new diagnostic entry button SQL Diagnosis has been added. Clicking this jumps you to the SQL diagnosis page. After selecting a time range, click Search to view SQL executions during that period and locate issues.

Tenant Backup

Supports setting backup strategies at the tenant level for clusters of version V4.0.0. You can configure different backup strategies for tenants based on their importance, including cycle and backup method. It also supports setting backup strategies at the cluster level (effective only for tenants without a tenant-level backup strategy), meeting your diverse configuration needs.

1. You can set backup strategies for individual or multiple tenants without configuring a cluster-level backup strategy.
2. You can set separate backup strategies for some tenants while a cluster-level backup strategy is already in place.

Alerts

As a core enterprise-level feature, OCP's alert capability provides timely and secure warning assurance for clusters and related objects. To enhance the alert operation and maintenance experience, reduce the complexity of alert configuration, and better support delivery service personnel, V4.0.1 comprehensively optimizes the alert function, simplifies the original alert configuration process, and strengthens alert capabilities, enabling you to configure alert-related settings through the platform.

• Capability enhancements
  • Added metric alert configuration. You can configure alert rules by combining multiple different metrics using "AND" or "OR".
  • Added alert template functionality. You can set batch alert rules for alert targets and use default alert templates.
  • Added alert muting by tag. You can mute alerts based on specific tags (such as SQLID or session ID), enabling more precise alert muting.
  • Added DingTalk, WeCom, Lark, and email as alert channel types. Configuration is simple, requiring at least two forms to complete the channel setup.
• Configuration optimizations
  • Alert events
    • Removed the original alert message module. You can now view alert sending records within an alert event.
    • SQLIDs in alert events support linking to diagnostic pages.
  • Alert rules
    • Supports keyword alerts for more log types, such as OceanBase logs, OBProxy logs, and host logs.
    • Default alert rule configurations support adjusting alert targets.
  • Alert channels
    • DingTalk & WeCom alert channels support configuring reminders (@) to specify users within a group.
    • Alert channel configurations support setting alert message templates in different languages. When pushing alert messages, you can select a specified language for delivery.
    • Alert channels support configuring alert message formats in JSON format.
  • Alert push
    • The original Alert Subscription feature has been renamed Alert Push. It supports pushing alert information by alert group or alert template. Group-based alert pushes support specifying alert targets.
    • When configuring alert push, you can choose whether to receive notifications when alerts recover.
  • Others
    • Alert target selection supports reverse filtering rules, meaning they do not take effect for certain specific targets among all alert targets.

Inspection

To make the inspection feature more convenient to use and to accurately grasp the risks of managed resources, OCP V4.0.1 has redesigned the inspection feature, merging the original health check and inspection capabilities, and supplementing a large number of inspection rules based on research feedback. Starting from the dimension of inspection targets, it supports inspection functions for different scenarios.

• Inspection targets: Inspection operations now start with targets as the primary entry point, making the operation simpler and clearer.
  • You can define inspection items for each OceanBase cluster, tenant, and OBProxy cluster object.
  • You can specify a single object to initiate an inspection, or inspect all objects.
• Inspection scenarios: Three preset inspection scenarios are provided, matching different inspection items for different scenarios.
  • Basic inspection: A basic health check of resources managed by OCP, suitable for routine inspection work.
  • Performance inspection: An inspection for performance jitter and anomalies of resources managed by OCP, suitable for performance analysis work.
  • In-depth inspection: An in-depth check of resources managed by OCP to identify hidden risks, suitable for inspection work before business peaks.
• Scheduling rules: Each object and its corresponding inspection scenario support different scheduling rules.
  • Supports scheduling cycle configuration in daily, weekly, and monthly dimensions.
• Inspection report: A detailed inspection report is generated for each inspection task for your analysis.
  • The inspection report is checked and highlights low, medium, and high-risk items according to the inspection item rule settings.
  • The inspection report supports online viewing and downloading to local storage.

Feature enhancements

Cluster management

• Supports custom SQL and RPC ports when creating a cluster.
• Added a recommended parameter template when creating a V2.2.77 cluster.
• Added an io_bench result check when creating a cluster (throws an exception if the IOPS for the 16KB IO block is less than 1000).
• Supports heterogeneous deployment at the zone level, meaning it supports mixed x86 and ARM deployments.
• Added an Reinstall OBM node operation and maintenance feature, supporting in-place reinstallation of OBM nodes.
• The Replace OBM node operation and maintenance management feature now supports skipping offline host cleanup operations.
• Added a prompt that only hosts in the same IDC can be selected for Replace and Add OBM nodes.
• The cluster list supports batch querying by cluster name.
• The display method for primary and standby clusters in the cluster list has been adjusted to a tile layout.
• Cluster parameter management supports viewing Modified parameters and filtering by Read-only parameter.

Tenant management

• Added a prompt for the minimum unit resource specification when selecting units for creating and managing tenants.
• Added a risk prompt when the unit specifications or quantities differ between zones during tenant creation.
• Removed the concept of overprovisioning from tenant unit management; no longer requires setting CPU and memory min/max values.
• The tenant list supports batch querying by tenant name.
• Added a Tenant ID column to the tenant management list page.
• Tenant parameter management supports viewing Modified parameters and filtering by Read-only parameter.
• Fixed the issue where the lower_case_table_names parameter could not be set when creating a MySQL-compatible tenant.

Host management

• The host list supports batch querying by host IP and filtering by host type, IDC, and service.
• Host information now displays the CPU chip name, number of CPU cores, and total memory.
• Clock skew check is enabled by default for added hosts.

OBProxy

• OBProxy clusters support specifying a Proxyro password.
• Added a status column to the OBProxy cluster list to display the cluster status.
• Removed the restriction that OBProxy clusters with inconsistent hardware architectures are not allowed to upgrade.
• Added a Request Analysis menu, supporting statistics on request counts for clusters, tenants, and clients.
• Best practice parameters are configured by default during OBProxy deployment.

Monitoring

• Adjusted the default OCP monitoring collection frequency from 1 second to 5 seconds.
• Modified the CPU Usage chart label to Tenant CPU Consumption.
• Added IO usage and IO queue length charts to host monitoring. Added monitoring for the system, user, and iowait dimensions for CPU usage.

Other

• OCP supports the HTTPS authentication protocol, meeting the requirements of Level 3 of the Cybersecurity Classified Protection Scheme.
• The task list now supports filtering by Initiator and searching by Task Name.
• The OCP system parameter management list has added a Whether to Restart for Effectiveness column.
• Supports customizing the Agent installation directory (parameter: ocp.agent.home.path.prefix).
• Performance reports support adjusting the TopN configuration (parameter: ocp.perf.workload.report.tenant-top-sql-limit).
• Performance reports support enabling or disabling automatic snapshot capability, and support generating snapshots for specified clusters (parameters: ocp.perf.snapshot.generation.enable, ocp.perf.snapshot.generation.white-list).

Fixed Issues

OCP V4.0.1 fixes the following issues:

1. Fixed the issue where tenant allowlist synchronization failed after upgrading OCP from an older version to V3.3.3 in certain scenarios.

2. Fixed the issue where the unit of measurement for the io_util and io_qusize metrics was incorrect in OCP alerts.

3. Fixed the issue where OCP still executed the upgrade script with the original RS after an RS change occurred in some cases.

4. Fixed the issue where manual and automatic refreshes for the replica view in cluster resource management called different interfaces.

5. Fixed the issue where the server reported the error "Error writing JSON output" when binding Schema indexes for SlowSQL trace details.

6. Fixed the issue where the proxyro@sys password for the Meta cluster stored in the password box was incorrect during Antman deployment of OCP.

7. Fixed the issue where an agent started via SSH could not find the sysctl command due to an inherited PATH directory containing too few directories.

8. Fixed the issue where an OBProxy cluster could be permanently locked and inaccessible for maintenance in some cases.

9. Fixed the issue where the upgrade path could not be found when OCP uploaded the debuginfo package for the target version.

Known Issues

Version Usage Restrictions

Hardware Requirements

OCP-Server can be installed on physical servers or run in Docker containers. OCP-Server supports multi-node high-availability deployment.

The minimum hardware requirements for an OCP-Server node are listed in the following table.

OCP-Agent consumes very few resources and does not have specific hardware requirement for the installation node.

Operating System Requirements

The operating system requirements for installing the OCP server (including OCP-Agent) are listed in the following table.

Client requirements

Users typically access OCP services through a web browser. The client requirements are as follows.

If you need to access OCP from a device running iOS, the version requirements are shown in the following table.

For the best user experience, we recommend using a display with a resolution greater than 1440 × 810.