OceanBase logo

OceanBase

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

Product Overview
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

OceanBase

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

Product Overview
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

V4.4.2

  • What's New
    • Product Updates
  • Product Introduction
    • What is OceanBase Cloud Platform
    • Differences between Enterprise Edition and Community Edition
    • System architecture
    • Features
    • Limits
      • System requirements
      • Dependencies
  • Deploy OceanBase Cloud Platform (OCP)
    • Deploy OceanBase Cloud Platform (OCP) Enterprise Edition
      • Deployment overview
        • Deploy OCP cluster in the Single-node
        • Deploy OCP cluster in the High-availability
      • Prepare the deployment environment
        • Install OAT
        • Add a server
        • Check the environment
      • Deploy OCP
        • Plan resources
          • Host resources
          • OCP service configuration requirements
          • Planning resources of a single node OCP
            • OCP-Server specifications
            • MetaDB resources
            • MonitorDB resources
            • Host resources
          • MetaDB Resources
          • Planning resources of a high availability OCP
            • OCP-Server specifications
            • MetaDB resources
            • MonitorDB resources
            • Host resources
          • MonitorDB Resources
        • Deploy OCP
          • Prepare installation media
          • Deploying a single point of OCP
            • Prepare installation media
            • Create MetaDB
            • Install OCP
            • Initialize system parameters
          • Create MetaDB
          • Deploying a high availability of OCP
            • Prepare installation media
            • Create MetaDB
            • Install OCP
            • Register an OCP cluster
            • Initialize system parameters
          • Install 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
      • Appendix
        • Uninstall OCP
        • Check the NTP offset
    • Deploy OceanBase Cloud Platform (OCP) Community Edition
      • Overview
      • Installation process
      • Installation planning
        • User planning
        • Host planning
        • Disk and directory planning
        • Port planning
      • Prepare for the installation
      • Deploy OCP on the GUI
      • Use Docker to deploy OCP
      • Post-deployment check
      • Appendix
        • Install Docker
        • Uninstall OCP
        • Restart OCP
        • FAQ about deployment
  • Upgrade OceanBase Cloud Platform (OCP)
    • Upgrade OceanBase Cloud Platform (OCP) Enterprise Edition
      • Overview
      • Considerations
      • Preparations
      • Upgrade OCP
        • Take over OCP
        • Upgrade OCP
      • Verify after upgrade
        • Verify the cluster feature
        • Verify the tenant feature
        • Verify the host feature
        • Verify the software package feature
        • Verify the OBProxy feature
        • Verify the backup and restore feature
        • Verify alerts
        • Verify the task feature
        • Verify the password box feature
      • Appendix
        • Change a user's password
        • Version mapping
    • Upgrade OceanBase Cloud Platform (OCP) Community Edition
      • Upgrade OCP on the GUI
      • Upgrade OCP using Docker containers
      • Post-upgrade check
  • Quick Start
    • OCP operations
    • Log on to the OCP console
    • Upload a software package
    • Add hosts
    • Create a cluster
    • Create a primary tenant
    • Create a user
    • Create an OBProxy cluster
  • Cluster Management
    • Overview
    • Create a cluster
      • Create a distributed cluster
      • Create a standalone deployment
    • Manage clusters
      • Create a standby cluster
      • View details of a cluster
      • Scale a standalone system to a distributed cluster
      • Take over a cluster
      • Restart a cluster
      • Stop a cluster
      • Move out a cluster
      • Delete a cluster
      • Change the password
      • Manage Arbitration Service of a cluster
        • Add an arbitration service
        • Add an arbitration service group
        • Replace the arbitration service for a cluster
        • Remove an arbitration service
      • Enable automatic detection of deadlocks
      • Disable automatic detection of deadlocks
      • Manage O&M configuration
        • Overview
        • Manage parameters
        • View the parameter modification history
        • Configure resources for OCP Agent
      • Manage CPU binding configurations
      • View tenant-level information
      • Import a license
      • View the license
    • Manage zones of a cluster
      • Add a zone
      • Edit a zone
      • Restart a zone
      • Stop a zone
      • Delete a zone
    • Manage OBServers of a cluster
      • Add an OBServer node
      • Restart a faulty OBServer node
      • Stop an OBServer service
      • Stop an observer process
      • Replace an OBServer node
      • Reinstall an OBServer
      • Delete an OBServer
    • Upgrade version
    • View the topology of a cluster
    • Overview of cluster tenant management
    • View real-time monitoring data
    • Manage cluster resource
      • View the unit distribution
      • View resource usage
    • Manage major compaction of a cluster
      • Modify the major compaction settings of a cluster
      • Perform a major compaction
      • View details of a major compaction
      • View statistics of a major compaction
      • View the major compaction records
    • Manage security configurations
      • Manage SSL Link Encryption
      • Manage Transparent Data Encryption (TDE)
    • Manage SQL Audit
    • Manage cluster parameters
      • Parameter types
      • View parameters
      • Modify parameters
      • View the history of parameter changes
    • Manage Arbitration Services
      • Arbitration service Overview
      • Create an arbitration service
      • Take over an arbitration service
      • Stop an arbitration service
      • Start an arbitration service
      • Upgrade an arbitration service
      • Restart an arbitration service
      • Migrate an arbitration service
      • Replace an arbitration service
      • Associate a cluster
      • Dissociate an arbitration service
      • Delete an arbitration service
    • Manage Service Groups
      • Overview
      • Create an arbitration service group
      • Upgrade an arbitration service group
      • Edit an arbitration service group
      • Delete an arbitration service group
    • Manage cluster parameter templates
  • Tenant Management
    • Tenant and resource management
    • View tenant overview information
    • Create a primary tenant
    • Manage tenants
      • Overview
      • Create a standby tenant
      • Copy a tenant
      • Rename a tenant
      • Lock a tenant
      • Clone a tenant
      • Delete a tenant
      • Change the password of the sys tenant
      • Change the synchronization configuration
      • Enable Asymmetric Zone
      • Configure full link tracking for a tenant
      • Manage tenant parameters
      • Change the primary/standby protection mode
      • Modify the allowlist of a tenant
      • Modify the zone priority
      • Manage the binlog service for a tenant
      • Manage service names
    • Manage topulogy of a tenant
      • View tenant topology
      • View the topology of the primary/standby relationships of a tenant
    • Manage replicas of a tenant
      • Add a replica
      • Edit tenant replicas in a zone
      • Delete a tenant replica from a zone
      • Delete a unit
    • Manage databases
    • Manage users and permissions under a tenant
      • Manage users in a MySQL tenant
      • Manage user under an Oracle tenant
        • User overview under an Oracle tenant
        • Create a user under an Oracle tenant
        • Lock an Oracle tenant user
        • 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
      • System permissions
    • Manage resource isolation
      • Overview
      • Create a resource group
      • Create a resource isolation plan
      • Enable or disable a resource isolation plan
      • Modify a resource isolation plan
      • Delete a resource isolation plan
      • Modify a resource group
      • Delete a resource group
    • Manage the resources of a tenant
    • Manage major compaction under a tenant
      • Modify major compaction settings of a tenant
      • View details of tenant major compaction
      • Perform a major compaction
      • View the major compaction records
    • Manage statistical information
      • Overview
      • Collect statistics
      • Manage statistics collection tasks
    • Manage tenant parameters
      • View the parameters
      • Modify a parameter
      • View the parameter modification history
    • Manage unit specifications
    • View OCP resource unit specifications
    • Manage tenant parameter templates
  • OBProxy Management
    • OBProxy management overview
    • View details on the OBProxy page
    • Create an OBProxy cluster
    • Manage OBProxy Clusters
      • View details on the Overview page of an OBProxy cluster
      • Add a connectable OceanBase cluster
      • Manage load balancing
      • Change the password of the proxysys user
      • Change the password of the proxyro user
      • Move out an OBProxy cluster
      • Delete an OBProxy cluster
      • Upgrade an OBProxy cluster
      • Manage CPU core binding configurations
      • Stop or start an ODP cluster
      • Restart an ODP cluster
      • Delete a connected OceanBase cluster
      • Manage the proxyro account
    • Manage OBProxy Servers
      • Add an OBProxy
      • Take over OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Stop or start an OBProxy
      • Remove an OBProxy
      • Launch an OBProxy
      • Upgrade an OBProxy
      • Refresh OBProxy configurations
    • Request analysis
    • Manage security configurations
    • Manage OBProxy cluster parameters
    • Client configuration
    • Manage OBProxy parameter templates
    • OBProxy parameters descpription
  • Binlog Service Management
    • Overview of Binlog service
    • Create a binlog cluster
    • Manage Binlog Clusters
      • View information about a binlog cluster
      • Upgrade a binlog cluster
      • Start and stop a binlog cluster
      • Restart a binlog cluster
      • Delete a binlog cluster
      • Manage binlog cluster parameters
    • Manage Binlog Instance
      • View a binlog instance
      • Add an instance replica
      • Configure throttling
      • Start and stop a binlog instance
      • Restart a binlog instance
      • Switch primary and standby instances
      • Delete a Binlog instance
      • Manage binlog instance parameters
    • Manage Binlog Server
      • Add a binlog node
      • Start and stop a binlog server
      • Delete a binlog server
      • Clear binlog instances on a host
    • Manage binlog parameter templates
  • Host Management
    • Manage hosts
      • Host management operations
      • View host details
      • Add a host
      • View the details of tasks on a host
      • Modify a host
      • Restart OCP-Agent
      • Reinstall OCP Agent
      • Remove a host
      • Check host standardization
      • Host standardization check items
      • OCP-Agent processes
      • OCP-Agent O&M Script Instructions
    • Manage Host Types
    • Manage IDCs
    • Manage Regions
  • Alert Management
    • Overview
    • Alert-related concepts
    • View the alert overview
    • Manage alert rules
      • Create an alert rule
      • View an alert rule
      • Copy an alert rule
      • Edit an alert rule
      • Delete an alert rule
      • Alert rule groups
      • Export alert rule configurations
    • Manage alert templates
      • Create an alert template
      • Set alert objects
      • Export alert templates
      • View an alert template
      • Copy an alert template
      • Edit an alert template
      • Delete an alert template
    • Manage alert channels
      • Create an alert channel
      • View an alert channel
      • Edit an alert channel
      • Copy an alert channel
      • Delete an alert channel
      • Examples of alert channel configuration
      • Examples of alert channel configuration
    • Manage alert push
      • Create an alert push
      • View an alert push
      • Edit an alert push
      • Delete an alert push
    • View alert events
    • Manage blocking conditions
      • Create a blocking condition
      • Edit an alert blocking condition
      • Delete an alert blocking condition
    • OCP alert template tag
    • Optional monitoring metrics for custom alerts
  • Dashboard Management
    • Monitoring dashboard overview
    • Manage dashboards
    • Manage groups
    • Manage charts
  • Performance Monitoring
    • Manage monitoring
      • Overview
      • View database performance
      • View host performance monitoring data
      • View OBServer node performance monitoring data
      • View performance and SQL monitoring data
      • View transaction performance monitoring data
      • View storage and cache monitoring data
      • View database object monitoring data
      • View OBKV-Table monitoring data
      • View OBKV-HBase monitoring data
      • View OBKV-Redis monitoring data
      • View subscription connection monitoring charts
      • View performance monitoring data of a binlog instance
      • View resource monitoring data of a binlog instance
      • View host resource monitoring data
      • View host process monitoring data
      • View service monitoring data
      • View system monitoring data
      • View performance monitoring
      • Drill-down monitoring
      • Integrate monitoring data to an external time-series system
    • Use the custom monitoring feature
      • Overview
      • View collection items
      • Manage indicator items
        • Create a metric
        • Manage metrics
      • Manage charts
        • Create a chart
        • Manage charts
      • OCP metrics
  • Diagnostics and Tuning
    • SQL diagnostics
      • SQL diagnostics introduction
        • SQL diagnostics overview
        • SQL statement execution statistics
        • SQL execution plans
      • View the OceanBase Autonomy Service page
      • Diagnose suspicious SQL statements
      • Diagnose top SQL statements
      • View Comparison of Top SQL Statements
      • Diagnose slow SQL statements
      • Diagnose parallel SQL statements
      • Diagnose high-risk SQL statements
      • Diagnose new SQL statements
      • View the details of an SQL statement
      • View outlines
      • View the SQL collection enabling/disabling history
      • View SQL request analysis data
      • Parameters related to SQL performance diagnostics
    • Transaction diagnostics
      • Transaction overview
      • Diagnose transactions
      • Diagnose XA transactions and suspended transactions
    • Manage sessions
      • Manage the sessions of a tenant
      • View session statistics
      • View the deadlock history
      • View row lock analytics
    • View materialized views
    • View the Optimization Center page
    • View the capacity center
    • View diagnostics reports
      • Manage performance reports
      • Manage ASH reports
  • O&M Management
    • Manage information collection
      • Overview
      • Configure information collection items
      • Create an information collection task
      • View information collection details
      • Download an information collection report
    • Manage plans
      • Overview
      • Manage plans
      • View plan execution details
    • Manage inspections
      • Overview
      • Configure inspection items
      • Configure scheduling rules
        • Configure a scheduling rule for a single inspection object
        • Configure global scheduling rules
      • Initiate an inspection
        • Initiate an inspection for a single object
        • Initiate a global inspection
      • View an inspection task
      • Manage inspection reports
        • View an inspection report
        • Download an inspection report
    • Manage scheduled tasks
      • Overview of Scheduled Tasks
      • Create a scheduled task
      • Manage scheduled tasks
      • View scheduled task details
    • Manage the report center
  • AI Assistant
    • Manage an AI intelligent conversation
    • Enable AI-powered intelligent conversation
    • Overview
  • Backup and Recovery
    • Copy a restore task
    • Overview
    • Backup and restore guide
    • Initiate a restore task
    • Overview
    • View restore task information
    • Manage backup tasks
      • View backup tasks
      • View second backup tasks
    • Manage backup and recovery service
      • View services
      • 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 O\&M tasks
      • Uninstall a service on a node
    • Regular backup
      • Manage cluster-level backup strategy
        • Create a cluster-level backup strategy
        • Modify a cluster-level backup strategy
        • Delete a cluster-level backup strategy
        • Pause backup scheduling
        • View a cluster-level backup stategy
      • Manage tenant-level backup strategy
        • Create a tenant-level backup strategy
        • Modify a tenant-level backup strategy
        • Delete a tenant-level backup strategy
        • Pause backup scheduling
        • View a tenant-level backup stategy
    • Regular recovery
      • View sampling strategies
      • View sampling tasks
      • Create a sampling strategy for recovery
    • Backup now
      • Perform tenant backup immediately
      • Back up a cluster now
  • Disaster Recovery
    • Switching primary and standby databases
      • Start the original primary cluster in read-only mode after a failover
      • Decouple a standby cluster from the primary cluster
      • Primary/Standby cluster switchover for disaster recovery
      • Routine primary/standby cluster switchover
    • Switching primary and standby tenants
      • Decouple a standby tenant from its primary tenant
      • Failover
      • Create primary and standby tenants across OCP clusters
      • Switchover
    • OCP Manage OCP clusters in the multi-cluster mode
      • Register an OCP cluster
      • Switch an OCP cluster in a failover
      • OCP multi-cluster mode overview
      • Unbind a leader and a follower OCP cluster
      • Manage OCP cluster parameters
      • Switch an OCP cluster in daily maintenance
      • Enable the OCP multi-cluster mode
      • Delete a faulty follower OCP cluster
      • View Leader \& Follower Details
  • Log Management
    • Download logs
    • Configure log retention strategies
    • Trace query
    • Query logs
    • Configure trace query parameters
    • About OpenSearch
  • Software Package Management
    • Delete a software package
    • Download a software package
    • Upload a software package
  • System Management
    • View operation records
    • Manage tasks
    • View platform monitoring data
    • Manage external integration
      • Manage Prometheus
        • Overview of Prometheus
        • Create a Prometheus data source
        • Manage Prometheus data sources
      • Manage SSO integration
        • Overview
        • Create an SSO integration task
        • Enable/Disable an SSO integration task
        • Edit an SSO integration task
        • Delete an SSO integration task
      • Manage AI models
        • Connect to an AI model vendor
        • Add a model
        • Set a system model
        • Delete a model
      • Manage SQL audit
        • Overview of SQL Audit Integration with SLS and ES
        • Connect SQL Audit to SLS
        • Connect SQL Audit to ElasticSearch
    • Manage users and permissions
      • Overview
      • Manage a organization
        • View the resources of an organization
        • Delete an organization
        • Create an organization
        • Share resource configurations
        • Rename an organization
      • Manage a user
        • Copy a user
        • View a user
        • Delete a user
        • Change the password of a user
        • Edit a user
        • View the login history
        • Create a user
      • Manage a role
        • View a role
        • Edit a role
        • Default OCP roles
        • Copy a role
        • Delete a role
        • Create a role
    • Manage tags
      • Overview
      • Delete a tag
      • Edit a tag
      • Create a tag
      • Modify objects bound to a tag
    • Manage certificates
      • Certificate overview
      • Upload a certificate
      • Delete a certificate
    • Manage password box
      • Verify a credential
      • Edit a credential
      • Batch operations on credentials
      • Create a credential
      • Import a credential
      • Export a credential
      • Delete a credential
    • Manage system parameters
      • OCP configuration parameters
      • Modify system parameters
      • View system parameters
    • User center management
      • Log off the OCP console
      • Configure personal information
      • Change your logon password
  • SQL Tuning Practices
    • General SQL Performance Tuning Scenarios
      • Execution Plan Optimization
        • SQL statement performance deterioration caused by plan changes
      • Index Optimization
        • Inappropriate index of an SQL statement
        • No suitable indexes
        • Invalid index of an SQL statement
    • Customize Abnormal SQL Statement Determining Rules
      • Conditions
      • Custom column rules
    • Locate General Abnormal SQL Statements
      • How can I locate SQL statements for full-table scans in a tenant?
      • How can I locate SQL statements with high CPU load in a tenant?
      • How can I locate slow hard-parsed SQL statements in a tenant?
      • How can I locate erroneous SQL statements in a tenant?
      • How can I locate distributed SQL statements in a tenant?
      • How can I locate slow SQL statements that take a long time in a tenant?
      • How can I locate remote SQL statements in a tenant?
  • O&M Best practices
    • Send alert messages through email
    • Check the availability of an auto-increment column
    • Decouple a standby tenant from the primary tenant
    • Perform a failover
    • Check clog synchronization
    • Send alert messages to a Feishu group
    • Integrate OCP monitoring with Prometheus
    • Troubleshoot host issues in an OceanBase cluster
    • Push alert messages through HTTP
    • Automatic routing to the new primary tenant after a switchover
    • Perform an inspection in OCP to detect potential risks in an OceanBase cluster
    • Take over OBProxies
    • Use the arbitration service of OceanBase Database to achieve HA in a scenario with two IDCs
    • Configure custom monitoring
    • Migrate a cluster between IDCs in OCP
    • Restore lost data by using backup and restore
    • Import a monitoring dashboard to Grafana
    • Monitor the business load of OceanBase Database
    • Upgrade an OceanBase cluster
    • Perform a failover between primary and standby OceanBase clusters for disaster recovery in a scenario with two IDCs
    • Replace an OBProxy
    • Reduce the high availability of OceanBase clusters and tenants
    • Scale out an OceanBase cluster and scale up an OceanBase Database tenant
    • Check the NIC rate
    • Migrate an OceanBase cluster to another IDC
    • Organization and permission management
    • Perform a switchover between primary and standby OceanBase Database tenants in a scenario with two IDCs
    • Delete an OBProxy
    • Scale in an OceanBase cluster and scale down an OceanBase Database tenant
    • Scale in an OBProxy cluster
    • Expand the high availability of OceanBase clusters and tenants
    • Scale out an OBProxy cluster
    • Send alert messages to a WeChat Enterprise group
    • Move out an OBProxy cluster
    • Back up an OceanBase cluster
    • Migrate a resource unit from an OceanBase Database tenant
    • Send alert messages to a DingTalk group
    • SSL Link Encryption
    • Connect alerts to a Slack channel
    • Achieve high availability through an arbitration service group
  • Reference Guide
    • Alarm reference
      • Overview
      • Application alerts
        • base_backup_too_long_time_no_one_success_task
        • backup_process_dead
        • odp_sql_query_slow
        • upgrade_ocp_agent_failed
        • ob_host_tcp_retrans_percent_over_threshold The percentage of TCP retransmissions exceeding the threshold on the server
        • backup_storage_capacity_timeout_or_interrupted Backup restore directory capacity retrieval timeout or thread interrupted
        • ocp_remote_server_time_diff_too_large
        • ic_server_connect_failed Inter-Connector server connection failed
        • host_agent_goroutine_count_over_threshold The number of goroutines for the server agent exceeds the threshold.
        • host_ntp_service_not_exist The NTP service does not exist on the server.
        • backup_storage_capacity_over_threshold
        • partition_create_failed
        • host_disk_readonly
        • ocp_collect_metric_failure_rate_high OCP-Server collects metrics with a high failure rate
        • ob_host_net_recv_percent_over_threshold Host network receive bandwidth usage exceeds threshold
        • vpc_connect_failed VPC connection failed
        • ob_host_ssd_wear_indicator_over_threshold
        • host_agent_version_not_same
        • agentd_process_stop
        • ocp_alarm_detect_timeout
        • ob_host_cpu_percent_over_threshold CPU usage on the server exceeds the threshold
        • ocp_meta_db_disconnected OCP Meta Database Disconnected
        • system_obproxy_unavailable
        • node_load1_peak
        • base_secondary_backup_fail
        • backup_storage_capacity_retry_times_exceeded The maximum number of retries to obtain backup storage capacity has been exceeded.
        • odp_instance_expanse_failed
        • inc_backup_delay
        • ob_host_monitordb_disconnected OCP-Agent cannot connect to monitordb
        • odp_instance_compress_failed
        • ob_host_mem_percent_over_threshold Host memory usage exceeds the threshold
        • monitor_exporter_unavaliable A monitoring exporter is unavailable on the server.
        • ob_host_invalid_disk_exists OBServer has a bad disk
        • host_ntp_offset_too_large The offset between the host and the NTP server is too large.
        • Host log alerts
        • host_agent_res_memory_over_threshold Server Agent Memory Over Threshold
        • odp_sql_execute_failed
        • ob_host_net_send_percent_over_threshold The server's network send bandwidth usage exceeds the threshold.
        • ob_cluster_inspection_not_passed
        • host_agent_open_fd_count_over_threshold The number of open file descriptors for the server agent exceeds the threshold.
        • obagent_dead Agent service unavailable
        • ob_cluster_recyclebin_disk_used_over_threshold
        • host_unavailable
        • ocp_http_request_too_many_errors_occur
        • ocp_http_request_timeout
        • ob_license_expired
        • base_backup_timeout
        • mgragent_process_stop ocp_mgragent process stop
        • base_backup_fail
        • monagent_process_stop
        • ssl_certificate_is_expired SSL certificate expiration alert
        • ocp_contingency_failed
        • message_hardware_error Host hardware failure
        • binlog_process_stop Stop a Binlog Server process
        • binlog_process_dead Binlog Server process does not exist
        • ocp_system_cpu_usage_over_threshold OCP Node CPU Usage Exceeds Threshold
        • ocp_disk_percent_over_threshold OCP Node Disk Usage Exceeds Threshold
        • ocp_jvm_heap_memory_used_percent_over OCP Node JVM Heap Memory Usage Exceeds Threshold
        • ocp_distributed_server_deleted_count OCP Node Offline
        • message_log_alarm System Message Logs
        • system_parameter_not_taken_effect System parameter modification requires a restart to take effect
        • host_process_cpu_bind_core_is_invalid CPU Binding Configuration Inconsistent
        • ob_server_stopped Server Stop Service
      • OceanBase alerts
        • standby_tenant_sync_delay_too_long
        • ob_cpu_percent_over_threshold Average tenant thread usage rate exceeds the threshold on OceanBase server
        • ob_cluster_operation_info
        • ob_cluster_frozen_version_delta_over_threshold OceanBase cluster frozen version and baseline version delta exceeds threshold
        • refresh_location_cache_failed_by_metric
        • oas_anomaly_sql_from_anomaly_event_analysis_cpu_percent_high
        • obproxy_client_connections_usage_over_threshold OBProxy client connection usage exceeds threshold
        • ob_host_load1_per_cpu_over_threshold OceanBase server CPU average load1 exceeds threshold
        • agent_process_count_abnormal
        • ob_host_install_disk_percent_over_threshold OceanBase server installation directory disk usage exceeds the threshold
        • oas_anomaly_sql_from_anomaly_event_analysis_plan_changed
        • ob_tenant500_storage_short_meta_mem_hold_high OceanBase 500 tenant STORAGE_SHORT_TERM module memory usage exceeds the threshold
        • ob_tenant_exists_expired_xa_trans OceanBase tenant has expired XA transactions
        • ob_cluster_merge_error OceanBase cluster merge error
        • os_observer_not_exist OceanBase server process does not exist
        • ob_tenant_cpu_usage_over_threshold
        • ob_tenant_log_disk_usage_high OceanBase tenant log disk usage exceeded the limit
        • ob_cluster_no_merge OceanBase cluster with no major compactions for a long time
        • ob_cluster_sync_delay_time_too_long OceanBase cluster synchronization delay is too long
        • ob_host_data_disk_percent_over_threshold OceanBase host data disk usage over threshold
        • ob_mem_assigned_percent_over_threshold OceanBase has exceeded the threshold for memory allocated to tenants.
        • ob_tenant_expired_trans_exist OceanBase tenant has expired transactions
        • tenant_memstore_percent_over_threshold OceanBase tenant MemStore usage percentage exceeding the threshold
        • oas_anomaly_sql_from_sql_inspection_perf_degradation
        • ob_tenant_log_stream_degraded OceanBase tenant has degraded log streams
        • ob_server_sstable_percent_over_threshold OceanBase server data disk usage over threshold
        • obproxy_cannot_connected
        • ob_host_partition_count_over_threshold OceanBase server partition count exceeds the threshold
        • obproxy_core_dump OBProxy server Core Dump
        • ob_tenant_partition_replica_absent OceanBase tenant partition replica absent
        • tenant_active_memstore_percent_over_threshold OceanBase tenant active MemStore percentage over threshold
        • OceanBase log alerts
        • ob_cluster_no_frozen OceanBase cluster not frozen for a long time
        • ob_tenant_request_queue_over_threshold
        • ob_tenant_operation_info
        • oas_anomaly_sql_from_anomaly_event_analysis_perf_degradation
        • obproxyd_process_dead
        • ob_tenant_long_trans_exist
        • obproxy_host_operation
        • ob_cluster_rs_not_same
        • ob_cluster_merge_timeout OceanBase cluster merge timeout
        • ob_cpu_assigned_percent_over_threshold OceanBase has allocated more CPU resources to the tenant than allowed
        • refresh_location_cache_failed
        • ob_tenant_active_session_count_over_threshold
        • standby_tenant_sync_status_error
        • ob_cluster_status_check_failed
        • obproxy_process_stop Stop OBProxy Process
        • observer_process_stop OBServer process stop
        • ob_tenant_large_trans_exist OceanBase tenant has large transactions
        • ob_cluster_sync_failed
        • ob_host_disk_readonly OceanBase server disk read-only
        • ob_tenant_no_compaction OceanBase tenant has not performed major compaction for a long time
        • ob_server_cannot_connect_arbitration OceanBase cluster has nodes that cannot communicate with the arbitration service
        • ob_host_active_session_count_over_threshold
        • ob_cluster_active_session_count_over_threshold
        • ob_cannot_connected OceanBase server cannot be connected
        • ob_host_log_disk_percent_over_threshold OceanBase server log directory disk usage exceeds the threshold
        • ob_host_connection_percent_over_threshold OceanBase server connection percentage over threshold
        • obproxy_process_dead The OBProxy process does not exist.
        • host_operation
        • ob_tenant_partition_leader_absent
        • ob_host_task_timeout
        • ob_tenant_compaction_error OceanBase tenant compaction error
        • ob_host_operation
        • oas_anomaly_sql_from_sql_inspection_plan_changed
        • ob_tenant500_mem_hold_percent_over_threshold OceanBase 500 tenant memory usage over threshold
        • obproxy_cluster_operation
        • arbitration_service_unavailable
        • arbitration_auto_replace_operation_info
        • obproxyd_process_stop OBProxy daemon process stop
        • ob_cluster_exists_index_fail_table
        • same_alarm_rule_detect_too_many_targets
        • tenant_cpu_percent_over_threshold OceanBase tenant CPU usage exceeds threshold
        • ob_cluster_exists_inactive_server OceanBase cluster has an inactive OBServer node
        • ob_tenant_task_timeout OceanBase tenant task timeout
        • ob_tenant_slow_sql_exists OceanBase tenant has slow SQL
        • ob_tenant_no_frozen OceanBase tenant has not been frozen for a long time
        • ob_tenant500_mem_hold_over_threshold OceanBase 500 tenant memory usage exceeds the threshold
        • arbitration_group_auto_replace_failed
        • tenant_compaction_status_is_suspend Tenant Major Compaction Suspended
        • ob_tenant_service_name_is_invalid Tenant service name is invalid.
        • cluster_cgroup_value_inconsistent Inconsistent cgroup values in the cluster
        • ob_tenant_log_stream_replica_absent Absent Replica in OceanBase Tenant Log Stream
        • ob_tenant_log_stream_leader_absent OceanBase Tenant Log Stream Leader Absent
        • arbitration_node_connection_with_observer_error Unable to connect observer on the arbitration node
        • standby_cluster_sync_status_error Standby cluster synchronization status exception
        • ob_tenant_tde_kms_host_not_match Tenant TDE KMS service address does not match the current OCP service address
        • ob_tenant_tde_kms_cmk_info_not_exist Tenant TDE key information does not exist in the current OCP. Please update the tenant TDE key promptly.
        • tenant_all_unit_server_not_connectable OceanBase Tenant Cannot Be Connected
        • ob_tenant_mview_refresh_delay Materialized View Automatic Refresh Delay
        • ob_tenant_mview_refresh_error Tenant Materialized View Automatic Refresh Exception
        • tenant_vector_mem_used_percent_over_threshold OceanBase Tenant Vector Index Actual Memory Usage Exceeds Threshold
        • tenant_mini_merge_tablet_count_error Number of Tablets Exceeding the Limit for Minor Compaction SSTables in an OceanBase Tenant
        • tenant_compact_timeout_count_error Number of OceanBase Tenant Partitions (sstables) That Have Not Been Compacted for a Long Time
        • ob_tenant_session_kill_delay Tenant Session Killed Delay
        • ob_tenant_info_sync_failed OceanBase Tenant Information Synchronization Failed
        • ob_tenant_name_mismatch The tenant name of the OceanBase tenant has changed.
      • OAS alerts
        • node_memory_peak
        • os_nic_1000m_full
        • os_tsar_cpu_util_hwm
        • os_observer_fd_usage OceanBase server has too many open handles
        • os_tsar_traffic_error
        • os_tsar_cpu_util_full
        • os_kernel_ntp_delay
        • node_file_datalog1_usage
        • os_home_file_usage
        • os_tsar_nvme_ioawait OceanBase server node NVMe disk ioawait high
        • os_tsar_cpu_sys_abnormal
        • os_tsar_traffic_overload
        • os_tsar_traffic_drop
        • os_tsar_sda_ioawait OceanBase server high I/Oawait on disk SDA
        • os_kernel_io_hang OceanBase server I/O Hangs
        • sql_audit_collect_lost_percent_over_threshold
        • node_file_inode_usage High inode usage on the server
        • node_file_root_usage High root directory usage on the server
        • node_file_data1_usage
        • os_kernel_ntp_down
        • os_nic_1000m_hwm
        • os_cpu_irq_error Server CPU soft interrupt not scattered
        • os_observer_core_dump OceanBase server Core Dump
      • Appendix
        • Network troubleshooting
        • Handling alert responses
        • Exception handling for OceanBase cluster compaction
        • Apply throttling to an OceanBase cluster
    • Metric reference
      • Overview of metrics
      • Monitoring metrics list
      • OBProxy cluster
        • Memory for the obproxy process
        • Client connections
        • Number of threads in the obproxy process
        • RPC request time consumption
        • RPC sessions
        • Number of file descriptors for the obproxy process
        • TPS
        • Server connections
        • RPC requests
        • Net bytes
        • QPS
        • OBProxy CPU usage
        • Log error
        • Route table queries
        • Average response time for each SQL statement
      • OceanBase Database tenant
        • Performance and SQL
          • Wait events
          • Rpc package rt
          • MemStore usage
          • Request queue size
          • SQL execution plan category
          • Tenant thread usage
          • Request waiting queue
          • Clog synchronization delay
          • QPS
          • Cursors
          • Frontend workload
          • Tenant CPU cost
          • Metrics related to time consumption of wait events
          • DB time metrics
          • Background workload metrics
          • Response time (SQL mode)
          • RPC packet throughput
          • Sessions
          • SQL execution phase
          • memroy usage pecent
          • Request waiting queue time consuming
          • SQL execution plan time
          • PX worker thread usage
          • RPC Request Success Rate
          • Number of GTS Requests
          • RPC Network Latency
          • RPC Delivery Failure
        • Storage and Cache
          • Cache size
          • Cache hit rates
          • IOPS
          • Log disk
          • Frozen MEMStore
          • Number of cache requests
          • I/O Throughput
          • Data disk
          • MemStore
          • IO time-consuming
          • Minor compaction partitions
          • Vector Index Data Size
          • Actual Usage Percentage of Vector Index Data
        • OBKV_Table
          • Response time (OBKV-Table)
          • Average number of statement lines processed (OBKV-Table)
          • QPS (OBKV-Table)
        • Transaction
          • Transaction table read request hits
          • XA Transactions
          • Number of transaction logs
          • Partition
          • Lock waits
          • Transaction response time
          • Average execution duration of XA statements
          • TPS
          • Time consumed by transaction logs
          • TPS
          • Transaction log volume
          • Transaction response time details
          • Time consumed by lock waits
          • XA Statement Count
          • MemStore Lock Request Success Rate
          • Transaction Rollback Ratio
        • OBKV_HBase
          • QPS (OBKV_Hbase)
          • Average number of statement lines processed (OBKV-HBase)
          • Response time (OBKV-HBase)
        • OBKV_Redis
          • Response time (OBKV-Redis)
          • QPS (OBKV-Redis)
        • Database objects
          • Objects
      • Host
        • Host Performance
          • I/O usage
          • TCP retransmission rate
          • Packet forwarding
          • I/O queue length
          • Linux system load
          • I/O throughput
          • CPU Utilization
          • Inode usage
          • Time consumed by I/O operations
          • Network throughput
          • NTP clock offset
          • IOPS
        • Host Resources
          • Memory
          • Disk
          • Memory usage
        • Host Processes
          • Number of process file descriptors
          • Process resident memory
          • Number of process threads
          • Number of OCP-Agent process goroutines
          • Process CPU utilization
      • OceanBase cluster
        • Database performance
          • Query response time
          • I/O Throughput
          • Request queue time
          • Number of sessions
          • IOPS
          • Transaction response time
          • Number of transaction logs
          • QPS
          • Time consumed by transaction logs
          • TPS
          • TPS
          • Transaction log volume
          • IO time-consuming
        • OBServer performance
          • Error logs
          • Number of process threads
          • Process memory
          • Process file descriptors
          • Process CPU utilization
          • sys500 memory occupation
      • Binlog Service
        • Subscription Connection Monitoring
          • Associate RPS
          • Network Traffic
          • Sending Delay
        • Binlog Resource Monitoring
          • disk used
          • Binlog Disk Write Rate
          • memory used
          • FD count
          • disk ratio
          • CPU
          • network bytes
          • memory
        • Binlog Performance Monitoring
          • Binlog Delay
          • Binlog RPS
    • API Reference
      • Overview
      • API call description
      • Rules for generating AK/SK signatures
      • Task return structure
      • Software packages
        • Query software packages
        • Delete a software package
        • Upload a software package
      • Cluster management
        • Query arbitration service parameters
        • Upgrade an arbitration service group
        • Delete multiple OBServers at a time
        • Stop an OceanBase cluster
        • Create a zone for an OceanBase cluster
        • Start an arbitration service
        • Query the list of arbitration services
        • Take over an arbitration service
        • Restart a zone in an OceanBase cluster
        • Query the parameter metadata of OceanBase clusters
        • Add an OBServer node
        • Perform a switchover pre-check
        • Query resource statistics of an OceanBase cluster
        • Associate an arbitration service with multiple OceanBase clusters
        • Upgrade an OceanBase cluster
        • Query information of an arbitration service group
        • Query details of an arbitration service
        • Perform a switchover
        • Create an arbitration service
        • Restart an OceanBase cluster
        • Query zones of an OceanBase cluster
        • Start an OBServer node
        • Create an OceanBase cluster
        • Perform an arbitration service takeover precheck
        • Move out an OceanBase cluster
        • Dissociate an arbitration service from multiple clusters
        • Stop a zone in an OceanBase cluster
        • Modify parameters of an OceanBase cluster
        • Query OBServer nodes of an OceanBase cluster
        • Query resource statistics of all OBServer nodes in an OceanBase cluster
        • Query parameters of an OceanBase cluster
        • Perform a failover
        • Perform a takeover precheck on an OceanBase cluster
        • Start an OceanBase cluster
        • Delete a zone from an OceanBase cluster
        • Change the password of an OceanBase cluster
        • Delete an arbitration service group
        • Stop an OBServer node
        • Query the list of OceanBase clusters
        • Update an arbitration service group
        • Migrate an arbitration service
        • Perform a failover pre-check
        • Bind/Unbind tags to/from an arbitration service
        • Replace the arbitration service for multiple clusters
        • Stop an arbitration service
        • Restart an OBServer node
        • Replace an OBServer node
        • Perform an association precheck on multiple OceanBase clusters
        • Query the list of arbitration service groups
        • Delete an OceanBase cluster
        • Create an arbitration service group
        • Start a zone in an OceanBase cluster
        • Query OBServer nodes in a zone
        • Query units of an OceanBase cluster
        • Upgrade an arbitration service
        • Perform a precheck on batch arbitration service replacement
        • Take over an OceanBase cluster
        • Delete an arbitration service
        • Restart an arbitration service
        • Enable JVM Environment Dependency Service
        • Edit JVM Environment Dependency Service
        • Stop the JVM environment dependency service
      • Database management
        • Grant database privileges to a user
        • Query database objects
        • Query the list of database roles
        • Grant global privileges to a role
        • Change global privileges of a role
        • Query database user details
        • Change database privileges of a user
        • Delete a database user
        • Query databases
        • Revoke database privileges of a user
        • Grant roles to a role
        • Change roles of a role
        • Create a database user
        • Create a database role
        • Lock a database user
        • Query database role details
        • Delete a database role
        • Revoke roles of a user
        • Query the list of database users
        • Delete a database
        • Revoke object privileges of a user
        • Revoke roles of a role
        • Change global privileges of a user
        • Unlock a database user
        • Change the password of a database user
        • Modify a database
        • Grant object privileges to a role
        • Create a database
        • Change roles of a user
        • Revoke global privileges of a role
        • Change object privileges of a user
        • Grant global privileges to a user
        • Revoke global privileges of a user
        • Grant roles to a user
        • Grant object privileges to a user
        • Change object privileges of a role
        • Revoke object privileges of a role
      • System management
        • Operation Audit
          • Query historical events
        • Health examination
          • Query the basic information of an OCP application
          • Query OCP server time
          • Query OCP application status
        • Agent management
          • Stop the OCP Agent process on a host
          • Stop the OCP Agent process on a host
          • Restart the OCP Agent process on a host
          • Query OCP Agent details on a host
          • Batch stop the OCP Agent processes on hosts
          • Batch restart the OCP Agent processes on hosts
          • Restart the OCP Agent process on a host
          • Query OCP Agent processes on a host
      • SQL performance
        • Query the performance indicator trend of an SQL statement
        • Query performance metrics of an SQL statement
        • Query a performance report
        • Query the operator structure of an execution plan
        • Query the list of slow SQL statements
        • Query SQL text
        • Generate a performance report
        • Query snapshots
        • Query the performance indicator trend of an execution plan
      • O&M tasks management
        • Query details about a task
        • Query tasks
        • Retry a task
        • Cancel a subtask
        • Roll back a task
        • Retry a subtask
        • Query subtask logs
        • Skip a subtask
      • Backup and recovery
        • View the log backup tasks of a tenant
        • View the data backup tasks of a tenant
        • Delete the backup strategy of a cluster
        • Parse the backup information of a tenant
        • Initiate tenant recovery
        • View restore tasks
        • Query the backup strategy of a tenant
        • Start backup scheduling for a cluster
        • Clear added restore resources
        • Query recovery tasks of a cluster
        • Stop backup scheduling for a tenant
        • Query the backup overview of a cluster
        • Modify the backup strategy of a cluster
        • Query backup capabilities of a cluster
        • Query the backup strategy of a cluster
        • Create a backup strategy for a tenant
        • Parse cluster backup data
        • Initiate a data backup for a tenant
        • Modify the backup strategy of a tenant
        • Query data backup tasks of a cluster
        • Start backup scheduling for a tenant
        • Add restore resources
        • Create a backup strategy for a cluster
        • Immediately back up a cluster
        • Preview a restore task
        • Delete the backup strategy of a tenant
        • Stop backup scheduling for a cluster
        • Query log backup tasks of a cluster
      • OBProxy management
        • Update configurations of an OBProxy cluster
        • Restart an OBProxy
        • Upgrade an OBProxy
        • Remove a connectable OceanBase cluster from an OBProxy cluster
        • Create an OBProxy cluster
        • Query the description information of the OBProxy parameters
        • Delete an OBProxy (not recommended)
        • Start an OBProxy
        • Query details about an OBProxy cluster
        • Add an OBProxy
        • Take over an OBProxy
        • Stop an OBProxy
        • Add a connectable OceanBase cluster to an OBProxy cluster
        • Query parameters of an OBProxy cluster
        • Upgrade an OBProxy
        • Delete an OBProxy cluster
        • Query OBProxy clusters
        • Delete an OBProxy
        • Restart an OBProxy
      • Tenant management
        • Create a tenant
        • Modify a replica of a tenant
        • Modify parameters of a tenant
        • Query tenants of a cluster
        • Create a standby tenant
        • Obtain a list of unit specifications
        • Delete a unit from a tenant
        • Perform a batch failover
        • Add a replica for a tenant
        • Create a resource unit specification
        • Perform a batch switchover
        • Unlock a tenant
        • Perform a switchover
        • Perform a failover precheck
        • Query all tenants
        • Query parameters of a tenant
        • Delete a replica of a tenant
        • Change the administrator password of a tenant
        • Delete a resource unit specification
        • Perform a batch switchover precheck
        • Query details about a tenant
        • Modify the allowlist of a tenant
        • Perform a switchover precheck
        • Lock a tenant
        • Perform a batch failover precheck
        • Modify zone priorities of a tenant
        • Query units of a tenant
        • Delete a tenant
        • Perform a failover
      • Inspection
        • Query inspection objects
        • Query the last inspection result of an inspection item
        • Initiate an inspection
        • Query the last inspection result of an inspection object
        • Query all inspection tasks
        • View the details of an inspection report
      • Host management
        • Query host types
        • Add host type information
        • Add IDC information
        • Query details about an IDC
        • Delete multiple hosts at a time
        • Query regions
        • Delete an IDC
        • Delete a region
        • Add multiple hosts at a time
        • Delete a host
        • Query details about a host type
        • Add region information
        • Query hosts
        • Query IDCs
        • Query details about a host
        • Query details about a region
        • Delete a host type
      • Alerts
        • Call an alert API
        • Query alert events
        • Obtain current alerts
        • Obtain alert history
      • Monitoring
        • Query monitoring data by tag
        • Query monitoring data
        • Query the description of a monitoring metric
    • Information Collection Reference
      • Data Disk Full
        • Collect information about the disk space occupied by temporary files of a tenant
        • Collect incremental data generated during cluster compactions
        • Collect information about sizes of data of different versions in major SSTables
        • Collect information about the macroblock utilization of nodes
        • Collect the data disk usage information of nodes in a cluster
      • CPU Exceptions
        • Collect information about threads with high CPU utilization in an observer process
        • Collect information about processes with high CPU utilization on a cluster node
      • Major Compaction Exceptions
        • Collect the last-one-day records of major compaction events scheduled by RootService
        • Collect major compaction parameter settings
        • Collect diagnostic information about major compactions
        • Collect the checksum information about tablets
        • Collect information about the major compaction status of zones of a cluster
        • Collect the major compaction time
        • Collect RootService task records
        • Collect the checksum information about columns
        • Collect information about the ongoing major compaction in a cluster
        • Collect suggestions provided based on historical major compactions
        • Collect information about DAG warnings in OceanBase Database
      • Cluster Exceptions
        • Collect connectivity information of the sys tenant
        • Collect information about the core dump file of the observer process
        • Collect host logs containing the CRASH ERROR keyword
        • Collect obstack information on a cluster node
        • Collect information about bad disks
        • Collect information about OBServer nodes in a cluster
      • OCP Agent Exceptions
        • Collect panic logs of the mgragent process
        • Collect information about goroutines of the agent processes
        • Collect panic logs of the monagent process
      • Memory Exceptions
        • Collect memory allocation sampling data of OBServer nodes
        • Collect KV cache information of a tenant
        • Collect memory leakage detection information
        • Collect MemStore information of a tenant
        • Collect information about modules with highest memory usage
      • Other Tenants Exceptions
        • Collect host logs containing the dump tenant info keyword
        • Collect host logs containing the dump tenant info keyword
        • Collect host logs containing the dump tenant disk usage keyword
      • Host Exceptions
        • Collect host information by running the df -h command
        • Collect logs from the /var/log/messages directory of a host
    • Error codes reference
      • OCP error codes
      • OBServer error codes
        • Oracle mode
          • OBE-02000 to OBE-04999
          • Overview
          • OBE-01000 to OBE-01499
          • OBE-05000 to OBE-10000
          • OBE-10000 to OBE-19999
          • OBE-01500 to OBE-01999
          • OBE-30000 to OBE-49999
          • OBE-20000 to OBE-29999
          • OBE-00000 to OBE-00999
          • OBE-50000 to OBE-99999
          • PLS-00000 to PLS-00999
        • MySQL mode
          • 5000 to 5999
          • 10000 to 12000
          • 8000 to 8999
          • Overview
          • 6000 to 6999
          • 22998, 30926, 38104, and 38105
          • 9000 to 9499
          • 7000 to 7999
          • 4500 to 4999
          • 0001 to 3999
          • 4000 to 4499
          • 9500 to 9999
  • FAQ
    • FAQ on the OCP system
    • FAQ about deployment
    • FAQ on alerts
    • OCP multi-cluster FAQ
    • FAQ on upgrade
    • FAQ on monitoring
      • FAQ on monitoring metrics
      • FAQ on SQL monitoring
      • FAQ about resource usage
      • Use OCP-Agent to pull time-series monitoring data
    • FAQ on O&M
      • FAQ on backup and recovery
      • FAQ on the OCP software package
      • FAQ about OceanBase clusters
      • FAQ on OBProxy
      • FAQ about OceanBase tenants
      • FAQ on accounts and passwords
      • FAQ on host management
  • Appendix
    • AWS S3 protocol
    • Install and configure OCI
    • Component listening port list
    • Processes
    • OCP background tasks
    • Grafana dashboard
    • Modify the log stream downgrade control time
    • Tables managed by the daemon
    • Configure cgroup
    • Create a Slack channel and obtain its webhook URL
    • HTTPS Authentication Instructions
  • Release Notes
    • Version number guidelines
    • V4.0
      • OCP V4.0.3
      • OCP V4.0.2
      • OCP V4.0.1
      • OCP V4.0.0
    • V4.3
      • OCP V4.3.6
      • OCP V4.3.4
      • OCP V4.3.1
      • OCP V4.3.0
      • OCP V4.3.5
      • OCP V4.3.3
      • OCP V4.3.2
    • V3.3
      • OCP V3.3.3
      • OCP V3.3.1
      • OCP V3.3.0
      • OCP V3.3.5
      • OCP V3.3.4
    • V4.2
      • OCP V4.2.0
      • OCP V4.2.2
      • OCP V4.2.1
    • V4.4
      • OCP V4.4.2
      • OCP V4.4.1
      • OCP V4.4.0
    • V3.2
      • OCP V3.2.3
    • V3.1
      • OCP V3.1.2
    • V4.1
      • OCP V4.1.0

