OCP configuration parameters|V4.0.0|OceanBase Cloud Platform|OCP docs|Distributed Database

Parameter	Default value	Description
ocp.version	2.5.0	The version of OCP.
server.port	8080	The startup port number of the application server. Default value: 8080. A restart is required for a modification to take effect.
ocp.env	private	The OCP environment.
ocp.site.url	`http://localhost:8080`	The URL for accessing the OCP site. The URL must start with HTTP. HTTPS is not supported. It must contain the virtual IP (VIP) address, domain name, and port number, and not end with a forward slash (/). Example: `http://localhost:8080`
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.active.standby.cluster.enabled	TRUE	Specifies whether to support hot backup for OceanBase Database. Hot backup is supported by default. It is disabled when OCP upgrades to V2.4.x from an earlier version. To enable it, make sure that the OBProxy version is not earlier than V1.7.2.

Parameter	Default value	Description
server.servlet.session.timeout	30 m	The timeout value for session logons and sessions. Default value: 30 m. Minimum value: 60 s. 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.auth.whitelist	/api/v2/time,/api/v2/mc/info,/api/v2/loginKey,.Action=(ObRootServiceInfo\|ObRootServiceRegister\|ObIDCRegionInfo\|GetObProxyConfig\|AllocateClusterIdByNameAndIdx\|DeleteObRootServiceInfoByClusterName\|GetObRootServiceInfoUrlTemplate).,performance/ash/reports/.*/data	The whitelist for API operations that do not require a password. It is a string that consists of API URLs, separated with commas. Regular expressions are supported. Default value: /api/v2/time. A restart is required for a modification to take effect.
ocp.iam.auth.basic.enabled	TRUE	Specifies whether to enable the Basic Auth logon mode, which is generally used by clients such as applications and SDKs. Default value: TRUE. You can enable this feature at the same time as ocp.iam.auth. 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.csrf.url.excluded	/api/v2/iam/login.,.Action=(ObRootServiceInfo\|ObRootServiceRegister\|ObIDCRegionInfo\|GetObProxyConfig\|AllocateClusterIdByNameAndIdx\|DeleteObRootServiceInfoByClusterName).,/api/v2/monitor/metric/scan.	The list of URLs for which CSRF protection is skipped. Regular expressions are supported. Default value: /api/v2/iam/login.*. This parameter only takes effect when CSRF protection is enabled. The URL is a complete string that contains the path and the query parameters.
ocp.iam.login.max-attempts	20	The maximum number of consecutive unsuccessful logon attempts allowed. When this threshold is exceeded, the client IP address is temporarily blocked. Default value: 20.
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	20	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: 20
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.

Parameter	Default value	Description
`spring.datasource.druid.name`	metadb-connect-pool	The name of the Druid connection pool of MetaDB . A restart is required for a modification to take effect.
spring.datasource.druid.initialSize	10	The number of physical connections created upon initialization. A restart is required for a modification to take effect.
spring.datasource.druid.minIdle	2	The minimum connection pool size. A restart is required for a modification to take effect.
spring.datasource.druid.maxActive	100	The maximum connection pool size. A restart is required for a modification to take effect.
spring.datasource.druid.testWhileIdle	TRUE	We recommend that you set this parameter to TRUE , because it enhances security without affecting performance. When you apply for a connection, the system tests whether the connection is valid. A restart is required for a modification to take effect.
spring.datasource.druid.keepAlive	TRUE	For connections within the number of minIdle in the connection pool, if the idle time exceeds minEvictableIdleTimeMillis (default value: 1800 seconds), the keepAlive operation is performed. A restart is required for a modification to take effect.
spring.datasource.druid.validationQuery	SELECT 1 FROM DUAL	The SQL statement used to verify whether a connection is valid. A restart is required for a modification to take effect.
spring.datasource.druid.maxWait	2000	The maximum wait time for obtaining a connection. Unit: milliseconds. A restart is required for a modification to take effect.
spring.datasource.druid.keepAlive	TRUE	For connections within the number of minIdle in the connection pool, if the idle time exceeds minEvictableIdleTimeMillis (default value: 1800 seconds), the keepAlive operation is performed. A restart is required for a modification to take effect.

