OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Cloud Platform

V4.3.2

  • Document Overview
  • Product Introduction
    • What is OceanBase Cloud Platform?
    • Differences between the features of OCP Enterprise Edition and OCP Community Edition
    • System architecture
    • Features
    • Limits
      • System requirements
      • Dependencies
  • Deploy OceanBase Cloud Platform (OCP)
    • Deploy OceanBase Cloud Platform (OCP) Enterprise Edition
      • Deployment overview
        • Deploy OCP cluster in the Single-node
        • Deploy OCP cluster in the High-availability
      • Prepare the deployment environment
        • Install OAT
        • Add a server
        • Check the environment
      • Deploy OCP
        • Plan resources
          • Planning resources of a single node OCP
            • OCP-Server specifications
            • MetaDB resources
            • MonitorDB resources
            • Host resources
          • Planning resources of a high availability OCP
            • OCP-Server specifications
            • MetaDB resources
            • MonitorDB resources
            • Host resources
        • Deploy OCP
          • Deploying a single point of OCP
            • Prepare installation media
            • Create MetaDB
            • Install OCP
            • Initialize system parameters
          • Deploying a high availability of OCP
            • Prepare installation media
            • Create MetaDB
            • Install OCP
            • Register an OCP cluster
            • Initialize system parameters
        • Check after deployment
      • Deployment FAQ
        • Optimize MonitorDB parameters
        • F5 Big-IP LTM and alert configuration
          • Connect OBProxy to F5 Big-IP LTM
          • Connect OCP-Console to F5 Big-IP LTM
          • Monitor the OCP service health
        • Ubuntu deployment FAQ
        • EulerOS deployment FAQ
        • Client requirements
        • Start and stop OCP
      • Appendix
        • Uninstall OCP
        • Check the NTP offset
    • Deploy OceanBase Cloud Platform (OCP) Community Edition
      • Overview
      • Installation process
      • Installation planning
        • User planning
        • Host planning
        • Disk and directory planning
        • Port planning
      • Prepare for the installation
      • Deploy OCP on the GUI
      • Use Docker to deploy OCP
      • Post-deployment check
      • Appendix
        • Install Docker
        • Uninstall OCP
        • Restart OCP
        • FAQ about deployment
  • Upgrade OceanBase Cloud Platform (OCP)
    • Upgrade OceanBase Cloud Platform (OCP) Enterprise Edition
      • Overview
      • Considerations
      • Preparations
      • Upgrade OCP
        • Take over OCP
        • Upgrade OCP
      • Verify after upgrade
        • Verify the cluster feature
        • Verify the tenant feature
        • Verify the host feature
        • Verify the software package feature
        • Verify the OBProxy feature
        • Verify the backup and restore feature
        • Verify the alert feature
        • Verify the task feature
        • Verify the password box feature
      • Appendix
        • Change a user's password
        • Version mapping
    • Upgrade OceanBase Cloud Platform (OCP) Community Edition
      • Upgrade OCP on the GUI
      • Upgrade OCP using Docker containers
      • Post-upgrade check
  • Quick Start
    • OCP operations
    • Log on to the OCP console
    • Upload a software package
    • Add a host
    • Create a cluster
    • Create a tenant
    • Create a user
    • Create an OBProxy cluster
  • Cluster Management
    • Overview
    • Create a cluster
      • Create a distributed cluster
      • Create a standalone centralized database
    • Manage clusters
      • Create a standby cluster
      • View the details of a cluster
      • Upgrade a standalone centralized database to a distributed cluster
      • Take over a cluster
      • Restart a cluster
      • Stop a cluster
      • Move out a cluster
      • Delete a cluster
      • Change the password
      • Enable automatic detection of deadlocks
      • Disable automatic detection of deadlocks
      • Manage O&M configuration
        • Overview
        • Manage parameters
        • View the parameter modification history
      • Manage CPU core binding configurations
    • Manage Arbitration Service
      • Arbitration service Overview
      • Create an arbitration service
      • Take over an arbitration service
      • Stop an arbitration service
      • Start an arbitration service
      • Upgrade an arbitration service
      • Restart an arbitration service
      • Migrate an arbitration service
      • Delete an arbitration service
      • Add an arbitration service
      • Replace an arbitration service
      • Remove an arbitration service
    • Manage zones of a cluster
      • Add a zone
      • Restart a zone
      • Stop a zone
      • Delete a zone
    • Manage OBServers of a cluster
      • Add an OBServer node
      • Restart a faulty OBServer node
      • Stop an OBServer service
      • Stop the observer process
      • Replace an OBServer node
      • Reinstall an OBServer
      • Delete an OBServer
    • Upgrade an OceanBase cluster
    • View the topology of a cluster
    • Overview of cluster tenant management
    • Manage cluster resource
      • View the unit distribution
      • View resource usage
    • Manage major compaction of a cluster
      • Modify the major compaction settings of a cluster
      • Perform a major compaction
      • View details of major compaction
      • View major freeze statistics
    • Manage cluster parameter templates
    • Manage cluster parameters
      • Parameter types
      • View parameters
      • Modify parameters
      • View the history of parameter changes
  • Tenant Management
    • Tenant and resource management
    • View tenant overview information
    • Create a primary tenant
    • Manage unit specifications
    • View OCP resource unit specifications
    • Manage tenants
      • View the details of a tenant
      • Create a standby tenant
      • Copy a tenant
      • Rename a tenant
      • Lock a tenant
      • Clone a tenant
      • Delete a tenant
      • Change the password of the sys tenant
      • Configure full link tracking for a tenant
      • Manage the binlog service for a tenant
    • Modify the allowlist of a tenant
    • Modify zone priorities
    • Manage topulogy of a tenant
      • View the topology of a tenant
      • View the topology of primary/standby relationships of a tenant
    • Manage replicas of a tenant
      • Add a replica
      • Edit a tenant replica in a zone
      • Delete a tenant replica from a zone
    • Manage databases
    • Manage users and permissions under a tenant
      • Manage users in a MySQL tenant
      • Manage user under an Oracle tenant
        • User overview under an Oracle tenant
        • Create a user under an Oracle tenant
        • Change the password of a user under an Oracle tenant
        • Delete a user under an Oracle tenant
        • Create a role under an Oracle tenant
        • Manage users
        • Manage roles
      • System privileges in a MySQL tenant
    • Manage resource isolation
      • Overview
      • Create a resource group
      • Create a resource isolation plan
      • Enable or disable a resource isolation plan
      • Modify a resource isolation plan
      • Delete a resource isolation plan
      • Modify a resource group
      • Delete a resource group
    • Manage the resources of a tenant
    • Manage major compaction under a tenant
      • Modify major compaction settings of a tenant
      • Details of tenant major compaction
      • Perform a major compaction
    • Manage tenant parameter templates
    • Manage tenant parameters
      • View the parameters
      • Modify a parameter
      • View the parameter modification history
  • OBProxy Management
    • OBProxy management overview
    • View details on the OBProxy page
    • Create an OBProxy cluster
    • Manage OBProxy Clusters
      • View details on the Overview page of an OBProxy cluster
      • Add a connectable OceanBase cluster
      • Manage load balancing
      • Change the password of the proxysys user
      • Change the password of the proxyro user
      • Migrate an OBProxy cluster
      • Delete an OBProxy cluster
      • Upgrade an OBProxy cluster
      • Manage CPU core binding configurations
      • Stop or start an ODP cluster
      • Restart an ODP cluster
      • Delete a connected OceanBase cluster
      • Manage the proxyro account
    • Manage OBProxy Servers
      • Add an OBProxy
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Stop or start an OBProxy
      • Remove an OBProxy
      • Launch an OBProxy
      • Upgrade an OBProxy
      • Refresh OBProxy configurations
    • Request analysis
    • Parameter management
    • Client configuration
    • OBProxy parameters descpription
  • Binlog Service Management
    • Binlog service overview
    • Create a binlog cluster
    • Manage Binlog Clusters
      • View information about a binlog cluster
      • Start and stop a binlog cluster
      • Restart a binlog cluster
      • Delete a binlog cluster
      • Manage Binlog Instance
        • View a binlog instance
        • Configure throttling
        • Start and stop a binlog instance
        • 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 cluster parameters
  • Host Management
    • Host management operations
    • View details of a host
    • Add a host
    • View the details of tasks on a host
    • Modify a host
    • Restart OCP-Agent
    • Reinstall OCP Agent
    • Remove a host
    • Perform host standardization checks
    • Host standardization check items
    • OCP-Agent processes
    • OCP-Agent O&M Script Instructions
  • Alert Management
    • Overview
    • Alert-related concepts
    • Manage alert rules
      • Create an alert rule
      • View an alert rule
      • Copy an alert rule
      • Edit an alert rule
      • Delete an alert rule
      • Alert rule groups
      • Export alert rule configurations
    • Manage alert templates
      • Create an alert template
      • Set alert objects
      • Export alert templates
      • View an alert template
      • Copy an alert template
      • Edit an alert template
      • Delete an alert template
    • Manage alert channels
      • Create an alert channel
      • View an alert channel
      • Edit an alert channel
      • Copy an alert channel
      • Delete an alert channel
      • Examples of alert channel configuration
      • Examples of alert channel configuration
    • Manage alert push
      • Create an alert push
      • View an alert push
      • Edit an alert push
      • Delete an alert push
    • View alert events
    • Manage blocking conditions
      • Create a blocking condition
      • Edit an alert blocking condition
      • Delete an alert blocking condition
    • OCP alert template tag
    • Optional monitoring metrics for custom alerts
  • Dashboard Management
    • Monitoring dashboard overview
    • Manage dashboards
    • Manage groups
    • Manage charts
  • Performance Monitoring
    • Manage monitoring
      • Overview
      • View database performance
      • View host performance
      • View the performance and SQL monitoring data of a tenant
      • View transaction performance data
      • View storage and cache monitoring data
      • View 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 resources
      • View host processes
      • View service monitoring data
      • View system monitoring data
      • View performance monitoring
      • Drill-down monitoring
      • Integrate monitoring data to an external time-series system
    • Use the custom monitoring feature
      • Overview
      • View collection items
      • Manage indicator items
        • Create a metric
        • Manage metrics
      • Manage charts
        • Create a chart
        • Manage charts
      • OCP metrics
  • Diagnostics and Tuning
    • SQL Diagnostics
      • SQL Diagnostics Introduction
        • SQL diagnostics overview
        • SQL statement execution statistics
        • SQL execution plans
      • View the OceanBase Autonomy Service page
      • 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
      • SQL performance diagnosis related parameter configuration
    • Transaction Diagnostics
      • Overview of transaction
      • Diagnose transactions
      • 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
      • Manage ASH reports
      • Performance report
  • O&M Management
    • Manage Information Collection
      • Overview
      • Configure information collection items
      • Create an information collection task
      • View information collection details
      • Download an information collection report
    • Manage Plans
      • Overview
      • Manage plans
      • View plan execution details
    • Manage Inspection
      • Inspection
      • Configure inspection items
      • Configure Scheduling Rules
        • Configure a scheduling rule for a single object
        • Configure a global scheduling rule
      • Initiate Inspection
        • Initiate an inspection for a single object
        • Initiate a global inspection
      • View an inspection task
      • Manage Inspection reports
        • View an inspection report
        • Download an inspection report
  • Backup and Recovery
    • Overview
    • Backup and restore guide
    • Overview
    • Backup now
      • Back up cluster now
      • Back up a tenant now
    • Regular backup
      • Manage cluster-level backup strategy
        • Create a cluster-level backup strategy
        • Modify a cluster-level backup strategy
        • Delete a cluster-level backup strategy
        • Pause backup scheduling
        • View a cluster-level backup stategy
      • Manage tenant-level backup strategy
        • Create a tenant-level backup strategy
        • Modify a tenant-level backup strategy
        • Delete a tenant-level backup strategy
        • Pause backup scheduling
        • View a tenant-level backup stategy
    • Manage backup tasks
      • View backup tasks
      • View second backup tasks
    • Initiate a restore job
    • Regular recovery
      • Create a sampling strategy for recovery
      • View sampling strategies
      • View sampling tasks
    • View restore tasks
    • Manage backup and recovery service
      • View services
      • Install a service
      • Add a node
      • Upgrade the version of a service
      • Update service configurations
      • Copy a service
      • Delete a service
      • Stop a service on a node
      • Restart a service on a node
      • View O\&M tasks
      • Uninstall a service on a node
  • Disaster Recovery
    • Switching primary and standby tenants
      • Switchover
      • Failover
      • Decouple a standby tenant from its primary tenant
      • Create a standby tenant for a primary tenant managed by another OCP cluster
    • Switching primary and standby databases
      • Routine primary/standby cluster switchover
      • Primary/Standby cluster switchover for disaster recovery
      • Decouple a standby cluster from the primary cluster
      • Start the original primary cluster in read-only mode after a failover
    • OCP Manage OCP clusters in the multi-cluster mode
      • OCP multi-cluster mode overview
      • Register an OCP cluster
      • View Leader \& Follower Details
      • Manage OCP cluster parameters
      • Switch an OCP cluster in daily maintenance
      • Switch an OCP cluster in a failover
      • Delete a faulty follower OCP cluster
      • Unbind a leader and a follower OCP cluster
      • Enable the OCP multi-cluster mode
  • Log Management
    • Query logs
    • Download logs
    • Configure trace query parameters
    • Trace query
    • About OpenSearch
  • Software Package Management
    • Upload a software package
    • Download a software package
    • Delete a software package
  • System Management
    • Manage password box
      • Create a credential
      • Export a credential
      • Import a credential
      • Verify a credential
      • Edit a credential
      • Delete a credential
      • Batch operations on credentials
    • Manage users
      • Manage a user
        • Users overview
        • Create a user
        • View users
        • Edit a user
        • Copy a user
        • Change a user password
        • Delete a user
        • Logon history
      • Manage a role
        • Role overview
        • Create a role
        • Copy a role
        • View a role
        • Edit a role
        • Delete a role
        • Default OCP roles
    • Manage tags
      • Overview
      • Create a tag
      • Modify objects bound to a tag
      • Edit a tag
      • Delete a tag
    • 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
      • View system parameters
      • Modify system parameters
      • OCP configuration parameters
    • Manage tasks
    • User center management
      • Configure personal information
      • Change your logon password
      • Log off the OCP console
  • SQL Tuning Practices
    • Locate General Abnormal SQL Statements
      • How can I locate SQL statements with high CPU load in a tenant?
      • How can I locate slow SQL statements that take a long time in a tenant?
      • How can I locate SQL statements for full-table scans in a tenant?
      • How can I locate distributed SQL statements in a tenant?
      • How can I locate remote SQL statements in a tenant?
      • How can I locate slow hard-parsed SQL statements in a tenant?
      • How can I locate erroneous SQL statements in a tenant?
    • Customize Abnormal SQL Statement Determining Rules
      • Conditions
      • Custom column rules
    • General SQL Performance Tuning Scenarios
      • Execution Plan Optimization
        • SQL statement performance deterioration caused by plan changes
      • Index Optimization
        • No suitable indexes
        • Inappropriate index of an SQL statement
        • Invalid index of an SQL statement
  • O&M Best practices
    • Upgrade an OceanBase cluster
    • Migrate a resource unit from an OceanBase Database tenant
    • Expand the high availability of OceanBase clusters and tenants
    • Reduce the high availability of OceanBase clusters and tenants
    • Scale out an OceanBase cluster and scale up an OceanBase Database tenant
    • Scale in an OceanBase cluster and scale down an OceanBase Database tenant
    • Troubleshoot host issues in an OceanBase cluster
    • Migrate an OceanBase cluster to another IDC
    • Perform a failover between primary and standby OceanBase clusters for disaster recovery in a scenario with two IDCs
    • Perform a switchover between primary and standby OceanBase Database tenants in a scenario with two IDCs
    • Use the arbitration service of OceanBase Database to achieve HA in a scenario with two IDCs
    • Scale out an OBProxy cluster
    • Scale in an OBProxy cluster
    • Replace an OBProxy
    • Move out an OBProxy cluster
    • Take over OBProxies
    • Delete an OBProxy
    • Perform a failover
    • Decouple a standby tenant from the primary tenant
    • Back up an OceanBase cluster
    • Use the backup and restore module to restore data
    • Monitor the business load of OceanBase Database
    • Integrate OCP monitoring into Prometheus
    • Configure custom monitoring
    • Perform an inspection in OCP to detect potential risks in an OceanBase cluster
    • Check clog synchronization
    • Check the NIC rate
    • Check the availability of an auto-increment column
    • Send alert messages to a DingTalk group
    • Send alert messages to a Feishu group
    • Send alert messages to a WeChat Enterprise group
    • Send alert messages through email
    • Push alert messages through HTTP
  • Reference Guide
    • Alarm reference
      • Alert Reference
      • OceanBase alerts
        • ob_cannot_connected
        • ob_cluster_rs_not_same
        • ob_cluster_status_check_failed
        • ob_cluster_exists_inactive_server
        • ob_cluster_exists_index_fail_table
        • ob_cluster_frozen_version_delta_over_threshold
        • ob_cluster_merge_error
        • ob_cluster_merge_timeout
        • ob_cluster_no_frozen
        • ob_cluster_no_merge
        • ob_cluster_operation_info
        • ob_cluster_sync_failed
        • ob_cpu_assigned_percent_over_threshold
        • ob_cpu_percent_over_threshold
        • ob_host_connection_percent_over_threshold
        • ob_host_disk_readonly
        • ob_tenant_expired_trans_exist
        • ob_host_load1_per_cpu_over_threshold
        • ob_host_partition_count_over_threshold
        • OceanBase log alerts
        • ob_mem_assigned_percent_over_threshold
        • ob_server_sstable_percent_over_threshold
        • ob_tenant_long_trans_exist
        • ob_tenant_operation_info
        • ob_tenant500_mem_hold_over_threshold
        • ob_tenant500_mem_hold_percent_over_threshold
        • tenant_active_memstore_percent_over_threshold
        • tenant_cpu_percent_over_threshold
        • tenant_memstore_percent_over_threshold
        • obproxy_process_dead
        • obproxyd_process_dead
        • obproxy_cannot_connected
        • ob_cluster_sync_delay_time_too_long
        • ob_host_data_disk_percent_over_threshold
        • ob_host_log_disk_percent_over_threshold
        • ob_host_install_disk_percent_over_threshold
        • ob_tenant_exists_expired_xa_trans
        • ob_cluster_active_session_count_over_threshold
        • ob_tenant_active_session_count_over_threshold
        • ob_host_active_session_count_over_threshold
        • ob_tenant_slow_sql_exists
        • ob_tenant_large_trans_exist
        • same_alarm_rule_detect_too_many_targets
        • ob_tenant_expired_trans_exist
        • ob_tenant_long_trans_exist
        • ob_tenant_task_timeout
        • ob_host_task_timeout
        • ob_tenant_log_disk_usage_high
        • ob_tenant_no_compaction
        • ob_tenant_no_frozen
        • ob_tenant_compaction_error
        • host_operation
        • obproxy_host_operation
        • obproxy_cluster_operation
        • ob_host_operation
        • refresh_location_cache_failed
        • ob_tenant_log_stream_degraded
        • arbitration_service_unavailable
        • observer_process_stop
        • obproxyd_process_stop
        • obproxy_process_stop
        • standby_tenant_sync_delay_too_long
        • standby_tenant_sync_status_error
        • obproxy_client_connections_usage_over_threshold
        • ob_tenant_request_queue_over_threshold
        • oas_anomaly_sql_from_anomaly_event_analysis_cpu_percent_high
        • oas_anomaly_sql_from_anomaly_event_analysis_perf_degradation
        • oas_anomaly_sql_from_anomaly_event_analysis_plan_changed
        • oas_anomaly_sql_from_sql_inspection_perf_degradation
        • oas_anomaly_sql_from_sql_inspection_plan_changed
        • os_observer_not_exist
        • refresh_location_cache_failed_by_metric
        • ob_tenant_cpu_usage_over_threshold
        • ob_tenant_partition_replica_absent
        • ob_tenant_partition_leader_absent
        • ob_tenant500_storage_short_meta_mem_hold_high
        • obproxy_core_dump
        • ob_server_cannot_connect_arbitration
        • agent_process_count_abnormal
      • Application alerts
        • ob_cluster_inspection_not_passed
        • ob_host_ssd_wear_indicator_over_threshold
        • ob_host_mem_percent_over_threshold
        • ob_host_net_recv_percent_over_threshold
        • ob_host_net_send_percent_over_threshold
        • ob_host_tcp_retrans_percent_over_threshold
        • ob_host_cpu_percent_over_threshold
        • inc_backup_delay
        • base_backup_fail
        • base_backup_too_long_time_no_one_success_task
        • backup_process_dead
        • backup_storage_capacity_over_threshold
        • backup_storage_capacity_retry_times_exceeded
        • backup_storage_capacity_timeout_or_interrupted
        • ocp_remote_server_time_diff_too_large
        • monitor_exporter_unavailable
        • system_obproxy_unavailable
        • host_unavailable
        • host_ntp_offset_too_large
        • host_ntp_service_not_exist
        • host_agent_res_memory_over_threshold
        • host_agent_open_fd_count_over_threshold
        • host_agent_goroutine_count_over_threshold
        • partition_create_failed
        • obagent_dead
        • host_disk_readonly
        • ic_server_connect_failed Inter-Connector
        • vpc_connect_failed
        • node_load1_peak
        • Host log alerts
        • base_backup_timeout
        • base_secondary_backup_fail
        • ocp_meta_db_disconnected
        • ocp_http_request_timeout
        • ocp_http_request_too_many_errors_occur
        • ocp_alarm_detect_timeout
        • odp_instance_compress_failed
        • odp_instance_expanse_failed
        • odp_sql_execute_failed
        • odp_sql_query_slow
        • agentd_process_stop
        • mgragent_process_stop
        • monagent_process_stop
        • ocp_contingency_failed
        • ob_host_invalid_disk_exists
        • ob_cluster_recyclebin_disk_used_over_threshold
        • ob_host_monitordb_disconnected
        • upgrade_ocp_agent_failed
        • host_agent_version_not_same
        • ocp_collect_metric_failure_rate_high
      • OAS alerts
        • os_cpu_irq_error
        • os_tsar_cpu_sys_abnormal
        • os_observer_fd_usage
        • os_tsar_cpu_util_full
        • os_tsar_cpu_util_hwm
        • os_kernel_io_hang
        • os_tsar_sda_ioawait
        • os_tsar_nvme_ioawait
        • os_tsar_traffic_drop
        • os_tsar_traffic_error
        • os_observer_core_dump
        • os_nic_1000m_full
        • os_nic_1000m_hwm
        • os_tsar_traffic_overload
        • node_file_root_usage
        • node_file_inode_usage
        • os_kernel_ntp_down
        • os_kernel_ntp_delay
        • node_memory_peak
        • os_home_file_usage
        • node_file_data1_usage
        • node_file_datalog1_usage
        • sql_audit_collect_lost_percent_over_threshold
      • Appendix
        • Exception handling for OceanBase cluster compaction
        • Apply throttling to an OceanBase cluster
        • Network troubleshooting
        • Execute the alert clearance plan
    • API Reference
      • Overview
      • API call description
      • Rules for generating a signature by using AK/SK
      • Task return structure
      • 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
        • Query tenants of a cluster
        • Query all tenants
        • Query details about a tenant
        • Create a tenant
        • Create a standby tenant
        • Delete a tenant
        • Lock a tenant
        • Unlock a tenant
        • Query units of a tenant
        • Delete a unit from a tenant
        • Add a replica for a tenant
        • Delete a replica of a tenant
        • Modify a replica of a tenant
        • Modify zone priorities of a tenant
        • Change the administrator password of a tenant
        • Modify the whitelist of a tenant
        • Query parameters of a tenant
        • Modify parameters of a tenant
        • Obtain a list of unit specifications
        • Create a resource unit specification
        • Delete a resource unit specification
        • Perform a switchover precheck
        • Perform a switchover
        • Perform a batch switchover precheck
        • Perform a batch switchover
        • Perform a failover precheck
        • Perform a failover
        • Perform a batch failover precheck
        • Perform a batch failover
      • OBProxy management
        • Create an OBProxy cluster
        • Delete an OBProxy cluster
        • Query OBProxy clusters
        • Query details about an OBProxy cluster
        • Update configurations of an OBProxy cluster
        • Add an OBProxy
        • Take over an OBProxy
        • Delete an OBProxy
        • Restart an OBProxy
        • Upgrade an OBProxy
        • Add a connectable OceanBase cluster for an OBProxy cluster
        • Remove a connectable OceanBase cluster from an OBProxy cluster
        • Query the description information of the OBProxy parameters
        • Query parameters of an OBProxy cluster
      • Database management
        • Query databases
        • Create a database
        • Modify a database
        • Delete a database
        • Query the list of database users
        • Query database user details
        • Create a database user
        • Delete a database user
        • Change the password of a database user
        • Lock a database user
        • Unlock a database user
        • Query the list of database roles
        • Query database role details
        • Create a database role
        • Delete a database role
        • Query database objects
        • Grant global privileges to a user
        • Revoke global privileges of a user
        • Change global privileges of a user
        • Grant global privileges to a role
        • Revoke global privileges of a role
        • Change global privileges of a role
        • Grant roles to a user
        • Revoke roles of a user
        • Change roles of a user
        • Grant roles to a role
        • Revoke roles of a role
        • Change roles of a role
        • Grant database privileges to a user
        • Revoke database privileges of a user
        • Change database privileges of a user
        • Grant object privileges to a user
        • Revoke object privileges of a user
        • Change object privileges of a user
        • Grant object privileges to a role
        • Revoke object privileges of a role
        • Change object privileges of a role
      • Monitoring
        • Query the description information of monitoring metrics
        • Query monitoring data
        • Query monitoring data by tag
      • Alerts
        • Call an alert API
        • Alert events
          • Query the alert event list
          • Query alert events
        • Alert notifications
          • Query alert notifications
      • Inspection
        • Query all inspection tasks
        • Query inspection objects
        • View the details of an inspection report
        • Initiate an inspection
        • Query the last inspection result of an inspection item
        • Query the last inspection result of an inspection object
      • SQL performance
        • Query performance indicators of an SQL statement
        • Query the performance indicator trend of an SQL statement
        • Query SQL text
        • Query performance indicators of an execution plan
        • Query the performance indicator trend of an execution plan
        • Query the operator structure of an execution plan
        • Query the list of slow SQL statements
        • Query snapshots
        • Generate a performance report
        • Query a performance report
      • Backup and recovery
        • Query backup capabilities of a cluster
        • Create a backup strategy for a cluster
        • Modify the backup strategy of a cluster
        • Delete the backup strategy of a cluster
        • Query the backup strategy of a cluster
        • Query the backup overview of a cluster
        • Query data backup tasks of a cluster
        • Query log backup tasks of a cluster
        • Query recovery tasks of a cluster
        • Immediately back up a cluster
        • Parse cluster backup data
        • Start backup scheduling for a cluster
        • Stop backup scheduling for a cluster
        • Initiate tenant recovery
        • Preview a restore task
        • Add restore resources
        • Clear added restore resources
        • Initiate a data backup for a tenant
        • Create a backup strategy for a tenant
        • Delete the backup strategy of a tenant
        • View the data backup tasks of a tenant
        • View the log backup tasks of a tenant
        • View restore tasks
        • Parse the backup information of a tenant
        • Query the backup strategy of a tenant
        • Modify the backup strategy of a tenant
        • Start backup scheduling for a tenant
        • Stop backup scheduling for a tenant
      • Host management
        • Query regions
        • Query details about a region
        • Add region information
        • Delete a region
        • Query IDCs
        • Query details about an IDC
        • Add IDC information
        • Delete an IDC
        • Query host types
        • Query details about a host type
        • Add host type information
        • Delete a host type
        • Query hosts
        • Query details about a host
        • Add multiple hosts at a time
        • Delete a host
        • Delete multiple hosts at a time
      • Software packages
        • Query software packages
        • Upload a software package
        • Delete a software package
      • O&M tasks management
        • Query tasks
        • Query details about a task
        • Retry a task
        • Roll back a task
        • Query subtask logs
        • Retry a subtask
        • Skip a subtask
        • Cancel a subtask
      • 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
          • Query OCP Agent details on a host
          • Stop the OCP Agent process on a host
          • Batch stop the OCP Agent processes on hosts
          • Restart the OCP Agent process on a host
          • Batch restart the OCP Agent processes on hosts
          • Query OCP Agent processes on a host
          • Restart the OCP Agent process on a host
          • Stop the OCP Agent process on a host
    • Metric reference
      • Overview of metrics
      • Monitoring metrics list
      • OceanBase cluster
        • QPS
        • Query response time
        • TPS
        • Transaction response time
        • Request queue time
        • Number of sessions
        • TPS
        • Number of transaction logs
        • Transaction log volume
        • Time consumed by transaction logs
        • IOPS
        • IO time-consuming
        • I/O Throughput
        • Process memory
        • Process CPU utilization
        • Process file descriptors
        • Number of process threads
        • sys500 memory occupation
        • Error logs
      • OceanBase Database tenant
        • QPS
        • Response time (SQL mode)
        • Sessions
        • SQL execution plan category
        • SQL execution plan time
        • Wait events
        • Metrics related to time consumption of wait events
        • Request waiting queue
        • Request waiting queue time consuming
        • Request queue size
        • Tenant CPU cost
        • Tenant thread usage
        • memroy usage pecent
        • MemStore usage
        • Rpc package rt
        • RPC packet throughput
        • Cursors
        • Clog synchronization delay
        • DB time metrics
        • Metrics for the SQL execution phase
        • Frontend workload metrics
        • Backend wait event metrics
        • TPS
        • Transaction response time
        • Transaction response time details
        • Number of transaction logs
        • Transaction log volume
        • Time consumed by transaction logs
        • Lock waits
        • Time consumed by lock waits
        • TPS
        • Partitions
        • Number of XA transactions
        • Number of XA statements
        • Transaction table read request hits
        • Average execution duration of XA statements
        • MemStore
        • IOPS
        • IO time-consuming
        • I/O Throughput
        • Cache size
        • Cache hit rates
        • Number of cache requests
        • Frozen MemStores
        • Log disk
        • Data disk
        • QPS (OBKV-Table)
        • Response time (OBKV-Table)
        • Average number of statement lines processed (OBKV-Table)
        • QPS (OBKV_Hbase)
        • Response time (OBKV-HBase)
        • Average number of statement lines processed (OBKV-HBase)
      • Binlog Service
        • Sending Delay
        • Associate RPS
        • Network Traffic
        • Binlog Delay
        • Binlog RPS
        • CPU
        • memory used
        • memory
        • disk used
        • Binlog Disk Write Rate
        • disk ratio
        • FD count
        • network bytes
      • OBProxy cluster
        • TPS
        • QPS
        • Client connections
        • Server connections
        • Average response time for each SQL statement
        • Memory for the obproxy process
        • CPU utilization of the obproxy process
        • Number of file descriptors for the obproxy process
        • Number of threads in the obproxy process
        • Number of error logs
        • Average route table queries per second
        • Average bytes in a network request or response
      • Host
        • Linux system load
        • CPU Utilization
        • I/O usage
        • I/O queue length
        • IOPS
        • Time consumed by I/O operations
        • I/O throughput
        • Network throughput
        • TCP retransmission rate
        • Packet forwarding
        • NTP clock offset
        • Inode usage
        • Memory
        • Memory usage
        • Disk
        • Process resident memory
        • Process CPU utilization
        • Number of process file descriptors
        • Number of process threads
        • Number of OCP-Agent process goroutines
    • Information Collection Reference
      • Major Compaction Exceptions
        • Collect information about the major compaction status of zones of a cluster
        • Collect information about the ongoing major compaction in a cluster
        • Collect suggestions provided based on historical major compactions
        • Collect diagnostic information about major compactions
        • Collect information about DAG warnings in OceanBase Database
        • Collect RootService task records
        • Collect the last-one-day records of major compaction events scheduled by RootService
        • Collect the checksum information about tablets
        • Collect the checksum information about columns
        • Collect major compaction parameter settings
        • Collect the major compaction time
      • OCP Agent Exceptions
        • Collect panic logs of the mgragent process
        • Collect panic logs of the monagent process
        • Collect information about goroutines of the agent processes
      • Cluster Exceptions
        • Collect information about bad disks
        • Collect information about OBServer nodes in a cluster
        • Collect obstack information on a cluster node
      • CPU Exceptions
        • Collect information about processes with high CPU utilization on a cluster node
        • Collect information about threads with high CPU utilization in an observer process
      • Data Disk Full
        • Collect the data disk usage information of nodes in a cluster
        • Collect incremental data generated during cluster compactions
        • Collect information about the disk space occupied by temporary files of a tenant
        • Collect information about sizes of data of different versions in major SSTables
        • Collect information about the macroblock utilization of nodes
  • FAQ
    • FAQ about deployment
    • FAQ on upgrade
    • FAQ on O&M
      • FAQ on accounts and passwords
      • FAQ on host management
      • FAQ on OceanBase cluster
      • FAQ on OceanBase tenants
      • FAQ on OBProxy
      • FAQ on the OCP software package
      • FAQ on backup and recovery
    • FAQ on monitoring
      • FAQ on monitoring metrics
      • FAQ on SQL monitoring
      • FAQ about resource usage
      • Use OCP-Agent to pull time-series monitoring data
    • FAQ on alerts
    • FAQ on the OCP system
    • OCP multi-cluster FAQ
  • Appendix
    • OCP error codes
    • OCP background tasks
    • Tables managed by the daemon
    • Component listening port list
    • Processes
    • Install and configure OCI
    • AWS S3 protocol
  • Release Notes
    • V4.3
      • OCP V4.3.2
      • OCP V4.3.1
      • OCP V4.3.0

