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.2.2

  • 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) Community Edition
      • Installation process
      • Prepare for the installation
      • Overview
      • Post-deployment check
      • Use Docker to deploy OCP
      • Deploy OCP on the GUI
      • Installation planning
        • User planning
        • Host planning
        • Disk and directory planning
        • Port planning
      • Appendix
        • Install Docker
        • Restart OCP
        • Uninstall OCP
        • FAQ about deployment
    • Deploy OceanBase Cloud Platform (OCP) Enterprise Edition
      • Deployment overview
        • Deploy OCP cluster in the High-availability
        • Deploy OCP cluster in the Single-node
      • Prepare the deployment environment
        • Install OAT
        • Add a server
        • Check the environment
      • Deploy OCP
        • Plan resources
          • Planning resources of a single node OCP
            • MonitorDB resources
            • OCP-Server specifications
            • Host resources
            • MetaDB resources
          • Planning resources of a high availability OCP
            • MonitorDB resources
            • Host resources
            • MetaDB resources
            • OCP-Server specifications
        • Deploy OCP
          • Deploying a single point of OCP
            • Prepare installation media
            • Create MetaDB
            • Install OCP
            • Initialize system parameters
          • Deploying a high availability of OCP
            • Create MetaDB
            • Initialize system parameters
            • Register an OCP cluster
            • Prepare installation media
            • Install OCP
        • Check after deployment
      • Deployment FAQ
        • Optimize MonitorDB parameters
        • F5 Big-IP LTM and alert configuration
          • Monitor the OCP service health
          • Connect OBProxy to F5 Big-IP LTM
          • Connect OCP-Console to F5 Big-IP LTM
        • Ubuntu deployment FAQ
        • EulerOS deployment FAQ
        • Client requirements
        • Start and stop OCP
      • Appendix
        • Uninstall OCP
  • Upgrade OceanBase Cloud Platform (OCP)
    • Upgrade OceanBase Cloud Platform (OCP) Enterprise Edition
      • Overview
      • Considerations
      • Preparations
      • Appendix
        • Version mapping
        • Change a user's password
      • 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
      • Upgrade OCP
        • Take over OCP
        • Upgrade OCP
    • Upgrade OceanBase Cloud Platform (OCP) Community Edition
      • Post-upgrade check
      • Upgrade OCP on the GUI
      • Upgrade OCP using Docker containers
  • Quick Start
    • OCP operations
    • Log on to the OCP console
    • Create a cluster
    • Create a tenant
    • Create a user
    • Create an OBProxy cluster
    • Add a host
    • Upload a software package
  • Cluster Management
    • Upgrade an OceanBase cluster
    • View the topology of a cluster
    • Overview of cluster tenant management
    • Manage cluster parameter templates
    • Overview
    • 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 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
    • Manage zones of a cluster
      • Add a zone
      • Restart a zone
      • Stop a zone
      • Delete a zone
    • 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 cluster resource
      • View the unit distribution
      • View resource usage
    • Manage cluster parameters
      • Parameter types
      • View parameters
      • Modify parameters
      • View the history of parameter changes
    • 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
    • Create a cluster
      • Create a distributed cluster
      • Create a standalone centralized database
  • Tenant Management
    • Tenant and resource management
    • Create a primary tenant
    • Modify the allowlist of a tenant
    • View OCP resource unit specifications
    • Manage tenant parameter templates
    • Modify zone priorities
    • Manage databases
    • Manage the resources of a tenant
    • Manage unit specifications
    • View cluster overview information
    • 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
    • Manage major compaction under a tenant
      • Perform a major compaction
      • Modify major compaction settings of a tenant
      • Details of tenant major compaction
    • 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 users and permissions under a tenant
      • System privileges in a MySQL tenant
      • Manage users in a MySQL tenant
      • Manage user under an Oracle tenant
        • Create a role under an Oracle tenant
        • Create a user under an Oracle tenant
        • Delete a user under an Oracle tenant
        • User overview under an Oracle tenant
        • Manage roles
        • Manage users
        • Change the password of a user under an Oracle tenant
    • Manage tenant parameters
      • View the parameters
      • Modify a parameter
      • View the parameter modification history
    • Manage replicas of a tenant
      • Edit a tenant replica in a zone
      • Add a replica
      • Delete a tenant replica from a zone
    • Manage topulogy of a tenant
      • View the topology of a tenant
      • View the topology of primary/standby relationships of a tenant
  • OBProxy Management
    • Parameter management
    • Create an OBProxy cluster
    • View details on the OBProxy page
    • Request analysis
    • Client configuration
    • OBProxy parameters descpription
    • OBProxy management overview
    • 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 ODP 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
      • Stop or start an OBProxy
      • Take over an OBProxy
      • Refresh OBProxy configurations
      • Upgrade an OBProxy
      • Delete an OBProxy
      • Remove an OBProxy
      • Launch an OBProxy
      • Add an OBProxy
      • Restart an OBProxy
  • Host Management
    • OCP-Agent processes
    • View details of a host
    • Perform host standardization checks
    • Host standardization check items
    • Reinstall OCP Agent
    • View the details of tasks on a host
    • Add a host
    • Modify a host
    • Host management operations
    • Restart OCP-Agent
    • OCP-Agent O&M Script Instructions
    • Remove a host
  • Alert Management
    • Overview
    • Alert-related concepts
    • Manage alert rules
      • Create an alert rule
      • Copy an alert rule
      • View an alert rule
      • Edit an alert rule
      • Export alert rule configurations
      • Alert rule groups
      • Delete an alert rule
    • 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
      • Edit an alert blocking condition
      • Create a blocking condition
      • Delete an alert blocking condition
    • OCP alert template tag
    • Optional monitoring metrics for custom alerts
  • Dashboard Management
    • Manage dashboards
    • Monitoring dashboard overview
    • Manage groups
    • Manage charts
  • Performance Monitoring
    • Use the custom monitoring feature
      • View collection items
      • Overview
      • OCP metrics
      • Manage indicator items
        • Create a metric
        • Manage metrics
      • Manage charts
        • Create a chart
        • Manage charts
    • 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
  • Inspection Management
    • View an inspection task
    • Configure inspection items
    • Inspection
    • Configure Scheduling Rules
      • Configure a global scheduling rule
      • Configure a scheduling rule for a single object
    • Manage Inspection reports
      • View an inspection report
      • Download an inspection report
    • Initiate Inspection
      • Initiate an inspection for a single object
      • Initiate a global inspection
  • 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
      • Diagnostics Transaction
      • Overview of 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
      • Performance report
      • Manage ASH report
  • Backup and Recovery
    • Overview
    • Backup and recovery guide
    • Initiate a restore task
    • Overview
    • View restore tasks
    • Manage backup and recovery service
      • Stop a service on a node
      • Copy a service
      • Uninstall a service on a node
      • Add a node
      • Upgrade the version of a service
      • Restart a service on a node
      • Delete a service
      • View services
      • Install a service
      • Update service configurations
      • View O\&M tasks
    • Manage backup tasks
      • View second backup tasks
      • View backup tasks
    • Regular backup
      • Manage cluster-level backup strategy
        • View a cluster-level backup stategy
        • Create a cluster-level backup strategy
        • Modify a cluster-level backup strategy
        • Delete a cluster-level backup strategy
        • Pause backup scheduling
      • Manage tenant-level backup strategy
        • Pause backup scheduling
        • Create a tenant-level backup strategy
        • View a tenant-level backup stategy
        • Delete a tenant-level backup strategy
        • Modify a tenant-level backup strategy
    • Regular recovery
      • View sampling strategies
      • View sampling tasks
      • Create a sampling strategy for recovery
    • Backup now
      • Back up tenant now
      • Back up 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
      • Switchover
      • Failover
      • Decouple a standby tenant from its primary tenant
    • 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
    • OCP Manage OCP in multi-zone mode
      • View details of multiple zones
      • Manage parameters in multi-zone mode
      • Multi-zone overview
  • 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
    • Manage tasks
    • View Operation Audit
    • Manage system parameters
      • Modify system parameters
      • View system parameters
      • OCP configuration parameters
    • Manage roles
      • Role overview
      • Create a role
      • Copy a role
      • View a role
      • Edit a role
      • Delete a role
      • Default OCP roles
    • Manage users
      • Users overview
      • Create a user
      • View users
      • Edit a user
      • Copy a user
      • Change a user password
      • Delete a user
      • Logon history
    • User center management
      • Configure personal information
      • Change your logon password
      • Log off the OCP console
    • Manage password box
      • Create a credential
      • Edit a credential
      • Verify a credential
      • Import a credential
      • Export a credential
      • Delete a credential
      • Batch operations on credentials
    • Manage tags
      • Delete a tag
      • Overview
      • Modify objects bound to a tag
      • Edit a tag
      • Create a tag
  • SQL Tuning Practices
    • 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?
    • Customize Abnormal SQL Statement Determining Rules
      • Conditions
      • Custom column rules
    • 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
  • O&M Best practices
    • Send alert messages through email
    • Send alert messages to a Feishu group
    • Integrate OCP monitoring into Prometheus
    • Troubleshoot host issues in an OceanBase cluster
    • Push alert messages through HTTP
    • Use the backup and restore module to restore data
    • Monitor the business load of OceanBase Database
    • Scale out an OceanBase cluster and scale up an OceanBase Database tenant
    • Migrate an OceanBase cluster to another IDC
    • Scale in an OceanBase cluster and scale down an OceanBase Database tenant
    • Send alert messages to a WeChat Enterprise group
    • Migrate a resource unit from an OceanBase Database tenant
    • Send alert messages to a DingTalk group
    • Upgrade an OceanBase cluster
    • Scale out an OBProxy cluster
    • Scale in an OBProxy cluster
    • Replace an OBProxy
    • Move out an OBProxy cluster
    • Take over OBProxies
    • Back up an OceanBase cluster
    • Configure custom monitoring
    • Perform an inspection in OCP to detect potential risks in an OceanBase cluster
    • Check clog synchronization
    • Check the NIC rate
    • Check the availability of an auto-increment column
    • Expand the high availability of OceanBase clusters and tenants
    • Reduce the high availability of OceanBase clusters and tenants
    • Perform a failover between primary and standby OceanBase clusters for disaster recovery in a scenario with two IDCs
  • Reference Guide
    • Alarm reference
      • Alert Reference
      • 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
        • ocp_http_request_timeout
        • ocp_collect_metric_failure_rate_high
        • host_agent_res_memory_over_threshold
        • ob_host_net_recv_percent_over_threshold
        • vpc_connect_failed
        • odp_sql_execute_failed
        • 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
      • 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
      • OAS alerts
        • os_cpu_irq_error
        • os_tsar_cpu_sys_abnormal
        • os_observer_fd_usage
        • os_tsar_cpu_util_full
        • os_tsar_cpu_util_hwm
        • os_kernel_io_hang
        • os_tsar_sda_ioawait
        • os_tsar_nvme_ioawait
        • os_tsar_traffic_drop
        • os_tsar_traffic_error
        • os_observer_core_dump
        • os_nic_1000m_full
        • os_nic_1000m_hwm
        • os_tsar_traffic_overload
        • node_file_root_usage
        • node_file_inode_usage
        • os_kernel_ntp_down
        • os_kernel_ntp_delay
        • node_memory_peak
        • os_home_file_usage
        • node_file_data1_usage
        • node_file_datalog1_usage
        • sql_audit_collect_lost_percent_over_threshold
      • Appendix
        • Exception handling for OceanBase cluster compaction
        • Apply throttling to an OceanBase cluster
        • Network troubleshooting
        • Execute the alert clearance plan
    • 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
        • Query parameters of an OceanBase cluster
        • Perform a failover pre-check
        • Stop a zone in 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
        • 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
        • Perform a switchover
      • Backup and recovery
        • Query backup capabilities of a cluster
        • Create a backup strategy for a cluster
        • Modify the backup strategy of a cluster
        • Delete the backup strategy of a cluster
        • Query the backup strategy of a cluster
        • Query the backup overview of a cluster
        • Query data backup tasks of a cluster
        • Query log backup tasks of a cluster
        • Query recovery tasks of a cluster
        • Immediately back up a cluster
        • Parse cluster backup data
        • Initiate tenant recovery
      • OceanBase user and privilege management
        • Query database user details
        • Query database user details
        • Create a database user
        • Delete a database user
        • Change the password of a database user
        • Lock a database user
        • Unlock a database user
        • Query the database role details
        • Query database role details
        • Create a database role
        • Delete a database role
        • Query database objects
        • Grant global privileges to a user
        • Revoke global privileges of a user
        • Change global privileges of a user
        • Grant global privileges to a role
        • Revoke global privileges of a role
        • Change global privileges of a role
        • Grant roles to a user
        • Revoke roles of a user
        • Change roles of a user
        • Grant roles to a role
        • Revoke roles of a role
        • Change roles of a role
        • Grant database privileges to a user
        • Revoke database privileges of a user
        • Change database privileges of a user
        • Grant object privileges to a user
        • Revoke object privileges of a user
        • Change object privileges of a user
        • Grant object privileges to a role
        • Revoke object privileges of a role
        • Change object privileges of a role
      • 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 regions
        • Query details about a region
        • Add a region
        • Delete a region
        • Query IDCs
        • Query details about an IDC
        • Add an IDC
        • Delete an IDC
        • Query host types
        • Query details about a host type
        • Add a host type
        • Delete a host type
        • Query hosts
        • Query details about a host
        • Add multiple hosts at a time
        • Delete a host
        • Delete multiple hosts at a time
      • 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
        • Query tenants of a cluster
        • Query all tenants
        • Query details about a tenant
        • Create a tenant
        • Create a tenant
        • Delete a tenant
        • Lock a tenant
        • Unlock a tenant
        • Query units of a tenant
        • Delete a unit from a tenant
        • Add a replica for a tenant
        • Delete a replica of a tenant
        • Modify a replica of a tenant
        • Modify zone priorities of a tenant
        • Change the administrator password of a tenant
        • Modify the whitelist of a tenant
        • Query parameters of a tenant
        • Modify parameters of a tenant
        • OceanBase database management
          • Query databases
          • Create a database
          • Modify a database
          • Delete a database
        • Obtain a list of unit specifications
        • Create a resource unit specification
        • Delete a resource unit specification
      • Alerts
        • Call an alert API
        • Alert events
          • Query the alert event list
          • Query alert events
        • Alert notifications
          • Query alert notifications
      • OCP event history
        • Query event history
      • SQL performance
        • Query performance indicators of an SQL statement
        • Query the performance indicator trend of an SQL statement
        • Query SQL text
        • Query performance indicators of an execution plan
        • Query the performance indicator trend of an execution plan
        • Query the operator structure of an execution plan
      • Health examination
        • Query the basic information of an OCP application
        • Query OCP server time
        • Query OCP application status
      • Monitoring
        • Query the metadata of a monitoring metric
        • Query monitoring data
        • Query monitoring data and group the queried data by tag
    • Metric reference
      • Overview of metrics
      • Monitoring metrics list
      • OceanBase Database tenant
        • QPS
        • Response time
        • Sessions
        • SQL execution plan category
        • SQL execution plan time
        • Waiting for events
        • Waiting for event time
        • Request waiting queue
        • Request waiting queue time consuming
        • Request queue size
        • Tenant CPU cost
        • Tenant thread usage
        • memroy usage pecent
        • MemStore usage
        • Rpc package rt
        • RPC packet throughput
        • Cursors
        • Clog synchronization delay
        • TPS
        • Transaction response time
        • Transaction response time details
        • Number of transaction logs
        • Transaction log volume
        • Time consumed by transaction logs
        • Lock waits
        • Time consumed by lock waits
        • TPS
        • Partitions
        • Number of XA transactions
        • Number of XA statements
        • Average execution duration of XA statements
        • Transaction table read request hits
        • MemStore
        • IOPS
        • IO time-consuming
        • I/O Throughput
        • Cache size
        • Cache hit rates
        • Number of cache requests
      • OBProxy cluster
        • TPS
        • QPS
        • Client connections
        • Server connections
        • Average response time for each SQL statement
        • Memory for the obproxy process
        • CPU utilization of the obproxy process
        • Number of file descriptors for the obproxy process
        • Number of threads in the obproxy process
        • Number of error logs
        • Average route table queries per second
        • Average bytes in a network request or response
      • Host
        • Linux system load
        • CPU Utilization
        • I/O usage
        • I/O queue length
        • IOPS
        • Time consumed by I/O operations
        • I/O throughput
        • Network throughput
        • TCP retransmission rate
        • Packet forwarding
        • NTP clock offset
        • Inode usage
        • Memory
        • Memory usage
        • Disk
        • Process resident memory
        • Process CPU utilization
        • Number of process file descriptors
        • Number of process threads
        • Number of OCP-Agent process goroutines
      • 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 about deployment
    • FAQ on upgrade
    • 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
    • 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 alerts
    • FAQ on the OCP system
    • OCP multi-cluster FAQ
  • Appendix
    • Component listening port list
    • Processes
    • OCP background tasks
    • OCP error codes
    • Tables managed by the daemon

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 Installation process Prepare for the installation Overview Post-deployment check Use Docker to deploy OCP Deploy OCP on the GUI Overview Considerations Preparations Post-upgrade check Upgrade OCP on the GUI Upgrade OCP using Docker containers OCP operations Log on to the OCP console Create a cluster Create a tenant Create a user Create an OBProxy cluster Add a host Upload a software package Upgrade an OceanBase cluster View the topology of a cluster Overview of cluster tenant management Manage cluster parameter templates Overview 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 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 Add a zone Restart a zone Stop a zone Delete a zone 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 View the unit distribution View resource usage Parameter types View parameters Modify parameters View the history of parameter changes Modify the major compaction settings of a cluster Perform a major compaction View details of major compaction View major freeze statistics Create a distributed cluster Create a standalone centralized database Tenant and resource management Create a primary tenant Modify the allowlist of a tenantView OCP resource unit specifications Manage tenant parameter templates Modify zone priorities Manage databases Manage the resources of a tenant Manage unit specifications View cluster overview information 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 Perform a major compaction Modify major compaction settings of a tenant Details of tenant major compaction
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.2.2
iconOceanBase Cloud Platform
V 4.2.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

