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

V4.3.0

  • Document Overview
  • Product Introduction
    • What is OceanBase Cloud Platform?
    • Differences between the features of OCP Enterprise Edition and OCP 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
          • Planning resources of a single node OCP
            • OCP-Server specifications
            • MetaDB resources
            • MonitorDB resources
            • Host resources
          • Planning resources of a high availability OCP
            • OCP-Server specifications
            • MetaDB resources
            • MonitorDB resources
            • Host resources
        • Deploy OCP
          • Deploying a single point of OCP
            • Prepare installation media
            • Create MetaDB
            • Install OCP
            • Initialize system parameters
          • Deploying a high availability of OCP
            • Prepare installation media
            • Create MetaDB
            • 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 the alert feature
        • 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 a host
    • Create a cluster
    • Create a tenant
    • Create a user
    • Create an OBProxy cluster
  • Cluster Management
    • Overview
    • Create a cluster
      • Create a distributed cluster
      • Create a standalone centralized database
    • Manage clusters
      • Create a standby cluster
      • View the details of a cluster
      • Upgrade a standalone centralized database to a distributed cluster
      • Take over a cluster
      • Restart a cluster
      • Stop a cluster
      • Migrate a cluster
      • Delete a cluster
      • Change the password
      • Enable automatic detection of deadlocks
      • Disable automatic detection of deadlocks
      • Disable SQL collection
      • View the SQL collection history
    • Manage Arbitration Service
      • 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
      • Delete an arbitration service
      • Add an arbitration service
      • Replace an arbitration service
      • Remove an arbitration service
    • Manage zones of a cluster
      • Add 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 the observer process
      • Replace an OBServer node
      • Reinstall an OBServer
      • Delete an OBServer
    • Upgrade an OceanBase cluster
    • View the topology of a cluster
    • Overview of cluster tenant management
    • 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 major compaction
      • View major freeze statistics
    • Manage cluster parameter templates
    • Manage cluster parameters
      • Parameter types
      • View parameters
      • Modify parameters
      • View the history of parameter changes
  • Tenant Management
    • Tenant and resource management
    • View tenant overview information
    • Create a primary tenant
    • Manage unit specifications
    • View OCP resource unit specifications
    • Manage tenants
      • Overview of the Tenant Details page
      • Create a standby tenant
      • Copy a tenant
      • Lock a tenant
      • Delete a tenant
      • Change the password of the sys tenant
      • Configure full link tracking for a tenant
    • Modify the allowlist of a tenant
    • Modify zone priorities
    • Manage topulogy of a tenant
      • View the topology of a tenant
      • View the topology of primary/standby relationships of a tenant
    • Manage replicas of a tenant
      • Add a replica
      • Edit a tenant replica in a zone
      • Delete a tenant replica from a zone
    • 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
        • 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 privileges in a MySQL tenant
    • 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
      • Details of tenant major compaction
      • Perform a major compaction
    • Manage tenant parameter templates
    • Manage tenant parameters
      • View the parameters
      • Modify a parameter
      • View the parameter modification history
  • 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
      • Migrate an OBProxy cluster
      • Delete an OBProxy cluster
      • Upgrade an OBProxy cluster
      • 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 an 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
    • Parameter management
    • Client configuration
    • OBProxy parameters descpription
  • Host Management
    • Host management operations
    • View details of a host
    • Add a host
    • View the details of tasks on a host
    • Modify a host
    • Restart OCP-Agent
    • Reinstall OCP Agent
    • Remove a host
    • Perform host standardization checks
    • Host standardization check items
    • OCP-Agent processes
    • OCP-Agent O&M Script Instructions
  • Alert Management
    • Overview
    • Alert-related concepts
    • 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
      • OCP Overview
      • View database performance
      • View host performance
      • View the performance and SQL monitoring data of a tenant
      • View transaction performance data
      • View storage and cache monitoring data
      • View host resources
      • View host processes
      • 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
      • Suspicious SQL diagnostics
      • TopSQL diagnostics
      • View Comparison of Top SQL Statements
      • SlowSQL diagnostics
      • ParallelSQL diagnostics
      • High Risk SQL diagnostics
      • New SQL diagnostics
      • View details of an SQL statement
      • View outlines
      • View the SQL collection enable/disable history
      • View SQL request analysis
      • SQL performance diagnosis related parameter configuration
    • Transaction Diagnostics
      • Overview of transaction
      • Diagnostics Transaction
      • Diagnose XA transactions and suspended transactions
    • Manage sessions
      • Manage the sessions of a tenant
      • View session statistics
      • View the deadlock history
    • View the Optimization Center page
    • View the capacity center
    • View diagnostics reports
      • Manage ASH report
      • Performance report
  • 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 Inspection
      • Inspection
      • Configure inspection items
      • Configure Scheduling Rules
        • Configure a scheduling rule for a single object
        • Configure a global scheduling rule
      • Initiate 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
  • Backup and Recovery
    • Overview
    • Backup and recovery guide
    • Overview
    • Backup now
      • Back up cluster now
      • Back up a tenant now
    • 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
    • Manage backup tasks
      • View backup tasks
      • View second backup tasks
    • Initiate a restore task
    • Regular recovery
      • Create a sampling strategy for recovery
      • View sampling strategies
      • View sampling tasks
    • View restore 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
  • Disaster Recovery
    • Switching primary and standby databases
      • Routine primary/standby cluster switchover
      • Primary/Standby cluster switchover for disaster recovery
      • Decouple a standby cluster from the primary cluster
      • Start the original primary cluster in read-only mode after a failover
    • Switching primary and standby tenants
      • Switchover
      • Failover
      • Decouple a standby tenant from its primary tenant
      • Create a standby tenant for a primary tenant managed by another OCP cluster
    • OCP Manage OCP clusters in the multi-cluster mode
      • OCP multi-cluster mode overview
      • Register an OCP cluster
      • View 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
      • Enable the OCP multi-cluster mode
  • Log Management
    • Download logs
    • 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 Audit
    • Manage tasks
    • Manage users
      • Manage a user
        • Users overview
        • Create a user
        • View users
        • Edit a user
        • Copy a user
        • Change a user password
        • Delete a user
        • Logon history
      • Manage a role
        • Role overview
        • Create a role
        • Copy a role
        • View a role
        • Edit a role
        • Delete a role
        • Default OCP roles
    • Manage tags
      • Overview
      • Create a tag
      • Modify objects bound to a tag
      • Edit a tag
      • Delete a tag
    • Manage password box
      • Create a credential
      • Export a credential
      • Import a credential
      • Verify a credential
      • Edit a credential
      • Delete a credential
      • Batch operations on credentials
    • Manage system parameters
      • View system parameters
      • Modify system parameters
      • OCP configuration parameters
    • User center management
      • Configure personal information
      • Change your logon password
      • Log off the OCP console
  • SQL Tuning Practices
    • General SQL Performance Tuning Scenarios
      • Execution Plan Optimization
        • SQL statement performance deterioration caused by plan changes
      • Index Optimization
        • No suitable indexes
        • Inappropriate index of an SQL statement
        • 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 with high CPU load in a tenant?
      • How can I locate slow SQL statements that take a long time in a tenant?
      • How can I locate SQL statements for full-table scans in a tenant?
      • How can I locate distributed SQL statements in a tenant?
      • How can I locate remote SQL statements 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?
  • O&M Best practices
    • Send alert messages through email
    • Check the availability of an auto-increment column
    • Check clog synchronization
    • Send alert messages to a Feishu group
    • Integrate OCP monitoring into Prometheus
    • Troubleshoot host issues in an OceanBase cluster
    • Push alert messages through HTTP
    • Perform an inspection in OCP to detect potential risks in an OceanBase cluster
    • Take over OBProxies
    • Configure custom monitoring
    • Send alert messages to a DingTalk group
    • Use the backup and restore module to restore data
    • 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
    • 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
    • Delete an OBProxy
    • Perform a failover
    • Decouple a standby tenant from the primary tenant
    • Perform a switchover between primary and standby OceanBase Database tenants in a scenario with two IDCs
    • Use the arbitration service of OceanBase Database to achieve HA in a scenario with two IDCs
  • Reference Guide
    • Alarm 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
        • OceanBase log alerts
        • 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
        • 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_slow_sql_exists
        • ob_tenant_large_trans_exist
        • same_alarm_rule_detect_too_many_targets
        • ob_tenant_expired_trans_exist
        • ob_tenant_long_trans_exist
        • ob_tenant_task_timeout
        • ob_host_task_timeout
        • ob_tenant_log_disk_usage_high
        • ob_tenant_no_compaction
        • ob_tenant_no_frozen
        • ob_tenant_compaction_error
        • host_operation
        • obproxy_host_operation
        • obproxy_cluster_operation
        • ob_host_operation
        • refresh_location_cache_failed
        • ob_tenant_log_stream_degraded
        • arbitration_service_unavailable
        • observer_process_stop
        • obproxyd_process_stop
        • obproxy_process_stop
        • standby_tenant_sync_delay_too_long
        • standby_tenant_sync_status_error
        • obproxy_client_connections_usage_over_threshold
        • ob_tenant_request_queue_over_threshold
        • oas_anomaly_sql_from_anomaly_event_analysis_cpu_percent_high
        • oas_anomaly_sql_from_anomaly_event_analysis_perf_degradation
        • oas_anomaly_sql_from_anomaly_event_analysis_plan_changed
        • oas_anomaly_sql_from_sql_inspection_perf_degradation
        • oas_anomaly_sql_from_sql_inspection_plan_changed
        • os_observer_not_exist
        • refresh_location_cache_failed_by_metric
        • ob_tenant_cpu_usage_over_threshold
        • ob_tenant_partition_replica_absent
        • ob_tenant_partition_leader_absent
        • ob_tenant500_storage_short_meta_mem_hold_high
        • obproxy_core_dump
        • ob_server_cannot_connect_arbitration
        • agent_process_count_abnormal
      • Application alerts
        • ob_host_monitordb_disconnected
        • base_backup_too_long_time_no_one_success_task
        • backup_process_dead
        • odp_sql_query_slow
        • ob_cluster_inspection_not_passed
        • upgrade_ocp_agent_failed
        • monitor_exporter_unavailable
        • ob_host_tcp_retrans_percent_over_threshold
        • odp_instance_compress_failed
        • backup_storage_capacity_timeout_or_interrupted
        • ob_host_invalid_disk_exists
        • ocp_remote_server_time_diff_too_large
        • host_agent_open_fd_count_over_threshold
        • ic_server_connect_failed Inter-Connector
        • Host log alerts
        • host_agent_goroutine_count_over_threshold
        • obagent_dead
        • host_ntp_service_not_exist
        • host_ntp_offset_too_large
        • backup_storage_capacity_over_threshold
        • base_backup_timeout
        • partition_create_failed
        • host_disk_readonly
        • odp_sql_execute_failed
        • ocp_collect_metric_failure_rate_high
        • host_agent_res_memory_over_threshold
        • ob_host_net_recv_percent_over_threshold
        • vpc_connect_failed
        • ocp_http_request_timeout
        • ob_host_ssd_wear_indicator_over_threshold
        • mgragent_process_stop
        • host_agent_version_not_same
        • agentd_process_stop
        • base_backup_fail
        • ocp_alarm_detect_timeout
        • ob_host_net_send_percent_over_threshold
        • ob_host_cpu_percent_over_threshold
        • monagent_process_stop
        • ocp_meta_db_disconnected
        • ocp_contingency_failed
        • system_obproxy_unavailable
        • node_load1_peak
        • base_secondary_backup_fail
        • ob_host_mem_percent_over_threshold
        • backup_storage_capacity_retry_times_exceeded
        • odp_instance_expanse_failed
        • inc_backup_delay
        • ocp_http_request_too_many_errors_occur
        • ob_cluster_recyclebin_disk_used_over_threshold
        • host_unavailable
      • OAS alerts
        • node_memory_peak
        • os_nic_1000m_full
        • os_tsar_cpu_util_hwm
        • os_observer_fd_usage
        • 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
        • os_tsar_cpu_sys_abnormal
        • os_tsar_traffic_overload
        • os_tsar_traffic_drop
        • os_tsar_sda_ioawait
        • os_kernel_io_hang
        • sql_audit_collect_lost_percent_over_threshold
        • node_file_inode_usage
        • node_file_root_usage
        • node_file_data1_usage
        • os_kernel_ntp_down
        • os_nic_1000m_hwm
        • os_cpu_irq_error
        • os_observer_core_dump
      • Appendix
        • Network troubleshooting
        • Execute the alert clearance plan
        • Exception handling for OceanBase cluster compaction
        • Apply throttling to an OceanBase cluster
    • API Reference
      • Overview
      • API call description
      • Rules for generating a signature by using AK/SK
      • Task return structure
      • Task management
        • Query details about a task
        • Roll back a task
        • Skip a subtask
        • Retry a task
        • Query tasks
        • Query logs of a subtask instance
        • Cancel a subtask
        • Retry a subtask
      • Cluster information
        • Restart a zone in an OceanBase cluster
        • Perform a failover
        • Start an OBServer
        • Delete a zone from an OceanBase cluster
        • Delete multiple OBServers at a time
        • Change the password of an OceanBase cluster
        • Query servers
        • Stop an OceanBase cluster
        • Stop an OBServer
        • Query clusters
        • Restart an OBServer
        • Query servers in a zone
        • Delete an OceanBase cluster
        • Perform a switchover
        • Query parameters of an OceanBase cluster
        • Perform a failover pre-check
        • Stop a zone in an OceanBase cluster
        • Obtain resource statistics of an OceanBase cluster
        • Create an OceanBase cluster
        • Replace an OBServer
        • Perform a switchover pre-check
        • Query zones of an OceanBase cluster
        • Modify parameters of an OceanBase cluster
        • Upgrade an OceanBase cluster
        • Add an OBServer
        • Obtain resource statistics of all OBServer nodes in a cluster
        • Obtain information of resource units
        • Start a zone in an OceanBase cluster
        • Restart an OceanBase cluster
        • Query the parameter metadata of an OceanBase cluster
        • Start an OceanBase cluster
        • Create a zone for an OceanBase cluster
      • Backup and recovery
        • Query the backup strategy of a cluster
        • Preview a restore task
        • Initiate tenant recovery
        • Add restore resources
        • Query the backup overview of a cluster
        • Query log backup tasks of a cluster
        • Query data backup tasks of a cluster
        • Immediately back up a cluster
        • Delete the backup strategy of a cluster
        • Modify the backup strategy of a cluster
        • Create a backup strategy for a cluster
        • Clear added restore resources
        • Parse cluster backup data
        • Query recovery tasks of a cluster
        • Query backup capabilities of a cluster
      • OceanBase user and privilege management
        • Delete a database user
        • Revoke roles of a user
        • Query database role details
        • Lock a database user
        • Change global privileges of a user
        • Change roles of a user
        • Change object privileges of a user
        • Delete a database role
        • Grant database privileges to a user
        • Unlock a database user
        • Change the password of a database user
        • Create a database role
        • Query the database role details
        • Revoke object privileges of a user
        • Query database user details
        • Create a database user
        • Query database user details
        • Grant object privileges to a user
        • Change object privileges of a role
        • Revoke database privileges of a user
        • Revoke global privileges of a user
        • Grant global privileges to a user
        • Revoke roles of a role
        • Revoke object privileges of a role
        • Revoke global privileges of a role
        • Grant roles to a user
        • Grant roles to a role
        • Grant object privileges to a role
        • Change global privileges of a role
        • Change roles of a role
        • Query database objects
        • Grant global privileges to a role
        • Change database privileges of a user
      • OBProxy management
        • Delete an OBProxy
        • Remove a connectable OceanBase cluster from an OBProxy cluster
        • Query the parameter metadata of an OBProxy
        • Query OBProxy clusters
        • Restart an OBProxy
        • Update configurations of an OBProxy cluster
        • Take over an OBProxy
        • Delete an OBProxy cluster
        • Create an OBProxy cluster
        • Upgrade an OBProxy
        • Add a connectable OceanBase cluster for an OBProxy cluster
        • Query details about an OBProxy cluster
        • Query parameters of an OBProxy cluster
        • Add an OBProxy
      • Software packages
        • Delete a software package
        • Query software packages
        • Upload a software package
      • Hosts
        • Query IDCs
        • Query regions
        • Delete a host type
        • Query details about a region
        • Query details about an IDC
        • Query host types
        • Query details about a host
        • Add multiple hosts at a time
        • Add a region
        • Delete a region
        • Delete a host
        • Delete multiple hosts at a time
        • Add a host type
        • Query hosts
        • Delete an IDC
        • Query details about a host type
        • Add an IDC
      • OCP Agent management
        • Restart basic OCP Agent processes on a host
        • Stop OCP Agent processes on a host
        • Batch restart basic OCP Agent processes on a host
        • Query OCP Agent processes on a host
        • Stop basic OCP Agent processes on a host
        • Query OCP Agent details on a host
        • Restart OCP Agent processes on a host
        • Batch stop basic OCP Agent processes on a host
      • Tenant information
        • Delete a unit from a tenant
        • Create a tenant
        • Delete a replica of a tenant
        • Unlock a tenant
        • Query parameters of a tenant
        • Query all tenants
        • Query units of a tenant
        • Query tenants of a cluster
        • Query details about a tenant
        • Modify a replica of a tenant
        • Create a tenant
        • Modify the whitelist of a tenant
        • Modify zone priorities of a tenant
        • Change the administrator password of a tenant
        • Obtain a list of unit specifications
        • Create a resource unit specification
        • Modify parameters of a tenant
        • Lock a tenant
        • Add a replica for a tenant
        • Delete a tenant
        • Delete a resource unit specification
        • OceanBase database management
          • Create a database
          • Modify a database
          • Delete a database
          • Query databases
      • Inspection
        • Query all inspection tasks
        • Query inspection objects
        • View the details of an inspection report
        • Initiate an inspection
      • Alerts
        • Call an alert API
        • Alert events
          • Query alert events
          • Query the alert event list
        • Alert notifications
          • Query alert notifications
      • Performance Report
        • Query snapshots
        • Generate a performance report
        • Query a performance report
      • OCP event history
        • Query event history
      • SQL performance
        • Query the operator structure of an execution plan
        • Query performance indicators of an SQL statement
        • Query the performance indicator trend of an SQL statement
        • Query performance indicators of an execution plan
        • Query the performance indicator trend of an execution plan
        • Query SQL text
      • Health examination
        • Query OCP server time
        • Query the basic information of an OCP application
        • Query OCP application status
      • Monitoring
        • Query monitoring data and group the queried data by tag
        • Query monitoring data
        • Query the metadata of a monitoring metric
    • Metric reference
      • Overview of metrics
      • Monitoring metrics list
      • OceanBase Database tenant
        • Number of XA statements
        • TPS
        • Cache size
        • I/O Throughput
        • RPC packet throughput
        • Number of transaction logs
        • Partitions
        • Frozen MemStores
        • IOPS
        • Average execution duration of XA statements
        • SQL execution plan category
        • Transaction response time
        • Tenant CPU cost
        • Backend wait event metrics
        • Request waiting queue
        • Response time
        • Time consumed by lock waits
        • Rpc package rt
        • Metrics for the SQL execution phase
        • Cursors
        • Request queue size
        • Wait events
        • Tenant thread usage
        • QPS
        • Sessions
        • Time consumed by transaction logs
        • memroy usage pecent
        • Cache hit rates
        • MemStore usage
        • Clog synchronization delay
        • Lock waits
        • DB time metrics
        • MemStore
        • TPS
        • SQL execution plan time
        • Transaction table read request hits
        • Number of XA transactions
        • Metrics related to time consumption of wait events
        • Number of cache requests
        • Request waiting queue time consuming
        • Transaction log volume
        • Frontend workload metrics
        • Transaction response time details
        • IO time-consuming
      • OBProxy cluster
        • Memory for the obproxy process
        • Client connections
        • Number of threads in the obproxy process
        • Number of file descriptors for the obproxy process
        • TPS
        • Server connections
        • Average bytes in a network request or response
        • QPS
        • CPU utilization of the obproxy process
        • Number of error logs
        • Average route table queries per second
        • Average response time for each SQL statement
      • Host
        • IOPS
        • CPU Utilization
        • I/O throughput
        • Network throughput
        • Process CPU utilization
        • Number of process threads
        • NTP clock offset
        • Disk
        • Inode usage
        • Number of OCP-Agent process goroutines
        • I/O queue length
        • Packet forwarding
        • I/O usage
        • Time consumed by I/O operations
        • Memory
        • Process resident memory
        • Linux system load
        • Memory usage
        • Number of process file descriptors
        • TCP retransmission rate
      • OceanBase cluster
        • Time consumed by transaction logs
        • Number of transaction logs
        • Process file descriptors
        • Request queue time
        • TPS
        • Transaction response time
        • I/O Throughput
        • Transaction log volume
        • IOPS
        • QPS
        • Number of process threads
        • Process memory
        • Number of sessions
        • TPS
        • Query response time
        • IO time-consuming
        • sys500 memory occupation
        • Process CPU utilization
        • Error logs
  • 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 on OceanBase cluster
      • FAQ on OBProxy
      • FAQ on OceanBase tenants
      • FAQ on accounts and passwords
      • FAQ on host management
  • Appendix
    • Install and configure OCI
    • Component listening port list
    • Processes
    • OCP background tasks
    • OCP error codes
    • Tables managed by the daemon
  • Release Notes
    • V4.3
      • OCP V4.3.0

