跳到主要内容

BE 配置项

该文档主要介绍 BE 的相关配置项。

BE 的配置文件 be.conf 通常存放在 BE 部署路径的 conf/ 目录下。而在 0.14 版本中会引入另一个配置文件 be_custom.conf。该配置文件用于记录用户在运行时动态配置并持久化的配置项。

BE 进程启动后,会先读取 be.conf 中的配置项,之后再读取 be_custom.conf 中的配置项。be_custom.conf 中的配置项会覆盖 be.conf 中相同的配置项。

查看配置项

有两种方式能够查看 BE 配置项:

  1. 通过 BE 前端页面查看

    在浏览器中打开 BE 前端页面: http://be_host:be_webserver_port/varz

  2. 通过命令行查看

    可以在 MySQL 客户端中,通过以下命令查看 BE 的配置项,具体语法参照SHOW-CONFIG

    SHOW BACKEND CONFIG;

    结果中各列含义如下:

    1. BackendId: backend 节点 ID。
    2. Host: backend 节点 IP。
    3. Key: 配置项名称。
    4. Value: 配置项的值。
    5. Type: 配置项值类型,如整型、字符串。
    6. 是否可以动态配置。如果为 true,表示该配置项可以在运行时进行动态配置。如果 false,则表示该配置项只能在 be.conf 中配置并且重启 FE 后生效。

设置配置项

BE 的配置项有两种方式进行配置:

  1. 静态配置

conf/be.conf 文件中添加和设置配置项。be.conf 中的配置项会在 BE 进行启动时被读取。没有在 be.conf 中的配置项将使用默认值。

  1. 动态配置

BE 启动后,可以通过以下命令动态设置配置项。

curl -X POST http://{be_ip}:{be_http_port}/api/update_config?{key}={value}

在 0.13 版本及之前,通过该方式修改的配置项将在 BE 进程重启后失效。在 0.14 及之后版本中,可以通过以下命令持久化修改后的配置。修改后的配置项存储在 be_custom.conf 文件中。

curl -X POST http://{be_ip}:{be_http_port}/api/update_config?{key}={value}\&persist=true

应用举例

  1. 静态方式修改 max_base_compaction_threads

通过在 be.conf 文件中添加:

max_base_compaction_threads=5

之后重启 BE 进程以生效该配置。

  1. 动态方式修改 streaming_load_max_mb

BE 启动后,通过下面命令动态设置配置项 streaming_load_max_mb:

curl -X POST http://{be_ip}:{be_http_port}/api/update_config?streaming_load_max_mb=1024

返回值如下,则说明设置成功。

{
"status": "OK",
"msg": ""
}

BE 重启后该配置将失效。如果想持久化修改结果,使用如下命令:

curl -X POST http://{be_ip}:{be_http_port}/api/update_config?streaming_load_max_mb=1024\&persist=true

配置项列表

服务

be_port

  • 类型:int32
  • 描述:BE 上 Thrift Server 的端口号,用于接收来自 FE 的请求
  • 默认值:9060

heartbeat_service_port

  • 类型:int32
  • 描述:BE 上心跳服务端口(Thrift),用于接收来自 FE 的心跳
  • 默认值:9050

webserver_port

  • 类型:int32
  • 描述:BE 上的 HTTP Server 的服务端口
  • 默认值:8040

brpc_port

  • 类型:int32
  • 描述:BE 上的 brpc 的端口,用于 BE 之间通讯
  • 默认值:8060

arrow_flight_sql_port

  • 类型:int32
  • 描述:FE 上的 Arrow Flight SQL Server 的端口,用于从 Arrow Flight Client 和 BE 之间通讯
  • 默认值:-1

enable_https

  • 类型:bool
  • 描述:是否支持 https. 如果是,需要在 be.conf 中配置ssl_certificate_pathssl_private_key_path
  • 默认值:false

priority_networks

  • 描述:为那些有很多 ip 的服务器声明一个选择策略。请注意,最多应该有一个 ip 与此列表匹配。这是一个以分号分隔格式的列表,用 CIDR 表示法,例如 10.10.10.0/24,如果没有匹配这条规则的 ip,会随机选择一个。
  • 默认值:空

storage_root_path

  • 类型:string

  • 描述:BE 数据存储的目录,多目录之间用英文状态的分号;分隔。可以通过路径区别存储目录的介质,HDD 或 SSD。可以添加容量限制在每个路径的末尾,通过英文状态逗号,隔开。如果用户不是 SSD 和 HDD 磁盘混合使用的情况,不需要按照如下示例一和示例二的配置方法配置,只需指定存储目录即可;也不需要修改 FE 的默认存储介质配置

    示例 1 如下:

    注意:如果是 SSD 磁盘要在目录后面加上.SSD,HDD 磁盘在目录后面加.HDD

    storage_root_path=/home/disk1/doris.HDD;/home/disk2/doris.SSD;/home/disk2/doris

    说明

    • /home/disk1/doris.HDD,表示存储介质是HDD;
    • /home/disk2/doris.SSD,表示存储介质是SSD;
    • /home/disk2/doris,存储介质默认为HDD

    示例 2 如下:

    注意:不论 HHD 磁盘目录还是 SSD 磁盘目录,都无需添加后缀,storage_root_path 参数里指定 medium 即可

    storage_root_path=/home/disk1/doris,medium:hdd;/home/disk2/doris,medium:ssd

    说明

    • /home/disk1/doris,medium:hdd,表示存储介质是HHD;
    • /home/disk2/doris,medium:ssd,表示存储介质是SSD;
  • 默认值:${DORIS_HOME}/storage

heartbeat_service_thread_count

  • 类型:int32
  • 描述:执行 BE 上心跳服务的线程数,默认为 1,不建议修改
  • 默认值:1

ignore_broken_disk

  • 类型:bool

  • 描述:当 BE 启动时,会检查storage_root_path 配置下的所有路径。

    • ignore_broken_disk=true

    如果路径不存在或路径下无法进行读写文件 (坏盘),将忽略此路径,如果有其他可用路径则不中断启动。

    • ignore_broken_disk=false

    如果路径不存在或路径下无法进行读写文件 (坏盘),将中断启动失败退出。

  • 默认值:false

