From 8efa1796454cc02584b1105a626cb3c7302fa7b9 Mon Sep 17 00:00:00 2001 From: Yingchun Lai Date: Sat, 27 Jan 2024 18:49:19 +0800 Subject: [PATCH] Update config Chinese doc (#65) --- _docs/zh/administration/config.md | 389 ++++++++++++++---------------- 1 file changed, 176 insertions(+), 213 deletions(-) diff --git a/_docs/zh/administration/config.md b/_docs/zh/administration/config.md index 432ef233..d71acfb3 100644 --- a/_docs/zh/administration/config.md +++ b/_docs/zh/administration/config.md @@ -2,48 +2,48 @@ permalink: administration/config --- -## 配置组成部分 +# 配置组成部分 -Pegasus的配置为ini格式，主要有以下组成部分： +Pegasus 的配置为 ini 格式，主要有以下组成部分： -* core：一个Pegasus Service内核引擎运行时的相关参数配置。 -* network：RPC组件的相关参数配置。 -* 线程池相关：Pegasus进程中启动的各个线程池的相关参数配置。 -* app相关：app是rDSN中的一个概念，可以理解成分布式系统中的“组件”或者“job”，例如Pegasus中的MetaServer、ReplicaServer就各是一个app。一个进程内可以启动多个app，针对每个app，可以分别配置其行为，譬如名字、端口、线程池等。 -* task相关：task也是rDSN中的一个概念，可以理解成“异步任务”。比如一个RPC异步调用、一个异步文件IO操作、一个超时事件，都是一个task。每种task都有定义一个唯一的名字。针对每种task，都可以配置其相关的行为，譬如trace、profiler等。 -* 一致性协议相关：一致性replication协议的相关参数配置。 -* RocksDB相关：Pegasus所依赖的RocksDB的参数配置。 -* 其他杂项：Pegasus中一些组件模块的参数配置，譬如日志、监控、Zookeeper配置等。 +* core：一个 Pegasus Service 内核引擎运行时的相关参数配置。 +* network：RPC 组件的相关参数配置。 +* 线程池相关：Pegasus 进程中启动的各个线程池的相关参数配置。 +* app 相关：app 是 rDSN 中的一个概念，可以理解成分布式系统中的 “组件” 或者 “job”，例如 Pegasus 中的 MetaServer、ReplicaServer 就各是一个 app。一个进程内可以启动多个 app，针对每个 app，可以分别配置其行为，譬如名字、端口、线程池等。 +* task 相关：task 也是 rDSN 中的一个概念，可以理解成 “异步任务”。比如一个 RPC 异步调用、一个异步文件 IO 操作、一个超时事件，都是一个 task。每种 task 都有定义一个唯一的名字。针对每种 task，都可以配置其相关的行为，譬如 trace、profiler 等。 +* 一致性协议相关：一致性 replication 协议的相关参数配置。 +* RocksDB 相关：Pegasus 所依赖的 RocksDB 的参数配置。 +* 其他：Pegasus 中一些组件模块的参数配置，譬如日志、监控、Zookeeper 配置等。 -配置文件中会涉及到一些rDSN的概念，对这些概念的进一步理解，请参见[rDSN项目](https://github.com/XiaoMi/rdsn)。 +配置文件中会涉及到一些 rDSN 的概念，对这些概念的进一步理解，请参见 [rDSN 项目](https://github.com/XiaoMi/rdsn)。 -下面列举出了Pegasus配置文件的部分说明。这些配置项有些是和client通用的，比如app、task、threadpool等，其他是server端所独有的。要理解这些配置的真正含义，建议先阅读PacificA论文，并了解清楚rDSN项目和Pegasus架构。 +下面列举出了 Pegasus 配置文件的部分说明。这些配置项有些是和 client 通用的，比如 app、task、threadpool 等，其他是 server 端所独有的。要理解这些配置的真正含义，建议先阅读 PacificA 论文，并了解清楚 rDSN 项目和 Pegasus 架构。 -## 配置文件部分说明 +# 配置文件部分说明 ```ini -;;;; 各个app配置项的默认模板 +;;;; 各个 app 配置项的默认模板 [apps..default] run = true count = 1 -;;;; meta app的配置项 +;;;; meta app 的配置项 [apps.meta] type = meta name = meta -arguments = -;meta的运行端口 +arguments = +; meta 的运行端口 ports = 34601 -;meta app运行时需要的线程池 +; meta app 运行时需要的线程池 pools = THREAD_POOL_DEFAULT,THREAD_POOL_META_SERVER,THREAD_POOL_META_STATE,THREAD_POOL_FD,THREAD_POOL_DLOCK,THREAD_POOL_FDS_SERVICE run = true -;meta app的实例个数，每个实例的运行端口依次为ports, ports+1... -;可以用参数-app_list meta@1的方式启动指定的app -count = 3 +; meta app 的实例个数，每个实例的运行端口依次为 ports, ports+1... +; 可以用参数 - app_list meta@1 的方式启动指定的 app +count = 3 -;;;; replica app的配置项目 -[apps.replica] +;;;; replica app 的配置项目 +[apps.replica] type = replica name = replica arguments = @@ -52,276 +52,240 @@ pools = THREAD_POOL_DEFAULT,THREAD_POOL_REPLICATION_LONG,THREAD_POOL_REPLICATION run = true count = 1 -;;;; pegasus内核引擎运行参数 -[core] -;rDSN相关概念，参见rDSN文档 +;;;; pegasus 内核引擎运行参数 +[core] +; rDSN 相关概念，参见 rDSN 文档 tool = nativerun -;rDSN相关概念，参见rDSN文档 +; rDSN 相关概念，参见 rDSN 文档 toollets = profiler -;启动时是否暂停以等待交互输入 +; 启动时是否暂停以等待交互输入 pause_on_start = false -;logging级别 -logging_start_level = LOG_LEVEL_DEBUG -;logging的实现类 -logging_factory_name = dsn::tools::simple_logger -;进程退出时是否将缓存的日志数据刷出到文件系统 +; logging 级别 +logging_start_level = LOG_LEVEL_DEBUG +; logging 的实现类 +logging_factory_name = dsn::tools::simple_logger +; 进程退出时是否将缓存的日志数据刷出到文件系统 logging_flush_on_exit = true -;默认的数据文件夹 +; 默认的数据目录 data_dir = /home/work/data/pegasus/@cluster@ ;;;; 网络相关配置 [network] -;负责网络IO的线程个数 +; 负责网络 IO 的线程个数 io_service_worker_count = 4 -;每个客户端IP限制的连接数 +; 每个客户端 IP 限制的连接数 conn_threshold_per_ip = 0 ;;;; 线程池相关配置的默认模板 [threadpool..default] -;线程池的默认线程数 +; 线程池的默认线程数 worker_count = 4 -;;;; 线程池THREAD_POOL_REPLICATION的配置 +;;;; 线程池 THREAD_POOL_REPLICATION 的配置 [threadpool.THREAD_POOL_REPLICATION] -;线程池名称 +; 线程池名称 name = replica -;rDSN相关概念，partitioned = ture表示每个线程有一个自己的任务队列， -;且task会根据hash分派到特定的线程执行 -partitioned = true -;线程在OS中的调度优先级 +; rDSN 相关概念，partitioned = ture 表示每个线程有一个自己的任务队列，且 task 会根据 hash 规则分派到特定的线程执行 +partitioned = true +; 线程在 OS 中的调度优先级 worker_priority = THREAD_xPRIORITY_NORMAL -;线程池中的线程数，如果没有配置则使用默认模板的值 +; 线程池中的线程数，如果没有配置则使用默认模板的值 worker_count = 23 -;;;; 线程池XXXXX的相关配置 +;;;; 线程池 XXXXX 的相关配置 [threadpool.XXXXX] ..... -;;;; meta_server的相关配置 -[meta_server] -;MetaServer的地址列表 -server_list = 127.0.0.1:34601,127.0.0.1:34602,127.0.0.1:34603 -;MetaServer在元数据存储服务上的根目录， -;一个集群的不同meta_server要配成相同的值，不同的集群用不同的值 -cluster_root = /pegasus/my-cluster -;元数据存储服务的实现类 -meta_state_service_type = meta_state_service_zookeeper -;元数据存储服务的初始化参数 -meta_state_service_parameters = -;分布式锁服务的实现类 -distributed_lock_service_type = distributed_lock_service_zookeeper -;分布式锁服务的初始化参数 -distributed_lock_service_parameters = /pegasus/onebox/127.0.0.1 -;判断一个ReplicaServer是不是稳定运行的时间阈值 +;;;; meta_server 的相关配置 +[meta_server] +; MetaServer 的地址列表 +server_list = 127.0.0.1:34601,127.0.0.1:34602,127.0.0.1:34603; MetaServer 在元数据存储服务上的根目录，一个集群的不同 meta_server 要配成相同的值，不同的集群用不同的值 +cluster_root = /pegasus/my-cluster +; 元数据存储服务的实现类 +meta_state_service_type = meta_state_service_zookeeper +; 元数据存储服务的初始化参数 +meta_state_service_parameters = +; 分布式锁服务的实现类 +distributed_lock_service_type = distributed_lock_service_zookeeper +; 分布式锁服务的初始化参数 +distributed_lock_service_parameters = /pegasus/onebox/127.0.0.1 +; 判断一个 ReplicaServer 是不是稳定运行的时间阈值 stable_rs_min_running_seconds = 600 -;一个ReplicaServer最多可以崩溃的次数， -;如果崩溃太频繁，就会上MetaServer的黑名单 -max_succssive_unstable_restart = 5 -;负载均衡器的实现类 +; 一个 ReplicaServer 最多可以崩溃的次数，如果崩溃太频繁，就会上 MetaServer 的黑名单 +max_succssive_unstable_restart = 5 +; 负载均衡器的实现类 server_load_balancer_type = greedy_load_balancer -;当一个secondary被移除后，等待它回来的最长时间阈值 +; 当一个 secondary 被移除后，等待它回来的最长时间阈值 replica_assign_delay_ms_for_dropouts = 300000 -;如果不可用节点比例太高，MetaServer会进入freezed的保护状态 +; 如果不可用节点比例太高，MetaServer 会进入 freezed 的保护状态 node_live_percentage_threshold_for_update = 50 -;如果不可用的节点个数太少，MetaServer也会进入freezed的保护状态 +; 如果不可用的节点个数太少，MetaServer 也会进入 freezed 的保护状态 min_live_node_count_for_unfreeze = 3 -;表删除后在回收站中默认的保留时间 +; 表删除后在回收站中默认的保留时间 hold_seconds_for_dropped_app = 604800 -;MetaServer启动时的默认function_level状态， -;steady表示不进行负载均衡的稳定状态 +; MetaServer 启动时的默认 function_level 状态。steady 表示不进行负载均衡的稳定状态 meta_function_level_on_start = steady -;如果为true, 集群启动时就会进入“元数据恢复”流程 +; 如果为 true, 集群启动时就会进入 “元数据恢复” 流程 recover_from_replica_server = false -;一个replica group中最多保留的副本数(可用副本+尸体) -max_replicas_in_group = 4 +; 一个 replica group 中最多保留的副本数 (可用副本 + 尸体) +max_replicas_in_group = 4 -;;;; 集群在bootstrap时默认要创建的表 +;;;; 集群在 bootstrap 时默认要创建的表 [replication.app] -;表名 +; 表名 app_name = temp -;type表征了存储引擎，pegasus表示我们基于rocksdb实现的存储引擎 +; 存储引擎类型，pegasus 表示我们基于 rocksdb 实现的存储引擎。当前只可选 pegasus app_type = pegasus -;分片数 +; 分片数 partition_count = 8 -;每个分片的副本个数 +; 每个分片的副本个数 max_replica_count = 3 -;rDSN参数，对于app_type = pegasus需要设置为true +; rDSN 参数，对于 app_type = pegasus 需要设置为 true stateful = true -package_id = - -;;;; 一致性协议相关配置，很多概念和PacificA相关 -[replication] -;shared log存储的文件夹路径 -slog_dir = /home/work/ssd1/pegasus/@cluster@ -;replica数据存储的文件夹路径列表，建议一块磁盘配置一个项， -;tag为磁盘的标记名 -data_dirs = tag1:/home/work/ssd2/pegasus/@cluster@,tag2:/home/work/ssd3/pegasus/@cluster@ -;黑名单文件，文件中每行是一个需忽略掉的文件夹，主要用于过滤坏盘 +package_id = + +;;;; 一致性协议相关配置，很多概念和 PacificA 相关 +[replication] +; shared log 存储的文件夹路径（2.6开始已被移除） +slog_dir = /home/work/ssd1/pegasus/@cluster@ +; replica 数据存储的文件夹路径列表，建议一块磁盘配置一个项。tag 为磁盘的标记名 +data_dirs = tag1:/home/work/ssd2/pegasus/@cluster@,tag2:/home/work/ssd3/pegasus/@cluster@ +; 黑名单文件，文件中每行是一个需忽略掉的文件夹，主要用于过滤坏盘 data_dirs_black_list_file = /home/mi/.pegasus_data_dirs_black_list - -;ReplicaServer启动时是否要拒绝掉客户端写 +; ReplicaServer 启动时是否要拒绝掉客户端写 deny_client_on_start = false -;ReplicaServer启动时是否等待一段时间后才开始连接MetaServer -delay_for_fd_timeout_on_start = false -;是否打印commit log的调试信息 -verbose_log_on_commit = false -;primary会定期生成一个空的写操作以检查group状态，是否禁止该特性 +; ReplicaServer 启动时是否等待一段时间后才开始连接 MetaServer +delay_for_fd_timeout_on_start = false +; 是否打印 commit log 的调试信息 +verbose_log_on_commit = false +; primary 会定期生成一个空的写操作以检查 group 状态，是否禁止该特性 empty_write_disabled = false - -;prepare的超时时间 +; prepare 的超时时间 prepare_timeout_ms_for_secondaries = 1000 -;给learner发prepare的超时时间 -prepare_timeout_ms_for_potential_secondaries = 3000 - -;是否禁止掉客户端写请求的batch功能 +; 给 learner 发 prepare 的超时时间 +prepare_timeout_ms_for_potential_secondaries = 3000 +; 是否禁止掉客户端写请求的 batch 功能 batch_write_disabled = false -;保留多少个已经commit的写请求在队列中 +; 保留多少个已经 commit 的写请求在队列中 staleness_for_commit = 20 -;prepare_list的容量 -max_mutation_count_in_prepare_list = 110 -;想要成功进行一次写操作，最少需要多少个副本 -mutation_2pc_min_replica_count = 2 - -;primary会定期推送group状态给其他成员，是否禁用该特性 -group_check_disabled = false -;group check的时间间隔 -group_check_interval_ms = 100000 - -;是否禁用定期checkpoint的生成 -checkpoint_disabled = false -;checkpoint的尝试触发时间间隔，尝试触发并不一定生成checkpoint -checkpoint_interval_seconds = 100 +; prepare_list 的容量 +max_mutation_count_in_prepare_list = 110 +; 想要成功进行一次写操作，最少需要多少个副本 +mutation_2pc_min_replica_count = 2 +; primary 会定期推送 group 状态给其他成员，是否禁用该特性 +group_check_disabled = false +; group check 的时间间隔 +group_check_interval_ms = 100000 +; 是否禁用定期 checkpoint 的生成 +checkpoint_disabled = false +; checkpoint 的尝试触发时间间隔。注意尝试触发并不一定生成 checkpoint +checkpoint_interval_seconds = 100 checkpoint_min_decree_gap = 10000 -;checkpoint的强制触发时间间隔，强制触发会将memtable的数据刷出 -checkpoint_max_interval_hours = 1 - -;是否禁用WAL的垃圾回收 +; checkpoint 的强制触发时间间隔，强制触发会将 memtable 的数据刷出 +checkpoint_max_interval_hours = 1 +; 是否禁用 WAL 的垃圾回收 gc_disabled = false +; WAL 的垃圾回收间隔 gc_interval_ms = 30000 -;如果一个replica需要关闭，在内存中保留多长时间 +; 如果一个 replica 需要关闭，在内存中保留多长时间 gc_memory_replica_interval_ms = 300000 -;一个因为IO错误关闭掉的replica，在磁盘保留多长时间 +; 一个因为 IO 错误关闭掉的 replica，在磁盘保留多长时间 gc_disk_error_replica_interval_seconds = 172800000 - -;failure detector是否禁止 +; failure detector 相关参数 fd_disabled = false fd_check_interval_seconds = 5 fd_beacon_interval_seconds = 3 fd_lease_seconds = 10 fd_grace_seconds = 15 - -;每一个private log多大，超过了该阈值就滚动到下一个文件 -log_private_file_size_mb = 32 -;private log一个batch的最小容量 -log_private_batch_buffer_kb = 512 -;private log一个batch的最小条数 -log_private_batch_buffer_count = 512 -;超过该事件没写private log, 则强制刷一次 -log_private_batch_buffer_flush_interval_ms = 100000 +; 每一个 private log 多大，超过了该阈值就滚动到下一个文件 +log_private_file_size_mb = 32 +; private log 一个 batch 的最小容量 +log_private_batch_buffer_kb = 512 +; private log 一个 batch 的最小条数 +log_private_batch_buffer_count = 512 +; 超过该事件没写 private log, 则强制刷一次 +log_private_batch_buffer_flush_interval_ms = 100000 log_private_reserve_max_size_mb = 0 log_private_reserve_max_time_seconds = 0 - -;shared log多大，超过该阈值就滚动到下一个文件 -log_shared_file_size_mb = 32 +; shared log 多大，超过该阈值就滚动到下一个文件 +log_shared_file_size_mb = 32 log_shared_file_count_limit = 32 log_shared_batch_buffer_kb = 0 log_shared_force_flush = false - -;replica server会定期和meta server同步本机所服务的replica, -;该配置表示是否禁止这一特性 -config_sync_disabled = false -;同步的时间间隔 -config_sync_interval_ms = 30000 - -;meta server跑负载均衡的周期 -lb_interval_ms = 10000 - +; replica server 会定期和 meta server 同步本机所服务的 replica。该配置表示是否禁止这一特性 +config_sync_disabled = false +; 同步的时间间隔 +config_sync_interval_ms = 30000 +; meta server 跑负载均衡的周期 +lb_interval_ms = 10000 + +;;;; pegasus server 层相关配置 [pegasus.server] -;;; rocksdb相关配置 -;是否打印Pegasus中反应RocksDB运行情况的调试日志 +;;; rocksdb 相关配置 +; 是否打印 Pegasus 中反应 RocksDB 运行情况的调试日志 rocksdb_verbose_log = false -;RocksDB Get操作的慢日志阈值，如果操作时长超过了该数值， -;那么将会被写入日志。0代表不会写入 +; RocksDB Get 操作的慢日志阈值，如果操作时长超过了该数值，那么将会打印相关日志。0 代表不打印 rocksdb_abnormal_get_time_threshold_ns = 100000000 -;RocksDB Get操作的大key日志阈值，如果操作获取的value的长度大于该数值， -;那么将会被写入日志。0代表不会写入 +; RocksDB Get 操作的大 key 日志阈值，如果操作获取的 value 的长度大于该数值，那么将会打印相关日志。0 代表不打印 rocksdb_abnormal_get_size_threshold = 1000000 -;RocksDB Multi-Get操作的慢日志阈值，如果操作时长超过了该数值， -;那么将会被写入日志。0代表不会写入 +; RocksDB Multi-Get 操作的慢日志阈值，如果操作时长超过了该数值，那么将会打印相关日志。0 代表不打印 rocksdb_abnormal_multi_get_time_threshold_ns = 100000000 -;如果RocksDB Multi-Get操作的所有key-value的长度之和大于该数值， -;那么将会被写入日志。0代表不会写入 +; 如果 RocksDB Multi-Get 操作的所有 key-value 的长度之和大于该数值，那么将会打印相关日志。0 代表不打印 rocksdb_abnormal_multi_get_size_threshold = 10000000 -;如果RocksDB Multi-Get操作的key-value对数量超过了该数值， -;那么将会被写入日志。0代表不会写入 +; 如果 RocksDB Multi-Get 操作的 key-value 对数量超过了该数值，那么将会打印相关日志。0 代表不打印 rocksdb_abnormal_multi_get_iterate_count_threshold = 1000 -;单个memtable的最大size。 -;一旦memtable大小超过该数值，将会被标记为不可修改， -;并且会创建一个新的memtable。 -;然后，一个后台线程会把memtable的内容落盘到一个SST文件 +; 单个 memtable 的最大 size。一旦 memtable 大小超过该数值，将会被标记为不可修改，并且会创建一个新的 memtable。然后，一个后台线程会把 memtable 的内容落盘到一个 SST 文件 rocksdb_write_buffer_size = 67108864 -;memtable的最大数量，包括active-memtable和immutable-memtable， -;如果active memtable被填满，并且memtable的总数量大于该数值， -;那么将会被延缓写入 +; memtable 的最大数量，包括 active-memtable 和 immutable-memtable，如果 active memtable 被填满，并且 memtable 的总数量大于该数值，那么将会被延缓写入 rocksdb_max_write_buffer_number = 3 -;后台flush线程数量。flush线程在高优先级的线程池中 +; 后台 flush 线程数量。flush 线程在高优先级的线程池中 rocksdb_max_background_flushes = 4 -;后台compaction线程数量。compaction线程在低优先级的线程池中 +; 后台 compaction 线程数量。compaction 线程在低优先级的线程池中 rocksdb_max_background_compactions = 12 -;RocksDB LSM tree层数 -rocksdb_num_levels = 6 -;level 1层的文件大小最大为target_file_size_base字节 +; RocksDB LSM tree 层数 +rocksdb_num_levels = 6 +; level 1 层的文件大小最大为 target_file_size_base 字节 rocksdb_target_file_size_base = 67108864 -;每一层文件大小是其上一层的rocksdb_target_file_size_multiplier倍。 -;默认情况下rocksdb_target_file_size_multiplier是１， -;也就是说每层的文件大小相同 +; 每一层文件大小是其上一层的 rocksdb_target_file_size_multiplier 倍 rocksdb_target_file_size_multiplier = 1 -;level 1层中的所有文件的总大小 +; level 1 层中的所有文件的总大小 rocksdb_max_bytes_for_level_base = 671088640 -;每一层其所有总文件大小是其上一层的rocksdb_max_bytes_for_level_multiplier倍。 -;默认情况下rocksdb_max_bytes_for_level_multiplier是10， -;也就是说每层总文件大小是上一层的10倍。 -rocksdb_max_bytes_for_level_multiplier = 10 -;如果level 0中的文件数量超过了该指定数值，L0->L1 compaction将会被触发 +; 每一层其所有总文件大小是其上一层的 rocksdb_max_bytes_for_level_multiplier 倍 +rocksdb_max_bytes_for_level_multiplier = 10 +; 如果 level 0 中的文件数量超过了该指定数值，L0->L1 compaction 将会被触发 rocksdb_level0_file_num_compaction_trigger = 4 -;如果level 0中的文件数量超过了该指定数值，那么写入速度将会被降低 +; 如果 level 0 中的文件数量超过了该指定数值，那么写入速度将会被降低 rocksdb_level0_slowdown_writes_trigger = 30 -;如果level 0中的文件数量超过了该指定数值，那么写入将会被禁止 +; 如果 level 0 中的文件数量超过了该指定数值，那么写入将会被禁止 rocksdb_level0_stop_writes_trigger = 60 -;压缩算法类型, 支持 none，snappy，lz4，zstd几种选项。 -;支持为每一层单独配置压缩算法，用逗号分隔，如: -;“none,none,snappy,zstd” 表示L0，L1不进行压缩， -;L2使用snappy压缩，L3往下使用zstd压缩。 -rocksdb_compression_type = lz4 -;如果该值被设置为true，则表示禁用block cache功能 +; 压缩算法类型，支持 none，snappy，lz4，zstd 几种选项。支持为每一层单独配置压缩算法，用逗号分隔，如: “none,none,snappy,zstd” 表示 L0，L1 不进行压缩，L2 使用 snappy 压缩，L3 往下使用 zstd 压缩。 +rocksdb_compression_type = lz4 +; 如果该值被设置为 true，则表示禁用 block cache 功能 rocksdb_disable_table_block_cache = false -;进程中所有RocksDB实例共享的 Block Cache 内存容量，以 bytes为单位 +; 进程中所有 RocksDB 实例共享的 Block Cache 内存容量，以 bytes 为单位 rocksdb_block_cache_capacity = 10737418240 -;shard id的bit位数。 -;为了并发操作，block cache被分成很多shard, -;数量为2^rocksdb_block_ache_num_shard_bits个 -rocksdb_block_cache_num_shard_bits = -1 -;如果该值被设置为true,则表示禁用bloom filter功能 +; shard id 的 bit 位数。为了并发操作，block cache 被分成很多 shard，数量为 2^rocksdb_block_ache_num_shard_bits 个 +rocksdb_block_cache_num_shard_bits = -1 +; 如果该值被设置为 true, 则表示禁用 bloom filter 功能 rocksdb_disable_bloom_filter = false -;;; 监控相关配置，部分和小米的开源监控系统open-falcon相关 +;;; 监控相关配置，部分与 open-falcon 相关 perf_counter_cluster_name = onebox -;监控项的汇报周期 -perf_counter_update_interval_seconds = 10 -;是否允许直接向service拉去监控项 +; 监控项的汇报周期 +perf_counter_update_interval_seconds = 10 +; 是否允许直接向 service 拉去监控项 perf_counter_enable_stat = true -;是否允许把所有监控项打印到日志 +; 是否允许把所有监控项打印到日志 perf_counter_enable_logging = false -;是否允许把监控项推送到falcon +; 是否允许把监控项推送到 falcon perf_counter_enable_falcon = false - falcon_host = 127.0.0.1 falcon_port = 1988 falcon_path = /v1/push -;;;; task相关配置模板，里面的概念都和rDSN相关 +;;;; task 相关配置模板，里面的概念都和 rDSN 相关 [task..default] is_trace = false is_profile = false @@ -332,9 +296,9 @@ rpc_timeout_milliseconds = 5000 disk_write_fail_ratio = 0.0 disk_read_fail_ratio = 0.0 -;;;; task RPC_L2_CLIENT_READ的相关配置， -;选项均继承模板，自定义的部分表示该task需要监控的内容 -[task.RPC_L2_CLIENT_READ] +;;;; task RPC_L2_CLIENT_READ 的相关配置， +; 选项均继承模板，自定义的部分表示该 task 需要监控的内容 +[task.RPC_L2_CLIENT_READ] is_profile = true profiler::inqueue = false profiler::queue = false @@ -343,18 +307,17 @@ profiler::qps = false profiler::cancelled = false profiler::latency.server = false -;;;;;;; 以下是各种各样的杂项配置 ;;;; 监控实现类相关 [components.pegasus_perf_counter_number_percentile_atomic] counter_computation_interval_seconds = 10 -;;;; zookeeper相关 +;;;; zookeeper 相关 [zookeeper] hosts_list = 127.0.0.1:22181 timeout_ms = 10000 logfile = zoo.log -;;;; logger的实现类相关 +;;;; logger 的实现类相关 [tools.simple_logger] short_header = false fast_flush = false @@ -362,11 +325,11 @@ max_number_of_log_files_on_disk = 500 stderr_start_level = LOG_LEVEL_ERROR ``` -## 配置建议 +# 配置建议 一些配置建议： -* 配置文件中所有需要使用机器名的地方，都建议使用IP地址。 +* 配置文件中所有需要使用服务器地址的地方，都建议使用 IP 地址。 * 大部分配置项，建议使用默认值。 -* 对于高级用户，可以根据需要自行配置，但是前提是需要理解配置项的作用和影响。 -* 由于文档不能面面俱到，对配置项的作用不太清楚的，可以直接查看源代码。 +* 在理解配置项的作用和影响的前提下，可以根据需要自行更改配置值。 +* 对于配置项的进一步了解，可以查看源代码。