Download PDF

Document Overview What is OceanBase Cloud Platform? Differences between the features of OCP Enterprise Edition and OCP Community Edition System architecture Features System requirements Dependencies Overview Installation process Prepare for the installation Deploy OCP on the GUI Use Docker to deploy OCP Post-deployment check Overview Considerations Preparations Upgrade OCP on the GUI Upgrade OCP using Docker containers Post-upgrade check OCP operations Log on to the OCP console Upload a software package Add a host Create a cluster Create a tenant Create a user Create an OBProxy cluster Overview Create a distributed cluster Create a standalone centralized database Create a standby cluster View the details of a cluster Upgrade a standalone centralized database to a distributed cluster Take over a cluster Restart a cluster Stop a cluster Migrate a cluster Delete a cluster Change the password Enable automatic detection of deadlocks Disable automatic detection of deadlocks Disable SQL collection View the SQL collection history 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 Delete an arbitration service Add an arbitration service Replace an arbitration service Remove an arbitration service Add a zone Restart a zone Stop a zone Delete a zone Add an OBServer node Restart a faulty OBServer node Stop an OBServer service Stop the observer process Replace an OBServer node Reinstall an OBServerDelete an OBServer Upgrade an OceanBase cluster View the topology of a cluster Overview of cluster tenant management View the unit distribution View resource usage Modify the major compaction settings of a cluster Perform a major compaction View details of major compaction View major freeze statistics Manage cluster parameter templates Parameter types View parameters Modify parameters View the history of parameter changes Tenant and resource management View tenant overview information Create a primary tenant Manage unit specificationsView OCP resource unit specifications Overview of the Tenant Details page Create a standby tenant Copy a tenantLock a tenant Delete a tenant Change the password of the sys tenant Configure full link tracking for a tenant Modify the allowlist of a tenant Modify zone priorities View the topology of a tenant View the topology of primary/standby relationships of a tenant Add a replica Edit a tenant replica in a zone Delete a tenant replica from a zone Manage databases
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. V4.3.0
iconOceanBase Cloud Platform
V 4.3.0
  • 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