ob_host_net_recv_percent_over_threshold

Last Updated:2024-03-22 09:34:34  Updated
share
What is on this page
Description
Principle
Alert rule
Alert information
Alert templates
Impact on the system
Possible causes
Suggested solutions

folded

share

Description

This alert is triggered when the inbound bandwidth usage of the OBServer exceeds the threshold.

Principle

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

Parameter Value
Metric ob_host_net_send_percent
Source
  • bandwidth: The network bandwidth is collected by using the psutil.net_if_stats() function of the Python script. The collected data is converted to a value in bytes, where 1 Gbit/s = 1024 Mbit/s, 1 Mbit/s = 1024 Kbit/s, 1 Kbit/s = 1024 bit/s, and 1 byte = 8 bits.
  • node_network_receive_bytes_total: The total amount of inbound data. The data is collected by using the node_exporter process and can be viewed on the local host at http://localhost:63000/metrics.
  • Collected metrics node_network_receive_bytes_total and bandwidth
    Metric expression 100 * max(sum(rate(node_network_receive_bytes_total{@LABELS}[@INTERVAL]) by (device,@GBLABELS)) by (device,@GBLABELS) / sum(bandwidth{@LABELS}) by (device,@GBLABELS)) by (@GBLABELS)
    Collection cycle 1 second

    Note

    The metric source of this alert is special. The network bandwidth usage of the local host is monitored by the OCP-Agent and the data is collected by using the Python script and the exporter process. For more information, see the description in the Source row of the preceding table.

    The value of the metric ob_host_net_send_percent indicates the inbound bandwidth usage of the OBServer. When this value exceeds the threshold, this alert is triggered. The default threshold is 80%.

    Alert rule

    Metric Default threshold (unit: %) Duration Detection cycle Time before clearance
    ob_host_net_send_percent 80 120 seconds 60 seconds 5 minutes

    Alert information

    Trigger method Alert level Scope
    Metric expression Critical Server

    Alert templates

    • Overview: ${alarm_target} ${alarm_name}

    • Details: Cluster: ${ob_cluster_name}, Host: ${host}, Alert: ${alarm_name}. The inbound bandwidth usage of the OBServer is ${value}%, exceeding the threshold of ${alarm_threshold}%.

    • Overview example: ob_cluster=C1-1000:svr_ip=xxx.xxx.xxx.xxx. The inbound bandwidth usage of the OBServer exceeds the threshold.

    • Details example: Cluster: obcluster-1, Host: xxx.xxx.xxx.xxx, Alert: The inbound bandwidth usage of the OBServer exceeds the threshold. The inbound bandwidth usage of the OBServer is 81.0%, exceeding the threshold of 80.0%.

    Impact on the system

    When the network bandwidth is fully utilized, the performance of the OceanBase cluster is bottlenecked. When business traffic continuously increases, the performance of the OceanBase cluster cannot meet the business requirements.

    Possible causes

    This problem is commonly found in cases where the business traffic of the OceanBase cluster increases, for example, more and more SQL queries are received.

    Suggested solutions

    Go to the Monitoring page of the host that triggered the alert in the OCP console, and then view the network throughput on the Host Performance tab.

    Check the network throughput when the alert is triggered.

    • If the network throughput soars, it is likely that the business traffic sharply increases in a short time.

      Wait for the business traffic to restore to normal and check whether the alert is automatically cleared five minutes later.

    • If the network throughput steadily increases or remains high after a sharp rise, it reflects normal business growth.

      Contact the network engineer to increase the network bandwidth of the host.

    Previous topic

    ob_host_mem_percent_over_threshold
    Last

    Next topic

    ob_host_net_send_percent_over_threshold
    Next
    What is on this page
    Description
    Principle
    Alert rule
    Alert information
    Alert templates
    Impact on the system
    Possible causes
    Suggested solutions