Download PDF

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

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Cloud Platform
  3. V4.3.2
iconOceanBase Cloud Platform
V 4.3.2
  • V 4.3.6
  • V 4.3.5
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.2
  • V 4.0.0 and earlier

OCP configuration parameters

Last Updated:2026-04-20 07:26:00  Updated
share
What is on this page
Global configuration
Security and logon
Monitoring
Performance diagnostics
Alerting
Backup and Restore
Log analysis
Inspection
OceanBase connection management
Host
OCP Agent
File management
Flow control
System logs

folded

share

This topic lists all system parameters of OceanBase Cloud Platform (OCP) for reference by OCP administrators. After a parameter is modified, the modification takes effect in about 10 minutes by default. Some parameters only take effect after OCP Server restarts. The need for restart is indicated in the description column of the tables.

Global configuration

Parameter Default value Description
ocp.site.url http://localhost:8080 The URL for accessing the OCP console. The URL must start with http or https. It must contain the virtual IP (VIP) address, domain name, and port number, and not end with a forward slash (/).
ocp.config-url.site.url - The URL for accessing the OCP config url service. The default value is empty, indicating that the URL specified for the ocp.site.url parameter is used. If the config url service is deployed separately, you must set a value different from that of ocp.site.url.
ocp.config-url.use-request-address TRUE The URL for the requests used by responses in the config url service. The default value is TRUE. If it is set to FALSE, responses will use the URL specified for the ocp.config-url.site.url parameter.
ocp.system.default.timezone - The default time zone of OCP. If this parameter is not specified, the default time zone of the system is used. A restart is required for a modification to take effect.
ocp.system.default.language zh-CN The system default language, which is not the frontend display language. The default value of zh-CN is used if this parameter is not specified. A restart is required for a modification to take effect.
ocp.web.tracking.enabled false Specifies whether to enable the telemetry feature of OCP. By default, the telemetry feature is disabled in the Enterprise Edition and enabled in the Community Edition. The telemetry feature collects usage information of users in some scenarios and shares desensitized usage information with OceanBase Database to improve the product experience. For example, the information helps you understand how users use OceanBase Database, enabling improvements in user experience.
You can run the update config_properties set value = 'false' where `key` = 'ocp.web.tracking.enabled'; command in MetaDB of OCP to disable this feature.