tenant_memstore_percent_over_threshold

Last Updated:2026-04-14 07:51:05  Updated
share
What is on this page
Description
Principle
Alert rule
Alert information
Alert templates
Impact on the system
Possible causes
Solutions

folded

share

Description

This alert is triggered when the memory usage of a tenant exceeds the threshold.

Principle

The following table describes the key parameters that are involved in the monitoring and alerting logic.

Parameter Value
Metric ob_tenant_host_memstore_percent
Source SQL: select /*+read_consistency(weak)*/ tenant_name, tenant_id, stat_id, value from v$sysstat, __all_tenant where stat_id IN (130001, 130004) and (con_id > 1000 or con_id = 1) and__all_tenant.tenant_id = v$sysstat.con_id;
The value of the value field is used as the value of sysstat_value, and the values of other fields are used as labels.
Collected metric sysstat_value
Metric expression 100 * sum(sysstat_value{metric_group="sysstat",stat_id="130001",@LABELS}) by (@GBLABELS) / sum(sysstat_value{metric_group="sysstat",stat_id="130004",@LABELS}) by (@GBLABELS)
Collection cycle 1 second

Note

  • When the statistical event ID (stat_id) is 130001, the total used memory space of the tenant is collected.
  • When stat_id is 130004, the maximum available memory space of the tenant is collected.

