OCP 配置参数列表

参数名	默认值	参数说明
ocp.site.url	`http://localhost:8080`	外部访问 OCP 网站的地址: 要求以 http 开始（不支持https），包含VIP地址/域名/端口的网址，且结尾不含斜杠（/），比如 `http://localhost:8080`。
ocp.config-url.site.url		外部访问 OCP config url 服务的地址，默认为空，表示使用和 ocp.site.url 相同的值；如果 config url 服务单独部署，需配置和 ocp.site.url 不同的值。
ocp.config-url.use-request-address	TRUE	Config url 服务的 response 使用请求端使用的地址，默认为 true，如设置为 false，response 中使用 ocp.config-url.site.url 配置的地址。
ocp.system.default.timezone		系统默认时区，若不设置则使用 system default time zone，重启生效。
ocp.system.default.language	zh-CN	系统默认语言（非前端语言设置），若不设置则使用 zh-CN，重启生效。

参数名	默认值	参数说明
server.servlet.session.timeout	30m	登录会话 /Session 超时的时间，默认是 30m，e最少 60s。如果不加后缀单位，则默认是秒。
ocp.iam.auth	local	Web 页面登录选项：目前支持 local（本地 MetaDB中的OCP 账户）、和 buc （Alibaba 集团员工账户）；默认local。重启生效。
ocp.iam.csrf.enabled	TRUE	是否启用CSRF跨站点请求伪造安全保护，通常基于网页登录的方式都推荐要启用，默认true。重启生效。
ocp.iam.login.max-attempts	5	登录时允许连续输错用户名或密码的次数，如果超过限制则会临时阻止客户端IP的登录，默认是 5 次。
ocp.iam.login.lockout-minutes	30	如果超过登录失败限制，则会临时阻止客户端IP的登录的时间，单位是分钟，默认是 30 分钟。
ocp.iam.login.client.max-attempts	10	同一客户端连续访问登录接口的次数，如果超过限制则会临时阻止客户端的登录请求，默认是 20 次。
ocp.iam.login.client.lockout-minutes	10	如果同一客户端登录请求超过限制，则会临时阻止客户端的登录请求，单位是分钟，默认是 10分钟。

参数名	默认值	参数说明
ocp.monitor.collect.obcluster.enabled	true	是否开启 OceanBase 集群的监控采集，开启后将对所有 OceanBase 集群进行监控采集。
ocp.monitor.collect.obproxy.enabled	true	是否开启 OBProxy 的监控采集，开启后将对所有 OBProxy 集群进行监控采集。
ocp.monitor.collect.host.enabled	true	是否开启主机监控采集，开启后将对所有主机进行监控采集。
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}	监控数据保存天数，key 是监控数据的表名，value 是保存的天数，修改后重启生效。