Security and logon

Parameter Default value Description
server.servlet.session.timeout 30m The timeout value for session logons and sessions. Default value: 30m. Minimum value: 60s. If no unit is specified, the default unit of second is used.
ocp.iam.auth local The web page logon option. Valid values: local (for OCP accounts in the local MetaDB) and buc (for Alibaba Group employee accounts). Default value: local. A restart is required for a modification to take effect.
ocp.iam.csrf.enabled TRUE Specifies whether to enable protection against cross-site request forgery (CSRF). We recommend that you enable this feature for web-based logons. Default value: TRUE. A restart is required for a modification to take effect.
ocp.iam.login.max-attempts 5 The maximum number of consecutive unsuccessful logon attempts allowed. When this threshold is exceeded, the client IP address is temporarily blocked. Default value: 5.
ocp.iam.login.lockout-minutes 30 The amount of time a client IP address is blocked after the maximum number of unsuccessful logon attempts is exceeded. Default value: 30. Unit: minutes.
ocp.iam.login.client.max-attempts 10 The maximum number of consecutive logon attempts allowed for a client. When this threshold is exceeded, the client IP address is temporarily blocked. Default value: 10.
ocp.iam.login.client.lockout-minutes 10 The amount of time a client IP address is blocked after the maximum number of logon attempts is exceeded. Default value: 10. Unit: minutes.

