CNDBA社区
1 系统配置项说明
1.1 系统变量和系统配置项对比
OB 数据库中有 2 个容易混淆的概念：变量和配置项。简单的理解他们的区别如下：
- 变量：针对会话的配置；
- 配置项，也就是参数，针对租户 或者 集群。
具体对比如下表：
| 对比项 | 系统配置项 | 系统变量 |
|---|---|---|
| 生效范围 | 分为集群、Zone、机器和租户。 | 分为租户的 Global 或 Session 级别。 |
| 生效方式 | 动态生效：edit_level 为 dynamic_effective 重启生效：edit_level 为 static_effective |
设置 Session 级别的变量仅对当前 Session 有效，对其他 Session 无效。 设置 Global 级别的变量对当前 Session 无效，需要重新登录建立新的 Session 才会生效。 |
| 修改方式 | 支持通过 SQL 语句修改，示例： ALTER SYSTEM SET schema_history_expire_time=’1h’; 支持通过启动参数修改，示例： cd /home/admin/oceanbase && ./bin/observer -o “schema_history_expire_time=’1h’”; |
仅支持通过 SQL 语句修改，示例如下： SET ob_query_timeout = 20000000; SET GLOBAL ob_query_timeout = 20000000; |
| 查询方式 | 可以使用 SHOW PARAMETERS 语句查询。示例：SHOW PARAMETERS LIKE ‘schema_history_expire_time’; | 可以使用 SHOW [GLOBAL] VARIABLES 语句查询。示例如下： SHOW VARIABLES LIKE ‘ob_query_timeout’; SHOW GLOBAL VARIABLES LIKE ‘ob_query_timeout’; |
| 持久化 | 持久化到内部表与配置文件，可以在 /home/admin/oceanbase/etc/observer.config.bin 与 /home/admin/oceanbase/etc/observer.config.bin.history 文件中查询该配置项。 | 仅 Global 级别的变量会持久化，Session 级别的变量不会进行持久化。 |
| 生命周期 | 长，从进程启动到退出。 | 短，需要租户的 Schema 创建成功以后才生效。 |
1.2 系统配置项说明
OceanBase 数据库的配置项分为集群级配置项和租户级配置项。通过配置项的设置可以控制集群的负载均衡、合并时间、合并方式、资源分配和模块开关等功能。
生效方式：
配置项一般分为动态生效和重启生效两种方式，大部分配置项为动态生效方式，即不需要重启 OBServer 节点即可生效。
1.2.1 查看配置项
可以通过 SHOW PARAMETERS 或者 GV$OB_PARAMETERS 视图查看：
obclient [oceanbase]> SHOW PARAMETERS LIKE 'max_syslog_file_count'/G;
*************************** 1. row ***************************
zone: zone2
svr_type: observer
svr_ip: 10.103.241.134
svr_port: 2882
name: max_syslog_file_count
data_type: NULL
value: 4
info: specifies the maximum number of the log files that can co-exist before the log file recycling kicks in. Each log file can occupy at most 256MB disk space. When this value is set to 0, no log file will be removed. Range: [0, +∞) in integer
section: OBSERVER
scope: CLUSTER
source: DEFAULT
edit_level: DYNAMIC_EFFECTIVE
obclient [oceanbase]> select * from `GV$OB_PARAMETERS` gop where name='max_syslog_file_count'/G;
*************************** 1. row ***************************
SVR_IP: 10.103.241.134
SVR_PORT: 2882
ZONE: zone2
SCOPE: CLUSTER
TENANT_ID: NULL
NAME: max_syslog_file_count
DATA_TYPE: NULL
VALUE: 4
INFO: specifies the maximum number of the log files that can co-exist before the log file recycling kicks in. Each log file can occupy at most 256MB disk space. When this value is set to 0, no log file will be removed. Range: [0, +∞) in integer
SECTION: OBSERVER
EDIT_LEVEL: DYNAMIC_EFFECTIVE
其中，scope 列对应的值为 CLUSTER 表示该配置项为集群级别；如果 scope 列对应的值为 TENANT，则表示该配置项为租户级别。
1.2.2 修改配置项
obclient [oceanbase]> ALTER SYSTEM SET max_syslog_file_count = 5;
Query OK, 0 rows affected (0.059 sec)
obclient [oceanbase]> SHOW PARAMETERS LIKE 'max_syslog_file_count'/G;
*************************** 1. row ***************************
zone: zone2
svr_type: observer
svr_ip: 10.103.241.134
svr_port: 2882
name: max_syslog_file_count
data_type: NULL
value: 5
info: specifies the maximum number of the log files that can co-exist before the log file recycling kicks in. Each log file can occupy at most 256MB disk space. When this value is set to 0, no log file will be removed. Range: [0, +∞) in integer
section: OBSERVER
scope: CLUSTER
source: DEFAULT
edit_level: DYNAMIC_EFFECTIVE
2 系统配置项汇总
2.1 集群级配置项
2.1.1 带宽相关
1.enable_ob_ratelimit 用于在 RPC 连接中，启用区域之间的速率限制。
2.ob_ratelimit_stat_period 用于设置 OBServer 节点计算和更新最大带宽的时间间隔。
2.1.2 负载均衡相关
1.balancer_idle_time 用于设置负载均衡等后台任务线程空闲时的唤醒间隔时间。
2.balancer_log_interval 用于负载均衡等后台任务线程打印统计日志的间隔时间。
3.balancer_task_timeout 用于设置负载均衡等后台任务的超时时间。
4.balancer_tolerance_percentage 用于设置负载均衡策略中，租户内多个 Unit 间磁盘不均衡程度的宽容度，如果在均值 + 或 - 宽容度范围之内，不会触发执行均衡动作。
5.enable_rebalance 用于设置是否开启自动负载均衡的功能。
6.server_balance_critical_disk_waterlevel 用于设置磁盘空间的负载均衡功能的水位线。
7.server_balance_disk_tolerance_percent 用于设置节点间磁盘负载均衡策略中不均衡程度的容忍度。
8.resource_hard_limit 用于分配 Unit 。
9.enable_sys_unit_standalone 用于设置系统租户的 Unit 是否独占节点。
2.1.3 副本相关
1.enable_rereplication 用于设置是否开启自动补副本的功能。
2.ls_meta_table_check_interval 用于设置 DBA_OB_LS_LOCATIONS/CDB_OB_LS_LOCATIONS 视图的后台巡检线程的检查间隔。
3.sys_bkgd_migration_change_member_list_timeout 用于设置副本迁移时变更 Paxos 成员组操作的超时时间。
4.sys_bkgd_migration_retry_num 用于设置副本迁移失败时最多重试次数。
2.1.4 备份恢复相关
1.backup_data_file_size 用于设置备份数据文件的容量。
2.1.5 集群相关
1.all_server_list 用于显示群集中的所有服务器地址。
2.cluster 用于设置本 OceanBase 集群名。
3.cluster_id 用于设置本 OceanBase 集群 ID。
4.rpc_timeout 用于设置集群内部请求的超时时间。
2.1.6 SQL 相关
1.sql_login_thread_count 用于设置处理 SQL 登录请求的线程数量。
2.1.7 CPU 相关
1.cpu_count 用于设置系统 CPU 总数。如果设置为 0，系统将自动检测 CPU 数量。
2.server_balance_cpu_mem_tolerance_percent 在节点负载均衡策略中，用于设置 CPU 和内存资源不均衡的容忍度。
3.server_cpu_quota_max 用于设置系统可以使用的最大 CPU 配额。
4.server_cpu_quota_min 用于设置系统可以使用的最小 CPU 配额，系统会自动预留。
5.token_reserved_percentage 在控制租户 CPU 调度中，用于设置每次预留多少比例的空闲 token 数给租户。
6.workers_per_cpu_quota 用于设置分配给每个 CPU 配额的工作线程数量。
2.1.8 目录路径相关
1.config_additional_dir 用于设置本地存储配置文件的多个目录，为了冗余存储多份配置文件。
2.data_dir 用于设置存储 SSTable 等数据的目录。
2.1.9 内存空间相关
1.datafile_disk_percentage 表示占用 data_dir 所在磁盘（磁盘 data_dir 所在磁盘将被 OceanBase 数据库系统初始化用于存储数据）总空间的百分比。
2.data_disk_usage_limit_percentage 用于设置数据文件最大可以写入的百分比，超过这个阈值后，禁止数据迁入。
3.enable_sql_operator_dump 用于设置是否允许 SQL 处理过程的中间结果写入磁盘以释放内存。
4.global_write_halt_residual_memory 用于设置触发暂停普通租户写入（sys 租户不受影响）的全局剩余内存阈值。
5.leak_mod_to_check 用于内存泄露检查，是属于内部调试的功能。
6.memory_chunk_cache_size 用于设置内存分配器缓存的内存块容量。
7.memory_limit 表示可用的总内存大小。
8.memory_limit_percentage 用于设置系统总可用内存大小占总内存大小的百分比。
9.memory_reserved 用于设置系统预留给 KVCache 的内存容量。
10.memstore_limit_percentage 用于设置租户使用 MemStore 的内存占其总可用内存的百分比。
11.system_memory 用于设置系统预留给租户 ID 为 500 的租户的内存容量。
12.use_large_pages 用于管理数据库使用的内存大页。
2.1.10 调试相关
1.debug_sync_timeout 用于打开 Debug Sync 调试开关，并设置其超时时间。
2.enable_rich_error_msg 用于设置是否在客户端消息中添加服务器地址、时间、追踪 ID 等调试信息。
2.1.11 压缩算法相关
1.default_compress_func 用于设置表数据的默认压缩算法，也可以在建表的时候指定其他压缩算法。
2.default_compress 用于设置在 Oracle 模式下，建表时使用的默认压缩策略。
3.tableapi_transport_compress_func 用于设置 tableAPI 查询结果传输使用的压缩算法。
2.1.12 事务及事务日志相关
1.log_disk_size 用于设置 Redo 日志磁盘的大小。
2.log_disk_percentage 用于设置 Redo 日志占用其所在磁盘总空间的百分比。
3.clog_sync_time_warn_threshold 用于设置事务日志同步耗时告警阈值，同步耗时超过该值产生 WARN 日志。
4.dtl_buffer_size 用于设置 SQL 数据传输模块使用的缓存大小。
5.ignore_replay_checksum_error 用于设置是否忽略回放事务日志时发生的校验和错误。
6.trx_2pc_retry_interval 用于设置两阶段提交失败时候自动重试的时间间隔。
2.1.13 转储与合并相关
1.enable_major_freeze 用于设置是否开启自动全局冻结的功能。
2.micro_block_merge_verify_level 用于设置合并时宏块的校验级别。
3.row_compaction_update_limit 用于设置触发内存中行内数据合并的修改次数。
2.1.14 PX 相关
1.px_workers_per_cpu_quota 用于设置并行执行工作线程数的比例。
2.px_task_size 用于设置 SQL 并行查询引擎每个任务处理的数据量大小。
3.max_px_worker_count 用于设置 SQL 并行查询引擎使用的最大线程数。
2.1.15 缓存相关
1.bf_cache_miss_count_threshold 用于控制 Bloomfilter Cache 的触发次数，当宏块未命中次数达到该值时，创建 Bloomfilter 缓存。
2.bf_cache_priority 用于设置 Bloom Filter 缓存优先级。
3.cache_wash_threshold 用于设置触发缓存清理的容量阈值。
4.fuse_row_cache_priority 用于设置融合行缓存在缓存系统中的优先级。
5.user_row_cache_priority 用于设置基线数据行缓存在缓存系统中的优先级。
6.autoinc_cache_refresh_interval 用于设置自增列缓存的刷新间隔。
7.plan_cache_evict_interval 用于设置执行计划缓存的淘汰时间间隔。
8.index_block_cache_priority 用于设置元数据索引微块缓存优先级。
9.opt_tab_stat_cache_priority 用于设置统计信息缓存优先级。
10.tablet_ls_cache_priority 用于设置 Tablet 映射缓存优先级。
11.user_block_cache_priority 用于设置数据块缓存在缓存系统中的优先级。
2.1.16 Location Cache 相关
1.virtual_table_location_cache_expire_time 用于设置虚拟表的位置信息缓存过期时间。
2.location_cache_refresh_rpc_timeout 通过 RPC 刷新 location_cache 的超时时间。
3.location_cache_refresh_sql_timeout 通过 SQL 刷新 location_cache 的超时时间。
4.location_cache_refresh_min_interval 用于设置位置缓存刷新请求的最小间隔，防止产生过多刷新请求造成系统压力过大。
5.location_cache_cpu_quota 用于设置位置缓存模块使用的 CPU 配额。
6.location_fetch_concurrency 用于设置单机 location_cache 刷新的最大并发数。
7.location_refresh_thread_count 用于设置 OBServer 节点从 Root Service 中获取分区位置信息的线程数量。
2.1.17 日志相关
1.enable_record_trace_log 用于设置是否记录追踪日志。
2.enable_async_syslog 用于设置是否启用系统日志异步写。
3.enable_syslog_recycle 用于设置是否开启回收系统日志的功能。
4.enable_syslog_wf 用于设置是否把 WARN 以上级别的系统日志打印到一个单独的日志文件中。
5.max_string_print_length 用于设置打印系统日志时，单行日志最大长度。
6.max_syslog_file_count 用于设置在回收日志文件之前可以容纳的日志文件数量。
7.syslog_level 用于设置系统日志级别。
8.trace_log_sampling_interval 用于设置定期打印跟踪日志信息的时间。
2.1.18 分区相关
1.tablet_meta_table_check_interval 用于设置 DBA_OB_TABLET_REPLICAS/CDB_OB_TABLET_REPLICAS 视图的后台巡检线程的检查间隔。
2.tablet_meta_table_scan_batch_count 用于设置 Tablet meta table 迭代器使用过程中在内存里缓存的 Tablet 数量。
3.tablet_size 用于设置分区内部并行处理（合并、查询等）时每个分片的大小。
2.1.19 读写/查询相关
1.weak_read_version_refresh_interval 用于设置弱一致性读版本号的刷新周期，影响弱一致性读数据的延时。
2.large_query_worker_percentage 用于设置预留给处理大查询的工作线程百分比。
3.large_query_threshold 用于设置查询执行时间的阈值。
4.trace_log_slow_query_watermark 用于设置查询的执行时间阈值，如果查询的执行时间超过该阈值，则被认为是慢查询，慢查询的追踪日志会被打印到系统日志中。
2.1.20 Root Service 相关
1.rootservice_async_task_queue_size 用于设置 Root Service 内部异步任务队列的大小。
2.rootservice_async_task_thread_count 用于设置 Root Service 内部异步任务使用的线程池大小。
3.rootservice_list 用于显示 Root Service 及其副本所在的机器列表。
4.rootservice_ready_check_interval 用于设置 Root Service 启动后等待和检查集群状态的时间间隔。
5.rootservice_memory_limit 用于设置 Root Service 的最大内存容量限制。
6.lease_time 用于设置心跳租约时长。
7.server_check_interval 用于设置 Server 表一致性检查的时间间隔。
8.server_permanent_offline_time 用于设置节点心跳中断的时间阈值，即节点心跳中断多久后认为其被永久下线，永久下线的节点上的数据副本需要被自动补足。
9.ob_event_history_recycle_interval 用于控制历史事件的回收间隔。
2.1.21 I/O 相关
1.rdma_io_thread_count 用于设置 Libreasy 的 RDMA I/O 线程数。
2.syslog_io_bandwidth_limit 用于设置系统日志所能占用的磁盘 IO 带宽上限，超过带宽上限容量的系统日志将被丢弃。
3.disk_io_thread_count 用于设置磁盘 IO 线程数。必须为偶数。
4.net_thread_count 用于设置网络 I/O 线程数。
2.1.22 TCP 相关
1.enable_tcp_keepalive 用于开启或关闭客户端连接的探活机制。
2.tcp_keepidle 用于设置客户端连接上服务器后，如果没有数据发送，多久后会发送 Keepalive 探测分组，单位为秒。
3.tcp_keepintvl 用于设置开启客户端连接的探活机制后，前后两次探测之间的时间间隔，单位为秒。
4.tcp_keepcnt 用于设置关闭一个非活跃连接之前的最大重试次数。
2.1.23 其他
1.builtin_db_data_verify_cycle 用于设置数据坏块自检周期，单位为天。当值为 0 时表示不检查。
2.data_storage_warning_tolerance_time 用于控制数据盘状态设为 WARNING 状态的容忍时间。
3.dead_socket_detection_timeout 用于设置检测失效 Socket 的时间间隔。
4.enable_sys_table_ddl 用于指定是否允许手动创建系统表。
5.internal_sql_execute_timeout 用于设置系统内部 DML 请求的时间间隔。
6.migration_disable_time 用于设置因磁盘满等原因导致某个节点数据迁入失败时的暂停迁入时长。
7.schema_history_expire_time 用于设置元数据历史数据过期时间。
8.datafile_size 用于设置数据文件的大小。一般不需要设置。
9.devname 用于设置服务进程绑定的网卡设备名。
10.enable_perf_event 用于设置是否开启性能事件的信息收集功能。
11.enable_record_trace_id 用于设置是否记录应用端设置的追踪 ID。
12.enable_upgrade_mode 用于设置是否开启升级模式。在升级模式中，会暂停部分系统后台功能。
13.enable_ddl 用于设置是否允许执行 DDL。
14.high_priority_net_thread_count 用于设置高优先级网络线程数，值为 0 时，表示关闭该功能。
15.mysql_port 用于设置 SQL 服务协议端口号。
16.obconfig_url 用于设置 OBConfig 服务的 URL 地址。
17.rpc_port 用于设置远程访问的协议端口号。
18.ssl_client_authentication 用于设置是否开启 SSL 连接功能。
19.stack_size 用于设置程序函数调用栈的大小。
20.tenant_task_queue_size 用于设置每个租户的请求队列大小。
21.zone 用于设置节点所在的 Zone 的名字。该配置项一般不需要配置。
22.ssl_external_kms_info 用于记录 OceanBase 数据库 SSL 功能运行依赖的一些信息，通过 json 字符串方式记录不同 SSL 使用方式下依赖的相关配置，json 中至少包含类型 ssl_mode 字段。
23.recyclebin_object_expire_time 用于自动 Purge 回收站中过期的 Schema 对象。
24.default_row_format 用于设置在 MySQL 模式下，建表时使用的默认行格式。
25.enable_sql_audit 用于设置是否开启 SQL 审计功能。
26.min_observer_version 用于查看本集群最低的 OBServer 节点应用程序版本号。
27.sys_bkgd_net_percentage 用于设置后台系统任务可占用网络带宽百分比。
28.schema_history_recycle_interval 用于设置系统内部执行 schema 多版本记录回收任务的时间间隔。
29.enable_asan_for_memory_context 在使用 ob_asan 时，用于设置是否允许 ObAsanAllocator（默认 ObAllocator 作为 MemoryContext 的分配器）。
30.plan_cache_high_watermark 用于设置执行计划缓存占用内存的阈值，如果超过该阈值时将触发自动淘汰。
31.plan_cache_low_watermark 用于设置执行计划缓存占用内存的阈值，如果低于该阈值时将停止淘汰。
32.tenant_cpu_variation_per_server 用于设置租户多个 Unit 之间 CPU 配额调度允许的偏差。
33.system_trace_level 用于设置系统追踪日志的日志打印级别。
2.2 租户级配置项
2.2.1 用户登录相关
1.connection_control_failed_connections_threshold 用来指定用户错误登录尝试的阀值。
2.connection_control_min_connection_delay 指定了超过错误登录次数阈值之后，错误登录锁定的最小时长。
3.connection_control_max_connection_delay 指定了错误登录锁定时长的最大值，当时长达到这个最大值之后就不再增长。
2.2.2 审计相关
1.audit_sys_operations 用于设置是否追踪系统用户的操作行为。
2.audit_trail 用于设置是否启用数据库审核。
2.2.3 事务及事务日志相关
1.log_disk_utilization_limit_threshold 用于设置租户日志盘利用率限制阈值，当租户日志盘使用量超过租户日志盘空间总量乘以该值时，不再允许日志写入。
2.log_disk_utilization_threshold 用于设置租户日志盘利用率阈值，当租户日志盘使用量超过租户日志盘空间总量乘以该值时，进行日志文件重用。
3.writing_throttling_maximum_duration 通过控制内存分配进度，控制写入速度。即指定在触发写入限速后，剩余 MemStore 内存分配完所需的时间。
4.writing_throttling_trigger_percentage 用于设置写入速度的阈值。
2.2.4 转储与合并相关
1.default_progressive_merge_num 用于设置新建一张表时默认的渐进合并次数。
2.major_freeze_duty_time 用于设置每日定时冻结和合并的触发时刻。
3.major_compact_trigger 用于设置多少次小合并触发一次全局合并。
4.minor_compact_trigger 用于控制分层转储触发向下一层下压的阈值。
5.undo_retention 用于设置系统应保留的多版本数据范围，单位为秒，在转储时控制多版本数据的回收。
6.merger_check_interval 用于设置合并状态检查线程的调度间隔。
7.freeze_trigger_percentage 用于设置触发全局冻结的租户使用内存阈值。
2.2.5 CPU 相关
1.cpu_quota_concurrency 用于设置租户的每个 CPU 配额所允许的最大并发数。
2.2.6 加密相关
1.external_kms_info 用于存储一些密钥管理信息。
2.tde_method 用于设置透明表空间加密的方式。
2.2.7 PL
1.plsql_code_type 用于指定 PL/SQL 代码的编译类型。
2.plsql_debug 用于指定是否编译成 debug 版本。
3.plsql_optimize_level 用于指定编译优化级别。
4.plsql_warnings 用于控制 PL/SQL 编译器的报错行为，可以指定某类型或某个 warning 码的状态为enable、disable 或 error。
2.2.8 兼容相关
1.enable_sql_extension 用于设置是否开启租户的 SQL 扩展功能。
2.2.9 读写/查询相关
1.enable_monotonic_weak_read 用于设置是否开启单调读。
2.query_response_time_stats 用于设置是否启用 information_schema.QUERY_RESPONSE_TIME 视图的统计信息收集。
3.query_response_time_flush 用于设置是否刷新 information_schema.QUERY_RESPONSE_TIME 视图并重新读取 query_response_time_range_base。
4.query_response_time_range_base 用于设置 information_schema.QUERY_RESPONSE_TIME 视图收集时间参数的间隔时间。
2.2.10 路由相关
1.ob_proxy_readonly_transaction_routing_policy 用于控制 Proxy 对于事务的路由是否受只读语句的影响。
2.2.11 IO 相关
1.io_category_config 用于配置各类别 I/O 请求的百分比。
2.2.12 后台执行线程相关
1.compaction_low_thread_score 用于设置低优先级 compaction 的工作线程占用 CPU 时间片权重。
2.compaction_high_thread_score 用于设置高优先级 compaction 的工作线程占用 CPU 时间片权重。
3.compaction_mid_thread_score 用于设置中优先级 compaction 的工作线程占用 CPU 时间片权重。
4.ha_high_thread_score 用于设置高可用高优先级线程的当前工作线程数。
5.ha_mid_thread_score 用于设置高可用中优先级线程的当前工作线程数。
6.ha_low_thread_score 用于设置高可用低优先级线程的当前工作线程数。
7.ob_compaction_schedule_interval 用于设置 Compaction 调度的时间间隔。
2.2.13 备份恢复相关
1.log_restore_concurrency 用于设置恢复日志的并发度。
2.log_archive_concurrency 用于设置日志归档的并发度。
2.2.14 其他
1.enable_early_lock_release 用于设置是否开启提前解行锁的功能。
2.workarea_size_policy 用于设置手动或者自动调整 SQL 工作区大小的策略。
3.open_cursors 用于限制单个 Session 可以同时打开的游标数量。
4.ob_ssl_invited_common_names 用于记录当前租户运行的应用身份列表，该身份来自 SSL 双向认证中 Client 端证书 subject 中的 cn 字段（common name）。
5.ob_enable_batched_multi_statement 用于设置是否启用批处理功能的成组执行优化。
6.default_auto_increment_mode 用于设置默认的自增列自增模式。
7.ob_query_switch_leader_retry_timeout 用于设置失败 Query 的最大重试时间，单位为微秒（us）。
8.default_enable_extended_rowid 用于设置是否将表创建为 Extended ROWID 模式。
9.sql_work_area 用于设置租户的工作区内存。
10.max_stale_time_for_weak_consistency 用于设置弱一致性读允许读到多旧的数据。
版权声明：本文为博主原创文章，未经博主允许不得转载。
