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

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
    - 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 cluster feature
    - Verify the tenant feature
    - Verify the host feature
    - Verify the software package feature
    - Verify the OBProxy feature
    - Verify the backup and restore feature
    - Verify the alert feature
    - Verify the task feature
    - Verify the password box feature
  - Upgrade OCP
    - Take over OCP
    - Upgrade OCP
- Upgrade OceanBase Cloud Platform (OCP) Community Edition
  - Post-upgrade check
  - Upgrade OCP on the GUI
  - Upgrade OCP using Docker containers
Quick Start
- 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
  - Stop a cluster
  - Move out a cluster
  - Create a standby cluster
  - Upgrade a standalone centralized database to a distributed cluster
  - Enable automatic detection of deadlocks
  - Manage CPU binding configurations
  - View the details of a cluster
  - Manage O&M configuration
    - Manage parameters
    - Overview
    - View the parameter modification history
- 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
  - Edit 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
  - Create an arbitration service
  - Stop an arbitration service
  - Upgrade 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 a major compaction
  - Modify the major compaction settings of a cluster
  - View statistics of a major compaction
- Create a cluster
  - Create a distributed cluster
  - Create a standalone centralized database
Tenant Management
- Tenant and resource management
- Create a primary tenant
- View OCP resource unit specifications
- Manage tenant parameter templates
- Manage databases
- Manage the resources of a tenant
- Manage unit specifications
- View tenant overview information
- Manage tenants
  - Copy a tenant
  - Manage the binlog service for a tenant
  - Rename a tenant
  - Lock a tenant
  - Modify zone priorities
  - Change the password of the sys tenant
  - Manage service names
  - Modify the allowlist of a tenant
  - Configure full link tracking for a tenant
  - View the details of a tenant
  - 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
- Manage resource isolation
  - Overview
  - Create a resource group
  - Create a resource isolation plan
  - Enable or disable a resource isolation plan
  - Modify a resource isolation plan
  - Delete a resource isolation plan
  - Modify a resource group
  - Delete a resource group
- Manage users and permissions under a tenant
  - System privileges in a MySQL tenant
  - Manage users in a MySQL tenant
  - Manage user under an Oracle tenant
    - Create a role under an Oracle tenant
    - Create a user under an Oracle tenant
    - Delete a user under an Oracle tenant
    - User overview under an Oracle tenant
    - Manage roles
    - Manage users
    - Change the password of a user under an Oracle tenant
- Manage statistical information
  - Overview
  - Collect statistics
  - Manage statistics collection tasks
- 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
  - 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 an 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
- Binlog service overview
- Create a binlog cluster
- Manage binlog cluster parameters
- Manage Binlog Clusters
  - Start and stop a binlog cluster
  - View information about a binlog cluster
  - Restart a binlog cluster
  - Delete a binlog cluster
  - Manage Binlog Server
    - Delete a binlog server
    - Start and stop a binlog server
    - Add a binlog node
    - Clear binlog instances on a host
  - Manage Binlog Instance
    - View a binlog instance
    - Manage binlog instance parameters
    - Restart a binlog instance
    - Start and stop a binlog instance
    - Configure throttling
Host Management
- OCP-Agent processes
- View details of a host
- Perform host standardization checks
- Host standardization check items
- Reinstall OCP Agent
- View the details of tasks on a host
- Add a host
- Modify a host
- Host management operations
- Restart OCP-Agent
- OCP-Agent O&M Script Instructions
- Remove a host
Alert Management
- Overview
- Alert-related concepts
- Manage alert rules
  - Create an alert rule
  - Copy an alert rule
  - View an alert rule
  - Edit an alert rule
  - Export alert rule configurations
  - Alert rule groups
  - Delete an alert rule
- Manage alert templates
  - Create an alert template
  - Set alert objects
  - Export alert templates
  - View an alert template
  - Copy an alert template
  - Edit an alert template
  - Delete an alert template
- Manage alert channels
  - Create an alert channel
  - View an alert channel
  - Edit an alert channel
  - Copy an alert channel
  - Delete an alert channel
  - Examples of alert channel configuration
  - Examples of alert channel configuration
- Manage alert push
  - Create an alert push
  - View an alert push
  - Edit an alert push
  - Delete an alert push
- View alert events
- Manage blocking conditions
  - Edit an alert blocking condition
  - Create a blocking condition
  - Delete an alert blocking condition