Monitoring

Parameter Default value Description
ocp.monitor.collect.obcluster.enabled true Specifies whether to collect the monitoring data of OceanBase clusters. If this parameter is set to true, the monitoring data of all OceanBase clusters is collected.
ocp.monitor.collect.obproxy.enabled true Specifies whether to collect the monitoring data of OBProxies. If this parameter is set to true, the monitoring data of all OBProxy clusters is collected.
ocp.monitor.collect.host.enabled true Specifies whether to collect the monitoring data of hosts. If this parameter is set to true, the monitoring data of all hosts is collected.
ocp.monitor.data.retention-days {"ob_cluster_system_event":31,"ocp_metric_data_1":8,"ocp_metric_data_60":31,"metric_hour_data":1098,"metric_daily_data":1098} The number of days for which the monitoring data is retained. The key is the name of the table where the data is stored, and the value is the number of days for data retention. A restart is required for modifications to take effect.

Performance diagnostics

The following table describes the parameters for SQL performance diagnostics.

Parameter Default value Description
ocp.perf.sql-diag.awful-performance-index-used-config {"enabled":true, "cpuTimeLimitUs":100000, "execPsLimit":5.0, "fullLogicalReadsLimit":10000} The diagnostic parameter for poor performance despite the use of index.
  • enabled: specifies whether to enable this check item.
  • execPsLimit: the number of executions per second.
  • cpuTimeLimitUs: the average CPU time (μs).
  • fullLogicalReadsLimit: the number of logical reads.
