@@ -132,7 +132,3 @@ A:You can use the `obd update` command to update OBD. When you are done with t
## Protocol
OBD complies with [GPL-3.0](/LICENSE).
## Sysbench benchmark
-[Run the Sysbench benchmark test in OceanBase Database (Paetica, VLDB 2023)](https://github.com/oceanbase/oceanbase-doc/blob/V4.1.0/en-US/7.reference/3.performance-tuning-guide/6.performance-whitepaper/3.run-the-sysbench-benchmark-test-in-oceanbase-database.md)
login_password:oceanbase# Grafana login password. The default value is 'oceanbase'.
login_password:xxxxxxxxx# Grafana login password.
# data_dir: # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used).$data_dir can be empty. The default value is $home_path/data.
# logs_dir: # Directory where grafana can store logs, can be empty. The default value is $data_dir/log.
# plugins_dir: # Directory where grafana will automatically scan and look for plugins, can be empty. The default value is $data_dir/plugins.
login_password:oceanbase# Grafana login password. The default value is 'oceanbase'.
login_password:xxxxxxxxx# Grafana login password.
# data_dir: # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used).$data_dir can be empty. The default value is $home_path/data.
# logs_dir: # Directory where grafana can store logs, can be empty. The default value is $data_dir/log.
# plugins_dir: # Directory where grafana will automatically scan and look for plugins, can be empty. The default value is $data_dir/plugins.
login_password:oceanbase# Grafana login password. The default value is 'oceanbase'.
login_password:xxxxxxxxx# Grafana login password.
# data_dir: # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used).$data_dir can be empty. The default value is $home_path/data.
# logs_dir: # Directory where grafana can store logs, can be empty. The default value is $data_dir/log.
# plugins_dir: # Directory where grafana will automatically scan and look for plugins, can be empty. The default value is $data_dir/plugins.
login_password:oceanbase# Grafana login password. The default value is 'oceanbase'.
login_password:xxxxxxxxx# Grafana login password.
# data_dir: # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used).$data_dir can be empty. The default value is $home_path/data.
# logs_dir: # Directory where grafana can store logs, can be empty. The default value is $data_dir/log.
# plugins_dir: # Directory where grafana will automatically scan and look for plugins, can be empty. The default value is $data_dir/plugins.
login_password:oceanbase# Grafana login password. The default value is 'oceanbase'.
login_password:xxxxxxxxx# Grafana login password.
# data_dir: # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used).$data_dir can be empty. The default value is $home_path/data.
# logs_dir: # Directory where grafana can store logs, can be empty. The default value is $data_dir/log.
# plugins_dir: # Directory where grafana will automatically scan and look for plugins, can be empty. The default value is $data_dir/plugins.
login_password:oceanbase# Grafana login password. The default value is 'oceanbase'.
login_password:xxxxxxxxx# Grafana login password.
# data_dir: # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used).$data_dir can be empty. The default value is $home_path/data.
# logs_dir: # Directory where grafana can store logs, can be empty. The default value is $data_dir/log.
# plugins_dir: # Directory where grafana will automatically scan and look for plugins, can be empty. The default value is $data_dir/plugins.
"expr":"(sum(rate(ob_sysstat{stat_id=\"40003\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40005\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40009\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40009\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40001\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group))\n/\n(sum(rate(ob_sysstat{stat_id=\"40002\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40004\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40006\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40008\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40000\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group))",
"expr":"(sum(rate(ob_sysstat{stat_id=\"40003\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40005\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40007\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40009\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40001\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group))\n/\n(sum(rate(ob_sysstat{stat_id=\"40002\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40004\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40006\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40008\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group) + sum(rate(ob_sysstat{stat_id=\"40000\",ob_cluster_name=~\"$obcluster\",obzone=~\"$obzone\",svr_ip=~\"$observer\",tenant_name=~\"$tenant_name\"}[$__rate_interval])) by ($group))",
@@ -158,15 +158,15 @@ class ObVersionGraph(object):
res.insert(0,start_node)
ifresandres[-1].deprecated:
raiseException('upgrade destination version:{}{} is deprecated, not support upgrade.'.format(res[-1].version,'-{}'.format(res[-1].release)ifres[-1].releaseelse''))
merge_status=self.execute_sql("select max(global_broadcast_scn) as global_broadcast_scn, max(global_broadcast_scn > last_scn) as is_merging from CDB_OB_MAJOR_COMPACTION")
# 1. wait all tenant global_broadcast_scn = last_scn, record tenant_id, global_broadcast_scn
pre_tenant_scn_dict={}
tenant_ids=[]
fortenant_infoinself.execute_sql("select tenant_id from CDB_OB_MAJOR_COMPACTION",one=False):
tenant_ids.append(tenant_info['tenant_id'])
whiletenant_ids:
pre_tenant_scn_list=self.execute_sql("select tenant_id, global_broadcast_scn, last_scn from CDB_OB_MAJOR_COMPACTION where tenant_id in ({})".format(",".join([str(x)forxintenant_ids])),one=False)
self.execute_sql("alter system major freeze tenant = all",error=False)
# 3. wait merge start
whileself.execute_sql("select * from CDB_OB_MAJOR_COMPACTION where global_broadcast_scn <= %s",[pre_global_broadcast_scn]):
tenant_ids=pre_tenant_scn_dict.keys()
whiletenant_ids:
tenant_scn_list=self.execute_sql("select tenant_id, global_broadcast_scn from CDB_OB_MAJOR_COMPACTION where tenant_id in ({})".format(",".join([str(x)forxintenant_ids])),one=False)
@@ -158,15 +158,15 @@ class ObVersionGraph(object):
res.insert(0,start_node)
iflen(res)>0andres[-1].deprecated:
raiseException('upgrade destination version:{}{} is deprecated, not support upgrade.'.format(res[-1].version,'-{}'.format(res[-1].release)ifres[-1].releaseelse''))
merge_status=self.execute_sql("select max(global_broadcast_scn) as global_broadcast_scn, max(global_broadcast_scn > last_scn) as is_merging from CDB_OB_MAJOR_COMPACTION")
# 1. wait all tenant global_broadcast_scn = last_scn, record tenant_id, global_broadcast_scn
pre_tenant_scn_dict={}
tenant_ids=[]
fortenant_infoinself.execute_sql("select tenant_id from CDB_OB_MAJOR_COMPACTION",one=False):
tenant_ids.append(tenant_info['tenant_id'])
whiletenant_ids:
pre_tenant_scn_list=self.execute_sql("select tenant_id, global_broadcast_scn, last_scn from CDB_OB_MAJOR_COMPACTION where tenant_id in ({})".format(",".join([str(x)forxintenant_ids])),one=False)
self.execute_sql("alter system major freeze tenant = all",error=False)
# 3. wait merge start
whileself.execute_sql("select * from CDB_OB_MAJOR_COMPACTION where global_broadcast_scn <= %s",[pre_global_broadcast_scn]):
tenant_ids=pre_tenant_scn_dict.keys()
whiletenant_ids:
tenant_scn_list=self.execute_sql("select tenant_id, global_broadcast_scn from CDB_OB_MAJOR_COMPACTION where tenant_id in ({})".format(",".join([str(x)forxintenant_ids])),one=False)
description_en:specifies the current level of logging.
description_local:系统日志级别
-name:resource_hard_limit
require:false
type:INT
default:100
min_value:1
max_value:10000
section:LOAD_BALANCE
need_restart:false
description_en:Used along with resource_soft_limit in unit allocation. If server utilization is less than resource_soft_limit, a policy of best fit will be used for unit allocation; otherwise, a least load policy will be employed. Ultimately,system utilization should not be large than resource_hard_limit.
description_en:the name of the module under memory leak checks
description_local:内存泄露检查,用于内部调试目的
-name:balancer_task_timeout
require:false
type:TIME
default:20m
min_value:1s
max_value:NULL
section:LOAD_BALANCE
need_restart:false
description_en:the time to execute the load-balancing task before it is terminated.
description_local:负载均衡等后台任务的超时时间
-name:enable_upgrade_mode
require:false
type:BOOL
default:false
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:specifies whether upgrade mode is turned on. If turned on, daily merger and balancer will be disabled.
description_local:升级模式开关。在升级模式中,会暂停部分系统后台功能。
-name:multiblock_read_size
require:false
type:CAPACITY_MB
default:128K
min_value:0K
max_value:2M
section:SSTABLE
need_restart:false
description_en:multiple block batch read size in one read io request.
description_local:读取数据时IO聚合大小
-name:migration_disable_time
require:false
type:TIME
default:3600s
min_value:1s
max_value:NULL
section:ROOT_SERVICE
need_restart:false
description_en:the duration in which the observer stays in the block_migrate_in status, which means no partition is allowed to migrate into the server.
description_local:因磁盘满等原因导致某个节点数据迁入失败时,暂停迁入时长
-name:tablet_size
require:false
type:CAPACITY_MB
default:128M
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:default tablet size, has to be a multiple of 2M
description_local:分区内部并行处理(合并、查询等)时每个分片的大小
-name:dead_socket_detection_timeout
require:false
type:TIME
default:10s
min_value:0s
max_value:2h
section:OBSERVER
need_restart:false
description_en:specify a tcp_user_timeout for RFC5482. A zero value makes the option disabled
description_local:失效socket检测超时时间
-name:server_check_interval
require:false
type:TIME
default:30s
min_value:1s
max_value:NULL
section:ROOT_SERVICE
need_restart:false
description_en:the time interval between schedules of a task that examines the __all_server table.
description_local:server表一致性检查的时间间隔
-name:lease_time
require:false
type:TIME
default:10s
min_value:1s
max_value:5m
section:ROOT_SERVICE
need_restart:false
description_en:Lease for current heartbeat. If the root server does not received any heartbeat from an observer in lease_time seconds, that observer is considered to be offline.
description_en:the size of the queue for all asynchronous tasks at rootserver.
description_local:RootService内部异步任务队列的容量
-name:location_refresh_thread_count
require:false
type:INT
default:4
min_value:2
max_value:64
section:LOCATION_CACHE
need_restart:false
description_en:the number of threads that fetch the partition location information from the root service.
description_local:用于位置缓存刷新的线程数
-name:minor_compact_trigger
require:false
type:INT
default:2
min_value:0
max_value:16
section:TENANT
need_restart:false
description_en:minor_compact_trigger
description_local:触发小合并的迷你合并次数
-name:major_freeze_duty_time
type:MOMENT
default:Disable
min_value:00:00
max_value:23:59
section:DAILY_MERGE
need_restart:false
description_en:the start time of system daily merge procedure.
description_local:每日定时冻结和合并的触发时刻
-name:ignore_replay_checksum_error
require:false
type:BOOL
default:false
min_value:NULL
max_value:NULL
section:TRANS
need_restart:false
description_en:specifies whether error raised from the memtable replay checksum validation can be ignored.
description_local:是否忽略回放事务日志时发生的校验和错误
-name:user_block_cache_priority
require:false
type:INT
default:1
min_value:1
max_value:NULL
section:CACHE
need_restart:false
description_en:user block cache priority
description_local:数据块缓存在缓存系统中的优先级
-name:syslog_io_bandwidth_limit
require:false
type:CAPACITY_MB
default:30MB
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:Syslog IO bandwidth limitation, exceeding syslog would be truncated. Use 0 to disable ERROR log.
description_local:系统日志所能占用的磁盘IO带宽上限,超过带宽的系统日志将被丢弃
-name:workers_per_cpu_quota
require:false
type:INT
default:10
min_value:2
max_value:20
section:TENANT
need_restart:false
description_en:the ratio(integer) between the number of system allocated workers vs the maximum number of threads that can be scheduled concurrently.
description_local:每个CPU配额分配多少个工作线程
-name:enable_record_trace_id
require:false
type:BOOL
default:true
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:specifies whether record app trace id is turned on.
description_local:是否记录应用端设置的追踪ID
-name:config_additional_dir
require:false
type:STRING_LIST
default:etc2;etc3
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:additional directories of configure file
description_local:本地存储配置文件的多个目录,为了冗余存储多份配置文件
-name:enable_syslog_recycle
require:false
essential:true
type:BOOL
default:false
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:specifies whether log file recycling is turned on
description_local:是否自动回收系统日志
-name:max_syslog_file_count
require:false
essential:true
type:INT
default:0
min_value:0
max_value:NULL
section:OBSERVER
need_restart:false
description_en: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.
description_local:系统日志自动回收复用时,最多保留多少个。值0表示不自动清理。
-name:px_task_size
require:false
type:CAPACITY_MB
default:2M
min_value:2M
max_value:NULL
section:OBSERVER
need_restart:false
description_en:min task access size of px task
description_local:SQL并行查询引擎每个任务处理的数据量大小
-name:replica_safe_remove_time
require:false
type:TIME
default:2h
min_value:1m
max_value:NULL
section:ROOT_SERVICE
need_restart:false
description_en:the time interval that replica not existed has not been modified beyond which a replica is considered can be safely removed
description_local:已删除副本可以被清理的安全保留时间
-name:builtin_db_data_verify_cycle
require:false
type:INT
default:20
min_value:0
max_value:360
section:OBSERVER
need_restart:false
description_en:check cycle of db data.
description_local:数据坏块自检周期,单位为天。值0表示不检查。
-name:system_cpu_quota
require:false
type:DOUBLE
default:10
min_value:0
max_value:16
section:TENANT
need_restart:false
description_en:the number of vCPUs allocated to the server tenant
description_local:系统后台任务可使用CPU配额
-name:enable_sys_table_ddl
require:false
type:BOOL
default:false
min_value:NULL
max_value:NULL
section:ROOT_SERVICE
need_restart:false
description_en:specifies whether a system table is allowed be to created manually.
description_local:是否允许新建和修改系统表。主要在系统升级过程中使用。
-name:merge_thread_count
require:false
type:INT
default:0
min_value:0
max_value:256
section:OBSERVER
need_restart:false
description_en:worker thread num for compaction
description_local:用于合并的线程数
-name:net_thread_count
require:false
type:INT
default:0
min_value:0
max_value:128
section:OBSERVER
need_restart:true
description_en:the number of rpc/mysql I/O threads for Libeasy.
description_local:网络IO线程数
-name:max_stale_time_for_weak_consistency
require:false
type:TIME
default:5s
min_value:5s
max_value:NULL
section:OBSERVER
need_restart:false
description_en:the max data stale time that observer can provide service when its parent is invalid.
description_local:弱一致性读允许读到多旧的数据
-name:backup_log_archive_option
require:false
type:STRING
default:OPTIONAL
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:backup log archive option, support MANDATORY/OPTIONAL, COMPRESSION
description_local:日志备份的参数
-name:backup_concurrency
require:false
type:INT
default:0
min_value:0
max_value:100
section:OBSERVER
need_restart:false
description_en:backup concurrency limit.
description_local:observer备份基线的并发度
-name:balancer_log_interval
require:false
type:TIME
default:1m
min_value:1s
max_value:NULL
section:LOAD_BALANCE
need_restart:false
description_en:the time interval between logging the load-balancing tasks statistics.
description_local:负载均衡等后台任务线程打印统计日志的间隔时间
-name:restore_concurrency
require:false
type:INT
default:0
min_value:0
max_value:512
section:OBSERVER
need_restart:false
description_en:the current work thread num of restore macro block.
description_local:从备份恢复租户数据时最大并发度
-name:micro_block_merge_verify_level
require:false
type:INT
default:2
min_value:0
max_value:3
section:OBSERVER
need_restart:false
description_en:specify what kind of verification should be done when merging micro block. 0, no verification will be done; 1, verify encoding algorithm, encoded micro block will be read to ensure data is correct; 2, verify encoding and compression algorithm, besides encoding verification, compressed block will be decompressed to ensure data is correct; 3, verify encoding, compression algorithm and lost write protect
description_local:控制合并时宏块的校验级别
-name:bf_cache_miss_count_threshold
require:false
type:INT
default:100
min_value:0
max_value:NULL
section:CACHE
need_restart:false
description_en:bf cache miss count threshold, 0 means disable bf cache
description_en:the percentage of the workers reserved to serve large query request.
description_local:预留给大查询处理的工作线程百分比
-name:clog_transport_compress_all
require:false
type:BOOL
default:false
min_value:NULL
max_value:NULL
section:TRANS
need_restart:false
description_en:If this option is set to true, use compression for clog transport. The default is false(no compression)
description_local:事务日志传输时是否压缩
-name:flush_log_at_trx_commit
require:false
type:INT
default:1
min_value:0
max_value:2
section:TRANS
need_restart:false
description_en:0 means commit transactions without waiting clog write to buffer cache, 1 means commit transactions after clog flush to disk, 2 means commit transactions after clog write to buffer cache
description_en:post global major freeze when observer memsotre free memory(plus memory hold by frozen memstore and blockcache) reach this limit. limit calc by memory_limit * (1 - system_memory_percentage/100) * global_major_freeze_residual_memory/100
description_local:当剩余内存小于这个百分比时,触发全局冻结
-name:enable_sql_audit
require:false
type:BOOL
default:true
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:specifies whether SQL audit is turned on.
description_local:SQL审计功能开关
-name:merger_switch_leader_duration_time
require:false
type:TIME
default:3m
min_value:0s
max_value:30m
section:ROOT_SERVICE
need_restart:false
description_en:switch leader duration time for daily merge.
description_local:合并时,批量切主的时间间隔
-name:enable_record_trace_log
require:false
type:BOOL
default:false
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:specifies whether to always record the trace log.
description_en:backup expired day limit, 0 means not expired
description_local:恢复窗口大小
-name:default_row_format
require:false
type:STRING
default:compact
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:default row format in mysql mode
description_local:MySQL模式下,建表时使用的默认行格式
-name:stack_size
require:false
type:CAPACITY_MB
default:1M
min_value:512K
max_value:20M
section:OBSERVER
need_restart:true
description_en:the size of routine execution stack
description_local:程序函数调用栈大小
-name:balancer_idle_time
require:false
type:TIME
default:5m
min_value:10s
max_value:NULL
section:LOAD_BALANCE
need_restart:false
description_en:the time interval between the schedules of the partition load-balancing task.
description_local:负载均衡等后台任务线程空闲时的唤醒间隔时间
-name:memory_limit
name_local:最大运行内存
require:false
essential:true
type:CAPACITY_MB
default:0
min_value:NULL
max_value:NULL
modify_limit:decrease
section:OBSERVER
need_restart:false
description_en:the size of the memory reserved for internal use(for testing purpose). Please enter an capacity, such as 8G
description_local:可用总内存大小。请输入带容量带单位的整数,如8G
-name:system_memory
name_local:集群系统内存
essential:true
type:CAPACITY_MB
default:30G
min_value:0M
max_value:NULL
section:OBSERVER
need_restart:false
description_en:the memory reserved for internal use which cannot be allocated to any outer-tenant, and should be determined to guarantee every server functions normally. Please enter an capacity, such as 2G
description_en:the minimum memory limit of the resource pool
description_local:资源池最小内存限制
-name:virtual_table_location_cache_expire_time
require:false
type:TIME
default:8s
min_value:1s
max_value:NULL
section:LOCATION_CACHE
need_restart:false
description_en:expiration time for virtual table location info in partiton location cache.
description_local:虚拟表的位置信息缓存过期时间
-name:ssl_external_kms_info
require:false
type:STRING
default:
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:when using the external key management center for ssl, this parameter will store some key management information
description_local:配置ssl使用的主密钥管理服务
-name:enable_sql_operator_dump
require:false
type:BOOL
default:true
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:specifies whether sql operators (sort/hash join/material/window function/interm result/...) allowed to write to disk
description_local:是否允许SQL处理过程的中间结果写入磁盘以释放内存
-name:enable_rich_error_msg
require:false
type:BOOL
default:false
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:specifies whether add ip:port, time and trace id to user error message.
description_local:是否在客户端消息中添加服务器地址、时间、追踪ID等调试信息
-name:log_archive_concurrency
require:false
type:INT
default:0
min_value:0
max_value:NULL
section:OBSERVER
need_restart:false
description_en:concurrency for log_archive_sender and log_archive_spiter
description_local:日志归档并发度
-name:server_balance_disk_tolerance_percent
require:false
type:INT
default:1
min_value:1
max_value:100
section:LOAD_BALANCE
need_restart:false
description_en:specifies the tolerance (in percentage) of the unbalance of the disk space utilization among all servers. The average disk space utilization is calculated by dividing the total space by the number of servers. server balancer will start a rebalancing task when the deviation between the average usage and some server load is greater than this tolerance
description_local:节点负载均衡策略中,磁盘资源不均衡的容忍度
-name:user_tab_col_stat_cache_priority
require:false
type:INT
default:1
min_value:1
max_value:NULL
section:CACHE
need_restart:false
description_en:user tab col stat cache priority
description_local:统计数据缓存在缓存系统中的优先级
-name:recyclebin_object_expire_time
require:false
type:TIME
default:0s
min_value:0s
max_value:NULL
section:ROOT_SERVICE
need_restart:false
description_en:recyclebin object expire time, default 0 that means auto purge recyclebin off.
description_en:warm up duration time for minor freeze.
description_local:小合并产生新转储文件的预热时间
-name:migrate_concurrency
require:false
type:INT
default:10
min_value:0
max_value:64
section:OBSERVER
need_restart:false
description_en:set concurrency of migration, set upper limit to migrate_concurrency and set lower limit to migrate_concurrency/2
description_local:控制内部数据迁移的并发度
-name:redundancy_level
require:false
type:STRING
default:NORMAL
min_value:NULL
max_value:NULL
section:SSTABLE
need_restart:false
description_en:EXTERNAL, use extrernal redundancy; NORMAL, tolerate one disk failure, HIGH tolerate two disk failure if disk count is enough
description_local:OB内置本地磁盘RAID特性。暂勿使用
-name:trx_2pc_retry_interval
require:false
type:TIME
default:100ms
min_value:1ms
max_value:5000ms
section:TRANS
need_restart:false
description_en:the time interval between the retries in case of failure during a transactions two-phase commit phase
description_local:两阶段提交失败时候自动重试的间隔
-name:cpu_count
name_local:系统CPU总数
require:false
essential:true
type:INT
default:0
min_value:0
max_value:NULL
section:OBSERVER
need_restart:true
description_en:the number of CPUs in the system. If this parameter is set to zero, the number will be set according to sysconf; otherwise, this parameter is used.
description_local:系统CPU总数,如果设置为0,将自动检测
-name:appname
require:false
type:STRING
default:obcluster
min_value:NULL
max_value:NULL
section:OBSERVER
need_redeploy:true
description_en:Name of the cluster
description_local:本OceanBase集群名
-name:use_large_pages
require:false
type:STRING
default:false
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:true
description_en:used to manage the databases use of large pages, values are false, true, only
description_en:disk water level to determine server balance strategy
description_local:磁盘水位线超过该阈值时,负载均衡策略将倾向于优先考虑磁盘均衡
-name:location_fetch_concurrency
require:false
type:INT
default:20
min_value:1
max_value:1000
section:LOCATION_CACHE
need_restart:false
description_en:the maximum number of the tasks which fetch the partition location information concurrently.
description_local:位置缓存信息刷新的最大并发度
-name:enable_async_syslog
require:false
type:BOOL
default:true
min_value:NULL
max_value:NULL
section:OBSERVER
need_restart:false
description_en:specifies whether use async syslog
description_local:是否启用系统日志异步写
-name:clog_sync_time_warn_threshold
require:false
type:TIME
default:1s
min_value:1ms
max_value:10000ms
section:TRANS
need_restart:false
description_en:the time given to the commit log synchronization between a leader and its followers before a warning message is printed in the log file.
description_local:事务日志同步耗时告警阈值,同步耗时超过该值产生WARN日志
-name:location_cache_cpu_quota
require:false
type:DOUBLE
default:5
min_value:0
max_value:10
section:TENANT
need_restart:false
description_en:the number of vCPUs allocated for the requests regarding location info of the core tables.
description_local:位置缓存模块使用的CPU配额
-name:bf_cache_priority
require:false
type:INT
default:1
min_value:1
max_value:NULL
section:CACHE
need_restart:false
description_en:bloomfilter cache priority
description_local:布隆过滤器占用缓存的优先级
-name:merger_check_interval
require:false
type:TIME
default:10m
min_value:10s
max_value:60m
section:DAILY_MERGE
need_restart:false
description_en:the time interval between the schedules of the task that checks on the progress of MERGE for each zone.
description_local:合并状态检查线程的调度间隔
-name:enable_rootservice_standalone
require:false
type:BOOL
default:false
min_value:NULL
max_value:NULL
section:ROOT_SERVICE
need_restart:false
description_en:specifies whether the SYS tenant is allowed to occupy an observer exclusively, thus running in the standalone mode.
description_local:是否让系统租户和RootService独占observer节点
-name:px_workers_per_cpu_quota
require:false
type:INT
default:10
min_value:0
max_value:20
section:TENANT
need_restart:false
description_en:the ratio between the number of system allocated px workers vs the maximum number of threads that can be scheduled concurrently.
description_local:并行执行工作线程数的比例
-name:large_query_threshold
require:false
type:TIME
default:100ms
min_value:1ms
max_value:NULL
section:TENANT
need_restart:false
description_en:threshold for execution time beyond which a request may be paused and rescheduled as large request
description_local:一个查询执行时间超过该阈值会被判断为大查询,执行大查询调度策略
-name:sys_bkgd_net_percentage
require:false
type:INT
default:60
min_value:0
max_value:100
section:OBSERVER
need_restart:false
description_en:the net percentage of sys background net.
description_local:后台系统任务可占用网络带宽百分比
-name:fuse_row_cache_priority
require:false
type:INT
default:1
min_value:1
max_value:NULL
section:CACHE
need_restart:false
description_en:fuse row cache priority
description_local:融合行缓存在缓存系统中的优先级
-name:rpc_timeout
require:false
type:TIME
default:2s
min_value:NULL
max_value:NULL
section:RPC
need_restart:false
description_en:the time during which a RPC request is permitted to execute before it is terminated
description_local:集群内部请求的超时时间
-name:tenant_task_queue_size
require:false
type:INT
default:65536
min_value:1024
max_value:NULL
section:OBSERVER
need_restart:false
description_en:the size of the task queue for each tenant.
description_local:每个租户的请求队列大小
-name:resource_soft_limit
require:false
type:INT
default:50
min_value:1
max_value:10000
section:LOAD_BALANCE
need_restart:false
description_en:Used along with resource_hard_limit in unit allocation. If server utilization is less than resource_soft_limit, a policy of best fit will be used for unit allocation; otherwise, a least loadpolicy will be employed. Ultimately,system utilization should not be large than resource_hard_limit.
description_local:当所有节点的资源水位低于该阈值时,不执行负载均衡
-name:plan_cache_evict_interval
require:false
type:TIME
default:1s
min_value:0s
max_value:NULL
section:TENANT
need_restart:false
description_en:time interval for periodic plan cache eviction.
description_local:执行计划缓存的淘汰间隔
-name:server_balance_cpu_mem_tolerance_percent
require:false
type:INT
default:5
min_value:1
max_value:100
section:LOAD_BALANCE
need_restart:false
description_en:specifies the tolerance (in percentage) of the unbalance of the cpu/memory utilization among all servers. The average cpu/memory utilization is calculated by dividing the total cpu/memory by the number of servers. server balancer will start a rebalancing task when the deviation between the average usage and some server load is greater than this tolerance
description_local:节点负载均衡策略中,CPU和内存资源不均衡的容忍度
-name:autoinc_cache_refresh_interval
require:false
type:TIME
default:3600s
min_value:100ms
max_value:NULL
section:OBSERVER
need_restart:false
description_en:auto-increment service cache refresh sync_value in this interval
description_local:自动刷新自增列值的时间间隔
-name:all_server_list
require:false
type:STRING
default:
min_value:NULL
max_value:NULL
section:LOCATION_CACHE
need_restart:false
description_en:all server addr in cluster
description_local:集群中所有机器的列表,不建议人工修改
-name:enable_rebalance
require:false
type:BOOL
default:true
min_value:NULL
max_value:NULL
section:LOAD_BALANCE
need_restart:false
description_en:specifies whether the partition load-balancing is turned on.
description_local:自动负载均衡开关
-name:internal_sql_execute_timeout
require:false
type:TIME
default:30s
min_value:1000us
max_value:10m
section:OBSERVER
need_restart:false
description_en:the number of microseconds an internal DML request is permitted to execute before it is terminated.
description_local:系统内部SQL请求的超时时间
-name:user_row_cache_priority
require:false
type:INT
default:1
min_value:1
max_value:NULL
section:CACHE
need_restart:false
description_en:user row cache priority
description_local:基线数据行缓存在缓存系统中的优先级
-name:server_permanent_offline_time
require:false
type:TIME
default:3600s
min_value:20s
max_value:NULL
section:ROOT_SERVICE
need_restart:false
description_en:the time interval between any two heartbeats beyond which a server is considered to be permanently offline.
description_en:the number of tablet replica info that will be read by each request on the tablet-related system tables during procedures such as load-balancing, daily merge, election and etc. Range:(0,65536]
description_local:Tablet meta table 迭代器使用过程中在内存里缓存的 Tablet 数量。
description_en:Production mode switch, default True. Adjust the memory_limit and __min_full_resource_pool_memory The lower bound of memory is adjusted to 16G and 2147483648
description_en:When logging_file_name is configured, specify the log file size through this configuration
-name:logging_file_total_size_cap
name_local:日志总大小
type:STRING
require:true
essential:true
default:1GB
need_restart:true
description_local:日志文件总大小
description_en:When logging_file_name is configured, specify the total log file size through this configuration
-name:port
name_local:端口
require:true
essential:true
type:INT
default:8180
need_restart:true
description_en:the port of ocp server.
description_local:OCP server使用的端口
-name:jdbc_url
require:false
type:STRING
need_redeploy:true
description_en:The jdbc connection url for ocp meta db
description_local:OCP使用的元数据库的jdbc连接串
-name:jdbc_username
require:false
type:STRING
need_redeploy:true
description_en:The username name for ocp meta db
description_local:OCP使用的元数据库的用户名
-name:jdbc_password
require:false
type:STRING
default:
need_redeploy:true
description_en:The password name for ocp meta db
description_local:OCP使用的元数据库的密码
-name:admin_passwd
require:true
type:STRING
modify_limit:modify
default:
need_redeploy:true
description_en:The password for ocp web admin user,The password must be 8 to 32 characters in length, and must contain at least two digits, two uppercase letters, two lowercase letters, and two of the following special characters:~!@#%^&*_-+=|(){}[]:;,.?/