参数名	默认值	参数说明
ocp.perf.sql-diag.awful-performance-index-used-config	{"enabled":true, "cpuTimeLimitUs":100000, "execPsLimit":5.0, "fullLogicalReadsLimit":10000}	走索引性能依然差的诊断配置。 enabled：是否打开该检测项。 execPsLimit：每秒执行次数。 cpuTimeLimitUs：平均 CPU 时间（μs）。 fullLogicalReadsLimit：逻辑读次数。诊断对象：平均 CPU 时间 > cpuTimeLimitUs && 实际逻辑读 > fullLogicalReadsLimit && 未进行全表扫描 && 执行频率 > $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}	执行占比较高诊断的配置。 enabled：是否打开该检测项。 execPsLimit：执行频率（每秒执行次数）。 cpuTimeLimitUs：平均 CPU 时间（μs）。 maxCpuTimeLimitUs：最大 CPU 时间。 affectedRowsLimit：影响行数。 execLimit：执行次数。 sqlCountLimit：SQL 数。 cpuTimePercentLimit：CPU 占比。诊断对象：平均 CPU 时间 > $cpuTimeLimitUs \|\| 影响行数 > $affectedRowsLimit \|\| 最大 CPU 时间 > $maxCpuTimeLimitUs && 执行频率 >= $execPsLimit 判断标准：诊断时间内，被诊断的 SQL 的 CPU 时间占租户 CPU 时间超过$cpuTimePercentLimit，且租户的 SQL 执行总次数大于 $execLimit，且租户执行的不同 SQL 数大于 $sqlCountLimit，则视为占比过高。
ocp.perf.sql-diag.database-white-list	oceanbase,information_schema,mysql,__recyclebin,sys,__public	SQL 诊断时过滤掉的数据库名。
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}}	执行次数突刺诊断的配置。 enabled：是否打开该检测项 execPsLimit：执行频率（每秒执行次数）。 cpuTimeLimitUs：平均 CPU 时间（μs）。 pointsLimit：点数。 compareMin：比较时间（min）。 avgExecutionMultiply：执行频率均值倍率。 stdExecutionMultiply：执行频率标准差的倍率。诊断对象：平均 CPU 时间 >= $cpuTimeLimitUs && 平均每秒执行次数 >= $execPsLimit 。判断标准： 1. 取前 $compareMin 时间内满足诊断对象条件的 SQL，统计这些 SQL 前 compareMin 时间内每分钟执行频率的均值 avg_exec_ps，以及前 $compareMin 时间内执行频率的标准差std_exec_ps 和标准差与均值的百分比 range_percent，即统计如下信息：历史平均执行频率（avg_exec_ps）标准差（std_exec_ps） range_percent（std_exec_ps / avg_exec_ps * 100）。 2. 然后计算该 SQL 的平均每秒执行次数（exec_ps）。当 exec_ps 同时满足以下条件时则该 SQL 被认为是执行次数突刺。 exec_ps>=avg_exec_ps$multiple_value_1* exec_ps >= avg_exec_ps + std_exec_ps * $multiple_value_2 说明 multiple_value_1，随 avg_exec_ps 变化情况，依赖配置项 avgExecutionMultiply。当 avg_exec_ps>500，multiple_value_1=1.6，以此类推：100->2, 50->2.5, 10->3, 5->4, 1->5。 multiple_value_2，range_percent变化情况，依赖配置项stdExecutionMultiply。当 range_percent>80，multiple_value_2=4，以此类推：50->5, 30->6, 20->8, 10->15, 5->20, 3->30, 1->60, 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}	SQL 索引诊断配置参数，重启生效。不建议用户自行配置。
ocp.perf.sql-diag.ineffective-hint-config	{"enabled":true, "execPsLimit":5.0, "cpuTimeLimitUs":20000}	Hint 未生效诊断的配置。 enabled：是否打开该检测项。 execPsLimit：执行频率（每秒执行次数）。 * cpuTimeLimitUs：平均 CPU 时间（μs）。诊断对象：CPU 时间 >= $cpuTimeLimitUs && 执行频率 >= $execPsLimit 判断标准：解析诊断对象，满足"Hint 中指定的索引的与执行计划里的不一致。"则认为是 Hint 未生效。
ocp.perf.sql-diag.perf-diagnoser-config	{"enabled":true,"schedulePeriodMin":5, "coreThreadSize":10, "maxThreadSize":50,"maxQueueSize":10000,"diagPeriodSec":300,"diagOffsetSec":60,"maxDiagPeriodSec":1800}	SQL 性能诊断配置参数，重启生效。不建议用户自行配置。
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}}	执行计划变化且性能下降诊断的配置。 enabled：是否打开该检测项。 cpuTimeMultiply：CPU 倍率，若当前平均 CPU 时间大于 0 ms，则执行计划变化后的 CPU 时间应该下降 50 倍才算性能下降，若大于1ms 则为 30 倍，依此类推。 * compareMin：性能比较时间（min）。判断条件：该 SQL 在 $compareMin 时间内平均 CPU 时间，在计划变化后增加的倍数大于此处设置的 CPU 倍率，则视为性能下降。
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}}	性能下降诊断的配置。 enabled：是否打开该检测项。 execPsLimit：执行频率（每秒执行次数）。 cpuTimeLimitUs：平均 CPU 时间（μs）。 maxCpuTimeLimitUs：最大 CPU 时间。 affectedRowsLimit：影响行数。 execLimit：执行次数。 compareMin：基线数据的来源时间（min），为检测时间的前 $compareMin 时间。 cpuTimeMultiply：CPU 倍率，若当前 CPU 时间大于 0 ms, 则执行计划变化后的 CPU 时间应该下降 50 倍才算性能下降，若大于1ms 则为 30 倍，依此类推。诊断对象：诊断时间内满足下述条件的 SQL，平均 CPU 时间 > $cpuTimeLimitUs \|\| 影响行数 > $affectedRowsLimit \|\| 最大CPU 时间 > $maxCpuTimeLimitUs && 执行频率 > $execPsLimit。判断标准：基线作为比较对象，需满足"基线执行次数 > $execLimit"，否则不可作为比较对象。有了比较对象后，当检测的 SQL 同时满足下述条件则认为是性能比以前下降。当前平均 CPU 时间 >= 基线 CPU 时间 $cpuTimeMultiply，cpuTimeMultiply 默认值为 6。* 当前执行频率 >= 基线执行频率 * 0.5
ocp.perf.sql-diag.query-timeout	30000000	SQL 诊断查询时的超时时间（μs）。
ocp.perf.sql-diag.row-lock-contention-high-config	{"enabled":true, "execPsLimit":0, "cpuTimeLimitUs":1000, "elapsedTimeLimitUs":0}	热点行锁诊断的配置。 enabled：是否打开该检测项。 execPsLimit：执行频率（每秒执行次数）。 cpuTimeLimitUs：平均 CPU 时间（μs）。 elapsedTimeLimitUs：平均响应时间（μs）。检测对象：检测时间段内满足下述条件的 SQL 。执行频率 > $execPsLimit && 平均 CPU 时间 > $cpuTimeLimitUs && 平均响应时间 > $elapsedTimeLimitUs 说明 elapsedTimeLimitUs 不配置的话，则不作为过滤检测对象的条件。判断标准：检测对象中类型为"%select%for%update%"的即为造成热点行锁诊断的 SQL。
ocp.perf.sql-diag.table-scan-index-not-exists-config	{"enabled":true, "execPsLimit":1.0, "cpuTimeLimitUs":20000}	全表扫描且无可用索引的诊断配置。 enabled：是否打开该检测项。 execPsLimit：执行频率（每秒执行次数）。 cpuTimeLimitUs：平均 CPU 时间（μs）。诊断对象：v$sql_audit 中 table_scan >0 的 SQL，即进行了全表扫描的 SQL。判断标准：满足下述条件则认为是无索引。单表，该表无索引。 * 多表，有的表没有索引。
ocp.perf.sql-diag.table-scan-index-not-used-config	{"enabled":true, "execPsLimit":1.0, "cpuTimeLimitUs":2000}	全表扫描有索引未走的诊断配置。 enabled：是否打开该检测项。 execPsLimit：执行频率（每秒执行次数）。 * cpuTimeLimitUs：平均 CPU 时间（μs）。检测对象：检测时间段内满足下述条件的 SQL 。执行频率 > $execPsLimit && 平均 CPU 时间 > $cpuTimeLimitUs && 进行了全变扫描判断标准：有索引未走。
ocp.perf.sql.diag-plan-change-config	{"enabled":true,"schedulePeriodMin":5, "coreThreadSize":10, "maxThreadSize":50,"maxQueueSize":10000,"diagPeriodSec":300,"diagOffsetSec":300,"maxDiagPeriodSec":1800}	诊断任务调度参数配置。不建议用户自行配置。
ocp.perf.sql.max-query-range	24h	SQL 性能数据查询时的最大时间区间长度。默认值"24h"。若 TopSQL 和 SlowSQL 界面配置的查询时间超过该值，则提交查询时会报错。
ocp.perf.sql.plan-hist-level0-granularity	30s	OCP 聚合第 0 级 SQL 的 Plan 性能数据的时间粒度。 OCP 默认 30s 采集并聚合一次 SQL 的 Plan 性能数据并存于固定表中，供 TopSQL 查询时使用。通过调大该值可以降低 OCP 监控元数据存储空间的压力。
ocp.perf.sql.plan-hist-level0-query-interval	2h	第 0 级 Plan 性能数据的最大查询时间区间。超过该值，OCP 会去查看聚合时间粒度更大的数据表。
ocp.perf.sql.plan-hist-level0-retention	5d	第 0 级 Plan 性能数据的分区保留时间。性能数据的分区按天创建，系统默认只保留 5 天内的数据，超过 5 天的分区将会被删除。
ocp.perf.sql.prepare-partition-ahead	8	指定提前创建多少天的性能数据分区。要求传入以天为单位的时间。
ocp.perf.sql.query-timeout	30000000	SQL 性能数据查询时的超时时间（μs）。
ocp.perf.sql.sql-hist-level0-granularity	30s	OCP 聚合第 0 级 SQL 性能数据的时间粒度。说明为提高 OCP 监控采集性能，OCP 将按不同的时间粒度采集并聚合 SQL 的性能数据以供 TopSQL 的诊断时查询。共分三级，不同级别的数据被采集来后会按天存储到对应级别表的分区中。分区的保留时间由固定参数配置。同样的性能数据，时间粒度越大则消耗的存储空间越小。
ocp.perf.sql.sql-hist-level0-query-interval	2h	第 0 级 SQL 性能数据的最大查询时间区间。当用户在 TopSQL 界面中配置的查询时间区间超过该值时，系统将会从第 1 级 SQL 性能数据表中查询。
ocp.perf.sql.sql-hist-level0-retention	2d	第 0 级 SQL 性能数据的分区保留时间。对于按天创建用来存储第 0 级 SQL 性能数据的分区表，监控元数据库默认仅保留两天内创建的。
ocp.perf.sql.sql-hist-level1-granularity	2m	OCP 聚合第 1 级 SQL 性能数据的时间粒度。OCP 默认每 2 分钟聚合一次 SQL 性能数据并写入第 2 级 SQL 性能数据表中。
ocp.perf.sql.sql-hist-level1-query-interval	12h	第1级SQL性能数据的最大查询时间区间。当用户在 TOPSQL 界面中配置的查询时间区间超过该值时，系统将会从第 2 级 SQL 性能数据表中查询。
ocp.perf.sql.sql-hist-level1-retention	8d	第 1 级 SQL 性能数据的分区保留时间。
ocp.perf.sql.sql-hist-level2-granularity	10m	OCP 聚合第 2 级 SQL 性能数据的时间粒度。OCP 默认每 10 分钟聚合一次 SQL 性能数据并写入第 2 级 SQL 性能数据表中。
ocp.perf.sql.sql-hist-level2-query-interval	48h	第 2 级 SQL 性能数据的最大查询时间区间。因无更高级别的的采集粒度，即使超过该值，OCP 仍会从第 2 级 SQL 性能数据表中查询。
ocp.perf.sql.sql-hist-level2-retention	15d	第 2 级 SQL 性能数据的分区保留时间。
ocp.perf.ash.max-analyse-range	60m	OceanBase ASH报告的最大分析范围。
ocp.perf.ash.earliest-analyse-time	8	OceanBase ASH报告最早的分析时间。