Diagnostic objects: SQL queries that meet the following conditions during the diagnostic period: Average CPU time > cpuTimeLimitUs && Actual logical reads > fullLogicalReadsLimit && Full table scan is not performed && Execution frequency > $execPsLimit
ocp.perf.sql-diag.cpu-time-proportion-high-config {"enabled":true, "cpuTimeLimitUs":10000, "execPsLimit":10.0, "maxCpuTimeLimitUs":30000, "affectedRowsLimit":100, "execLimit":30, "sqlCountLimit":20, "cpuTimePercentLimit":20} The diagnostic parameter for a high CPU time percentage for execution.
  • enabled: specifies whether to enable this check item.
  • execPsLimit: the execution frequency, which is the number of executions per second.
  • cpuTimeLimitUs: the average CPU time (μs).
  • maxCpuTimeLimitUs: the upper limit of CPU time.
  • affectedRowsLimit: the number of affected rows.
  • execLimit: the number of executions.
  • sqlCountLimit: the number of SQL queries.
  • cpuTimePercentLimit: the CPU time percentage.
Diagnostic objects: SQL queries that meet the following conditions during the diagnostic period: Average CPU time > $cpuTimeLimitUs || Number of affected rows > $affectedRowsLimit || Upper limit of CPU time > $maxCpuTimeLimitUs && Execution frequency >= $execPsLimit.
Diagnostic criteria: During the diagnostic period, if all the following conditions are met, the CPU time percentage is considered high: (1) The percentage of the CPU time of the diagnosed SQL query to the CPU time of the tenant exceeds $cpuTimePercentLimit. (2) The total number of SQL executions by the tenant exceeds $execLimit. (3) The number of unique SQL queries executed by the tenant is greater than $sqlCountLimit.
ocp.perf.sql-diag.database-white-list oceanbase,information_schema,mysql,__recyclebin,sys,__public The names of the databases to be skipped in SQL diagnostics.
ocp.perf.sql-diag.execution-spike-config {"enabled":true, "cpuTimeLimitUs":3000, "execPsLimit":5.0, "pointsLimit":5, "compareMin":20, "avgExecutionMultiply": {"0":6, "1":5, "5":4, "10":3, "50": 2.5, "100": 2, "500": 1.6}, "stdExecutionMultiply": {"0":80, "1":60 , "3": 30,"5":20, "10":15, "20":8, "30":6, "50":5, "80":4}} The diagnostic parameter for execution spikes.
  • enabled: specifies whether to enable this check item.
  • execPsLimit: the execution frequency, which is the number of executions per second.
  • cpuTimeLimitUs: the average CPU time (μs).
  • pointsLimit: the number of points.
  • compareMin: the time of comparison (min).
  • avgExecutionMultiply: the multiple of the average execution frequency.
  • stdExecutionMultiply: the multiple of the standard deviation of the execution frequency.
  • Diagnostic objects: SQL queries that meet the following conditions during the diagnostic period: Average CPU time >= $cpuTimeLimitUs && Average number of executions per second >= $execPsLimit. Diagnostic criteria:
    1. Find the SQL queries that meet the diagnostic conditions within the first $compareMin after the diagnostics starts. Calculate the average execution frequency per minute (avg_exec_ps) of the SQL queries, the standard deviation of the execution frequency (std_exec_ps) in the first $compareMin, and the ratio of the standard deviation to the average (range_percent). In other words, the following statistics are calculated:
    • Historical average execution frequency (avg_exec_ps)
    • Standard deviation (std_exec_ps)
    • range_percent (std_exec_ps / avg_exec_ps * 100)

    2. Then, calculate the average number of executions per second (exec_ps) of the SQL query. If the exec_ps parameter meets all the following conditions at the same time, the SQL query is considered an execution spike:
    • exec_ps >= avg_exec_ps * $multiple_value_1
    • exec_ps >= avg_exec_ps + std_exec_ps * $multiple_value_2

    Note
    • The value of the multiple_value_1 parameter varies with that of the avg_exec_ps parameter, depending on the value of the avgExecutionMultiply parameter. When avg_exec_ps > 500, multiple_value_1 = 1.6. Likewise, 100 -> 2, 50 -> 2.5, 10 -> 3, 5 -> 4, and 1 ->5.
    • The value of the multiple_value_2 parameter varies with that of the range_percent parameter, depending on the value of the stdExecutionMultiply parameter. When range_percent > 80, multiple_value_2 = 4. Likewise, 50 -> 5, 30 -> 6, 20 -> 8, 10 -> 15, 5 -> 20, 3 -> 30, 1 -> 60, and 0 -> 80.