Download PDF

Product UpdatesWhat is OceanBase Cloud PlatformDifferences between Enterprise Edition and Community EditionSystem architectureFeaturesSystem requirementsDependenciesOverviewInstallation processPrepare for the installationDeploy OCP on the GUIUse Docker to deploy OCPPost-deployment checkOverviewConsiderationsPreparationsUpgrade OCP on the GUIUpgrade OCP using Docker containersPost-upgrade checkOCP operationsLog on to the OCP consoleUpload a software packageAdd hostsCreate a clusterCreate a primary tenantCreate a userCreate an OBProxy clusterOverviewCreate a distributed clusterCreate a standalone deploymentCreate a standby clusterView details of a clusterScale a standalone system to a distributed clusterTake over a clusterRestart a clusterStop a clusterMove out a clusterDelete a clusterChange the passwordEnable automatic detection of deadlocksDisable automatic detection of deadlocksManage CPU binding configurationsView tenant-level informationImport a licenseView the licenseAdd a zoneEdit a zoneRestart a zoneStop a zoneDelete a zoneAdd an OBServer nodeRestart a faulty OBServer nodeStop an OBServer serviceStop an observer processReplace an OBServer nodeReinstall an OBServerDelete an OBServerUpgrade versionView the topology of a clusterOverview of cluster tenant managementView real-time monitoring dataView the unit distributionView resource usageModify the major compaction settings of a clusterPerform a major compactionView details of a major compactionView statistics of a major compactionView the major compaction recordsManage SSL Link EncryptionManage Transparent Data Encryption (TDE)Manage SQL AuditParameter typesView parametersModify parametersView the history of parameter changesArbitration service OverviewCreate an arbitration serviceTake over an arbitration serviceStop an arbitration serviceStart an arbitration serviceUpgrade an arbitration serviceRestart an arbitration serviceMigrate an arbitration serviceReplace an arbitration serviceAssociate a clusterDissociate an arbitration serviceDelete an arbitration serviceOverviewCreate an arbitration service groupUpgrade an arbitration service groupEdit an arbitration service groupDelete an arbitration service groupManage cluster parameter templatesTenant and resource managementView tenant overview informationCreate a primary tenantOverviewCreate a standby tenantCopy a tenantRename a tenant
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogWhite PaperLive DemosTraining & CertificationTicket
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. V4.4.2
iconOceanBase Cloud Platform
V 4.4.2
Databases
  • OceanBase Database
  • OceanBase Cloud
  • OceanBase Tugraph
  • Interactive Tutorials
  • OceanBase Best Practices