Parameter	Default value	Description
ocp.monitordb.host	`xxx.xxx.xxx.xxx`	The name of the MonitorDB host.
ocp.monitordb.port	2883	The port of the MonitorDB.
ocp.monitordb.database		The database name of MonitorDB.
ocp.monitordb.password	******	The password of MonitorDB.
ocp.monitordb.username	root@ocp_meta#obocp	The username of MonitorDB.
ocp.monitordb.driverClassName	com.alipay.oceanbase.obproxy.mysql.jdbc.Driver	The jdbc driver. A restart is required for a modification to take effect.
ocp.monitordb.druid.name	monitordb-connect-pool	The name of the Druid connection pool. A restart is required for a modification to take effect.
ocp.monitordb.druid.initialSize	10	The number of physical connections created upon initialization. A restart is required for a modification to take effect.
ocp.monitordb.druid.minIdle	2	The minimum connection pool size. A restart is required for a modification to take effect.
ocp.monitordb.druid.maxActive	100	The maximum connection pool size. A restart is required for a modification to take effect.
ocp.monitordb.druid.testWhileIdle	TRUE	We recommend that you set this parameter to TRUE, because it enhances security without affecting performance. When you apply for a connection, the system tests whether the connection is valid. A restart is required for a modification to take effect.
ocp.monitordb.druid.validationQuery	SELECT 1 FROM DUAL	The SQL statement used to verify whether a connection is valid. A restart is required for a modification to take effect.
ocp.monitordb.druid.maxWait	2000	The maximum wait time for obtaining a connection. Unit: milliseconds. A restart is required for a modification to take effect.
ocp.monitordb.druid.keepAlive	TRUE	For connections within the number of minIdle in the connection pool, if the idle time exceeds minEvictableIdleTimeMillis (default value: 1800 seconds), the keepAlive operation will be executed. A restart is required for a modification to take effect.

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. Parameters: 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: The average CPU time > cpuTimeLimitUs && The actual logical reads > fullLogicalReadsLimit && The full table scan is not performed && The 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. Parameters: 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 the 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: The average CPU time > $cpuTimeLimitUs \|\| The number of affected rows > $affectedRowsLimit \|\| The upper limit of CPU time > $maxCpuTimeLimitUs && The 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. Parameters: 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: The average CPU time >= $cpuTimeLimitUs && The average number of executions per second >= $execPsLimit. Diagnostic criteria: 1. Find the SQL queries that meet the diagnostic conditions within the last $compareMin before the diagnosis. 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 last $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 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 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. Parameters: 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: The average CPU time >= $cpuTimeLimitUs && The executions frequency >= $execPsLimit. Diagnostic criteria: If the index specified in the hint is inconsistent with that in 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. Parameters 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). Evaluation 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 the 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 last $compareMin before the diagnosis. 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 conditions: The average CPU time > $cpuTimeLimitUs \|\| The number of affected rows > $affectedRowsLimit \|\| The upper limit of CPU time > $maxCpuTimeLimitUs && The 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 $execulimit. 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 diagnosis meets all the following conditions at the same time: The current average CPU time >= The 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: The execution frequency > $execPsLimit && The average CPU time > $cpuTimeLimitUs && The 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: The execution frequency > $execPsLimit, the average CPU Time > $cpuTimeLimitUs, and a 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: 24 h. 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 30 s. 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 diagnosis. 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.

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	Whether to check the clock offset of OCP Server and the managed host.
ocp.host.check.clock-diff.max-diff	50	The maximum difference between the time of OCP Server and that of remote servers. 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 of OCP Agent offline time. When the offline time difference exceeds this value, then send the host unavailable alarm. Unit: milliseconds.

Parameter	Default value	Description
ocp.alarm.send.once-timeout-ms	10000	The timeout value for the delivery of a single alert.
ocp.alarm.send.once-retry-times	1	The maximum number of retries for the delivery of a single alert.
ocp.alarm.send.batch-max	20	The maximum number of new notifications that can be sent at a time.
ocp.alarm.send.retry-timeout-minutes	60	Retry timeout value. A notification that exceeds this value will not be resent. Default value: 60. Unit: minutes.
ocp.alarm.send.total-failed-retry-times	3	The maximum number of retries after a notification fails to be sent.
ocp.alarm.send.total-timeout-seconds	60	The timeout value for a notification sent by a single server.
ocp.alarm.send.period.ms	2000	The interval at which notifications are sent. A restart is required for a modification to take effect. Default value: 2000. Unit: milliseconds.
ocp.alarm.recover-message-template		Recovery message template for alert channels. The default value of this parameter is empty, meaning that the system-default template is used. If this parameter is specified, the specified value replaces the default template.