ocp.perf.sql-diag.index-diagnoser-config {"enabled":true,"schedulePeriodMin":5, "coreThreadSize":10, "maxThreadSize":50,"maxQueueSize":10000,"diagPeriodSec":300,"diagOffsetSec":60,"maxDiagPeriodSec":1800} The parameter for SQL index diagnostics. It takes effect after a restart. We recommend that you leave this parameter unchanged.
ocp.perf.sql-diag.ineffective-hint-config {"enabled":true, "execPsLimit":5.0, "cpuTimeLimitUs":20000} The diagnostic parameter for inactive hints.
  • enabled: specifies whether to enable this check item.
  • execPsLimit: the execution frequency, which is the number of executions per second.
  • cpuTimeLimitUs: the average CPU time (μs).
Diagnostic objects: SQL queries that meet the following conditions during the diagnostic period: CPU time >= $cpuTimeLimitUs && Execution frequency >= $execPsLimit.
Diagnostic criteria: If the index specified in the hint is inconsistent with that of the execution plan, the hint is inactive.
ocp.perf.sql-diag.perf-diagnoser-config {"enabled":true,"schedulePeriodMin":5, "coreThreadSize":10, "maxThreadSize":50,"maxQueueSize":10000,"diagPeriodSec":300,"diagOffsetSec":60,"maxDiagPeriodSec":1800} The parameter for SQL performance diagnostics. It takes effect after a restart. We recommend that you leave this parameter unchanged.
ocp.perf.sql-diag.performance-degradation-after-plan-changed-config {"enabled":true, "compareMin":5, "cpuTimeMultiply": {"0":50, "1":30, "10":10, "100":8, "1000":6}} The diagnostic parameter for changes in the execution plan and performance degradation.
  • enabled: specifies whether to enable this check item.
  • cpuTimeMultiply: the multiple of CPU time. If the current average CPU time is greater than 0 ms, the performance is considered degraded only when the CPU time is increased by at least 50 times after the execution plan is changed. If the current average CPU time is greater than 1 ms, the performance is considered degraded when the CPU time is increased by at least 30 times, and so forth.
  • compareMin: the time of performance comparison (min).
Diagnostic criteria: The performance is considered degraded if the average CPU time of the SQL query within $compareMin is increased by more times than the specified multiple of CPU time after the execution plan is changed.
ocp.perf.sql-diag.performance-degradation-config {"enabled":true, "cpuTimeLimitUs":10000, "execPsLimit":5.0, "maxCpuTimeLimitUs":30000, "affectedRowsLimit":100, "execLimit":5, "compareMin":20, "cpuTimeMultiply": {"0":50, "1":30, "10":10, "100":8, "1000":6}} The diagnostic parameter for performance degradation.
  • enabled: specifies whether to enable this check item.
  • execPsLimit: the execution frequency, which is the number of executions per second.
  • cpuTimeLimitUs: the average CPU time (μs).
  • maxCpuTimeLimitUs: the upper limit of CPU time.
  • affectedRowsLimit: the number of affected rows.
  • execLimit: the number of executions.
  • compareMin: the source time (min) of the baseline data. It is the first $compareMin after the diagnostics starts.
  • cpuTimeMultiply: the multiple of CPU time. If the current CPU time is greater than 0 ms, the performance is considered degraded only when the CPU time is increased by at least 50 times after the execution plan is changed. If the current average CPU time is greater than 1 ms, the performance is considered degraded when the CPU time is increased by at least 30 times, and so forth.