mem_limit

  • 类型:string
  • 描述:限制 BE 进程使用服务器最大内存百分比。用于防止 BE 内存挤占太多的机器内存,该参数必须大于 0,当百分大于 100% 之后,该值会默认为 100%。
  • 默认值:90%

cluster_id

  • 类型:int32
  • 描述:配置 BE 的所属于的集群 id。
    • 该值通常由 FE 通过心跳向 BE 下发,不需要额外进行配置。当确认某 BE 属于某一个确定的 Doris 集群时,可以进行配置,同时需要修改数据目录下的 cluster_id 文件,使二者相同。
  • 默认值:-1

custom_config_dir

  • 描述:配置 be_custom.conf 文件的位置。默认为 conf/ 目录下。
    • 在某些部署环境下,conf/目录可能因为系统的版本升级被覆盖掉。这会导致用户在运行是持久化修改的配置项也被覆盖。这时,我们可以将 be_custom.conf 存储在另一个指定的目录中,以防止配置文件被覆盖。
  • 默认值:空

trash_file_expire_time_sec

  • 描述:回收站清理的间隔,24 个小时,当磁盘空间不足时,trash 下的文件保存期可不遵守这个参数
  • 默认值:86400

es_http_timeout_ms

  • 描述:通过 http 连接 ES 的超时时间,默认是 5 秒
  • 默认值:5000 (ms)

es_scroll_keepalive

  • 描述:es scroll keep-alive 保持时间,默认 5 分钟
  • 默认值:5 (m)

external_table_connect_timeout_sec

  • 类型:int32
  • 描述:和外部表建立连接的超时时间。
  • 默认值:5 秒

pipeline_status_report_interval

  • 描述:配置文件报告之间的间隔;单位:秒
  • 默认值:5

brpc_max_body_size

  • 描述:这个配置主要用来修改 brpc 的参数 max_body_size

    • 有时查询失败,在 BE 日志中会出现 body_size is too large 的错误信息。这可能发生在 SQL 模式为 multi distinct + 无 group by + 超过 1T 数据量的情况下。这个错误表示 brpc 的包大小超过了配置值。此时可以通过调大该配置避免这个错误。

brpc_socket_max_unwritten_bytes

  • 描述:这个配置主要用来修改 brpc 的参数 socket_max_unwritten_bytes

    • 有时查询失败,BE 日志中会出现 The server is overcrowded 的错误信息,表示连接上有过多的未发送数据。当查询需要发送较大的 bitmap 字段时,可能会遇到该问题,此时可能通过调大该配置避免该错误。

transfer_large_data_by_brpc

  • 类型:bool
  • 描述:该配置用来控制是否在 Tuple/Block data 长度大于 1.8G 时,将 protoBuf request 序列化后和 Tuple/Block data 一起嵌入到 controller attachment 后通过 http brpc 发送。为了避免 protoBuf request 的长度超过 2G 时的错误:Bad request, error_text=[E1003]Fail to compress request。在过去的版本中,曾将 Tuple/Block data 放入 attachment 后通过默认的 baidu_std brpc 发送,但 attachment 超过 2G 时将被截断,通过 http brpc 发送不存在 2G 的限制。
  • 默认值:true

brpc_num_threads

  • 描述:该配置主要用来修改 brpc 中 bthreads 的数量。该配置的默认值被设置为 -1, 这意味着 bthreads 的数量将被设置为机器的 cpu 核数。

    • 用户可以将该配置的值调大来获取更好的 QPS 性能。更多的信息可以参考https://github.com/apache/incubator-brpc/blob/master/docs/cn/benchmark.md
  • 默认值:-1

thrift_rpc_timeout_ms

  • 描述:Thrift 默认超时时间
  • 默认值:60000

thrift_client_retry_interval_ms

  • 类型:int64
  • 描述:用来为 be 的 thrift 客户端设置重试间隔,避免 FE 的 Thrift Server 发生雪崩问题,单位为 ms。
  • 默认值:1000

thrift_connect_timeout_seconds

  • 描述:默认 Thrift 客户端连接超时时间
  • 默认值:3 (s)

thrift_server_type_of_fe

  • 类型:string

  • 描述:该配置表示 FE 的 Thrift 服务使用的服务模型,类型为 string, 大小写不敏感,该参数需要和 FE 的 thrift_server_type 参数的设置保持一致。目前该参数的取值有两个,THREADEDTHREAD_POOL

    • 若该参数为THREADED, 该模型为非阻塞式 I/O 模型,

    • 若该参数为THREAD_POOL, 该模型为阻塞式 I/O 模型。

thrift_max_message_size

默认值:100MB

Thrift 服务器接收请求消息的大小(字节数)上限。如果客户端发送的消息大小超过该值,那么 Thrift 服务器会拒绝该请求并关闭连接,这种情况下,client 会遇到错误:“connection has been closed by peer”,使用者可以尝试增大该参数以绕过上述限制。

txn_commit_rpc_timeout_ms

  • 描述:txn 提交 rpc 超时
  • 默认值:60000 (ms)

txn_map_shard_size

  • 描述:txn_map_lock 分片大小,取值为 2^n,n=0,1,2,3,4。这是一项增强功能,可提高管理 txn 的性能
  • 默认值:128

txn_shard_size

  • 描述:txn_lock 分片大小,取值为 2^n,n=0,1,2,3,4,这是一项增强功能,可提高提交和发布 txn 的性能
  • 默认值:1024

unused_rowset_monitor_interval

  • 描述:清理过期 Rowset 的时间间隔
  • 默认值:30 (s)

max_client_cache_size_per_host

  • 描述:每个主机的最大客户端缓存数,BE 中有多种客户端缓存,但目前我们使用相同的缓存大小配置。如有必要,使用不同的配置来设置不同的客户端缓存。
  • 默认值:10

string_type_length_soft_limit_bytes

  • 类型:int32
  • 描述:String 类型最大长度的软限,单位是字节
  • 默认值:1048576