In the metric expression, the ratio of the sum of the values of the value field when stat_id is 130001 to the sum of the values of the value field when stat_id is 130004 is used as the memory usage of a tenant.

The value of the ob_tenant_host_memstore_percent metric indicates the memory usage of a tenant in the OceanBase cluster. When the memory usage exceeds the threshold, this alert is triggered. The default threshold is 85%.

Alert rule

Metric Default threshold (unit: %) Duration Detection cycle Time before clearance
ob_tenant_host_memstore_percent 85 0 seconds 60 seconds 5 minutes

Alert information

Trigger method Alert level Scope
Based on the expression of the metric Warning Tenant

Alert templates

  • Overview template: ${alarm_target} ${alarm_name}

  • Details template: Cluster: ${ob_cluster_name}. Alert: ${alarm_name}. The MemStore usage reaches ${value_shown}, which exceeds the threshold ${alarm_threshold}%.

  • Overview example: ob_cluster=obcluster-1:tenant_name=tenant-1:svr_ip=xxx.xxx.xxx.xxx. The memory usage of the OceanBase Database tenant exceeds the threshold.

  • Details example: Cluster: obcluster-1. Alert: The memory usage of the OceanBase Database tenant exceeds the threshold. The MemStore usage reaches 86.0%, which exceeds the threshold 85.0%.