参数名	默认值	参数说明
ocp.alarm.send.enabled	true	告警发送功能开关，默认开启。
ocp.alarm.datasource.slow-sql-exclude-obclusters	sys#*	慢SQL告警数据源不生效的集群，如：*#cluster1,tenant2#cluster2
ocp.alarm.datasource.trans-stat-exclude-obclusters		事务告警数据源不生效的集群，如：*#cluster1,tenant2#cluster2
ocp.alarm.detect.too-many-targets-alarm-threshold	20	同一告警规则检测到告警实例的个数，当超过该个数时，合并为同一条告警。
ocp.alarm.notification.expired-days	90	告警的归档天数，超过归档天数告警消息将归档到历史库，告警事件会被删除。
ocp.alarm.host.property	svr_ip	主机告警展示的信息，配置为svr_ip展示IP，配置为host_name展示主机名。

参数名	默认值	参数说明
ocp.backup.alarm.backup-data-retention-days	7	备份数据保留的最近天数。
ocp.backup.alarm.backup-liboblog-expire-days	7	备份 liboblog 保留的最近天数。
ocp.backup.storage.collect.task.timeout	10800000	备份恢复容量采集每个目录任务的采集超时时间。
ocp.backup.storage.collect.command.timeout	3600000	备份恢复容量采集每个采集指令的超时时间(一个目录采集任务多次下发采集指令)。
ocp.backup.storage.collect.period.minutes	180	备份恢复容量采集周期（分钟）。
ocp.backup.storage.collect.schedule.enabled	true	备份恢复容量定时采集开关，默认打开。true代表打开，false代表关闭。
ocp.backup.storage.collect.max.retry.times	2	备份恢复容量采集每个采集任务重试的次数限制。
ocp.backup.storage.collect.host.task.concurrency	8	备份恢复容量采集每台主机的任务并发数限制。
ocp.backup.storage.collect.obtain-idle-host-interval-seconds	60	备份恢复容量采集获取空闲主机的时间间隔，单位秒。
ocp.backup.storage.collect.obtain-idle-host-times	60	备份恢复容量采集获取空闲主机的最大重试次数。
ocp.backup.restore-time-pre-check.enabled	true	发起恢复前是否检查恢复时间在可恢复时间区间内，默认开启。
ocp.backup.oss.support.cname	true	备份恢复OSS访问是否支持cname，默认开启。
ocp.backup.backup-command.timeout	300	备份命令超时时间，单位秒。