big_column_size_buffer

  • 类型:int64
  • 描述:当使用 odbc 外表时,如果 odbc 源表的某一列类型为 HLL, CHAR 或者 VARCHAR,并且列值长度超过该值,则查询报错'column value length longer than buffer length'. 可增大该值
  • 默认值:65535

small_column_size_buffer

  • 类型:int64
  • 描述:当使用 odbc 外表时,如果 odbc 源表的某一列类型不是 HLL, CHAR 或者 VARCHAR,并且列值长度超过该值,则查询报错'column value length longer than buffer length'. 可增大该值
  • 默认值:100

查询

fragment_mgr_asynic_work_pool_queue_size

  • 描述:单节点上异步任务的队列上限
  • 默认值:4096

fragment_mgr_asynic_work_pool_thread_num_min

  • 描述:处理异步任务的线程数,默认最小启动 16 个线程。
  • 默认值:16

fragment_mgr_asynic_work_pool_thread_num_max

  • 描述:根据后续任务动态创建线程,最大创建 512 个线程。
  • 默认值:512

doris_scanner_row_num

  • 描述:每个扫描线程单次执行最多返回的数据行数
  • 默认值:16384

doris_scanner_row_bytes

  • 描述:每个扫描线程单次执行最多返回的数据字节
    • 说明:如果表的列数太多,遇到 select * 卡主,可以调整这个配置
  • 默认值:10485760

doris_scanner_thread_pool_queue_size

  • 类型:int32
  • 描述:Scanner 线程池的队列长度。在 Doris 的扫描任务之中,每一个 Scanner 会作为一个线程 Task 提交到线程池之中等待被调度,而提交的任务数目超过线程池队列的长度之后,后续提交的任务将阻塞直到队列之中有新的空缺。
  • 默认值:102400

doris_scanner_thread_pool_thread_num

  • 类型:int32
  • 描述:Scanner 线程池线程数目。在 Doris 的扫描任务之中,每一个 Scanner 会作为一个线程 Task 提交到线程池之中等待被调度,该参数决定了 Scanner 线程池的大小。
  • 默认值:48

doris_max_remote_scanner_thread_pool_thread_num

  • 类型:int32
  • 描述:Remote scanner thread pool 的最大线程数。Remote scanner thread pool 用于除内表外的所有 scan 任务的执行。
  • 默认值:512

exchg_node_buffer_size_bytes

  • 类型:int32
  • 描述:ExchangeNode 节点 Buffer 队列的大小,单位为 byte。来自 Sender 端发送的数据量大于 ExchangeNode 的 Buffer 大小之后,后续发送的数据将阻塞直到 Buffer 腾出可写入的空间。
  • 默认值:10485760

doris_scan_range_max_mb

  • 类型:int32
  • 描述:每个 OlapScanner 读取的最大数据量
  • 默认值:1024

compaction

disable_auto_compaction

  • 类型:bool
  • 描述:关闭自动执行 compaction 任务
    • 一般需要为关闭状态,当调试或测试环境中想要手动操作 compaction 任务时,可以对该配置进行开启
  • 默认值:false

enable_vertical_compaction

  • 类型:bool
  • 描述:是否开启列式 compaction
  • 默认值:true

vertical_compaction_num_columns_per_group

  • 类型:int32
  • 描述:在列式 compaction 中,组成一个合并组的列个数
  • 默认值:5

vertical_compaction_max_row_source_memory_mb

  • 类型:int32
  • 描述:在列式 compaction 中,row_source_buffer 能使用的最大内存,单位是 MB。
  • 默认值:200

vertical_compaction_max_segment_size

  • 类型:int32
  • 描述:在列式 compaction 中,输出的 segment 文件最大值,单位是 m 字节。
  • 默认值:268435456

enable_ordered_data_compaction

  • 类型:bool
  • 描述:是否开启有序数据的 compaction
  • 默认值:true

ordered_data_compaction_min_segment_size

  • 类型:int32
  • 描述:在有序数据 compaction 中,满足要求的最小 segment 大小,单位是 m 字节。
  • 默认值:10485760

max_base_compaction_threads

  • 类型:int32
  • 描述:Base Compaction 线程池中线程数量的最大值,-1 表示每个磁盘一个线程。
  • 默认值:4

generate_compaction_tasks_interval_ms

  • 描述:生成 compaction 作业的最小间隔时间
  • 默认值:10(ms)

base_compaction_min_rowset_num

  • 描述:BaseCompaction 触发条件之一:Cumulative 文件数目要达到的限制,达到这个限制之后会触发 BaseCompaction
  • 默认值:5

base_compaction_min_data_ratio

  • 描述:BaseCompaction 触发条件之一:Cumulative 文件大小达到 Base 文件的比例。
  • 默认值:0.3(30%)

total_permits_for_compaction_score

  • 类型:int64
  • 描述:被所有的 compaction 任务所能持有的 "permits" 上限,用来限制 compaction 占用的内存。
  • 默认值:10000
  • 可动态修改:是

compaction_promotion_size_mbytes

  • 类型:int64
  • 描述:cumulative compaction 的输出 rowset 总磁盘大小超过了此配置大小,该 rowset 将用于 base compaction。单位是 m 字节。
    • 一般情况下,配置在 2G 以内,为了防止 cumulative compaction 时间过长,导致版本积压。
  • 默认值:1024

compaction_promotion_ratio

  • 类型:double
  • 描述:cumulative compaction 的输出 rowset 总磁盘大小超过 base 版本 rowset 的配置比例时,该 rowset 将用于 base compaction。
    • 一般情况下,建议配置不要高于 0.1,低于 0.02。
  • 默认值:0.05

compaction_promotion_min_size_mbytes

  • 类型:int64
  • 描述:Cumulative compaction 的输出 rowset 总磁盘大小低于此配置大小,该 rowset 将不进行 base compaction,仍然处于 cumulative compaction 流程中。单位是 m 字节。
    • 一般情况下,配置在 512m 以内,配置过大会导致 base 版本早期的大小过小,一直不进行 base compaction。
  • 默认值:128

