OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Cloud Platform

V3.3.1Enterprise Edition

  • Document Overview
  • Product Introduction
    • What is OceanBase Cloud Platform?
    • System architecture
    • Features
    • Limits
      • System requirements
      • Dependencies
  • Deployment Guide
    • Product Introduction
      • What is OceanBase Cloud Platform?
      • System architecture
    • Deployment
      • Overview
      • Deploy OCP on a single node
      • Deploy OCP clusters in the multi-cluster mode
    • Plan resources
      • OCP-Server specifications
      • MetaDB resources
      • MonitorDB resources
      • Host resources
    • Prepare the deployment environment
      • Standardize a host
      • Check the environment
    • Deploy OCP on a single node
      • Prepare installation media
      • Generate a configuration file
      • Multi-zone deployment
      • Deploy OCP
      • Register an OCP cluster
      • Initialize system parameters
    • Check after deployment
    • Deployment FAQ
      • Optimize MonitorDB parameters
      • F5 Big-IP LTM and alert configuration
        • Connect OBProxy to F5 Big-IP LTM
        • Connect OCP-Console to F5 Big-IP LTM
        • Monitor the OCP service health
      • Ubuntu deployment FAQ
      • EulerOS deployment FAQ
      • Client requirements
      • Start and stop OCP
  • Quick Start
    • OCP operations
    • Upload a software package
    • Add a host
    • Create a cluster
    • Create a tenant
    • Create a user
    • Create an OBProxy cluster
  • User Guide
    • OCP overview
    • Log on to the OceanBase Cloud Platform console
    • Features
      • Clusters
        • Cluster management
        • Cluster overview
        • Overview of the cluster details page
      • Tenants
        • Tenant and resource management
        • Tenant overview
        • Overview of the Tenant Details page
      • Hosts
        • Host overview
        • Host details
      • Packages
      • OBProxy
        • OBProxy management overview
        • OBProxy overview
        • OBProxy cluster overview
      • Backup and recovery
        • Overview
        • Backup and recovery overview
        • Backup overview
        • Restoration overview
        • Services
      • Monitoring
        • Drill-down monitoring
      • Diagnostics
        • Overview of SQL diagnostics
        • Overview of transaction diagnostics
      • System management
        • Alert overview
        • View tasks
        • Inspection
        • Security overview
        • View system parameters
        • Historical events
        • OCP multi-cluster mode
        • Multi-zone overview
      • Personal center
        • Specify personal information
        • Change your logon password
        • Configure alert subscription
        • Password box
          • Manage connection credentials of an OceanBase cluster
          • Manage connection credentials of an OBProxy
          • Manage connection credentials of a host
        • Log off the OCP console
    • Manage clusters
      • Cluster management operations
      • Basic cluster operations
        • Take over a cluster
        • Create a cluster
        • Delete a cluster
        • Stop a cluster
        • Restart a cluster
        • Manage zones of a cluster
          • Create a zone
          • Restart a zone
          • Stop a zone
          • Delete a zone
        • Manage OBServers of a cluster
          • Add an OBServer
          • Restart an OBServer
          • Stop an OBServer
          • Stop an OBServer process
          • Replace an OBServer
          • Delete an OBServer
        • Upgrade the version of an OceanBase cluster
        • Change the password
        • Create a standby cluster
        • Routine primary/standby cluster switchover
        • Primary/Standby cluster switchover for disaster recovery
        • Decouple a standby cluster from the primary cluster
        • Enable automatic detection of deadlocks
        • Disable automatic detection of deadlocks
        • Download logs
        • Disable SQL collection
        • iew the SQL collection history
        • Start the original primary cluster in read-only mode after a failover
      • View the topology of a cluster
      • Overview of cluster tenant management
      • Performance monitoring
      • Performance report
      • Cluster resource management
        • View unit distribution
        • View resource usage
      • Health inspection
      • Major compaction management
        • Modify major freeze configurations
        • Major compaction details
        • Major freeze statistics
        • Perform a major compaction
      • Cluster backup and recovery
      • Manage parameters
        • View parameters
        • Modify parameters
        • Parameter types
        • View the history of parameter changes
      • Manage cluster parameter templates
    • Manage tenants
      • Tenant management operations
      • Basic tenant operations
        • Create a tenant
        • Unit specification management
        • Create a user under an Oracle tenant
        • Lock a tenant
        • Copy a tenant
        • Delete a tenant
        • Add a replica
        • Change the password of the SYS tenant
        • Edit a tenant replica of a zone
        • Delete a tenant replica from a zone
        • Modify zone priorities
        • Modify the whitelist
      • View a tenant topology
      • Database management
      • User management under a MySQL tenant
      • User management under an Oracle tenant
        • User overview under an Oracle tenant
        • Create a user under an Oracle tenant
        • Change the password of a user under an Oracle tenant
        • Delete a user under an Oracle tenant
        • Create a role under an Oracle tenant
        • Manage users
        • Manage roles
      • Performance monitoring
      • Tenant resource management
      • Transaction diagnostics
      • SQL diagnostics
        • Suspicious SQL diagnostics
        • TopSQL diagnostics
        • SlowSQL diagnostics
        • ParallelSQL diagnostics
        • View SQL statement details
        • View the SQL collection enable/disable history
        • View outlines
        • View SQL request analysis
      • Backup and recover a tenant
      • Manage sessions
        • View tenant sessions
        • View session statistics
        • View deadlock analysis
        • Manage ASH report
      • Manage parameters
        • View the parameters
        • Modify a parameter
        • View the parameter modification history
      • Manage tenant parameter templates
    • Manage hosts
      • Host management operations
      • Add a host
      • Modify a host
      • Restart OCP Agent
      • Reinstall OCP Agent
      • Host monitoring
    • Manage software packages
      • Upload a software package
      • Download a software package
      • Delete a software package
    • Manage OBProxies
      • Create an OBProxy cluster
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Upgrade an OBProxy
      • Add an OBProxy
      • Refresh OBProxy configurations
      • Monitor OBProxy cluster performance
      • OBProxy cluster parameter management
      • Add a connectable OceanBase cluster
      • Delete an OBProxy cluster
      • Upgrade all OBProxies in an OBProxy cluster
      • Restart all OBProxies in an OBProxy cluster
      • Delete a connected OceanBase cluster
    • Use backup and recovery
      • Backup and recovery management operations
      • Backup and recovery guide
      • Create a backup strategy
      • Back up now
      • Create a sampling strategy for recovery
      • Initiate a recovery task
      • Install a service
      • Add a node
      • Upgrade the version of a service
      • Update service configurations
      • Copy a service
      • Delete a service
      • Stop a service on a node
      • Restart a service on a node
      • View operation and maintenance tasks
      • Uninstall a service on a node
    • Manage alerts
      • Alert-related concepts
      • Create an alert item
      • View alert items
      • Copy an alert item
      • Edit an alert item
      • Delete an alert item
      • Alert groups
      • Create an alert channel
      • View alert channels
      • Edit an alert channel
      • Delete an alert channel
      • View alert events
      • View the alert notification history
      • Create a blocking condition
      • Edit a blocking condition
      • Delete a blocking condition
      • Add a filtering keyword
      • Modify the expiration time of a filter keyword
      • Delete a filter keyword
      • Create an alert subscription
      • Manage alert subscriptions
    • Use system management
      • Role overview
      • Create a role
      • Manage roles
      • Copy a role
      • Create a user
      • View users
      • Edit a user
      • Copy a user
      • Change a user password
      • Delete a user
      • Logon history
      • Manage system parameters
      • Query logs
      • Manage tasks
      • Use the inspection feature
        • Initiate an inspection
        • Create an inspection rule
        • Modify inspection scheduling
        • Modify an inspection rule
        • Delete an inspection rule
        • View inspection rules
    • Manage OCP clusters in the multi-cluster mode
      • Register an OCP cluster
      • Leader \& Follower Details
      • Manage OCP cluster parameters
      • Switch an OCP cluster in daily maintenance
      • Switch an OCP cluster in a failover
      • Delete a faulty follower OCP cluster
      • Unbind a leader and a follower OCP cluster
    • Manage OCP in multi-zone mode
      • View details of multiple zones
      • Manage parameters in multi-zone mode
    • Appendix
      • OCP configuration parameters
      • SQL performance module
      • OCP resource unit specifications
      • OCP error table
      • OCP alert template variables
      • Call an alert API
      • OCP background tasks
      • Monitoring metrics
      • Examples of alert channel configuration
      • OBProxy startup parameters
      • System privileges in a MySQL tenant
      • Component listening port list
      • OCP-Agent processes
      • Enable the OCP multi-cluster mode
      • PAM permission denied
      • Failed to upload the software package
      • Check the sudo permissions of a user
      • Default OCP roles
      • FAQ about multi-zone mode
      • FAQ about OBProxy takeover
      • Diagnose XA transactions and suspended transactions
  • Metric reference
    • Overview of metrics
    • OceanBase cluster
      • QPS
      • Query response time
      • TPS
      • Transaction response time
      • Request queue time
      • Number of sessions
      • TPS
      • Number of transaction logs
      • Transaction log volume
      • Time consumed by transaction logs
      • IOPS
      • Time consumed by I/O operations
      • I/O throughput
    • OceanBase Database tenant
      • QPS
      • Response time
      • Sessions
      • SQL execution plan types
      • Wait events
      • Time consumed by waiting events
      • Request queue
      • Request queue time
      • CPU utilization
      • MemStore usage
      • Time consumed by RPC packets
      • RPC packet throughput
      • opened_cursors
      • Clog synchronization delay
      • TPS
      • Transaction response time
      • Number of transaction logs
      • Transaction log volume
      • Time consumed by transaction logs
      • Lock waits
      • Time consumed by lock waits
      • TPS
      • MemStore
      • IOPS
      • Time consumed by I/O operations
      • I/O throughput
      • Cache size
      • Cache hit rates
      • Number of cache requests
    • OBProxy cluster
      • TPS
      • Requests per second
      • Client connections
      • Server connections
      • Average response time for each SQL statement
      • Average error packets per second
      • Average route table queries per second
      • Average bytes in a network request or response
    • Host
      • Linux system load
      • CPU utilization
      • IOPS
      • Time consumed by I/O operations
      • I/O throughput
      • Network throughput
      • Memory
      • Disk
  • Troubleshooting
    • Failed to register a follower OCP cluster
    • Failed to add credentials to the password box
    • Restricted OCP logon
    • Failed to view logs in OCP
    • Failed to upload the software package
    • Do IO Bench error
    • Check the sudo permissions of a user
    • PAM permission denied
    • Resolve the problem of no sudo permissions when adding a host
    • Questions about OCP-Agent
      • Exceptions of the ocp_agent processes
      • System resource constraints and PAM
    • Appendix
      • Processes
      • OCP-Agent O\&M script
  • Alert Reference
    • Alert Reference
    • OceanBase alerts
      • ob_cannot_connected
      • ob_cluster_rs_not_same
      • ob_cluster_status_check_failed
      • ob_cluster_exists_inactive_server
      • ob_cluster_exists_index_fail_table
      • ob_cluster_frozen_version_delta_over_threshold
      • ob_cluster_merge_error
      • ob_cluster_merge_timeout
      • ob_cluster_no_frozen
      • ob_cluster_no_merge
      • ob_cluster_operation_info
      • ob_cluster_sync_failed
      • ob_cpu_assigned_percent_over_threshold
      • ob_cpu_percent_over_threshold
      • ob_host_connection_percent_over_threshold
      • ob_host_disk_readonly
      • ob_tenant_expired_trans_exist
      • ob_host_load1_per_cpu_over_threshold
      • ob_host_partition_count_over_threshold
      • ob_log_alarm
      • ob_mem_assigned_percent_over_threshold
      • ob_server_sstable_percent_over_threshold
      • ob_tenant_long_trans_exist
      • ob_tenant_operation_info
      • ob_tenant500_mem_hold_over_threshold
      • ob_tenant500_mem_hold_percent_over_threshold
      • ob_zone_sstable_percent_over_threshold
      • tenant_active_memstore_percent_over_threshold
      • tenant_cpu_percent_over_threshold
      • tenant_memstore_percent_over_threshold
      • obproxy_process_dead
      • obproxyd_process_dead
      • obproxy_cannot_connected
      • ob_cluster_sync_delay_time_too_long
      • ob_host_data_disk_percent_over_threshold
      • ob_host_log_disk_percent_over_threshold
      • ob_host_install_disk_percent_over_threshold
      • ob_tenant_exists_expired_xa_trans
      • ob_cluster_active_session_count_over_threshold
      • ob_tenant_active_session_count_over_threshold
      • ob_host_active_session_count_over_threshold
      • ob_tenant_full_clog_sync_delay
      • ob_tenant_readonly_clog_sync_delay
      • ob_tenant_logonly_clog_sync_delay
      • ob_tenant_slow_sql_exists
      • ob_tenant_large_trans_exist
      • same_alarm_rule_detect_too_many_targets
      • ob_tenant_task_timeout
      • ob_tenant_memtable_release_timeout
    • Application alerts
      • ob_cluster_inspection_not_passed
      • ob_host_ssd_wear_indicator_over_threshold
      • ob_host_mem_percent_over_threshold
      • ob_host_net_recv_percent_over_threshold
      • ob_host_net_send_percent_over_threshold
      • ob_host_tcp_retrans_percent_over_threshold
      • ob_host_cpu_percent_over_threshold
      • no_enough_exporter
      • inc_backup_delay
      • base_backup_fail
      • base_backup_too_long_time_no_one_success_task
      • backup_process_dead
      • backup_storage_capacity_over_threshold
      • backup_storage_capacity_retry_times_exceeded
      • backup_storage_capacity_timeout_or_interrupted
      • ocp_remote_server_time_diff_too_large
      • monitor_exporter_unavaliable
      • system_obproxy_unavailable
      • host_unavailable
      • host_ntp_offset_too_large
      • host_ntp_service_not_exist
      • host_agent_res_memory_over_threshold
      • host_agent_open_fd_count_over_threshold
      • host_agent_goroutine_count_over_threshold
      • partition_create_failed
      • obagent_dead
      • host_disk_readonly
      • ic_server_connect_failed
      • vpc_connect_failed
    • Appendix
      • Set an alert-blocking condition
      • Modify alert thresholds
      • Exception handling for OceanBase cluster compaction
      • OCP-Agent script
      • Apply throttling to an OceanBase cluster
      • Network troubleshooting
      • Tables managed by the daemon
      • Examples of alert channel configuration
  • API Reference
    • Overview
    • API call description
    • Cluster information
      • Query clusters
      • Create an OceanBase cluster
      • Delete an OceanBase cluster
      • Stop an OceanBase cluster
      • Start an OceanBase cluster
      • Restart an OceanBase cluster
      • Upgrade an OceanBase cluster
      • Query zones of an OceanBase cluster
      • Create a zone for an OceanBase cluster
      • Delete a zone from an OceanBase cluster
      • Stop a zone in an OceanBase cluster
      • Start a zone in an OceanBase cluster
      • Restart a zone in an OceanBase cluster
      • Add an OBServer
      • Delete multiple OBServers at a time
      • Stop an OBServer
      • Start an OBServer
      • Restart an OBServer
      • Replace an OBServer
      • Change the password of an OceanBase cluster
      • Query the parameter metadata of an OceanBase cluster
      • Query parameters of an OceanBase cluster
      • Modify parameters of an OceanBase cluster
      • Query servers
      • Query servers in a zone
    • Tenant information
      • Query tenants of a cluster
      • Query all tenants
      • Query details about a tenant
      • Create a tenant
      • Delete a tenant
      • Lock a tenant
      • Unlock a tenant
      • Query units of a tenant
      • Delete a unit from a tenant
      • Add a replica for a tenant
      • Delete a replica of a tenant
      • Modify a replica of a tenant
      • Modify zone priorities of a tenant
      • Change the administrator password of a tenant
      • Modify the whitelist of a tenant
      • Query parameters of a tenant
      • Modify parameters of a tenant
      • OceanBase database management
        • Query databases
        • Create a database
        • Modify a database
        • Delete a database
    • Hosts
      • Query regions
      • Query details about a region
      • Add a region
      • Delete a region
      • Query IDCs
      • Query details about an IDC
      • Add an IDC
      • Delete an IDC
      • Query host types
      • Query details about a host type
      • Add a host type
      • Delete a host type
      • Query hosts
      • Query details about a host
      • Add multiple hosts at a time
      • Delete a host
      • Delete multiple hosts at a time
    • Software packages
      • Query software packages
      • Upload a software package
      • Delete a software package
    • OBProxy management
      • Create an OBProxy cluster
      • Delete an OBProxy cluster
      • Query OBProxy clusters
      • Query details about an OBProxy cluster
      • Update configurations of an OBProxy cluster
      • Add an OBProxy
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Upgrade an OBProxy
      • Add a connectable OceanBase cluster for an OBProxy cluster
      • Remove a connectable OceanBase cluster from an OBProxy cluster
      • Query the parameter metadata of an OBProxy
      • Query parameters of an OBProxy cluster
    • Monitoring
      • Query the metadata of a monitoring metric
      • Query monitoring data
      • Query monitoring data and attach a tag to the data
    • Alerts
      • Alert events
        • Query the alert event list
        • Query alert events
      • Alert notifications
        • Query alert notifications
    • Task management
      • Query tasks
      • Query details about a task
      • Retry a task
      • Roll back a task
      • Query logs of a subtask instance
      • Retry a subtask
      • Skip a subtask
      • Cancel a subtask
    • OCP event history
      • Query event history
    • OceanBase user and privilege management
      • Query database user details
      • Query database user details
      • Create a database user
      • Delete a database user
      • Change the password of a database user
      • Lock a database user
      • Unlock a database user
      • Query the database role details
      • Query database role details
      • Create a database role
      • Delete a database role
      • Query database objects
      • Grant global privileges to a user
      • Revoke global privileges of a user
      • Change global privileges of a user
      • Grant global privileges to a role
      • Revoke global privileges of a role
      • Change global privileges of a role
      • Grant roles to a user
      • Revoke roles of a user
      • Change roles of a user
      • Grant roles to a role
      • Revoke roles of a role
      • Change roles of a role
      • Grant database privileges to a user
      • Revoke database privileges of a user
      • Change database privileges of a user
      • Grant object privileges to a user
      • Revoke object privileges of a user
      • Change object privileges of a user
      • Grant object privileges to a role
      • Revoke object privileges of a role
      • Change object privileges of a role
    • OCP Agent management
      • Query OCP Agent details on a host
      • Stop basic OCP Agent processes on a host
      • Batch stop basic OCP Agent processes on a host
      • Restart basic OCP Agent processes on a host
      • Batch restart basic OCP Agent processes on a host
      • Query OCP Agent processes on a host
      • Restart OCP Agent processes on a host
      • Stop OCP Agent processes on a host
    • SQL performance
      • Query performance indicators of an SQL statement
      • Query the performance indicator trend of an SQL statement
      • Query SQL text
      • Query performance indicators of an execution plan
      • Query the performance indicator trend of an execution plan
      • Query the operator structure of an execution plan
    • Backup and recovery
      • Query backup capabilities of a cluster
      • Create a backup strategy for a cluster
      • Modify the backup strategy of a cluster
      • Delete the backup strategy of a cluster
      • Query the backup strategy of a cluster
      • Query the backup overview of a cluster
      • Query data backup tasks of a cluster
      • Query log backup tasks of a cluster
      • Query recovery tasks of a cluster
      • Immediately back up a cluster
      • Parse cluster backup data
      • Initiate tenant recovery
    • Others
      • Query the basic information of an OCP application
      • Query OCP server time
      • Query OCP application status
    • Appendix
      • Task information
      • View alerts through APIs
  • FAQ
    • FAQ on deployment
    • FAQ on upgrade
    • FAQ on monitoring
      • FAQ on monitoring metrics
      • FAQ on SQL monitoring
      • FAQ about resource usage
    • FAQ on alerts
    • FAQ on O&M
      • FAQ on accounts and passwords
      • FAQ on host management
      • FAQ on OceanBase clusters
      • FAQ on OceanBase tenants
      • FAQ on OBProxy
      • FAQ on the OCP software package
      • FAQ on backup and recovery
    • FAQ on the OCP system
    • OCP multi-cluster FAQ