- OCP alert template tag
- Optional monitoring metrics for custom alerts
Dashboard Management
- Manage dashboards
- Monitoring dashboard overview
- Manage groups
- Manage charts
Performance Monitoring
- Use the custom monitoring feature
  - View collection items
  - Overview
  - OCP metrics
  - Manage indicator items
    - Create a metric
    - Manage metrics
  - Manage charts
    - Create a chart
    - Manage charts
- Manage monitoring
  - Overview
  - View database performance data
  - View host performance data
  - View OBServer node performance data
  - View the performance and SQL monitoring data of a tenant
  - View transaction performance data
  - View storage and cache monitoring data
  - View database object monitoring data
  - View OBKV-Table monitoring data
  - View OBKV-HBase 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 details of an SQL statement
  - View outlines
  - View the SQL collection enable/disable history
  - View SQL request analysis
  - Parameters related to SQL performance diagnostics
- Transaction Diagnostics
  - Diagnose transactions
  - Overview of transaction
  - Diagnose XA transactions and suspended transactions
- Manage sessions
  - Manage the sessions of a tenant
  - View session statistics
  - # View row lock analytics
  - View row lock analytics
- View the Optimization Center page
- View the capacity center
- View diagnostics reports
  - Performance report
  - Manage ASH reports
O&M Management
- Manage Inspection
  - Inspection
  - Configure inspection items
  - Configure Scheduling Rules
    - Configure a global scheduling rule
    - Configure a scheduling rule for a single 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
Backup and Recovery
- Overview
- Backup and restore 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 a 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
  - Create a standby tenant for a primary tenant managed by another OCP cluster
  - 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
- 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
  - Manage a role
    - Role overview
    - Create a role
    - Copy a role
    - View a role
    - Edit a role
    - Delete a role
    - Default OCP roles
  - Manage a user
    - Logon history
    - Delete a user
    - Users overview
    - Change a user password
    - Create a user
    - Edit a user
    - Copy a user
    - View users
- 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
- 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 to a DingTalk group
- Send alert messages through email
- Back up an OceanBase cluster
- 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 into Prometheus
- Troubleshoot host issues in an OceanBase cluster
- Push alert messages through HTTP
- Migrate a resource unit from an OceanBase Database tenant
- Automatic routing to the new primary tenant after a switchover
- Scale in an OBProxy cluster
- Perform an inspection in OCP to detect potential risks in an OceanBase cluster
- Take over OBProxies
- Scale out an OBProxy cluster
- 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
- Expand the high availability of OceanBase clusters and tenants
- Use the backup and restore module to restore data
- Move out an OBProxy cluster
- 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
- Send alert messages to a WeChat Enterprise group
- 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
- 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
Reference Guide
- Alarm reference
  - Overview
  - 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
- Metric reference
  - Overview of metrics
  - Monitoring metrics list
  - OceanBase Database tenant
    - Frontend workload metrics
    - Number of XA statements
    - # Average number of statement lines processed (OBKV-Table)
    - TPS
    - Cache size
    - IO time-consuming
    - I/O Throughput
    - SQL execution plan time
    - Number of transaction logs
    - Partitions
    - Transaction response time details
    - Frozen MemStores
    - Objects
    - IOPS
    - # Data disk
    - SQL execution plan category
    - Transaction table read request hits
    - Transaction response time
    - Tenant CPU cost
    - Metrics related to time consumption of wait events
    - Background workload metrics
    - Number of cache requests
    - # Response time (OBKV-Table)
    - Request waiting queue
    - Response time (SQL mode)
    - MemStore
    - Rpc package rt
    - # Average number of statement lines processed (OBKV-HBase)
    - Metrics for the SQL execution phase
    - # QPS (OBKV_Hbase)
    - # Log disk
    - Cursors
    - # Response time (OBKV-HBase)
    - Request queue size
    - Wait events
    - Tenant thread usage
    - QPS
    - Sessions
    - TPS
    - Time consumed by transaction logs
    - memroy usage pecent
    - PX worker thread usage
    - Cache hit rates
    - MemStore usage
    - # QPS (OBKV-Table)
    - Number of XA transactions
    - Clog synchronization delay
    - Lock waits
    - DB time metrics
    - Request waiting queue time consuming
    - Average execution duration of XA statements
    - Time consumed by lock waits
    - Transaction log volume
    - RPC packet throughput
  - 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
    - Net bytes
    - QPS
    - OBProxy CPU usage
    - Log error
    - Route table queries
    - 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
  - Binlog Service
    - memory used
    - network bytes
    - disk ratio
    - Sending Delay
    - FD count
    - disk used
    - Associate RPS
    - Binlog Disk Write Rate
    - Binlog RPS
    - memory
    - Network Traffic
    - Binlog Delay
    - CPU