compaction_min_size_mbytes

  • 类型:int64
  • 描述:cumulative compaction 进行合并时,选出的要进行合并的 rowset 的总磁盘大小大于此配置时,才按级别策略划分合并。小于这个配置时,直接执行合并。单位是 m 字节。
    • 一般情况下,配置在 128m 以内,配置过大会导致 cumulative compaction 写放大较多。
  • 默认值:64

default_rowset_type

  • 类型:string
  • 描述:标识 BE 默认选择的存储格式,可配置的参数为:"ALPHA", "BETA"。主要起以下两个作用
    • 当建表的 storage_format 设置为 Default 时,通过该配置来选取 BE 的存储格式。
    • 进行 Compaction 时选择 BE 的存储格式
  • 默认值:BETA

cumulative_compaction_min_deltas

  • 描述:cumulative compaction 策略:最小增量文件的数量
  • 默认值:5

cumulative_compaction_max_deltas

  • 描述:cumulative compaction 策略:最大增量文件的数量
  • 默认值:1000

base_compaction_trace_threshold

  • 类型:int32
  • 描述:打印 base compaction 的 trace 信息的阈值,单位秒
  • 默认值:10

base compaction 是一个耗时较长的后台操作,为了跟踪其运行信息,可以调整这个阈值参数来控制 trace 日志的打印。打印信息如下:

W0610 11:26:33.804431 56452 storage_engine.cpp:552] execute base compaction cost 0.00319222
BaseCompaction:546859:
- filtered_rows: 0
- input_row_num: 10
- input_rowsets_count: 10
- input_rowsets_data_size: 2.17 KB
- input_segments_num: 10
- merge_rowsets_latency: 100000.510ms
- merged_rows: 0
- output_row_num: 10
- output_rowset_data_size: 224.00 B
- output_segments_num: 1
0610 11:23:03.727535 (+ 0us) storage_engine.cpp:554] start to perform base compaction
0610 11:23:03.728961 (+ 1426us) storage_engine.cpp:560] found best tablet 546859
0610 11:23:03.728963 (+ 2us) base_compaction.cpp:40] got base compaction lock
0610 11:23:03.729029 (+ 66us) base_compaction.cpp:44] rowsets picked
0610 11:24:51.784439 (+108055410us) compaction.cpp:46] got concurrency lock and start to do compaction
0610 11:24:51.784818 (+ 379us) compaction.cpp:74] prepare finished
0610 11:26:33.359265 (+101574447us) compaction.cpp:87] merge rowsets finished
0610 11:26:33.484481 (+125216us) compaction.cpp:102] output rowset built
0610 11:26:33.484482 (+ 1us) compaction.cpp:106] check correctness finished
0610 11:26:33.513197 (+ 28715us) compaction.cpp:110] modify rowsets finished
0610 11:26:33.513300 (+ 103us) base_compaction.cpp:49] compaction finished
0610 11:26:33.513441 (+ 141us) base_compaction.cpp:56] unused rowsets have been moved to GC queue

cumulative_compaction_trace_threshold

  • 类型:int32
  • 描述:打印 cumulative compaction 的 trace 信息的阈值,单位秒
    • 与 base_compaction_trace_threshold 类似。
  • 默认值:2

compaction_task_num_per_disk

  • 类型:int32
  • 描述:每个磁盘(HDD)可以并发执行的 compaction 任务数量。
  • 默认值:4

compaction_task_num_per_fast_disk

  • 类型:int32
  • 描述:每个高速磁盘(SSD)可以并发执行的 compaction 任务数量。
  • 默认值:8

cumulative_compaction_rounds_for_each_base_compaction_round

  • 类型:int32
  • 描述:Compaction 任务的生产者每次连续生产多少轮 cumulative compaction 任务后生产一轮 base compaction。
  • 默认值:9

max_cumu_compaction_threads

  • 类型:int32
  • 描述:Cumulative Compaction 线程池中线程数量的最大值,-1 表示每个磁盘一个线程。
  • 默认值:-1

enable_segcompaction

  • 类型:bool
  • 描述:在导入时进行 segment compaction 来减少 segment 数量,以避免出现写入时的 -238 错误
  • 默认值:true

segcompaction_batch_size

  • 类型:int32
  • 描述:当 segment 数量超过此阈值时触发 segment compaction
  • 默认值:10

segcompaction_candidate_max_rows

  • 类型:int32
  • 描述:当 segment 的行数超过此大小时则会在 segment compaction 时被 compact,否则跳过
  • 默认值:1048576

segcompaction_batch_size

  • 类型:int32
  • 描述:单个 segment compaction 任务中的最大原始 segment 数量。
  • 默认值:10

segcompaction_candidate_max_rows

  • 类型:int32
  • 描述:segment compaction 任务中允许的单个原始 segment 行数,过大的 segment 将被跳过。
  • 默认值:1048576

segcompaction_candidate_max_bytes

  • 类型:int64
  • 描述:segment compaction 任务中允许的单个原始 segment 大小(字节),过大的 segment 将被跳过。
  • 默认值:104857600

segcompaction_task_max_rows

  • 类型:int32
  • 描述:单个 segment compaction 任务中允许的原始 segment 总行数。
  • 默认值:1572864

segcompaction_task_max_bytes

  • 类型:int64
  • 描述:单个 segment compaction 任务中允许的原始 segment 总大小(字节)。
  • 默认值:157286400

segcompaction_num_threads

  • 类型:int32
  • 描述:segment compaction 线程池大小。
  • 默认值:5

disable_compaction_trace_log

  • 类型:bool
  • 描述:关闭 compaction 的 trace 日志
    • 如果设置为 true,cumulative_compaction_trace_thresholdbase_compaction_trace_threshold 将不起作用。并且 trace 日志将关闭。
  • 默认值:true

pick_rowset_to_compact_interval_sec

  • 类型:int64
  • 描述:选取 rowset 去合并的时间间隔,单位为秒
  • 默认值:86400

max_single_replica_compaction_threads

  • 类型:int32
  • 描述:Single Replica Compaction 线程池中线程数量的最大值,-1 表示每个磁盘一个线程。
  • 默认值:-1

update_replica_infos_interval_seconds

  • 描述:更新 peer replica infos 的最小间隔时间
  • 默认值:60(s)

导入