Download PDF

Document Overview What is OceanBase Cloud Platform? System architecture Features System requirements Dependencies What is OceanBase Cloud Platform? System architecture Overview Deploy OCP on a single node Deploy OCP clusters in the multi-cluster mode OCP-Server specifications MetaDB resources MonitorDB resources Host resources Standardize a host Check the environment Prepare installation media Generate a configuration file Multi-zone deployment Deploy OCP Register an OCP cluster Initialize system parameters Check after deployment Optimize MonitorDB parameters Ubuntu deployment FAQ EulerOS deployment FAQ Client requirements Start and stop OCP OCP operations Upload a software package Add a host Create a cluster Create a tenant Create a user Create an OBProxy clusterOCP overview Log on to the OceanBase Cloud Platform console Packages Cluster management operations View the topology of a cluster Overview of cluster tenant managementPerformance monitoring Performance report Health inspection Cluster backup and recovery Manage cluster parameter templatesTenant management operations View a tenant topology Database management User management under a MySQL tenant Performance monitoring Tenant resource management Transaction diagnostics Backup and recover a tenant Manage tenant parameter templatesHost management operations Add a host Modify a host Restart OCP Agent Reinstall OCP Agent Host monitoring Upload a software package Download a software package Delete a software package Create an OBProxy cluster Take over an OBProxy Delete an OBProxy Restart an OBProxy Upgrade an OBProxy Add an OBProxy Refresh OBProxy configurations Monitor OBProxy cluster performance OBProxy cluster parameter management Add a connectable OceanBase cluster Delete an OBProxy cluster Upgrade all OBProxies in an OBProxy cluster Restart all OBProxies in an OBProxy cluster Delete a connected OceanBase cluster Backup and recovery management operations Backup and recovery guide Create a backup strategy Back up now Create a sampling strategy for recovery Initiate a recovery task Install a service Add a node Upgrade the version of a service Update service configurations Copy a service Delete a service Stop a service on a node Restart a service on a node View operation and maintenance tasks Uninstall a service on a node Alert-related concepts Create an alert item View alert items Copy an alert item Edit an alert item
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Cloud Platform
  3. V3.3.1