- API Reference
  - Overview
  - API call description
  - Rules for generating a signature by using AK/SK
  - Task return structure
  - Software packages
    - Query software packages
    - Delete a software package
    - Upload a software package
  - Database management
    - Grant roles to a user
    - Grant database privileges to a user
    - Grant object privileges to a user
    - Query database objects
    - Revoke global privileges of a role
    - Query the list of database roles
    - Change object privileges of a role
    - Grant global privileges to a role
    - Change global privileges of a role
    - Grant global privileges to a user
    - 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
    - Change object privileges of a 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 user
    - Revoke object privileges of a role
  - System management
    - Health examination
      - Query the basic information of an OCP application
      - Query OCP server time
      - Query OCP application status
    - Operation Audit
      - Query event history
    - 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 indicators 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
    - Query performance indicators 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
    - Upgrade an OBProxy
    - Remove a connectable OceanBase cluster from an OBProxy cluster
    - Create an OBProxy cluster
    - Query the description information of the OBProxy parameters
    - Query details about an OBProxy cluster
    - Add an OBProxy
    - Delete an OBProxy
    - Take over an OBProxy
    - Add a connectable OceanBase cluster for an OBProxy cluster
    - Query parameters of an OBProxy cluster
    - Delete an OBProxy cluster
    - Query OBProxy clusters
    - Restart an OBProxy
  - Cluster management
    - Query OceanBase clusters
    - Create an OceanBase cluster
    - Delete an OceanBase cluster
    - Stop an OceanBase cluster
    - Start an OceanBase cluster
    - Restart an OceanBase cluster
    - Upgrade an OceanBase cluster
    - # Move out an OceanBase cluster
    - # Perform a takeover precheck on an OceanBase cluster
    - # Take over an OceanBase cluster
    - Query zones of an OceanBase cluster
    - Create a zone for an OceanBase cluster
    - Delete a zone from an OceanBase cluster
    - Stop a zone in an OceanBase cluster
    - Start a zone in an OceanBase cluster
    - Restart a zone in an OceanBase cluster
    - Add an OBServer
    - Delete multiple OBServers at a time
    - Stop an OBServer
    - Start an OBServer
    - Restart an OBServer
    - Replace an OBServer
    - Change the password of an OceanBase cluster
    - Query the description information of the OceanBase cluster parameters
    - Query parameters of an OceanBase cluster
    - Modify parameters of an OceanBase cluster
    - Query the list of OBServers in an OceanBase cluster
    - Query the list of OBServers in a zone
    - Perform a switchover pre-check
    - Perform a failover pre-check
    - Perform a switchover
    - Perform a failover
    - Obtain resource statistics of an OceanBase cluster
    - Obtain resource statistics of all OBServer nodes in a cluster
    - Query the list of resource units in an OceanBase cluster
  - 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 whitelist 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 the alert event list
      - Query alert events
    - Alert notifications
      - Query alert notifications
  - Monitoring
    - Query monitoring data by tag
    - Query monitoring data
    - Query the description information of monitoring metrics
- Error codes reference
  - OCP error codes
  - OBServer error codes
    - Oracle mode
      - ORA-10000 to ORA-19999
      - Overview
      - ORA-02000 to ORA-04999
      - ORA-50000 to ORA-99999
      - ORA-05000 to ORA-10000
      - ORA-01000 to ORA-01499
      - ORA-00000 to ORA-00999
      - ORA-20000 to ORA-29999
      - PLS-00000 to PLS-00999
      - ORA-01500 to ORA-01999
      - ORA-30000 to ORA-49999
    - 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
- 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 disk usage keyword
    - Collect host logs containing the dump tenant info keyword
  - Host Exceptions
    - Collect host information by running the df -h command
    - Collect logs from the /var/log/messages directory of a host
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
- AWS S3 protocol
- Install and configure OCI
- Component listening port list
- Processes
- OCP background tasks
- Tables managed by the daemon
Release Notes
- V4.3
  - OCP V4.3.1
  - OCP V4.3.0
  - OCP V4.3.3
  - OCP V4.3.2

Download PDF

Document Feedback

Error logs

Last Updated：2025-07-25 03:35:59 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