enable_stream_load_record

  • 类型:bool
  • 描述:是否开启 stream load 操作记录,默认是不启用
  • 默认值:false

load_data_reserve_hours

  • 描述:用于 mini load。mini load 数据文件将在此时间后被删除
  • 默认值:4(h)

push_worker_count_high_priority

  • 描述:导入线程数,用于处理 HIGH 优先级任务
  • 默认值:3

push_worker_count_normal_priority

  • 描述:导入线程数,用于处理 NORMAL 优先级任务
  • 默认值:3

enable_single_replica_load

  • 描述:是否启动单副本数据导入功能
  • 默认值:true

load_error_log_reserve_hours

  • 描述:load 错误日志将在此时间后删除
  • 默认值:48(h)

load_error_log_limit_bytes

  • 描述:load 错误日志大小超过此值将被截断
  • 默认值:209715200 (byte)

load_process_max_memory_limit_percent

  • 描述:单节点上所有的导入线程占据的内存上限比例
    • 将这些默认值设置得很大,因为我们不想在用户升级 Doris 时影响负载性能。如有必要,用户应正确设置这些配置。
  • 默认值:50(%)

load_process_soft_mem_limit_percent

  • 描述:soft limit 是指站单节点导入内存上限的比例。例如所有导入任务导入的内存上限是 20GB,则 soft limit 默认为该值的 50%,即 10GB。导入内存占用超过 soft limit 时,会挑选占用内存最大的作业进行下刷以提前释放内存空间。
  • 默认值:50(%)

slave_replica_writer_rpc_timeout_sec

  • 类型:int32
  • 描述:单副本数据导入功能中,Master 副本和 Slave 副本之间通信的 RPC 超时时间。
  • 默认值:60

max_segment_num_per_rowset

  • 类型:int32
  • 描述:用于限制导入时,新产生的 rowset 中的 segment 数量。如果超过阈值,导入会失败并报错 -238。过多的 segment 会导致 compaction 占用大量内存引发 OOM 错误。
  • 默认值:200

high_priority_flush_thread_num_per_store

  • 类型:int32
  • 描述:每个存储路径所分配的用于高优导入任务的 flush 线程数量。
  • 默认值:1

routine_load_consumer_pool_size

  • 类型:int32
  • 描述:routine load 所使用的 data consumer 的缓存数量。
  • 默认值:10

multi_table_batch_plan_threshold

  • 类型:int32
  • 描述:一流多表使用该配置,表示攒多少条数据再进行规划。过小的值会导致规划频繁,多大的值会增加内存压力和导入延迟。
  • 默认值:200

multi_table_max_wait_tables

  • 类型:int32
  • 描述:一流多表使用该配置,如果等待执行的表的数量大于此阈值,将请求并执行所有相关表的计划。该参数旨在避免一次同时请求和执行过多的计划。将导入过程的多表进行小批处理,可以减少单次 rpc 的压力,同时可以提高导入数据处理的实时性。
  • 默认值:5

single_replica_load_download_num_workers

  • 类型:int32
  • 描述:单副本数据导入功能中,Slave 副本通过 HTTP 从 Master 副本下载数据文件的工作线程数。导入并发增大时,可以适当调大该参数来保证 Slave 副本及时同步 Master 副本数据。必要时也应相应地调大webserver_num_workers来提高 IO 效率。
  • 默认值:64

load_task_high_priority_threshold_second

  • 类型:int32
  • 描述:当一个导入任务的超时时间小于这个阈值是,Doris 将认为他是一个高优任务。高优任务会使用独立的 flush 线程池。
  • 默认:120

min_load_rpc_timeout_ms

  • 类型:int32
  • 描述:load 作业中各个 rpc 的最小超时时间。
  • 默认:20

kafka_api_version_request

  • 类型:bool
  • 描述:如果依赖的 kafka 版本低于 0.10.0.0, 该值应该被设置为 false。
  • 默认:true

kafka_broker_version_fallback

  • 描述:如果依赖的 kafka 版本低于 0.10.0.0, 当 kafka_api_version_request 值为 false 的时候,将使用回退版本 kafka_broker_version_fallback 设置的值,有效值为:0.9.0.x、0.8.x.y。
  • 默认:0.10.0

max_consumer_num_per_group

  • 描述:一个数据消费者组中的最大消费者数量,用于 routine load。
  • 默认:3

streaming_load_max_mb

  • 类型:int64
  • 描述:用于限制数据格式为 csv 的一次 Stream load 导入中,允许的最大数据量。
    • Stream Load 一般适用于导入几个 GB 以内的数据,不适合导入过大的数据。
  • 默认值:10240(MB)
  • 可动态修改:是

streaming_load_json_max_mb

  • 类型:int64
  • 描述:用于限制数据格式为 json 的一次 Stream load 导入中,允许的最大数据量。单位 MB。
    • 一些数据格式,如 JSON,无法进行拆分处理,必须读取全部数据到内存后才能开始解析,因此,这个值用于限制此类格式数据单次导入最大数据量。
  • 默认值:100
  • 可动态修改:是

olap_table_sink_send_interval_microseconds.

  • 描述:数据导入时,Coordinator 的 sink 节点有一个轮询线程持续向对应 BE 发送数据。该线程将每隔 olap_table_sink_send_interval_microseconds 微秒检查是否有数据要发送。
  • 默认值:1000

olap_table_sink_send_interval_auto_partition_factor.

  • 描述:如果我们向一个启用了自动分区的表导入数据,那么 olap_table_sink_send_interval_microseconds 的时间间隔就会太慢。在这种情况下,实际间隔将乘以该系数。
  • 默认值:0.001

线程

delete_worker_count

  • 描述:执行数据删除任务的线程数
  • 默认值:3

clear_transaction_task_worker_count

  • 描述:用于清理事务的线程数
  • 默认值:1

clone_worker_count

  • 描述:用于执行克隆任务的线程数
  • 默认值:3

be_service_threads

  • 类型:int32
  • 描述:BE 上 Thrift Server Service 的执行线程数,代表可以用于执行 FE 请求的线程数。
  • 默认值:64

