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
      • Dependencies
      • System requirements
  • 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
        • Host planning
        • Port planning
        • User planning
        • Disk and directory planning
      • Appendix
        • Install Docker
        • Restart OCP
        • Uninstall OCP
        • FAQ about deployment
    • Deploy OceanBase Cloud Platform (OCP) Enterprise Edition
      • Deploy OCP
        • Check after deployment
        • Deploy OCP
          • Deploying a high availability of OCP
            • Create MetaDB
            • Initialize system parameters
            • Register an OCP cluster
            • Prepare installation media
            • Install OCP
          • Deploying a single point of OCP
            • Initialize system parameters
            • Install OCP
            • Prepare installation media
            • Create MetaDB
        • Plan resources
          • Planning resources of a high availability OCP
            • MonitorDB resources
            • Host resources
            • MetaDB resources
            • OCP-Server specifications
          • Planning resources of a single node OCP
            • MonitorDB resources
            • OCP-Server specifications
            • Host resources
            • MetaDB resources
      • Deployment FAQ
        • Ubuntu deployment FAQ
        • Client requirements
        • Start and stop OCP
        • Optimize MonitorDB parameters
        • EulerOS deployment FAQ
        • 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
      • Prepare the deployment environment
        • Add a server
        • Check the environment
        • Install OAT
      • Deployment overview
        • Deploy OCP cluster in the High-availability
        • Deploy OCP cluster in the Single-node
      • 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 task feature
        • Verify the software package feature
        • Verify the password box feature
        • Verify the host feature
        • Verify the cluster feature
        • Verify the OBProxy feature
        • Verify the tenant feature
        • Verify the alert feature
        • Verify the backup and restore 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
    • Log on to the OCP console
    • Create a user
    • OCP operations
    • Create an OBProxy cluster
    • Create a tenant
    • Create a 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
      • Disable automatic detection of deadlocks
      • Restart a cluster
      • Change the password
      • Delete a cluster
      • Take over a cluster
      • View the SQL collection history
      • Stop a cluster
      • Migrate a cluster
      • Disable SQL collection
      • Create a standby cluster
      • Upgrade a standalone centralized database to a distributed cluster
      • Enable automatic detection of deadlocks
      • View the details of a cluster
    • Manage OBServers of a cluster
      • Stop the observer process
      • Restart a faulty OBServer node
      • Delete an OBServer
      • Replace an OBServer node
      • Reinstall an OBServer
      • Add an OBServer node
      • Stop an OBServer service
    • Manage zones of a cluster
      • Add a zone
      • Restart a zone
      • Stop a zone
      • Delete a zone
    • Manage Arbitration Service
      • Remove an arbitration service
      • Replace an arbitration service
      • Take over an arbitration service
      • Delete an arbitration service
      • Stop an arbitration service
      • Upgrade an arbitration service
      • Create an arbitration service
      • Start an arbitration service
      • Arbitration service Overview
      • Migrate an arbitration service
      • Restart an arbitration service
      • Add an arbitration service
    • Manage cluster resource
      • View resource usage
      • View the unit distribution
    • Manage cluster parameters
      • Parameter types
      • View parameters
      • View the history of parameter changes
      • Modify parameters
    • Manage major compaction of a cluster
      • Perform a major compaction
      • View details of major compaction
      • Modify the major compaction settings of a cluster
      • 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
      • Copy a tenant
      • Lock a tenant
      • Change the password of the sys tenant
      • Configure full link tracking for a tenant
      • Overview of the Tenant Details page
      • Create a standby tenant
      • Delete 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 isolation plan
      • Delete a resource isolation plan
      • Delete a resource group
      • Modify a resource group
      • Modify a resource isolation plan
      • Enable or disable a resource isolation plan
      • Create 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
      • Manage load balancing
      • Upgrade an OBProxy cluster
      • Migrate an OBProxy cluster
      • Add a connectable OceanBase cluster
      • Delete a connected OceanBase cluster
      • Manage the proxyro account
      • Change the password of the proxyro user
      • Stop or start an ODP cluster
      • Delete an ODP cluster
      • Restart an ODP cluster
      • Change the password of the proxysys user
      • View details on the Overview page of an OBProxy cluster
    • 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
    • Optional monitoring metrics for custom alerts
    • OCP alert template tag
    • View alert events
    • Manage alert push
      • Delete an alert push
      • Edit an alert push
      • View an alert push
      • Create an alert push
    • Manage blocking conditions
      • Edit an alert blocking condition
      • Create a blocking condition
      • Delete an alert blocking condition
    • 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
      • Delete an alert template
      • Edit an alert template
      • Create an alert template
      • View an alert template
      • Copy an alert template
      • Set alert objects
      • Export alert templates
    • 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
  • 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 statement execution statistics
        • SQL execution plans
        • SQL diagnostics overview
      • 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
      • Decouple a standby tenant from its primary tenant
      • Failover
      • Switchover
    • OCP Manage OCP clusters in the multi-cluster mode
      • Register an OCP cluster
      • Switch an OCP cluster in a failover
      • OCP multi-cluster mode overview
      • Unbind a leader and a follower OCP cluster
      • Manage OCP cluster parameters
      • Switch an OCP cluster in daily maintenance
      • Enable the OCP multi-cluster mode
      • Delete a faulty follower OCP cluster
      • View Leader \& Follower Details
    • 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
      • Default OCP roles
      • Delete a role
      • View a role
      • Copy a role
      • Create a role
      • Edit a role
    • Manage users
      • View users
      • Users overview
      • Create a user
      • Logon history
      • Delete a user
      • Copy a user
      • Change a user password
      • Edit a user
    • User center management
      • Change your logon password
      • Configure personal information
      • 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
    • General SQL Performance Tuning Scenarios
      • Execution Plan Optimization
        • SQL statement performance deterioration caused by plan changes
      • Index Optimization
        • Inappropriate index of an SQL statement
        • No suitable indexes
        • Invalid index of an SQL statement
    • Customize Abnormal SQL Statement Determining Rules
      • Conditions
      • Custom column rules
    • Locate General Abnormal SQL Statements
      • How can I locate SQL statements for full-table scans in a tenant?
      • How can I locate SQL statements with high CPU load in a tenant?
      • How can I locate slow hard-parsed SQL statements in a tenant?
      • How can I locate erroneous SQL statements in a tenant?
      • How can I locate distributed SQL statements in a tenant?
      • How can I locate slow SQL statements that take a long time in a tenant?
      • How can I locate remote SQL statements in a tenant?
  • O&M Best practices
    • Send alert messages through email
    • 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
        • 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
        • 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 the backup strategy of a cluster
        • Initiate tenant recovery
        • 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
        • 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
      • Alerts
        • Call an alert API
        • Alert events
          • Query alert events
          • Query the alert event list
        • Alert notifications
          • Query alert notifications
      • 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
        • Number of XA transactions
        • Number of transaction logs
        • Partitions
        • IOPS
        • SQL execution plan category
        • Transaction response time
        • Tenant CPU cost
        • Request waiting queue
        • Response time
        • Average execution duration of XA statements
        • Rpc package rt
        • Cursors
        • Request queue size
        • Waiting for events
        • Tenant thread usage
        • QPS
        • Sessions
        • Transaction log volume
        • Time consumed by transaction logs
        • memroy usage pecent
        • Cache hit rates
        • MemStore usage
        • IO time-consuming
        • Clog synchronization delay
        • Lock waits
        • MemStore
        • TPS
        • Transaction response time details
        • Transaction table read request hits
        • Waiting for event time
        • Number of cache requests
        • Request waiting queue time consuming
        • Time consumed by lock waits
        • RPC packet throughput
        • SQL execution plan time
      • 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
    • 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 Dependencies System requirements 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 Log on to the OCP console Create a user OCP operations Create an OBProxy cluster Create a tenant Create a 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 Disable automatic detection of deadlocks Restart a cluster Change the password Delete a cluster Take over a cluster View the SQL collection history Stop a cluster Migrate a cluster Disable SQL collection Create a standby cluster Upgrade a standalone centralized database to a distributed cluster Enable automatic detection of deadlocks View the details of a cluster Stop the observer process Restart a faulty OBServer nodeDelete an OBServer Replace an OBServer node Reinstall an OBServer Add an OBServer node Stop an OBServer service Add a zone Restart a zone Stop a zone Delete a zone Remove an arbitration service Replace an arbitration service Take over an arbitration service Delete an arbitration service Stop an arbitration service Upgrade an arbitration service Create an arbitration service Start an arbitration service Arbitration service Overview Migrate an arbitration service Restart an arbitration service Add an arbitration service View resource usage View the unit distribution Parameter types View parameters View the history of parameter changes Modify parameters Perform a major compaction View details of major compaction Modify the major compaction settings of a cluster 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 Copy a tenantLock a tenant Change the password of the sys tenant Configure full link tracking for a tenant Overview of the Tenant Details page Create a standby tenant Delete 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