参数名	默认值	参数说明
ocp.log.regex.observer	%s/log/*	observer日志的表达式。
ocp.log.regex.obproxy	/home/admin/logs/obproxy/log/*	obproxy日志的表达式。
ocp.log.regex.host	/var/log/message*	host日志的表达式。
ocp.analyze.enabled	false	是否开启数据中台。
ocp.analyze.ob.trace.enabled	false	是否开启抓取 trace 数据。
ocp.analyze.ob.log.enabled	false	是否开启抓取 ob log 数据。
ocp.analyze.es.client.addresses		数据中台 ES client 角色地址列表，用 , 分割。
ocp.analyze.es.client.username		数据中台 ES 连接认证用户名，可选。
ocp.analyze.es.client.password		数据中台 ES 连接认证密码，可选。
ocp.analyze.es.index.keep.days	7	数据中台 ES 索引保留天数。
ocp.analyze.es.index.shards	12	数据中台 ES 索引分片数。
ocp.analyze.es.index.replicas	1	数据中台 ES 索引副本数。
ocp.ob.slowsql.threshold		供ob-agent采集OceanBase集群的慢查询时间阈值，单位微秒。

参数名	默认值	参数说明
ocp.inspection.scrips.sequence-availability.threshold-percentage	0.8	巡检时序列可用性评判的百分比阈值。
ocp.monitor.exporter.check-active-period-seconds	60	检查正常状态exporter的间隔（秒）。
ocp.monitor.exporter.check-inactive-period-seconds	50	检查不正常状态exporter的间隔（秒）。

参数名	默认值	参数说明
obsdk.print.sql	true	OB连接管理中 sql 打印开关，默认开启。
obsdk.slow.query.threshold.millis	1000	OB连接管理中慢查询日志阈值，单位毫秒，默认值 1000 毫秒。
obsdk.operation.global.timeout.millis	300000	OB连接管理中运维命令全局超时时间，单位毫秒，取值范围10000~7200000，默认值 300000。

参数名	默认值	参数说明
ocp.host.remote-command.default-timeout-millis	30000	主机远程命令默认超时（毫秒）。
ocp.host.ssh-ping.max-delay-millis	3000	ocp server 通过 ssh 执行whoami的时间间隔（请求收发的时间差，单位毫秒），如果大于该阈值，则会影响添加主机等操作。
ocp.host.check.clock-diff.enable	false	是否检查 ocp server 与被管理主机的时钟差。
ocp.host.check.clock-diff.max-diff	50	ocp server 与被管理主机的最大时钟偏移（单位毫秒），如果大于该阈值，则会影响主机管理和监控。
ocp.host.check.unavailable-time-threshold	60000	OCP Agent 最大离线时长（单位毫秒），离线超过此时长则发送主机不可用告警。

参数名	默认值	参数说明
ocp.agent.home.path.prefix	/home/admin	OCP Agent 自定义安装路径。
ocp.agent.manager.http.port	62888	OCP-Agent 服务端口，运维使用。
ocp.agent.monitor.http.port	62889	OCP-Agent 服务端口，监控使用。
ocp.agent.auth.metric-auth-enabled	true	是否开启OCP Agent 的监控API鉴权。
monagent.log.level	info	设置ocp_monagent程序的日志级别，默认为info。
mgragent.log.level	info	设置ocp_mgragent程序的日志级别，默认为info。

参数名	默认值	参数说明
ocp.file.local.dir	#{systemProperties['user.home'].concat('/data/files')}	OCP 文件模块文件本地路径。
ocp.file.file-server.bucket.type	LOCAL	默认文件服务器类型，如：LOCAL, OSS等；默认值 LOCAL。

参数名	默认值	参数说明
ocp.iam.rate-limit.enabled	true	全局流控开关，支持动态启停。
ocp.iam.rate-limit.internal-api.connect.timeout	1000	流控内部接口调用时，连接的超时时间，（单位：毫秒）重启生效。
ocp.iam.rate-limit.internal-api.read.timeout	1000	流控内部接口调用时，读取的超时时间，（单位：毫秒）重启生效。
ocp.iam.rate-limit.task.schedule.period	3	流控主备角色管理任务的调度周期，（单位：秒）重启生效。
ocp.iam.rate-limit.on-user.enabled	true	流控是否对用户限流，支持动态启停。
ocp.iam.rate-limit.on-ip.enabled	false	流控是否对IP地址限流，支持动态启停。

参数名	默认值	参数说明
logging.file.name	${user.home}/logs/ocp/ocp.log	日志文件的完整名字（绝对路径+文件名字），可以用 Linux/macOS 系统环境变量如${HOME} 或者 java 系统变量${user.home}；默认是${user.home}/logs/ocp/ocp.log。
logging.file.max-history	100	当配置了 logging.file.name 后，设置最多保留的归档日志文件的天数。
logging.file.max-size	100MB	当配置了 logging.file.name 后，通过本配置指定日志文件大小，如 30MB、1GB 等；默认是 100MB。
logging.file.total-size-cap	10GB	当配置了logging.file.name后，通过本配置指定日志文件总大小，如1GB等；默认是10GB。
logging.level.org.hibernate.SQL	INFO	设置 spring sql 框架的日志级别，默认为 INFO。
logging.level.web	INFO	设置 spring web 框架的日志级别，默认为 INFO。
logging.level.com.alipay.ocp	INFO	设置 ocp 程序的日志级别，默认为 INFO。
logging.level.com.oceanbase.ocp	INFO	设置 ocp 程序的日志级别，默认为 INFO。

全局配置

安全与登录

监控

诊断与性能

告警

备份恢复

日志分析

巡检

OceanBase 连接管理

主机

OCP-Agent

文件管理

流控管理

系统日志