download_worker_count

  • 描述:下载线程数
  • 默认值:1

drop_tablet_worker_count

  • 描述:删除 tablet 的线程数
  • 默认值:3

flush_thread_num_per_store

  • 描述:每个 store 用于刷新内存表的线程数
  • 默认值:2

publish_version_worker_count

  • 描述:生效版本的线程数
  • 默认值:8

upload_worker_count

  • 描述:上传文件最大线程数
  • 默认值:1

webserver_num_workers

  • 描述:webserver 默认工作线程数
  • 默认值:48

send_batch_thread_pool_thread_num

  • 类型:int32
  • 描述:SendBatch 线程池线程数目。在 NodeChannel 的发送数据任务之中,每一个 NodeChannel 的 SendBatch 操作会作为一个线程 Task 提交到线程池之中等待被调度,该参数决定了 SendBatch 线程池的大小。
  • 默认值:64

send_batch_thread_pool_queue_size

  • 类型:int32
  • 描述:SendBatch 线程池的队列长度。在 NodeChannel 的发送数据任务之中,每一个 NodeChannel 的 SendBatch 操作会作为一个线程 Task 提交到线程池之中等待被调度,而提交的任务数目超过线程池队列的长度之后,后续提交的任务将阻塞直到队列之中有新的空缺。
  • 默认值:102400

make_snapshot_worker_count

  • 描述:制作快照的线程数
  • 默认值:5

release_snapshot_worker_count

  • 描述:释放快照的线程数
  • 默认值:5

内存

max_memory_sink_batch_count

  • 描述:最大外部扫描缓存批次计数,表示缓存 max_memory_cache_batch_count * batch_size row,默认为 20,batch_size 的默认值为 1024,表示将缓存 20 * 1024 行。
  • 默认值:20

memtable_mem_tracker_refresh_interval_ms

  • 描述:memtable 主动下刷时刷新内存统计的周期(毫秒)
  • 默认值:100

zone_map_row_num_threshold

  • 类型:int32
  • 描述:如果一个 page 中的行数小于这个值就不会创建 zonemap,用来减少数据膨胀。
  • 默认值:20

memory_mode

  • 类型:string
  • 描述:控制 tcmalloc 的回收。如果配置为 performance,内存使用超过 mem_limit 的 90% 时,doris 会释放 tcmalloc cache 中的内存,如果配置为 compact,内存使用超过 mem_limit 的 50% 时,doris 会释放 tcmalloc cache 中的内存。
  • 默认值:performance

max_sys_mem_available_low_water_mark_bytes

  • 类型:int64
  • 描述:系统/proc/meminfo/MemAvailable 的最大低水位线,单位字节,默认 1.6G,实际低水位线=min(1.6G,MemTotal * 10%),避免在大于 16G 的机器上浪费过多内存。调大 max,在大于 16G 内存的机器上,将为 Full GC 预留更多的内存 buffer;反之调小 max,将尽可能充分使用内存。
  • 默认值:1717986918

memory_limitation_per_thread_for_schema_change_bytes

  • 描述:单个 schema change 任务允许占用的最大内存。
  • 默认值:2147483648 (2GB)

mem_tracker_consume_min_size_bytes

  • 类型:int32
  • 描述:TCMalloc Hook consume/release MemTracker 时的最小长度,小于该值的 consume size 会持续累加,避免频繁调用 MemTracker 的 consume/release,减小该值会增加 consume/release 的频率,增大该值会导致 MemTracker 统计不准,理论上一个 MemTracker 的统计值与真实值相差 = (mem_tracker_consume_min_size_bytes * 这个 MemTracker 所在的 BE 线程数)。
  • 默认值:1048576

min_buffer_size

  • 描述:最小读取缓冲区大小
  • 默认值:1024 (byte)

write_buffer_size

  • 描述:刷写前缓冲区的大小
    • 导入数据在 BE 上会先写入到一个内存块,当这个内存块达到阈值后才会写回磁盘。默认大小是 100MB。过小的阈值可能导致 BE 上存在大量的小文件。可以适当提高这个阈值减少文件数量。但过大的阈值可能导致 RPC 超时
  • 默认值:104857600

remote_storage_read_buffer_mb

  • 类型:int32
  • 描述:读取 hdfs 或者对象存储上的文件时,使用的缓存大小。
    • 增大这个值,可以减少远端数据读取的调用次数,但会增加内存开销。
  • 默认值:16MB

path_gc_check

  • 类型:bool
  • 描述:是否启用回收扫描数据线程检查
  • 默认值:true

path_gc_check_interval_second

  • 描述:回收扫描数据线程检查时间间隔
  • 默认值:86400 (s)

path_gc_check_step

  • 默认值:1000

path_gc_check_step_interval_ms

  • 默认值:10 (ms)

scan_context_gc_interval_min

  • 描述:此配置用于上下文 gc 线程调度周期
  • 默认值:5 (分钟)

存储

default_num_rows_per_column_file_block

  • 类型:int32
  • 描述:配置单个 RowBlock 之中包含多少行的数据。
  • 默认值:1024

disable_storage_page_cache

  • 类型:bool
  • 描述:是否进行使用 page cache 进行 index 的缓存,该配置仅在 BETA 存储格式时生效
  • 默认值:false

disk_stat_monitor_interval

  • 描述:磁盘状态检查时间间隔。
  • 默认值:5(s)

max_garbage_sweep_interval

  • 描述:磁盘进行垃圾清理的最大间隔。
  • 默认值:3600 (s)

max_percentage_of_error_disk

  • 类型:int32
  • 描述:存储引擎允许存在损坏硬盘的百分比,损坏硬盘超过改比例后,BE 将会自动退出。
  • 默认值:0

min_garbage_sweep_interval

  • 描述:磁盘进行垃圾清理的最小间隔
  • 默认值:180 (s)

pprof_profile_dir

  • 描述:pprof profile 保存目录。
  • 默认值:${DORIS_HOME}/log

small_file_dir

  • 描述:用于保存 SmallFileMgr 下载的文件的目录。
  • 默认值:${DORIS_HOME}/lib/small_file/