iconOceanBase Cloud Platform
V 3.3.1Enterprise Edition
  • V 4.3.6
  • V 4.3.5
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.2
  • V 4.0.0 and earlier
Community Edition
  • V 4.0.0
  • V 3.1.1
Enterprise Edition
  • V 4.0.0
  • V 3.3.1

Performance report

Last Updated:2023-08-15 11:20:59  Updated
share
What is on this page
Introduction
Generate a performance report
View and download a report

folded

share

This topic describes how to use a performance report. A performance report provides you with information about the cluster load, performance, and SQL statements within a specified period of time, and helps you learn the cluster running status and troubleshoot performance-related problems.

Introduction

OceanBase Cloud Platform (OCP) can generate cluster performance reports. The Reports list on the Performance Reports page contains the following columns: Report Name , Snapshot Start Point , Snapshot End Point , Created By , Generation Status , Generated At , and Actions. The Actions column provides the View Report and Download Report options.

  • You can sort the reports by Snapshot Start Point , Snapshot End Point , and Generated At .

  • You can filter the reports by Generation Status .

Generate a performance report

  1. Log on to the OCP console. In the left-side navigation pane, click Clusters .

  2. Find the target cluster in the Clusters list and click the cluster name. The Overview page appears.

  3. In the left-side navigation pane, click Performance Report to go to the performance report details page.

  4. Click Generate Performance Report in the upper-right corner on the page that appears.

  5. In the dialog box that appears, set the following parameters.1

    Parameter Description
    Report Name Required. The name of the report.
    Snapshot Start Point You can select only a point in time in the past 30 days. The available points in time are fixed and cannot be customized.
    Snapshot End Point You can select only a point in time within 24 hours after the Snapshot Start Point. The available points in time are fixed and cannot be customized.
  6. If the SQL monitoring data of a tenant is abnormal in the performance report, select the tenant from the View OceanBase Tenant ASH Report drop-down list to go to the ASH Report page of the tenant.

    2

  7. Click OK . A report is generated for the performance between the snapshot start point and the snapshot end point. You can view the report in the Reports list and download it.