obproxy_cannot_connected

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
Solutions

folded

share

Description

This alert is triggered when the OBProxy is disconnected.

Principle

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

Parameter Value
Metric obproxy_connectable
Source OCP-Agent checks the local OBProxy connectivity by establishing a socket connection to localhost:2883. The timeout value is 0.8s.
Collected metric obproxy_connectable
Metric expression obproxyd_process_exists{app="ODP",@LABELS}
Collection cycle 1 second

Note

The metric source of this alert is special. OCP-Agent checks the local OBProxy connectivity by establishing a socket connection to localhost:2883 and returns the result to the collected metric.

  • The port number 2883 in the Source row is obtained by querying the config.conf file in home/admin/ocp_agent.
  • The value of the metric obproxy_connectable indicates the OBProxy connectivity. Valid values: 1 and 0. The value 1 indicates that the OBProxy is connectable and 0 indicates that it is unconnectable.

The alert is triggered when the value of the metric is 0.

Alert rule

Metric Default threshold Duration Detection cycle Time before clearance
obproxy_connectable 0 0 seconds 10 seconds 5 minutes

Alert information

Trigger method Alert level Scope
Based on the expression of the metric Stopped Server

Alert templates

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

  • Details template: OBProxy cluster: ${obproxy_cluster}. Host: ${host}. Alert: ${alarm_name}. Cause: ${failed_reason}.

  • Overview example: obproxy_template_id=0:obproxy_cluster=obproxy_01:host=xxx.xxx.xxx.xxx. OBProxy cannot be connected.

  • Details example: OBProxy cluster: obproxy_02. Host: xxx.xxx.xxx.xxx. Alert: OBProxy cannot be connected. Cause: OBPROXY_CONNECTION_ERROR.

${alarm_target} indicates the object that generated the alert, in the obproxy_template_id=xx:obproxy_cluster=xx:host=xx format. obproxy_cluster_id indicates the ID of the OBProxy cluster that generated the alert. obproxy_cluster indicates the name of the OBProxy cluster that generated the alert. svr_ip indicates the IP address of the OBProxy server that generated the alert.

Impact on the system

OBProxy provides access to an OceanBase cluster as the proxy. When OBProxy is not connected, the application cannot connect to the database.

Possible causes

This problem is commonly found in the following scenarios:

  • A network communication error occurs.

  • The obproxy process unexpectedly stops.

Solutions

Check the causes of OBProxy disconnection and recover the connection.

  • If the OBProxy server is damaged, replace it with a new one.

  • If the OBProxy node is no longer needed, you can delete it.

  • If a process exception occurs, see ob_cannot_connected.

Previous topic

obproxyd_process_dead
Last

Next topic

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