user_function_dir

  • 描述:udf 函数目录。
  • 默认值:${DORIS_HOME}/lib/udf

storage_flood_stage_left_capacity_bytes

  • 描述:数据目录应该剩下的最小存储空间,默认 1G。
  • 默认值:1073741824

storage_flood_stage_usage_percent

  • 描述:storage_flood_stage_usage_percent 和 storage_flood_stage_left_capacity_bytes 两个配置限制了数据目录的磁盘容量的最大使用。如果这两个阈值都达到,则无法将更多数据写入该数据目录。数据目录的最大已用容量百分比
  • 默认值:90(90%)

storage_medium_migrate_count

  • 描述:要克隆的线程数。
  • 默认值:1

storage_page_cache_limit

  • 描述:缓存存储页大小。
  • 默认值:20%

storage_page_cache_shard_size

  • 描述:StoragePageCache 的分片大小,值为 2^n (n=0,1,2,...)。建议设置为接近 BE CPU 核数的值,可减少 StoragePageCache 的锁竞争。
  • 默认值:16

index_page_cache_percentage

  • 类型:int32
  • 描述:索引页缓存占总页面缓存的百分比,取值为[0, 100]。
  • 默认值:10

segment_cache_capacity

  • Type: int32
  • Description: segment 元数据缓存(以 rowset id 为 key)的最大 rowset 个数。-1 代表向后兼容取值为 fd_number * 2/5
  • Default value: -1

storage_strict_check_incompatible_old_format

  • 类型:bool
  • 描述:用来检查不兼容的旧版本格式时是否使用严格的验证方式。
    • 配置用来检查不兼容的旧版本格式时是否使用严格的验证方式,当含有旧版本的 hdr 格式时,使用严谨的方式时,程序会打出 fatal log 并且退出运行;否则,程序仅打印 warn log.
  • 默认值:true
  • 可动态修改:否

sync_tablet_meta

  • 描述:存储引擎是否开 sync 保留到磁盘上
  • 默认值:true

pending_data_expire_time_sec

  • 描述:存储引擎保留的未生效数据的最大时长
  • 默认值:1800 (s)

create_tablet_worker_count

  • 描述:BE 创建 tablet 的工作线程数
  • 默认值:3

check_consistency_worker_count

  • 描述:计算 tablet 的校验和 (checksum) 的工作线程数
  • 默认值:1

max_tablet_version_num

  • 类型:int
  • 描述:限制单个 tablet 最大 version 的数量。用于防止导入过于频繁,或 compaction 不及时导致的大量 version 堆积问题。当超过限制后,导入任务将被拒绝。
  • 默认值:2000

tablet_map_shard_size

  • 描述:tablet_map_lock 分片大小,值为 2^n, n=0,1,2,3,4,这是为了更好地管理 tablet
  • 默认值:4

tablet_meta_checkpoint_min_interval_secs

  • 描述:TabletMeta Checkpoint 线程轮询的时间间隔
  • 默认值:600 (s)

tablet_meta_checkpoint_min_new_rowsets_num

  • 描述:TabletMeta Checkpoint 的最小 Rowset 数目
  • 默认值:10

tablet_rowset_stale_sweep_time_sec

  • 类型:int64
  • 描述:用来表示清理合并版本的过期时间,当当前时间 now() 减去一个合并的版本路径中 rowset 最近创建创建时间大于 tablet_rowset_stale_sweep_time_sec 时,对当前路径进行清理,删除这些合并过的 rowset, 单位为 s。
    • 当写入过于频繁,可能会引发 fe 查询不到已经合并过的版本,引发查询 -230 错误。可以通过调大该参数避免该问题。
  • 默认值:300

tablet_writer_open_rpc_timeout_sec

  • 描述:在远程 BE 中打开 tablet writer 的 rpc 超时。操作时间短,可设置短超时时间
    • 导入过程中,发送一个 Batch(1024 行)的 RPC 超时时间。默认 60 秒。因为该 RPC 可能涉及多个 分片内存块的写盘操作,所以可能会因为写盘导致 RPC 超时,可以适当调整这个超时时间来减少超时错误(如 send batch fail 错误)。同时,如果调大 write_buffer_size 配置,也需要适当调大这个参数
  • 默认值:60

tablet_writer_ignore_eovercrowded

  • 类型:bool
  • 描述:写入时可忽略 brpc 的'[E1011]The server is overcrowded'错误。
    • 当遇到'[E1011]The server is overcrowded'的错误时,可以调整配置项brpc_socket_max_unwritten_bytes,但这个配置项不能动态调整。所以可通过设置此项为true来临时避免写失败。注意,此配置项只影响写流程,其他的 rpc 请求依旧会检查是否 overcrowded。
  • 默认值:false

streaming_load_rpc_max_alive_time_sec

  • 描述:TabletsChannel 的存活时间。如果此时通道没有收到任何数据,通道将被删除。
  • 默认值:1200

alter_tablet_worker_count

  • 描述:进行 schema change 的线程数
  • 默认值:3

alter_index_worker_count

  • 描述:进行 index change 的线程数
  • 默认值:3

ignore_load_tablet_failure

  • 类型:bool
  • 描述:用来决定在有 tablet 加载失败的情况下是否忽略错误,继续启动 be
  • 默认值:false

BE 启动时,会对每个数据目录单独启动一个线程进行 tablet header 元信息的加载。默认配置下,如果某个数据目录有 tablet 加载失败,则启动进程会终止。同时会在 be.INFO 日志中看到如下错误信息:

load tablets from header failed, failed tablets size: xxx, path=xxx

表示该数据目录共有多少 tablet 加载失败。同时,日志中也会有加载失败的 tablet 的具体信息。此时需要人工介入来对错误原因进行排查。排查后,通常有两种方式进行恢复:

  1. tablet 信息不可修复,在确保其他副本正常的情况下,可以通过 meta_tool 工具将错误的 tablet 删除。
  2. ignore_load_tablet_failure 设置为 true,则 BE 会忽略这些错误的 tablet,正常启动。

report_disk_state_interval_seconds

  • 描述:代理向 FE 报告磁盘状态的间隔时间
  • 默认值:60 (s)