Tools
  • OceanBase Cloud Platform
  • OceanBase Migration Service
  • OceanBase Developer Center
  • OceanBase Migration Assessment
  • OceanBase Admin Tool
  • OceanBase Loader and Dumper
  • OceanBase Deployer
  • Kubernetes operator for OceanBase
  • OceanBase Diagnostic Tool
  • OceanBase Binlog Service
Connectors and Middleware
  • OceanBase Database Proxy
  • Embedded SQL in C for OceanBase
  • OceanBase Call Interface
  • OceanBase Connector/C
  • OceanBase Connector/J
  • OceanBase Connector/ODBC
  • OceanBase Connector/NET
  • V 4.4.2
  • 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

View database performance

Last Updated:2026-06-10 02:35:40  Updated
Share
What is on this page
Prerequisites
Limitations
Procedure

folded

Share

OCP allows you to view performance monitoring data of a cluster from different dimensions. You can view the data through the following two methods:

  • Method 1: Log in to the OCP console, and click Performance Monitoring in the left-side navigation pane.

  • Method 2: Log in to the OCP console, and click Performance Monitoring in the left-side navigation pane. The system automatically displays the OceanBase Cluster tab.

Prerequisites

  • If you view the database performance monitoring data of a cluster by using Method 1, make sure that the user who logs in to OCP has the following permissions:

    • The Cluster Read-Only resource permission.
    • The Performance Monitoring menu permission.
  • If you view the database performance monitoring data of a cluster by using Method 2, make sure that the user who logs in to OCP has the following permissions:

    • The Cluster Read-Only, Tenant Read-Only, or Host Read-Only resource permission.
    • The All menu permission.