Diagnostic objects: SQL queries that meet the following conditions during the diagnostic period: Average CPU time > $cpuTimeLimitUs || Number of affected rows > $affectedRowsLimit || Upper limit of CPU time > $maxCpuTimeLimitUs && Execution frequency > $execPsLimit. Diagnostic criteria: A baseline number of executions is taken as the reference for comparison. The baseline number of executions must be greater than $execLimit. Otherwise, it cannot be used as the reference for comparison. After the reference for comparison is determined, the performance is considered degraded when the SQL query under diagnostics meets all the following conditions at the same time:
  • Current average CPU time >= Baseline CPU time * $cpuTimeMultiply. The default value of cpuTimeMultiply is 6.
  • Current execution frequency >= Baseline execution frequency * 0.5.
ocp.perf.sql-diag.query-timeout 30000000 The timeout threshold of SQL diagnostic queries (μs).
ocp.perf.sql-diag.row-lock-contention-high-config {"enabled":true, "execPsLimit":0, "cpuTimeLimitUs":1000, "elapsedTimeLimitUs":0} The diagnostic parameter for high row lock contention.
  • enabled: specifies whether to enable this check item.
  • execPsLimit: the execution frequency, which is the number of executions per second.
  • cpuTimeLimitUs: the average CPU time (μs).
  • elapsedTimeLimitUs: the average response time (μs).
Diagnostic objects: SQL queries that meet the following conditions during the diagnostic period: Execution frequency > $execPsLimit && Average CPU time > $cpuTimeLimitUs && Average response time > $elapsedTimeLimitUs.
Note
The elapsedTimeLimitUs parameter is used only when it is configured. Diagnostic criteria: An SQL query is considered to have caused high row lock contention if its type is %select%for%update%.
ocp.perf.sql-diag.table-scan-index-not-exists-config {"enabled":true, "execPsLimit":1.0, "cpuTimeLimitUs":20000} The diagnostic parameter for the full-table scan without any indexes available.
  • enabled: specifies whether to enable this check item.
  • execPsLimit: the execution frequency, which is the number of executions per second.
  • cpuTimeLimitUs: the average CPU time (μs).
Diagnostic objects: SQL queries that meet the following conditions during the diagnostic period: table_scan > 0 in the v$sql_audit view. These queries involve full table scans. Diagnostic criteria: No index is available if the following conditions are met:
  • A single table is scanned and it has no index.
  • Multiple tables are scanned, and some tables have no index.
ocp.perf.sql-diag.table-scan-index-not-used-config {"enabled":true, "execPsLimit":1.0, "cpuTimeLimitUs":2000} The diagnostic parameter for a full-table scan without using the index.
  • enabled: specifies whether to enable this check item.
  • execPsLimit: the execution frequency, which is the number of executions per second.
  • cpuTimeLimitUs: the average CPU time (μs).
Diagnostic objects: SQL queries that meet the following conditions during the diagnostic period: Execution frequency > $execPsLimit && Average CPU time > $cpuTimeLimitUs && Full-table scan is performed.
Diagnostic criteria: The index is not used.
ocp.perf.sql.diag-plan-change-config {"enabled":true,"schedulePeriodMin":5, "coreThreadSize":10, "maxThreadSize":50,"maxQueueSize":10000,"diagPeriodSec":300,"diagOffsetSec":300,"maxDiagPeriodSec":1800} The parameter for scheduling of diagnostic tasks. We recommend that you leave this parameter unchanged.
ocp.perf.sql.max-query-range 24h The maximum length of time range for querying SQL performance data. Default value: 24h. If the time range of a query you specified on the TopSQL or SlowSQL tab exceeds the value of this parameter, an error is returned when you submit the query.
ocp.perf.sql.plan-hist-level0-granularity 30s The time interval for OCP to aggregate the performance data of the Level 0 SQL execution plans, or plans for short. By default, OCP collects and aggregates the performance data of plans once every 30s. The performance data is stored in specific tables for use in TopSQL diagnostics. You can increase this value to relieve the storage pressure for the MetaDB and MonitorDB of OCP.
ocp.perf.sql.plan-hist-level0-query-interval 2h The maximum time range for querying the Level 0 plan performance data. If the specified query time range exceeds this value, OCP queries data tables with larger aggregation time intervals.
ocp.perf.sql.plan-hist-level0-retention 5d The period for retaining performance data partitions of Level 0 plans. Performance data partitions are created by day. By default, the data is retained for only five days. Partitions that have been retained for more than five days are automatically deleted.
ocp.perf.sql.prepare-partition-ahead 8 The number of days for creating performance data partitions before the diagnostics. You need to specify the period in days.
ocp.perf.sql.query-timeout 30000000 The timeout threshold for SQL performance data queries (μs).
ocp.perf.sql.sql-hist-level0-granularity 30s The time interval for OCP to aggregate the performance data of the Level 0 SQL queries.
Note
To improve the performance of monitoring metric collection, OCP collects and aggregates SQL performance data at different time intervals for TopSQL diagnostics. The data is divided into three levels and is collected and stored in table partitions of the corresponding levels by day. The retention period for performance data partitions is specified by a fixed parameter. For the same type of performance data, a larger time interval requires less storage space.
ocp.perf.sql.sql-hist-level0-query-interval 2h The maximum time range for querying the Level 0 SQL performance data. If the time range you specified on the TopSQL tab exceeds this value, OCP queries the Level 1 SQL performance data tables.
ocp.perf.sql.sql-hist-level0-retention 2d The retention period for partitions of Level 0 SQL performance data. Partitions for Level 0 SQL performance data are created by day. By default, the MetaDB and MonitorDB of OCP only retains partitions created in the last two days.
ocp.perf.sql.sql-hist-level1-granularity 2m The time interval for OCP to aggregate the performance data of the Level 1 SQL queries. By default, OCP aggregates SQL performance data once every 2 minutes and writes the data into Level 2 SQL performance data tables.
ocp.perf.sql.sql-hist-level1-query-interval 12h The maximum time interval for querying the Level 1 SQL performance data. If the time range you specified on the TopSQL tab exceeds this value, OCP queries the Level 2 SQL performance data tables.
ocp.perf.sql.sql-hist-level1-retention 8d The retention period for partitions of Level 1 SQL performance data.
ocp.perf.sql.sql-hist-level2-granularity 10m The time interval for OCP to aggregate the performance data of the Level 2 SQL queries. By default, OCP aggregates SQL performance data once every 10 minutes and writes the data into Level 2 SQL performance data tables.
ocp.perf.sql.sql-hist-level2-query-interval 48h The maximum time interval for querying the Level 2 SQL performance data. Regardless of whether the time range you specified exceeds this value, OCP queries the Level 2 SQL performance data tables.
ocp.perf.sql.sql-hist-level2-retention 15d The retention period for partitions of Level 2 SQL performance data.
ocp.perf.ash.max-analyse-range 60m The maximum analysis range of the Active Sessions History (ASH) report of OceanBase Database.
ocp.perf.ash.earliest-analyse-time 8 The analysis start time recorded in the ASH report of OceanBase Database.

Alerting

Parameter Default value Description
ocp.alarm.send.enabled true Specifies whether to send alerts. This parameter is set to true by default.
ocp.alarm.datasource.slow-sql-exclude-obclusters sys#* Specifies the clusters in which the slow SQL statements of the data source are not alerted, such as *#cluster1,tenant2#cluster2.
ocp.alarm.datasource.trans-stat-exclude-obclusters - Specifies the clusters in which the transactions of the data source are not alerted, such as *#cluster1,tenant2#cluster2.
ocp.alarm.detect.too-many-targets-alarm-threshold 20 Specifies the maximum number of alerted instances that hit the same alert rule. If the number exceeds the specified value, the alerts for those instances are merged into one.
ocp.alarm.notification.expired-days 90 Specifies the number of days that an alert message is archived. After the specified number of days, the archived message is stored in the history database and the corresponding alert event is deleted.
ocp.alarm.host.property svr_ip Specifies the information displayed for an alerted host. If you set the value to svr_ip, the IP address of the alerted host is displayed. If you set the value to host_name, the name of the alerted host is displayed.

Backup and Restore

