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 Cloud

OceanBase Database

Tools Connectors and Middleware

QUICK START

OceanBase Cloud OceanBase 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

OceanBase Cloud Platform

V4.3.6

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

Download PDF

Document Feedback

Error logs

Last Updated：2026-04-03 03:16:02 Updated

This topic describes performance metrics related to error logs in an OceanBase cluster. You can specify a statistical range to query the metrics in a single zone or on a single OBServer node of an OceanBase cluster.

observer

Definition

The number of error logs on an OBServer node of a cluster within the specified statistical range.

Description

Metric	Metric name	Unit
observer	observer_log_error_count	N/A

Calculation expression

sum(rate(ob_log_level_count{level="ERROR",logSourceType="observer",@LABELS}[@INTERVAL])) by (@GBLABELS)

election

Definition

The number of election error logs on an OBServer node of a cluster within the specified statistical range.

Description

Metric	Metric name	Unit
election	election_log_error_count	N/A

Calculation expression

sum(rate(ob_log_level_count{level="ERROR",logSourceType="election",@LABELS}[@INTERVAL])) by (@GBLABELS)

rootservice

Definition

The number of rootservice error logs on an OBServer node of a cluster within the specified statistical range.

Description

Metric	Metric name	Unit
rootservice	rootservice_log_error_count	N/A

Calculation expression

sum(rate(ob_log_level_count{level="ERROR",logSourceType="rootservice",@LABELS}[@INTERVAL])) by (@GBLABELS)

Previous topic

sys500 memory occupation

Last

Next topic

QPS