result_buffer_cancelled_interval_time

  • 描述:结果缓冲区取消时间
  • 默认值:300 (s)

snapshot_expire_time_sec

  • 描述:快照文件清理的间隔
  • 默认值:172800 (48 小时)

日志

sys_log_dir

  • 类型:string
  • 描述:BE 日志数据的存储目录
  • 默认值:${DORIS_HOME}/log

sys_log_level

  • 描述:日志级别,INFO < WARNING < ERROR < FATAL
  • 默认值:INFO

sys_log_roll_mode

  • 描述:日志拆分的大小,每 1G 拆分一个日志文件
  • 默认值:SIZE-MB-1024

sys_log_roll_num

  • 描述:日志文件保留的数目
  • 默认值:10

sys_log_verbose_level

  • 描述:日志显示的级别,用于控制代码中 VLOG 开头的日志输出
  • 默认值:10

sys_log_verbose_modules

  • 描述:日志打印的模块,写 olap 就只打印 olap 模块下的日志
  • 默认值:空

aws_log_level

  • 类型:int32
  • 描述:AWS SDK 的日志级别
       Off = 0,
    Fatal = 1,
    Error = 2,
    Warn = 3,
    Info = 4,
    Debug = 5,
    Trace = 6
  • 默认值:3

log_buffer_level

  • 描述:日志刷盘的策略,默认保持在内存中
  • 默认值:空

其它

report_tablet_interval_seconds

  • 描述:代理向 FE 报告 olap 表的间隔时间
  • 默认值:60 (s)

report_task_interval_seconds

  • 描述:代理向 FE 报告任务签名的间隔时间
  • 默认值:10 (s)

enable_metric_calculator

  • 描述:如果设置为 true,metric calculator 将运行,收集 BE 相关指标信息,如果设置成 false 将不运行
  • 默认值:true

enable_system_metrics

  • 描述:用户控制打开和关闭系统指标
  • 默认值:true

enable_token_check

  • 描述:用于向前兼容,稍后将被删除
  • 默认值:true

max_runnings_transactions_per_txn_map

  • 描述:txn 管理器中每个 txn_partition_map 的最大 txns 数,这是一种自我保护,以避免在管理器中保存过多的 txns
  • 默认值:2000

max_download_speed_kbps

  • 描述:最大下载速度限制
  • 默认值:50000(kb/s)

download_low_speed_time

  • 描述:下载时间限制
  • 默认值:300 (s)

download_low_speed_limit_kbps

  • 描述:下载最低限速
  • 默认值:50 (KB/s)

enable_batch_download

  • 描述:是否允许批量下载文件,建议只在开启 binlog 的情况下打开
  • 默认值:false

priority_queue_remaining_tasks_increased_frequency

  • 描述:BlockingPriorityQueue 中剩余任务的优先级频率增加
  • 默认值:512

jdbc_drivers_dir

  • 描述:存放 jdbc driver 的默认目录。
  • 默认值:${DORIS_HOME}/jdbc_drivers

enable_simdjson_reader

  • 描述:是否在导入 json 数据时用 simdjson 来解析。
  • 默认值:true

enable_query_memory_overcommit

  • 描述:如果为 true,则当内存未超过 exec_mem_limit 时,查询内存将不受限制;当进程内存超过 exec_mem_limit 且大于 2GB 时,查询会被取消。如果为 false,则在使用的内存超过 exec_mem_limit 时取消查询。
  • 默认值:true

user_files_secure_path

  • 描述:local 表函数查询的文件的存储目录。
  • 默认值:${DORIS_HOME}

brpc_streaming_client_batch_bytes

  • 描述:brpc streaming 客户端发送数据时的攒批大小(字节)
  • 默认值:262144

grace_shutdown_wait_seconds

  • 描述:在云原生的部署模式下,为了节省资源一个 BE 可能会被频繁的加入集群或者从集群中移除。如果在这个 BE 上有正在运行的 Query,那么这个 Query 会失败。用户可以使用 stop_be.sh --grace 的方式来关闭一个 BE 节点,此时 BE 会等待当前正在这个 BE 上运行的所有查询都结束才会退出。同时,在这个时间范围内 FE 也不会分发新的 query 到这个机器上。如果超过 grace_shutdown_wait_seconds 这个阈值,那么 BE 也会直接退出,防止一些查询长期不退出导致节点没法快速下掉的情况。
  • 默认值:120

enable_java_support

  • 描述:BE 是否开启使用 java-jni,开启后允许 c++ 与 java 之间的相互调用。目前已经支持 hudi、java-udf、jdbc、max-compute、paimon、preload、avro
  • 默认值:true

group_commit_wal_path

  • 描述:Group Commit 存放 WAL 文件的目录,请参考 Group Commit
  • 默认值:默认在用户配置的storage_root_path的各个目录下创建一个名为wal的目录。配置示例:
    group_commit_wal_path=/data1/storage/wal;/data2/storage/wal;/data3/storage/wal

group_commit_memory_rows_for_max_filter_ratio

  • 描述:当 Group Commit 导入的总行数不高于该值,max_filter_ratio 正常工作,否则不工作,请参考 Group Commit
  • 默认值:10000

存算分离模式

deploy_mode

  • 默认值: ""

  • 描述: BE 运行的模式。cloud 表示算分离模式。

meta_service_endpoint

  • 默认值: ""

  • 描述: Meta Service 的端点应以 'host1:port,host2:port' 的格式指定。该值通常由 FE 通过心跳传递给 BE,无需配置。

enable_file_cache

  • 默认值:在存算分离模式下为 true,在非存算分离模式下为 false。

  • 描述:是否使用文件缓存。

file_cache_path

  • 默认值: [{"path":"${DORIS_HOME}/file_cache"}]

  • 描述:用于文件缓存的磁盘路径和其他参数,以数组形式表示,每个磁盘一个条目。path 指定磁盘路径,total_size 限制缓存的大小;-1 或 0 将使用整个磁盘空间。

  • 格式: [{"path":"/path/to/file_cache","total_size":21474836480},{"path":"/path/to/file_cache2","total_size":21474836480}]

Doris 首页
下载 PDF
本页导航