Parameter Default value Description
ocp.backup.alarm.backup-data-retention-days 7 The number of days for which backup data is retained.
ocp.backup.alarm.backup-liboblog-expire-days 7 The number of days for which the backup liboblog is retained.
ocp.backup.storage.collect.task.timeout 10800000 The timeout value for each directory storage collection task during backup and restore.
ocp.backup.storage.collect.command.timeout 3600000 The timeout value for each data collection command during a storage collection task of backup and restore. This parameter is used when a storage collection task requires more than one data collection command.
ocp.backup.storage.collect.period.minutes 180 The time interval, in minutes, between data collection commands during a storage collection task of backup and restore.
ocp.backup.storage.collect.schedule.enabled true Specifies whether to enable periodical storage collection tasks during backup and restore. This parameter is set to true by default. To disable the feature, set this parameter to false.
ocp.backup.storage.collect.max.retry.times 2 The maximum number of retries for each storage collection task during backup and restore.
ocp.backup.storage.collect.host.task.concurrency 8 The maximum concurrency of storage collection tasks on each host during backup and restore.
ocp.backup.storage.collect.obtain-idle-host-interval-seconds 60 The time interval, in seconds, between retries to obtain an idle host during a storage collection task of backup and restore.
ocp.backup.storage.collect.obtain-idle-host-times 60 The maximum number of retries to obtain an idle host during a storage collection task of backup and restore.
ocp.backup.restore-time-pre-check.enabled true Specifies whether to check whether the restore time is within the period during which data can be restored before the restore is initiated. By default, this parameter is set to true.
ocp.backup.oss.support.cname true Specifies whether to support cname when OSS is accessed during backup and restore. By default, this parameter is set to true.
ocp.backup.backup-command.timeout 300 The timeout period of a backup command, in seconds.

Log analysis

Parameter Default value Description
ocp.log.regex.observer %s/log/* The regular expression for the observer log.
ocp.log.regex.obproxy /home/admin/logs/obproxy/log/* The regular expression for the obproxy log.
ocp.log.regex.host /var/log/message* The regular expression for the host log.
ocp.analyze.enabled false Specifies whether to enable the data middle platform.
ocp.analyze.ob.trace.enabled false Specifies whether to enable trace data capture.
ocp.analyze.ob.log.enabled false Specifies whether to enable OceanBase log capture.
ocp.analyze.es.client.addresses - The list of addresses of the client roles of the data middle platform Elastic Search (ES). The addresses are separated with a comma (,).
ocp.analyze.es.client.username - Optional. The username for authentication of the connection to ES.
ocp.analyze.es.client.password - Optional. The password for authentication of the connection to ES.
ocp.analyze.es.index.keep.days 7 The number of days that the ES indexes are retained.
ocp.analyze.es.index.shards 12 The number of shards of each ES index.
ocp.analyze.es.index.replicas 1 The number of replicas of each ES index.
ocp.ob.slowsql.threshold - The time threshold, in microseconds, for OB-Agent to identify and collect a query of the OceanBase cluster as a slow query.

Inspection

Parameter Default value Description
ocp.inspection.scrips.sequence-availability.threshold-percentage 0.8 The threshold, in percentage, above which a sequence is identified as available during the inspection.
ocp.monitor.exporter.check-active-period-seconds 60 The time interval, in seconds, at which the status of active exporters is checked.
ocp.monitor.exporter.check-inactive-period-seconds 50 The time interval, in seconds, at which the status of inactive exporters is checked.

OceanBase connection management

Parameter Default value Description
obsdk.print.sql true Specifies whether to print SQL statements in OceanBase connection management. Default value: true.
obsdk.slow.query.threshold.millis 1000 The threshold for slow queries in OceanBase connection management. Default value: 1000. Unit: milliseconds.
obsdk.operation.global.timeout.millis 300000 The global timeout period for O&M commands in OceanBase connection management. Valid values: 10000 to 7200000. Default value: 300000. Unit: milliseconds.

Host

Parameter Default value Description
ocp.host.remote-command.default-timeout-millis 30000 The default timeout value for remote commands on the host. Unit: milliseconds.
ocp.host.ssh-ping.max-delay-millis 3000 The maximum time difference between the request and response for a whoami command sent by the OCP Server through SSH. When the actual delay exceeds this value, some operations such as adding a host may be affected. Unit: milliseconds.
ocp.host.check.clock-diff.enable false Specifies whether to check the difference between the time of OCP Server and that of the managed hosts.
ocp.host.check.clock-diff.max-diff 50 The maximum difference between the time of OCP Server and that of the managed hosts. When the actual time difference exceeds this value, host management and monitoring can be affected. Unit: milliseconds.
ocp.host.check.unavailable-time-threshold 60000 The maximum offline duration of OCP-Agent, in milliseconds. If the offline duration of OCP-Agent exceeds the specified value, an alert is sent, indicating that the host is unavailable.

OCP Agent

Parameter Default value Description
ocp.agent.home.path.prefix /home/admin The custom installation path of OCP Agent.
ocp.agent.manager.http.port 62888 The O&M port of OCP Agent.
ocp.agent.monitor.http.port 62889 The monitoring port of OCP Agent.
ocp.agent.auth.metric-auth-enabled true Specifies whether to enable authentication for the monitoring API of OCP Agent.
monagent.log.level info The log level of the ocp_monagent process. Default value: info.
mgragent.log.level info The log level of the ocp_mgragent process. Default value: info.

File management

Parameter Default value Description
ocp.file.local.dir #{systemProperties['user.home'].concat('/data/files')} The local storage path of files in the OCP file module.
ocp.file.file-server.bucket.type LOCAL The default type of the file server, such as LOCAL and OSS. Default value: LOCAL.

Flow control

Parameter Default value Description
ocp.iam.rate-limit.enabled true Specifies whether throttling is enabled at the global level. This parameter can be dynamically enabled and disabled.
ocp.iam.rate-limit.internal-api.connect.timeout 1000 The connection timeout value for calls made to the internal throttling APIs. Unit: milliseconds. A restart is required for a modification to take effect.
ocp.iam.rate-limit.internal-api.read.timeout 1000 The read timeout value for calls made to the internal throttling APIs. Unit: milliseconds. A restart is required for a modification to take effect.
ocp.iam.rate-limit.task.schedule.period 3 The scheduling cycle of primary and secondary role management tasks in throttling. Unit: seconds. A restart is required for a modification to take effect.
ocp.iam.rate-limit.on-user.enabled true Specifies whether throttling applies to users. This parameter can be dynamically enabled and disabled.
ocp.iam.rate-limit.on-ip.enabled false Specifies whether throttling applies to IP addresses. This parameter can be dynamically enabled and disabled.

System logs

Parameter Default value Description
logging.file.name ${user.home}/logs/ocp/ocp.log The full log file name, which contains the absolute path and the file name. System environment variables in Linux and macOS, such as ${HOME}, and Java system variables, such as ${user.home}, are supported. Default value: ${user.home}/logs/ocp/ocp.log.
logging.file.max-history 100 The maximum number of days to keep archived log files. This parameter is used after logging.file.name is configured.
logging.file.max-size 100MB The size of a log file, such as 30MB or 1GB. This parameter is used after logging.file.name is configured. Default value: 100MB.
logging.file.total-size-cap 10GB The total size of log files, such as 1GB. This parameter is used after logging.file.name is configured. Default value: 10GB.
logging.level.org.hibernate.SQL INFO The log level of SQL statements in the Spring framework. Default value: INFO.
logging.level.web INFO The log level of the Spring web framework. Default value: INFO.
logging.level.com.alipay.ocp INFO The log level of OCP. Default value: INFO.
logging.level.com.oceanbase.ocp INFO The log level of OCP. Default value: INFO.

Previous topic

Modify system parameters
Last

Next topic

Manage tasks
Next
What is on this page
Global configuration
Security and logon
Monitoring
Performance diagnostics
Alerting
Backup and Restore
Log analysis
Inspection
OceanBase connection management
Host
OCP Agent
File management
Flow control
System logs