View and download a report

OCP shows a list of performance reports generated in the last 90 days.

  • To view a performance report, click View Report in the Actions column.

  • To download a performance report in the .html format, click Download Report in the Actions column.

You can view the following information in a performance report:

  • Basic information

    Parameter Description
    Basic Cluster Information Includes the cluster version, cluster type, number of hosts, number of tenants, and start time and end time of the last major compaction.
    Node Basic Information Includes the host IP address, zone, availability of Root Server, status, service start time, and time of last deletion.
    Node Resources Includes the host IP address, zone, total CPU cores, allocated CPU cores, allocated CPU resources in percentage, total memory in MB, allocated memory in MB, allocated memory in percentage, disk usage in GB, and disk usage in percentage.
    Node Partitions Includes the host IP address, zone, associated tenants, number of partitions, and number of leader partitions. Note that the number of partitions includes the number of leader partitions.
    Tenant Resources Includes the tenant name, tenant ID, tenant type, resource unit configuration, zone priority, locality, and list of servers.
    Tenant Capacity Includes the associated tenants, tenant ID, associated hosts, and data capacity.
  • Workload Statistics: The table includes the following columns: Metrics , Cumulative Value , Start Value , End Value , Maximum Value , Maximum Value Occurred At , Minimum Value , Minimum Value Occurred At , and Average Value . For more information about monitoring metrics, see Metrics.

  • SQL Statistics

    Parameter Description
    SQL Sorted by Total Response Time * Top 10 SQL statements with the longest response time in the cluster. * Top 10 SQL statements with the longest response time in the tenant.
    SQL Sorted by CPU Time * Top 10 SQL statements with the longest CPU time in the cluster. * Top 10 SQL statements with the longest CPU time in the tenant.
    SQL Sorted by I/O Latency * Top 10 SQL statements with the longest I/O wait time in the cluster. * Top 10 SQL statements with the longest I/O wait time in the tenant.
    SQL Sorted by Network Latency * Top 10 SQL statements with the longest network latencies in the cluster. * Top 10 SQL statements with the longest network latencies in the tenant.
    SQL Sorted by Logical Reads * Top 10 SQL statements with the most logical reads in the cluster. * Top 10 SQL statements with the most logical reads in the tenant.
    SQL Sorted by Physical Reads * Top 10 SQL statements with the most physical reads in the cluster. * Top 10 SQL statements with the most physical reads in the tenant.
    SQL Sorted by Executions * Top 10 most executed SQL statements in the cluster. * Top 10 most executed SQL statements in the tenant.
    SQLs Sorted by Number of Remote Plan Executions * Top 10 most executed SQL statements in the cluster. * Top 10 most executed SQL statements in the tenant.
    SQLs Sorted by Distributed Plan Executions * Top 10 most executed SQL statements in the cluster. * Top 10 most executed SQL statements in the tenant.
    SQL Sorted by Affected Rows * Top 10 SQL statements affected most rows in the cluster. * Top 10 SQL statements affected most rows in the tenant.
    SQL Texts Displays the information of all the preceding SQL statements.
  • Cache Statistics

    This module provides the average KV cache hit rate of tenants. The statistic data source is the OceanBase view gv$systat. The hit rate is accurate to two decimal places.

    You can view the statistics of the following 7 types of caches: Block Cache, Block Index Cache, Clog Cache, Clog Index Cache, BloomFilter Cache, Location Cache, and Row Cache. The following statistics are displayed: cache hit rate, cache requests, and cache size. Note

    In the statistic report, you can move the pointer over a parameter in the table header to view the parameter description.

    Parameter Description
    Cache Hit Rate The hit rates of different types of caches in different tenants in the snapshot period. For more information about the cache types, see Caching.
    Cache Request Information about caches and cache requests in different tenants in the snapshot period, such as the number of cache requests, cache hits, and cache mishits.
    Cache Size The size of different types of caches in different tenants in the snapshot period. The start and end positions are displayed.
  • RPC Statistics

    Note

    In the statistic report, you can move the pointer over a parameter in the table header to view the data source of the parameter.

    Parameter Description
    Total RPCs The number and size of RPCs, RPC latencies, and the number of failed RPCs collected in dimensions of tenant and host. Sort RPCs by RPC size and display the Top 10 results.
    Package Code RPC Sort RPCs by package code and display the Top 10 results.
    Clog RPC Information about Clog RPCs collected in dimensions of tenant and host, such as the number of all Clog RPCs and successful Clog RPCs, and total time consumed by successful Clog RPCs.
    GTS RPC The number of GTS RPCs collected in dimensions of tenant and host.
    Location Cache RPC Information about Location Cache RPCs collected in dimensions of tenant and host, such as the number of all cache refreshes, cache refreshes by RPCs, and failed cache refreshes by RPCs.
  • Lock Statistics

    Parameter Description
    Row Lock Statistics The number of applications, waits, and timeouts, and wait time of row locks in a tenant.
    Latch Statistics You can view the following statistics on latches in a tenant: * Get: indicates the number of successful willing-to-wait latch requests. * Miss: indicates the number of failed willing-to-wait latch requests. * Sleep: indicates the number of failed willing-to-wait latch requests that result in process sleeps. * Spin Get: indicates the total number of spins in the tenant. * Immediate Get: indicates the number of successful immediate latch requests. * Immediate Miss: indicates the number of failed immediate latch requests.
  • Parameter Changes

    This module provides information about the changes of the parameters collected in dimensions of cluster, zone, server, and tenant in the snapshot period.

Previous topic

Performance monitoring
Last

Next topic

View unit distribution
Next
What is on this page
Introduction
Generate a performance report
View and download a report