Limitations

  • For the SQL Response Time monitoring metric:

    • The sub-metric items 99-all and 95-all apply to OceanBase Database of a version in [V4.2.1.7, V4.2.2.0).
    • The sub-metric items commit and rollback apply to OceanBase Database of a version in [V4.2.5.3, V4.3.0.0) or [V4.3.5.2, +∞).
  • For the QPS monitoring metric, the sub-metric items commit and rollback apply to OceanBase Database of a version in [V4.2.5.3, V4.3.0.0) or [V4.3.5.2, +∞).

Procedure

The following procedure uses Method 2 as an example.

  1. Log in to the OCP console.

  2. In the left-side navigation pane, click Performance Monitoring.

  3. The system automatically displays the OceanBase Cluster tab.

  4. In the Data Filtering section, configure the monitoring data filtering conditions.

    The following table describes the filtering conditions.

    Condition
    Description
    Refresh Refreshes the monitoring data. Auto-refresh is supported. Auto-refresh is disabled by default. If auto-refresh is enabled, you can configure the refresh frequency.
    Select Time (also known as the Monitoring Window) This option is not displayed in auto-refresh mode. Select a time range to obtain data within this range.
    Cluster Select a cluster to monitor it.
    Zone By default, all zones are monitored.
    OBServer By default, all OBServer nodes are monitored.
  5. The system automatically displays the Database Performance tab, where you can view the database performance monitoring data of the cluster.

    • OCP supports viewing database performance monitoring data in four dimensions: cluster, tenant, OBServer, and unit4. By default, data is displayed in the cluster dimension. The monitoring metrics vary depending on the dimension.
    • By default, all monitoring items are displayed in the current dimension. If you do not need to monitor a specific item, you can click Selected Chart on the right to uncheck the monitoring item.
    • All monitoring items support displaying the maximum value (max), average value (avg), and current value (current) of each sub-metric.
    • For more information about the specific meanings and value sources of all monitoring items, see Overview of monitoring metrics.

    The following features help you view and analyze performance monitoring data on the trend chart. You can combine the image and the following description for a better understanding.

    1. View and hide data of other sub-metrics: Hover the pointer over the metric section and scroll up and down with the mouse wheel to view data of all sub-metrics on the trend chart. Click the identifier of another sub-metric to gray it out, and the trend chart no longer displays the information of this sub-metric.

    2. Hover the pointer over a specific point on the trend chart to view detailed data at that point. Drag the pointer to select a region, and the system will zoom in to display the trend information in this region. You can view the detailed trend of this metric in this time period. You can double-click the trend chart to restore it.

    3. Zoom in on a trend chart: Click the zoom-in icon in the upper-right corner of the trend chart. The ① and ② features in the preceding figure also apply to the zoomed-in trend chart.

    4. Edit the monitoring metric: Click the edit icon in the upper-right corner of the trend chart to display only the sub-metrics you want to monitor.

    5. View monitoring data of different dimensions: On the Cluster tab, if you find that the monitoring data of a cluster is abnormal, such as high SQL response time, you can use drill-down analysis to locate the server causing the abnormal response time. Click the Drill-down Analysis icon in the upper-right corner of the trend chart. Supported dimensions for drill-down analysis are: Cluster > Tenant > OBServer.

      The ① and ② features in the preceding figure also apply to the trend chart on the drill-down page. In addition, you can:

      1. On the drill-down page, you can reconfigure the filtering conditions. If you do not set any filtering conditions, they will automatically inherit from the upper-level settings.

      2. If this metric has sub-metrics, you can select a sub-metric to view it, or click ① or ② in the figure to drill down to different dimensions for further analysis.

      3. If this metric involves tenant or host performance, the trend chart provides a direct jump to the relevant tenant or host Monitoring page.

        • To jump to the Performance Monitoring page of a tenant, hover the pointer over the Go to Tenant Performance Monitoring link in the upper-right corner of the trend chart, select the desired tenant, and click it.

        • To jump to the Performance Monitoring page of a host, hover the pointer over the Go to Host Performance Monitoring link in the upper-right corner of the trend chart, select the desired host, and click it.

  6. (Optional) Configure the monitoring data collection interval.

    By default, OCP collects monitoring data every second. This high-frequency collection places high demands on the performance of the OCP server and the storage performance of MonitorDB. If the monitoring data does not require high-frequency collection, you can modify the value of ocp.metric.collect.interval.second in config_properties to configure the monitoring data collection interval, thereby reducing resource usage and increasing the overall management scale.

    Note

    Currently, only the values 1, 5, 10, and 15 are supported. If you enter a value that is not listed above, the system will automatically adapt it to the nearest supported value:

    • Any value less than 1 is treated as 1.
    • Any value in the [1,5) range is treated as 1.
    • Any value in the [5,10) range is treated as 5.
    • Any value in the [10,15) range is treated as 10.
    • All other values are treated as 15.

    After you configure the monitoring data collection interval, OCP immediately starts collecting data at the new interval. The display interval of the monitoring data is three times the collection interval (except for 1 second). If the collection interval is 5 seconds, the display interval of the monitoring data is 15 seconds.

Previous topic

Overview
Last

Next topic

View host performance monitoring data
Next
What is on this page
Prerequisites
Limitations
Procedure