Impact on the system

If the tenant memory is insufficient, SQL statement execution may be slowed down, and writes may fail.

Possible causes

This problem is commonly found in cases where write requests sharply increase but only limited resources are available in the tenant.

Solutions

  1. Scale up the tenant memory. You can execute the alert clearance plan to handle the alerted issue. For more information, see Execute the alert clearance plan.

  2. Throttle the concurrency of SQL statements or increase the memory size in the unit specification of the tenant based on the check result.

    1. Go to the Performance Monitoring page of this tenant in the OceanBase Cloud Platform (OCP) console, and then click the Performance & SQL tab.

    2. Select Last 7 Days for Select Time.

    3. View the curve chart of MEMStore usage percent.

      Check whether the memory usage at the time when the alert was generated abnormally increases.

      • If the memory usage abnormally increases or regularly increases, accompanied by an alert indicating insufficient resources, bind a hint to write-type SQL statements of this tenant to limit the concurrency.

        For more information, see Apply throttling to an OceanBase cluster.

      • If the memory usage normally fluctuates or regularly increases and resources are sufficient, increase the memory size in the unit specification of the tenant.

        For more information, see Manage unit specifications.

Previous topic

tenant_cpu_percent_over_threshold
Last

Next topic

obproxy_process_dead
Next
What is on this page
Description
Principle
Alert rule
Alert information
Alert templates
Impact on the system
Possible causes
Solutions