Parameter	Default value	Description
backup.dbname.prefix	backup	The custom prefix of the backup and recovery MetaDB. The default prefix is backup. After you modify this parameter, the new prefix will be used for new databases created during the initialization or upgrade of OCP, and the prefix of existing databases are not changed.
ocp.backup.agent.relation.file.full-path.name	#{systemProperties['user.home'].concat('/ocp-server/etc/backup_agent_ob_relations_config.yaml')}	Describes the version of the backup and recovery module, the MetaDB that it depends on, and its matching relationship with the version of the OceanBase cluster.
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.alarm.last-data-backup-max-interval-minutes	1440	The period to check for failed baseline backup tasks. Default value: 1440 (one day). Unit: minutes.
ocp.backup.alarm.inc-backup-delay-threshold	3600	The alert threshold for delays in incremental backup. Unit: seconds.
ocp.backup.alarm.base-backup-last-finished-threshold	12960	The maximum interval between two baseline backup operations. Default value: 12960 (nine days). Unit: minutes.
ocp.backup.alarm.base-backup-timeout	10	The timeout value for the scheduling of baseline backup. Unit: minutes.
ocp.backup.storage.collect.task.timeout	9000	The timeout value for each directory storage collection task during backup and recovery.
ocp.backup.storage.collect.max.retry.times	2	The maximum number of retries for each storage collection task during backup and recovery.

Parameter	Default value	Description
ocp.agent.manager.http.port	62888	The OCP-Agent server port, used by maintenance.
ocp.agent.monitor.http.port	62889	The OCP-Agent server port, used by monitoring.

Parameter	Default value	Description
ocp.task.executor.core-pool-size	16	The core thread pool size for task execution threads. Default value: 16. A restart is required for a modification to take effect.
ocp.task.executor.keep-alive-seconds	120	The amount of time to keep idle sessions in the thread pool for task execution threads. A restart is required for a modification to take effect. Default value: 120. Unit: seconds.
ocp.task.executor.max-pool-size	64	The maximum size of the thread pool for task execution thread. Default value: 64. A restart is required for a modification to take effect.
ocp.task.executor.queue-capacity	1000	The size of the thread queue for tasks execution. Default value: 1000. A restart is required for a modification to take effect.

Parameter	Default value	Description
obsdk.ob.connection.mode	proxy	The method to connect to OceanBase. Valid values: proxy and direct. Default value: proxy.
obsdk.connectors.print.sql	TRUE	Specifies whether to print SQL statements in OceanBase connection management. Default value: TRUE.
obsdk.connectors.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	Global timeout period for operation and maintenance commands in OceanBase connection management. Valid values: 10000 ~ 7200000. Default value: 300000. Unit: milliseconds.

Parameter	Default value	Description
logging.file	${user.home}/logs/ocp/ocp.log	Obsolete, `logging.file.name` is recommended.
logging.file.name	${user.home}/logs/ocp/ocp.log	Full name of log files (absolute path + file name). You can use Linux/macOS system environment variables such as ${HOME} or java system variables ${user.home}. Default value: ${user.home}/logs/ocp/ocp.log.
logging.file.max-history	100	The maximum number of archived log files to keep. This parameter is used after logging.file is configured.
logging.file.max-size	100 MB	The size of a log file, such as 30 MB or 1 GB. This parameter is used after logging.file is configured. Default value: 100MB.
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.

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.local.built-in.dir	#{systemProperties['user.home'].concat('/ocp-server/lib')}	The local storage path of built-in files in the file module of OCP.
ocp.file.default-block-split-size	1048576	The default size of a file block in the file module of OCP. Default value: 1048576. Unit: bytes.
ocp.file.max-concurrent-count	16	The maximum concurrency for file processing on a single node in the file module of OCP. Default value: 16.
ocp.file.try-lock-timeout-milliseconds	60000	The lock overtime for a single node in the file module of OCP. Default value: 60000. Unit: milliseconds.

Parameter	Default value	Description
ocp.iam.rate-limit.enabled	TRUE	Specifies whether flow control is enabled on 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 flow control APIs. A restart is required for a modification to take effect. Unit: milliseconds.
ocp.iam.rate-limit.internal-api.read.timeout	1000	The read timeout value for calls made to the internal flow control APIs. A restart is required for a modification to take effect. Unit: milliseconds.
ocp.iam.rate-limit.task.schedule.period	3	The scheduling cycle of primary and secondary role management tasks in flow control. A restart is required for a modification to take effect. Unit: seconds.
ocp.iam.rate-limit.on-user.enabled	TRUE	Specifies whether flow control applies to users. This parameter can be dynamically enabled and disabled.

OceanBase

Customer Stories

Documentation

Community Edition

Enterprise Edition

OCP configuration parameters

Global configuration

Security and logon

OCP MetaDB connections

OCP MonitorDB connections

SQL performance module

Host operations

Alerting

backup and recovery

OCP-Agent

Background tasks and scheduling

OceanBase remote connection management

Log module

File management

Flow control