Coverage Report

Created: 2026-10-27 19:53

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/common/config.cpp
Line
Count
Source
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
18
#include <fmt/core.h>
19
#include <gflags/gflags.h>
20
#include <stdint.h>
21
22
#include <algorithm>
23
#include <cctype>
24
#include <cmath>
25
// IWYU pragma: no_include <bthread/errno.h>
26
#include <lz4/lz4hc.h>
27
28
#include <atomic>
29
#include <cerrno> // IWYU pragma: keep
30
#include <cmath>
31
#include <cstdlib>
32
#include <cstring>
33
#include <fstream> // IWYU pragma: keep
34
#include <functional>
35
#include <iostream>
36
#include <limits>
37
#include <map>
38
#include <memory>
39
#include <mutex>
40
#include <random>
41
#include <set>
42
#include <string>
43
#include <string_view>
44
#include <utility>
45
#include <vector>
46
47
#include "cloud/config.h"
48
#include "common/config.h"
49
#include "common/logging.h"
50
#include "common/status.h"
51
#include "io/fs/file_writer.h"
52
#include "io/fs/local_file_system.h"
53
#include "load/memtable/memtable_flush_executor.h"
54
#include "runtime/exec_env.h"
55
#include "runtime/workload_group/workload_group_manager.h"
56
#include "storage/storage_engine.h"
57
#include "util/cpu_info.h"
58
#include "util/string_util.h"
59
60
namespace doris::config {
61
#include "common/compile_check_avoid_begin.h"
62
63
// Dir of custom config file
64
DEFINE_String(custom_config_dir, "${DORIS_HOME}/conf");
65
66
// Dir of jdbc drivers
67
DEFINE_String(jdbc_drivers_dir, "${DORIS_HOME}/plugins/jdbc_drivers");
68
69
// cluster id
70
DEFINE_Int32(cluster_id, "-1");
71
// port on which BackendService is exported
72
DEFINE_Int32(be_port, "9060");
73
74
// port for brpc
75
DEFINE_Int32(brpc_port, "8060");
76
77
DEFINE_Int32(arrow_flight_sql_port, "8050");
78
79
// Validate Arrow input buffers in opted-in Arrow readers before converting them to Doris columns.
80
DEFINE_Bool(enable_arrow_input_validation, "true");
81
82
DEFINE_Int32(cdc_client_port, "9096");
83
84
DEFINE_String(cdc_client_java_opts, "");
85
86
// If the external client cannot directly access priority_networks, set public_host to be accessible
87
// to external client.
88
// There are usually two usage scenarios:
89
// 1. in production environment, it is often inconvenient to expose Doris BE nodes to the external network.
90
// However, a reverse proxy (such as Nginx) can be added to all Doris BE nodes, and the external client will be
91
// randomly routed to a Doris BE node when connecting to Nginx. set public_host to the host of Nginx.
92
// 2. if priority_networks is an internal network IP, and BE node has its own independent external IP,
93
// but Doris currently does not support modifying priority_networks, setting public_host to the real external IP.
94
DEFINE_mString(public_host, "");
95
96
// If the BE node is connected to the external network through a reverse proxy like Nginx
97
// and need to use Arrow Flight SQL, should add a server in Nginx to reverse proxy
98
// `Nginx:arrow_flight_sql_proxy_port` to `BE_priority_networks:arrow_flight_sql_port`. For example:
99
// upstream arrowflight {
100
//    server 10.16.10.8:8069;
101
//    server 10.16.10.8:8068;
102
//}
103
// server {
104
//    listen 8167 http2;
105
//    listen [::]:8167 http2;
106
//    server_name doris.arrowflight.com;
107
// }
108
DEFINE_Int32(arrow_flight_sql_proxy_port, "-1");
109
110
// the number of bthreads for brpc, the default value is set to -1,
111
// which means the number of bthreads is #cpu-cores
112
DEFINE_Int32(brpc_num_threads, "256");
113
// the time of brpc server keep idle connection, setting this value too small may cause rpc between backends to fail,
114
// the default value is set to -1, which means never close idle connection.
115
DEFINE_Int32(brpc_idle_timeout_sec, "-1");
116
117
// Maximum number of multi-dimensional bvar samples exported by /brpc_metrics.
118
// brpc 1.4 defaults this flag to 0, which disables all MultiDimension metrics.
119
DEFINE_String(bvar_max_dump_multi_dimension_metric_num, "5000");
120
121
// Declare a selection strategy for those servers have many ips.
122
// Note that there should at most one ip match this list.
123
// this is a list in semicolon-delimited format, in CIDR notation, e.g. 10.10.10.0/24
124
// If no ip match this rule, will choose one randomly.
125
DEFINE_String(priority_networks, "");
126
127
// memory mode
128
// performance or compact
129
DEFINE_String(memory_mode, "moderate");
130
131
DEFINE_mBool(enable_use_cgroup_memory_info, "true");
132
133
// process memory limit specified as number of bytes
134
// ('<int>[bB]?'), megabytes ('<float>[mM]'), gigabytes ('<float>[gG]'),
135
// or percentage of the physical memory ('<int>%').
136
// defaults to bytes if no unit is given"
137
// must larger than 0. and if larger than physical memory size,
138
// it will be set to physical memory size.
139
DEFINE_String(mem_limit, "90%");
140
141
// Soft memory limit as a fraction of hard memory limit.
142
DEFINE_Double(soft_mem_limit_frac, "0.9");
143
144
// Cache capacity reduce mem limit as a fraction of soft mem limit.
145
DEFINE_mDouble(cache_capacity_reduce_mem_limit_frac, "0.7");
146
147
// Schema change memory limit as a fraction of soft memory limit.
148
DEFINE_Double(schema_change_mem_limit_frac, "0.6");
149
150
// Many modern allocators (for example, tcmalloc) do not do a mremap for
151
// realloc, even in case of large enough chunks of memory. Although this allows
152
// you to increase performance and reduce memory consumption during realloc.
153
// To fix this, we do mremap manually if the chunk of memory is large enough.
154
//
155
// The threshold (128 MB, 128 * (1ULL << 20)) is chosen quite large, since changing the address
156
// space is very slow, especially in the case of a large number of threads. We
157
// expect that the set of operations mmap/something to do/mremap can only be
158
// performed about 1000 times per second.
159
//
160
// P.S. This is also required, because tcmalloc can not allocate a chunk of
161
// memory greater than 16 GB.
162
DEFINE_mInt64(mmap_threshold, "134217728"); // bytes
163
164
// When hash table capacity is greater than 2^double_grow_degree(default 2G), grow when 75% of the capacity is satisfied.
165
// Increase can reduce the number of hash table resize, but may waste more memory.
166
DEFINE_mInt32(hash_table_double_grow_degree, "31");
167
168
DEFINE_mInt32(max_fill_rate, "2");
169
170
DEFINE_mInt32(double_resize_threshold, "23");
171
172
// The maximum low water mark of the system `/proc/meminfo/MemAvailable`, Unit byte, default -1.
173
// if it is -1, then low water mark = min(MemTotal - MemLimit, MemTotal * 5%), which is 3.2G on a 64G machine.
174
// Turn up max. more memory buffers will be reserved for Memory GC.
175
// Turn down max. will use as much memory as possible.
176
// note that: `max_` prefix should be removed, but keep it for compatibility.
177
DEFINE_Int64(max_sys_mem_available_low_water_mark_bytes, "-1");
178
179
DEFINE_Int64(memtable_limiter_reserved_memory_bytes, "838860800");
180
181
// The size of the memory that gc wants to release each time, as a percentage of the mem limit.
182
DEFINE_mString(process_minor_gc_size, "5%");
183
DEFINE_mString(process_full_gc_size, "10%");
184
185
// gc will release cache, cancel task, and task will wait for gc to release memory,
186
// default gc strategy is conservative, if you want to exclude the interference of gc, let it be true
187
DEFINE_mBool(disable_memory_gc, "false");
188
189
// for the query being canceled,
190
// if (current time - cancel start time) < revoke_memory_max_tolerance_ms, the query memory is counted in `freed_memory`,
191
// and the query memory is expected to be released soon.
192
// if > revoke_memory_max_tolerance_ms, the query memory will not be counted in `freed_memory`,
193
// and the query may be blocked during the cancel process. skip this query and continue to cancel other queries.
194
DEFINE_mInt64(revoke_memory_max_tolerance_ms, "3000");
195
196
DEFINE_mBool(enable_stacktrace, "true");
197
198
DEFINE_mInt64(stacktrace_in_alloc_large_memory_bytes, "2147483647"); // 2GB -1
199
200
DEFINE_mInt64(crash_in_alloc_large_memory_bytes, "-1");
201
202
// The actual meaning of this parameter is `debug_memory`.
203
// 1. crash in memory tracker inaccurate, if memory tracker value is inaccurate, BE will crash.
204
//    usually used in test environments, default value is false.
205
// 2. print more memory logs.
206
DEFINE_mBool(crash_in_memory_tracker_inaccurate, "false");
207
208
// default is true. if any memory tracking in Orphan mem tracker will report error.
209
// !! not modify the default value of this conf!! otherwise memory errors cannot be detected in time.
210
// allocator free memory not need to check, because when the thread memory tracker label is Orphan,
211
// use the tracker saved in Allocator.
212
DEFINE_mBool(enable_memory_orphan_check, "true");
213
214
// The maximum time a thread waits for full GC. Currently only query will wait for full gc.
215
DEFINE_mInt32(thread_wait_gc_max_milliseconds, "1000");
216
217
DEFINE_mInt64(pre_serialize_keys_limit_bytes, "16777216");
218
219
// the port heartbeat service used
220
DEFINE_Int32(heartbeat_service_port, "9050");
221
// the count of heart beat service
222
DEFINE_Int32(heartbeat_service_thread_count, "1");
223
// the count of thread to create table
224
DEFINE_Int32(create_tablet_worker_count, "3");
225
// the count of thread to drop table
226
DEFINE_Int32(drop_tablet_worker_count, "3");
227
// the count of thread to batch load
228
DEFINE_Int32(push_worker_count_normal_priority, "3");
229
// the count of thread to high priority batch load
230
DEFINE_Int32(push_worker_count_high_priority, "3");
231
// the count of thread to publish version
232
DEFINE_Int32(publish_version_worker_count, "8");
233
// the count of tablet thread to publish version
234
DEFINE_Int32(tablet_publish_txn_max_thread, "32");
235
// the timeout of EnginPublishVersionTask
236
DEFINE_Int32(publish_version_task_timeout_s, "8");
237
// the count of thread to calc delete bitmap
238
DEFINE_Int32(calc_delete_bitmap_max_thread, "32");
239
// the num of threads to calc delete bitmap when building rowset, 0 = auto
240
DEFINE_Int32(calc_delete_bitmap_for_load_max_thread, "0");
241
// the count of thread to calc delete bitmap worker, only used for cloud
242
DEFINE_Int32(calc_delete_bitmap_worker_count, "8");
243
// the count of thread to calc tablet delete bitmap task, only used for cloud
244
DEFINE_Int32(calc_tablet_delete_bitmap_task_max_thread, "32");
245
// the count of thread to clear transaction task
246
DEFINE_Int32(clear_transaction_task_worker_count, "1");
247
// the count of thread to delete
248
DEFINE_Int32(delete_worker_count, "3");
249
// the count of thread to alter table
250
DEFINE_Int32(alter_tablet_worker_count, "3");
251
// the count of thread to alter index
252
DEFINE_Int32(alter_index_worker_count, "3");
253
// the count of thread to clone
254
DEFINE_Int32(clone_worker_count, "3");
255
// the count of thread to clone
256
DEFINE_Int32(storage_medium_migrate_count, "1");
257
// the count of thread to check consistency
258
DEFINE_Int32(check_consistency_worker_count, "1");
259
// the count of thread to upload
260
DEFINE_Int32(upload_worker_count, "1");
261
// the count of thread to download
262
DEFINE_Int32(download_worker_count, "1");
263
DEFINE_Int32(num_query_ctx_map_partitions, "128");
264
// the count of thread to make snapshot
265
DEFINE_Int32(make_snapshot_worker_count, "5");
266
// the count of thread to release snapshot
267
DEFINE_Int32(release_snapshot_worker_count, "5");
268
// the count of thread to make committed rowsets visible in cloud mode
269
DEFINE_Int32(cloud_make_committed_rs_visible_worker_count, "16");
270
// report random wait a little time to avoid FE receiving multiple be reports at the same time.
271
// do not set it to false for production environment
272
DEFINE_mBool(report_random_wait, "true");
273
// the interval time(seconds) for agent report tasks signature to FE
274
DEFINE_mInt32(report_task_interval_seconds, "10");
275
// the interval time(seconds) for agent report disk state to FE
276
DEFINE_mInt32(report_disk_state_interval_seconds, "30");
277
// the interval time(seconds) for agent report olap table to FE
278
DEFINE_mInt32(report_tablet_interval_seconds, "60");
279
// the max download speed(KB/s)
280
DEFINE_mInt32(max_download_speed_kbps, "50000");
281
// download low speed limit(KB/s)
282
DEFINE_mInt32(download_low_speed_limit_kbps, "50");
283
// download low speed time(seconds)
284
DEFINE_mInt32(download_low_speed_time, "300");
285
// whether to download small files in batch
286
DEFINE_mBool(enable_batch_download, "true");
287
// whether to enable stream load forward endpoint for cloud group commit
288
DEFINE_mBool(enable_group_commit_streamload_be_forward, "false");
289
// whether to check md5sum when download
290
DEFINE_mBool(enable_download_md5sum_check, "false");
291
// download binlog meta timeout, default 30s
292
DEFINE_mInt32(download_binlog_meta_timeout_ms, "30000");
293
// the interval time(seconds) for agent report index policy to FE
294
DEFINE_mInt32(report_index_policy_interval_seconds, "10");
295
296
// DNS cache: throttle "use cached ip" warning to once per N failures per host.
297
DEFINE_mInt32(dns_cache_log_every_n_failures, "10");
298
// DNS cache: evict a hostname after this many consecutive resolution failures.
299
DEFINE_mInt32(dns_cache_max_consecutive_failures, "30");
300
// DNS cache: after eviction, block re-resolve attempts for this many seconds.
301
// Set <= 0 to disable the negative cache (legacy behavior).
302
DEFINE_mInt32(dns_cache_negative_ttl_seconds, "60");
303
304
DEFINE_String(sys_log_dir, "");
305
DEFINE_String(user_function_dir, "${DORIS_HOME}/lib/udf");
306
// INFO, WARNING, ERROR, FATAL
307
DEFINE_mString(sys_log_level, "INFO");
308
// TIME-DAY, TIME-HOUR, SIZE-MB-nnn
309
DEFINE_String(sys_log_roll_mode, "SIZE-MB-1024");
310
// log roll num
311
DEFINE_Int32(sys_log_roll_num, "10");
312
// verbose log
313
DEFINE_Strings(sys_log_verbose_modules, "");
314
// verbose log level
315
DEFINE_Int32(sys_log_verbose_level, "10");
316
// verbose log FLAGS_v
317
DEFINE_Int32(sys_log_verbose_flags_v, "-1");
318
// log buffer level
319
DEFINE_String(log_buffer_level, "");
320
// log enable custom date time format
321
DEFINE_Bool(sys_log_enable_custom_date_time_format, "false");
322
// log custom date time format (https://en.cppreference.com/w/cpp/io/manip/put_time)
323
DEFINE_String(sys_log_custom_date_time_format, "%Y-%m-%d %H:%M:%S");
324
// log custom date time milliseconds format (fmt::format)
325
DEFINE_String(sys_log_custom_date_time_ms_format, ",{:03d}");
326
327
// number of threads available to serve backend execution requests
328
DEFINE_Int32(be_service_threads, "64");
329
330
// The pipeline task has a high concurrency, therefore reducing its report frequency
331
DEFINE_mInt32(pipeline_status_report_interval, "10");
332
DEFINE_mInt32(pipeline_task_exec_time_slice, "100");
333
334
// task executor min concurrency per task
335
DEFINE_Int32(task_executor_min_concurrency_per_task, "1");
336
// task executor max concurrency per task
337
DEFINE_Int32(task_executor_max_concurrency_per_task, "-1");
338
339
// task task executor inital split max concurrency per task, later concurrency may be adjusted dynamically
340
DEFINE_Int32(task_executor_initial_max_concurrency_per_task, "-1");
341
342
// Enable task executor in internal table scan.
343
DEFINE_Bool(enable_task_executor_in_internal_table, "false");
344
// Enable task executor in external table scan.
345
DEFINE_Bool(enable_task_executor_in_external_table, "false");
346
347
// number of scanner thread pool size for olap table
348
// and the min thread num of remote scanner thread pool
349
DEFINE_Int32(doris_scanner_thread_pool_thread_num, "-1");
350
351
DEFINE_Int32(doris_scanner_min_thread_pool_thread_num, "8");
352
DEFINE_Int32(remote_split_source_batch_size, "1000");
353
DEFINE_Int32(doris_max_remote_scanner_thread_pool_thread_num, "-1");
354
// number of olap scanner thread pool queue size
355
DEFINE_Int32(doris_scanner_thread_pool_queue_size, "102400");
356
// default thrift client connect timeout(in seconds)
357
DEFINE_mInt32(thrift_connect_timeout_seconds, "3");
358
359
// default thrift client retry interval (in milliseconds)
360
DEFINE_mInt64(thrift_client_retry_interval_ms, "1000");
361
// max message size of thrift request
362
// default: 100 * 1024 * 1024
363
DEFINE_mInt32(thrift_max_message_size, "104857600");
364
// max bytes number for single scan range, used in segmentv2
365
DEFINE_mInt32(doris_scan_range_max_mb, "1024");
366
// single read execute fragment row number
367
DEFINE_mInt32(doris_scanner_row_num, "16384");
368
// single read execute fragment row bytes
369
DEFINE_mInt32(doris_scanner_row_bytes, "10485760");
370
DEFINE_mInt32(doris_scanner_dynamic_interval_ms, "100");
371
// (Advanced) Maximum size of per-query receive-side buffer
372
DEFINE_mInt32(exchg_node_buffer_size_bytes, "20485760");
373
DEFINE_mInt32(exchg_buffer_queue_capacity_factor, "64");
374
375
// memory_limitation_per_thread_for_schema_change_bytes unit bytes
376
DEFINE_mInt64(memory_limitation_per_thread_for_schema_change_bytes, "2147483648");
377
378
DEFINE_mInt32(cache_prune_interval_sec, "10");
379
DEFINE_mInt32(cache_periodic_prune_stale_sweep_sec, "60");
380
// the clean interval of tablet lookup cache
381
DEFINE_mInt32(tablet_lookup_cache_stale_sweep_time_sec, "30");
382
DEFINE_mInt32(point_query_row_cache_stale_sweep_time_sec, "300");
383
DEFINE_mInt32(disk_stat_monitor_interval, "5");
384
DEFINE_mInt32(unused_rowset_monitor_interval, "30");
385
// Legacy name retained for compatibility; controls GLOBAL_ROWID_COL file-map GC.
386
DEFINE_mInt32(quering_rowsets_evict_interval, "30");
387
DEFINE_String(storage_root_path, "${DORIS_HOME}/storage");
388
DEFINE_mString(broken_storage_path, "");
389
DEFINE_Int32(min_active_scan_threads, "-1");
390
DEFINE_Int32(min_active_file_scan_threads, "-1");
391
392
// Config is used to check incompatible old format hdr_ format
393
// whether doris uses strict way. When config is true, process will log fatal
394
// and exit. When config is false, process will only log warning.
395
DEFINE_Bool(storage_strict_check_incompatible_old_format, "true");
396
397
// BE process will exit if the percentage of error disk reach this value.
398
DEFINE_mInt32(max_percentage_of_error_disk, "100");
399
DEFINE_mInt32(default_num_rows_per_column_file_block, "1024");
400
// pending data policy
401
DEFINE_mInt32(pending_data_expire_time_sec, "1800");
402
// inc_rowset snapshot rs sweep time interval
403
DEFINE_mInt32(tablet_rowset_stale_sweep_time_sec, "600");
404
// tablet stale rowset sweep by threshold size
405
DEFINE_Bool(tablet_rowset_stale_sweep_by_size, "false");
406
DEFINE_mInt32(tablet_rowset_stale_sweep_threshold_size, "100");
407
// garbage sweep policy
408
DEFINE_Int32(max_garbage_sweep_interval, "3600");
409
DEFINE_Int32(min_garbage_sweep_interval, "180");
410
DEFINE_mInt32(garbage_sweep_batch_size, "100");
411
DEFINE_mInt32(snapshot_expire_time_sec, "172800");
412
// It is only a recommended value. When the disk space is insufficient,
413
// the file storage period under trash dose not have to comply with this parameter.
414
DEFINE_mInt32(trash_file_expire_time_sec, "0");
415
// minimum file descriptor number
416
// modify them upon necessity
417
DEFINE_Int32(min_file_descriptor_number, "60000");
418
DEFINE_mBool(disable_segment_cache, "false");
419
// Enable checking segment rows consistency between rowset meta and segment footer
420
DEFINE_mBool(enable_segment_rows_consistency_check, "false");
421
DEFINE_mBool(enable_segment_rows_check_core, "false");
422
// ATTENTION: For test only. In test environment, there are no historical data,
423
// so all rowset meta should have segment rows info.
424
DEFINE_mBool(fail_when_segment_rows_not_in_rowset_meta, "false");
425
DEFINE_String(row_cache_mem_limit, "20%");
426
427
// Cache for storage page size
428
DEFINE_String(storage_page_cache_limit, "20%");
429
// Shard size for page cache, the value must be power of two.
430
// It's recommended to set it to a value close to the number of BE cores in order to reduce lock contentions.
431
DEFINE_Int32(storage_page_cache_shard_size, "256");
432
DEFINE_mInt32(file_cache_mem_storage_shard_num, "1024");
433
// Percentage for index page cache
434
// all storage page cache will be divided into data_page_cache and index_page_cache
435
DEFINE_Int32(index_page_cache_percentage, "10");
436
// whether to disable page cache feature in storage
437
DEFINE_mBool(disable_storage_page_cache, "false");
438
// whether to disable row cache feature in storage
439
DEFINE_mBool(disable_storage_row_cache, "true");
440
// Parquet page cache: threshold ratio for caching decompressed vs compressed pages
441
// If uncompressed_size / compressed_size <= threshold, cache decompressed;
442
// otherwise cache compressed if enable_parquet_cache_compressed_pages = true
443
DEFINE_Double(parquet_page_cache_decompress_threshold, "1.5");
444
// Parquet page cache: whether to enable caching compressed pages (when ratio exceeds threshold)
445
DEFINE_Bool(enable_parquet_cache_compressed_pages, "false");
446
// whether to disable pk page cache feature in storage
447
DEFINE_Bool(disable_pk_storage_page_cache, "false");
448
449
// Cache for mow primary key storage page size
450
DEFINE_String(pk_storage_page_cache_limit, "10%");
451
// data page size for primary key index
452
DEFINE_Int32(primary_key_data_page_size, "32768");
453
454
DEFINE_mInt32(data_page_cache_stale_sweep_time_sec, "300");
455
DEFINE_mInt32(index_page_cache_stale_sweep_time_sec, "600");
456
DEFINE_mInt32(pk_index_page_cache_stale_sweep_time_sec, "600");
457
458
DEFINE_mBool(enable_low_cardinality_optimize, "true");
459
DEFINE_Bool(enable_low_cardinality_cache_code, "true");
460
461
DEFINE_mBool(enable_adaptive_batch_size, "true");
462
463
// be policy
464
// whether check compaction checksum
465
DEFINE_mBool(enable_compaction_checksum, "false");
466
// whether disable automatic compaction task
467
DEFINE_mBool(disable_auto_compaction, "false");
468
// whether enable vertical compaction
469
DEFINE_mBool(enable_vertical_compaction, "true");
470
// whether enable ordered data compaction
471
DEFINE_mBool(enable_ordered_data_compaction, "true");
472
// In vertical compaction, column number for every group
473
DEFINE_mInt32(vertical_compaction_num_columns_per_group, "5");
474
// In vertical compaction, max memory usage for row_source_buffer
475
DEFINE_Int32(vertical_compaction_max_row_source_memory_mb, "1024");
476
// In vertical compaction, max dest segment file size
477
DEFINE_mInt64(vertical_compaction_max_segment_size, "1073741824");
478
// Density threshold for sparse column compaction optimization
479
// density = (total_cells - null_cells) / total_cells, smaller means more sparse
480
// When density <= threshold, enable sparse optimization
481
// 0 = disable optimization, 1 = always enable
482
// Default 0.05 means enable sparse optimization when desity <= 5%
483
DEFINE_mDouble(sparse_column_compaction_threshold_percent, "0.05");
484
// Enable RLE batch Put optimization for compaction
485
DEFINE_mBool(enable_rle_batch_put_optimization, "true");
486
487
// Enable PDEP-based bit unpacking. Disable it on CPUs where PDEP is microcoded and slower than
488
// the scalar implementation, such as AMD Zen+ and Zen 2.
489
DEFINE_Bool(enable_bmi2_optimizations, "true");
490
491
// In ordered data compaction, min segment size for input rowset
492
DEFINE_mInt32(ordered_data_compaction_min_segment_size, "10485760");
493
494
// This config can be set to limit thread number in compaction thread pool.
495
DEFINE_mInt32(max_base_compaction_threads, "4");
496
DEFINE_mInt32(max_cumu_compaction_threads, "-1");
497
498
// Changelog compaction
499
// ATTN(changelog-rename): formerly "binlog_compaction_wait_timesec_after_visible"
500
DEFINE_mInt64(changelog_compaction_wait_timesec_after_visible, "600");
501
// ATTN(changelog-rename): formerly "binlog_compaction_goal_size_mbytes"
502
DEFINE_mInt64(changelog_compaction_goal_size_mbytes, "128");
503
// ATTN(changelog-rename): formerly "binlog_compaction_task_num_per_disk"
504
DEFINE_mInt32(changelog_compaction_task_num_per_disk, "4");
505
// ATTN(changelog-rename): formerly "binlog_compaction_file_count_threshold"
506
DEFINE_mInt32(changelog_compaction_file_count_threshold, "100");
507
// ATTN(changelog-rename): formerly "binlog_level_compaction_max_deltas"
508
DEFINE_mInt32(changelog_level_compaction_max_deltas, "2000");
509
// ATTN(changelog-rename): formerly "binlog_compaction_time_threshold_seconds"
510
DEFINE_mInt64(changelog_compaction_time_threshold_seconds, "3600");
511
// ATTN(changelog-rename): formerly "max_binlog_compaction_threads"
512
DEFINE_mInt32(max_changelog_compaction_threads, "-1");
513
514
DEFINE_Bool(enable_base_compaction_idle_sched, "true");
515
DEFINE_mInt64(base_compaction_min_rowset_num, "5");
516
DEFINE_mInt64(base_compaction_max_compaction_score, "20");
517
DEFINE_mInt64(mow_base_compaction_max_compaction_score, "200");
518
DEFINE_mDouble(base_compaction_min_data_ratio, "0.3");
519
DEFINE_mInt64(base_compaction_dup_key_max_file_size_mbytes, "1024");
520
521
DEFINE_Bool(enable_skip_tablet_compaction, "true");
522
DEFINE_mInt32(skip_tablet_compaction_second, "10");
523
524
// output rowset of cumulative compaction total disk size exceed this config size,
525
// this rowset will be given to base compaction, unit is m byte.
526
DEFINE_mInt64(compaction_promotion_size_mbytes, "1024");
527
528
// output rowset of cumulative compaction total disk size exceed this config ratio of
529
// base rowset's total disk size, this rowset will be given to base compaction. The value must be between
530
// 0 and 1.
531
DEFINE_mDouble(compaction_promotion_ratio, "0.05");
532
533
// the smallest size of rowset promotion. When the rowset is less than this config, this
534
// rowset will be not given to base compaction. The unit is m byte.
535
DEFINE_mInt64(compaction_promotion_min_size_mbytes, "128");
536
537
// When output rowset of cumulative compaction total version count (end_version - start_version)
538
// exceed this config count, the rowset will be moved to base compaction.
539
// NOTE: this config only works for unique key merge-on-write tables. The default maximum value
540
// disables version-count-based promotion while retaining the option to enable it when needed.
541
DEFINE_mInt64(compaction_promotion_version_count, "9223372036854775807");
542
543
// The lower bound size to do cumulative compaction. When total disk size of candidate rowsets is less than
544
// this size, size_based policy may not do to cumulative compaction. The unit is m byte.
545
DEFINE_mInt64(compaction_min_size_mbytes, "64");
546
547
// cumulative compaction policy: min and max delta file's number
548
DEFINE_mInt64(cumulative_compaction_min_deltas, "5");
549
DEFINE_mInt64(cumulative_compaction_max_deltas, "1000");
550
DEFINE_mInt32(cumulative_compaction_max_deltas_factor, "10");
551
552
// The upper limit of "permits" held by all compaction tasks. This config can be set to limit memory consumption for compaction.
553
DEFINE_mInt64(total_permits_for_compaction_score, "1000000");
554
555
// sleep interval in ms after generated compaction tasks
556
DEFINE_mInt32(generate_compaction_tasks_interval_ms, "100");
557
558
// Compaction task number per disk.
559
// Must be greater than 2, because Base compaction and Cumulative compaction have at least one thread each.
560
DEFINE_mInt32(compaction_task_num_per_disk, "4");
561
// compaction thread num for fast disk(typically .SSD), must be greater than 2.
562
DEFINE_mInt32(compaction_task_num_per_fast_disk, "8");
563
DEFINE_Validator(compaction_task_num_per_disk,
564
                 [](const int config) -> bool { return config >= 2; });
565
DEFINE_Validator(compaction_task_num_per_fast_disk,
566
                 [](const int config) -> bool { return config >= 2; });
567
DEFINE_Validator(low_priority_compaction_task_num_per_disk,
568
                 [](const int config) -> bool { return config >= 2; });
569
570
// How many rounds of cumulative compaction for each round of base compaction when compaction tasks generation.
571
DEFINE_mInt32(cumulative_compaction_rounds_for_each_base_compaction_round, "9");
572
// Minimum number of threads required in the thread pool to activate the large cumu compaction delay strategy.
573
// The delay strategy is only applied when the thread pool has at least this many threads.
574
// Default -1 means disable.
575
DEFINE_mInt32(large_cumu_compaction_task_min_thread_num, "-1");
576
// Maximum size threshold (in bytes) for input rowsets. Compaction tasks with input size
577
// exceeding this threshold will be delayed when thread pool is near capacity. Default 512MB.
578
DEFINE_mInt32(large_cumu_compaction_task_bytes_threshold, "536870912");
579
// Maximum row count threshold for compaction input. Compaction tasks with row count
580
// exceeding this threshold will be delayed when thread pool is near capacity. Default 1 million.
581
DEFINE_mInt32(large_cumu_compaction_task_row_num_threshold, "1000000");
582
583
// Not compact the invisible versions, but with some limitations:
584
// if not timeout, keep no more than compaction_keep_invisible_version_max_count versions;
585
// if timeout, keep no more than compaction_keep_invisible_version_min_count versions.
586
DEFINE_mInt32(compaction_keep_invisible_version_timeout_sec, "1800");
587
DEFINE_mInt32(compaction_keep_invisible_version_min_count, "50");
588
DEFINE_mInt32(compaction_keep_invisible_version_max_count, "500");
589
590
// Threshold to logging compaction trace, in seconds.
591
DEFINE_mInt32(base_compaction_trace_threshold, "60");
592
DEFINE_mInt32(cumulative_compaction_trace_threshold, "10");
593
DEFINE_mBool(disable_compaction_trace_log, "true");
594
595
DEFINE_mBool(enable_compaction_task_tracker, "true");
596
DEFINE_mInt32(compaction_task_tracker_max_records, "10000");
597
598
// Interval to picking rowset to compact, in seconds
599
DEFINE_mInt64(pick_rowset_to_compact_interval_sec, "86400");
600
601
// Compaction priority schedule
602
DEFINE_mBool(enable_compaction_priority_scheduling, "true");
603
DEFINE_mInt32(low_priority_compaction_task_num_per_disk, "2");
604
DEFINE_mInt32(low_priority_compaction_score_threshold, "200");
605
606
// Thread count to do tablet meta checkpoint, -1 means use the data directories count.
607
DEFINE_Int32(max_meta_checkpoint_threads, "-1");
608
609
// Threshold to logging agent task trace, in seconds.
610
DEFINE_mInt32(agent_task_trace_threshold_sec, "2");
611
612
// This config can be set to limit thread number in tablet migration thread pool.
613
DEFINE_Int32(min_tablet_migration_threads, "1");
614
DEFINE_Int32(max_tablet_migration_threads, "1");
615
616
DEFINE_mInt32(finished_migration_tasks_size, "10000");
617
// If size less than this, the remaining rowsets will be force to complete
618
DEFINE_mInt32(migration_remaining_size_threshold_mb, "10");
619
// If the task runs longer than this time, the task will be terminated, in seconds.
620
// timeout = std::max(migration_task_timeout_secs,  tablet size / 1MB/s)
621
DEFINE_mInt32(migration_task_timeout_secs, "300");
622
// timeout for try_lock migration lock
623
DEFINE_Int64(migration_lock_timeout_ms, "1000");
624
625
// Port to start debug webserver on
626
DEFINE_Int32(webserver_port, "8040");
627
// TLS module enable flag
628
DEFINE_Bool(enable_tls, "false");
629
// Path of TLS certificate
630
DEFINE_String(tls_certificate_path, "");
631
// Path of TLS private key
632
DEFINE_String(tls_private_key_path, "");
633
// Password for encrypted TLS private key
634
DEFINE_String(tls_private_key_password, "");
635
// TLS peer verification mode
636
DEFINE_String(tls_verify_mode, "verify_peer");
637
// Path of TLS CA certificate
638
DEFINE_String(tls_ca_certificate_path, "");
639
// TLS certificate reload interval, in seconds
640
DEFINE_Int32(tls_cert_refresh_interval_seconds, "3600");
641
// Comma-separated excluded server protocols: brpc,thrift,http,arrowflight
642
DEFINE_String(tls_excluded_protocols, "");
643
// Required peer certificate DNS SAN allowlist for private protocols, syntax: brpc=a.com;thrift=b.com.
644
// Empty means allow all peers. Once configured, the list acts as an allowlist and only peers whose
645
// DNS SAN matches at least one configured entry for that protocol are allowed.
646
DEFINE_String(tls_peer_cert_required_san_dns, "");
647
// Https enable flag
648
DEFINE_Bool(enable_https, "false");
649
// Path of certificate
650
DEFINE_String(ssl_certificate_path, "");
651
// Path of private key
652
DEFINE_String(ssl_private_key_path, "");
653
// Whether to check authorization
654
DEFINE_Bool(enable_all_http_auth, "false");
655
// Number of webserver workers
656
DEFINE_Int32(webserver_num_workers, "128");
657
658
// Async replies: stream load only now
659
// reply wait timeout only happens if:
660
// 1. Stream load fragment execution times out
661
//    HTTP request freed → stream load canceled
662
// 2. Client disconnects
663
DEFINE_mInt32(async_reply_timeout_s, "60");
664
DEFINE_Validator(async_reply_timeout_s, [](const int config) -> bool { return config >= 3; });
665
666
// Used for mini Load. mini load data file will be removed after this time.
667
DEFINE_Int64(load_data_reserve_hours, "4");
668
// log error log will be removed after this time
669
DEFINE_mInt64(load_error_log_reserve_hours, "48");
670
// error log size limit, default 200MB
671
DEFINE_mInt64(load_error_log_limit_bytes, "209715200");
672
673
// Dedicated load cancellation workers. Requires a restart.
674
DEFINE_Int32(brpc_load_light_work_pool_threads, "32");
675
DEFINE_Validator(brpc_load_light_work_pool_threads,
676
                 [](const int config) -> bool { return config > 0; });
677
// Queue capacity: -1 selects a CPU-scaled default. Requires a restart.
678
DEFINE_Int32(brpc_load_light_work_pool_max_queue_size, "-1");
679
DEFINE_Validator(brpc_load_light_work_pool_max_queue_size,
680
                 [](const int config) -> bool { return config == -1 || config > 0; });
681
682
DEFINE_Int32(brpc_heavy_work_pool_threads, "-1");
683
DEFINE_Int32(brpc_peer_fetch_pool_threads, "-1");
684
DEFINE_Int32(brpc_light_work_pool_threads, "-1");
685
DEFINE_Int32(brpc_heavy_work_pool_max_queue_size, "-1");
686
DEFINE_Int32(brpc_peer_fetch_pool_max_queue_size, "-1");
687
DEFINE_Int32(brpc_light_work_pool_max_queue_size, "-1");
688
DEFINE_mBool(enable_bthread_transmit_block, "true");
689
DEFINE_Int32(brpc_arrow_flight_work_pool_threads, "-1");
690
DEFINE_Int32(brpc_arrow_flight_work_pool_max_queue_size, "-1");
691
692
//Enable brpc builtin services, see:
693
//https://brpc.apache.org/docs/server/basics/#disable-built-in-services-completely
694
DEFINE_Bool(enable_brpc_builtin_services, "true");
695
696
// Enable brpc connection check
697
DEFINE_Bool(enable_brpc_connection_check, "false");
698
699
DEFINE_mInt64(brpc_connection_check_timeout_ms, "10000");
700
701
// The maximum amount of data that can be processed by a stream load
702
DEFINE_mInt64(streaming_load_max_mb, "102400");
703
// Some data formats, such as JSON, cannot be streamed.
704
// Therefore, it is necessary to limit the maximum number of
705
// such data when using stream load to prevent excessive memory consumption.
706
DEFINE_mInt64(streaming_load_json_max_mb, "100");
707
// the alive time of a TabletsChannel.
708
// If the channel does not receive any data till this time,
709
// the channel will be removed.
710
DEFINE_mInt32(streaming_load_rpc_max_alive_time_sec, "1200");
711
// the timeout of a rpc to open the tablet writer in remote BE.
712
// short operation time, can set a short timeout
713
DEFINE_Int32(tablet_writer_open_rpc_timeout_sec, "60");
714
// You can ignore brpc error '[E1011]The server is overcrowded' when writing data.
715
DEFINE_mBool(tablet_writer_ignore_eovercrowded, "true");
716
// Whether to enable stream load record function, the default is false.
717
// False: disable stream load record
718
DEFINE_mBool(enable_stream_load_record, "false");
719
// Whether to enable stream load record to audit log table, the default is true.
720
DEFINE_mBool(enable_stream_load_record_to_audit_log_table, "false");
721
// the maximum bytes of a batch of stream load records to audit log table
722
DEFINE_mInt64(stream_load_record_batch_bytes, "104857600"); // 100MB
723
// the interval to send a batch of stream load records to audit log table
724
DEFINE_mInt64(stream_load_record_batch_interval_secs, "120"); // 2 minutes
725
// batch size of stream load record reported to FE
726
DEFINE_mInt32(stream_load_record_batch_size, "50");
727
// expire time of stream load record in rocksdb.
728
DEFINE_Int32(stream_load_record_expire_time_secs, "28800");
729
// time interval to clean expired stream load records
730
DEFINE_mInt64(clean_stream_load_record_interval_secs, "1800");
731
// enable stream load commit txn on BE directly, bypassing FE. Only for cloud.
732
DEFINE_mBool(enable_stream_load_commit_txn_on_be, "false");
733
// The buffer size to store stream table function schema info
734
DEFINE_Int64(stream_tvf_buffer_size, "1048576"); // 1MB
735
736
// request cdc client timeout
737
DEFINE_mInt32(request_cdc_client_timeout_ms, "120000");
738
739
// OlapTableSink sender's send interval, should be less than the real response time of a tablet writer rpc.
740
// You may need to lower the speed when the sink receiver bes are too busy.
741
DEFINE_mInt32(olap_table_sink_send_interval_microseconds, "1000");
742
DEFINE_mDouble(olap_table_sink_send_interval_auto_partition_factor, "0.001");
743
744
// Fragment thread pool
745
DEFINE_Int32(fragment_mgr_async_work_pool_thread_num_min, "16");
746
DEFINE_Int32(fragment_mgr_async_work_pool_thread_num_max, "2048");
747
DEFINE_Int32(fragment_mgr_async_work_pool_queue_size, "4096");
748
749
// The read size is the size of the reads sent to os.
750
// There is a trade off of latency and throughout, trying to keep disks busy but
751
// not introduce seeks. The literature seems to agree that with 8 MB reads, random
752
// io and sequential io perform similarly.
753
DEFINE_Int32(min_buffer_size, "1024"); // 1024, The minimum read buffer size (in bytes)
754
755
// for pprof
756
DEFINE_String(pprof_profile_dir, "${DORIS_HOME}/log");
757
// for jeprofile in jemalloc
758
DEFINE_mString(jeprofile_dir, "${DORIS_HOME}/log");
759
DEFINE_mBool(enable_je_purge_dirty_pages, "true");
760
DEFINE_mInt32(je_dirty_decay_ms, "5000");
761
762
// to forward compatibility, will be removed later
763
DEFINE_mBool(enable_token_check, "true");
764
765
// to open/close system metrics
766
DEFINE_Bool(enable_system_metrics, "true");
767
768
// Number of cores Doris will used, this will effect only when it's greater than 0.
769
// Otherwise, Doris will use all cores returned from "/proc/cpuinfo".
770
DEFINE_Int32(num_cores, "0");
771
772
// When BE start, If there is a broken disk, BE process will exit by default.
773
// Otherwise, we will ignore the broken disk,
774
DEFINE_Bool(ignore_broken_disk, "false");
775
DEFINE_Bool(ignore_file_cache_dir_upgrade_failure, "false");
776
777
// Sleep time in milliseconds between memory maintenance iterations
778
DEFINE_mInt32(memory_maintenance_sleep_time_ms, "50");
779
780
// Memory gc are expensive, wait a while to avoid too frequent.
781
DEFINE_mInt32(memory_gc_sleep_time_ms, "500");
782
783
// max write buffer size before flush, default 200MB
784
DEFINE_mInt64(write_buffer_size, "209715200");
785
DEFINE_mBool(enable_adaptive_write_buffer_size, "true");
786
// max buffer size used in memtable for the aggregated table, default 400MB
787
DEFINE_mInt64(write_buffer_size_for_agg, "104857600");
788
DEFINE_mInt64(min_write_buffer_size_for_partial_update, "1048576");
789
// max parallel flush task per memtable writer
790
DEFINE_mInt32(memtable_flush_running_count_limit, "2");
791
792
// maximum sleep time to wait for memory when writing or flushing memtable.
793
DEFINE_mInt32(memtable_wait_for_memory_sleep_time_s, "300");
794
795
DEFINE_Int32(load_process_max_memory_limit_percent, "50"); // 50%
796
797
// If the memory consumption of load jobs exceed load_process_max_memory_limit,
798
// all load jobs will hang there to wait for memtable flush. We should have a
799
// soft limit which can trigger the memtable flush for the load channel who
800
// consumes lagest memory size before we reach the hard limit. The soft limit
801
// might avoid all load jobs hang at the same time.
802
DEFINE_Int32(load_process_soft_mem_limit_percent, "80");
803
804
// If load memory consumption is within load_process_safe_mem_permit_percent,
805
// memtable memory limiter will do nothing.
806
DEFINE_Int32(load_process_safe_mem_permit_percent, "5");
807
808
// result buffer cancelled time (unit: second)
809
DEFINE_mInt32(result_buffer_cancelled_interval_time, "300");
810
811
// arrow flight result sink buffer rows size, default 4096 * 8
812
DEFINE_mInt32(arrow_flight_result_sink_buffer_size_rows, "32768");
813
// The timeout for ADBC Client to wait for data using arrow flight reader.
814
// If the query is very complex and no result is generated after this time, consider increasing this timeout.
815
DEFINE_mInt32(arrow_flight_reader_brpc_controller_timeout_ms, "300000");
816
817
// the increased frequency of priority for remaining tasks in BlockingPriorityQueue
818
DEFINE_mInt32(priority_queue_remaining_tasks_increased_frequency, "512");
819
820
// sync tablet_meta when modifying meta
821
DEFINE_mBool(sync_tablet_meta, "false");
822
823
// sync when closing a file writer
824
DEFINE_mBool(sync_file_on_close, "true");
825
826
// default thrift rpc timeout ms
827
DEFINE_mInt32(thrift_rpc_timeout_ms, "60000");
828
829
// txn commit rpc timeout
830
DEFINE_mInt32(txn_commit_rpc_timeout_ms, "180000");
831
832
// If set to true, metric calculator will run
833
DEFINE_Bool(enable_metric_calculator, "true");
834
835
// max consumer num in one data consumer group, for routine load
836
DEFINE_mInt32(max_consumer_num_per_group, "3");
837
838
// the max size of thread pool for routine load task.
839
// this should be larger than FE config 'max_routine_load_task_num_per_be' (default 5)
840
DEFINE_Int32(max_routine_load_thread_pool_size, "1024");
841
842
// the timeout of condition variable wait in blocking_get and blocking_put
843
DEFINE_mInt32(blocking_queue_cv_wait_timeout_ms, "1000");
844
845
// max external scan cache batch count, means cache max_memory_cache_batch_count * batch_size row
846
// default is 20, batch_size's default value is 1024 means 20 * 1024 rows will be cached
847
DEFINE_mInt32(max_memory_sink_batch_count, "20");
848
849
// This configuration is used for the context gc thread schedule period
850
// note: unit is minute, default is 5min
851
DEFINE_mInt32(scan_context_gc_interval_min, "5");
852
853
// es scroll keep-alive
854
DEFINE_String(es_scroll_keepalive, "5m");
855
856
// HTTP connection timeout for es
857
DEFINE_mInt32(es_http_timeout_ms, "5000");
858
859
// the max client cache number per each host
860
// There are variety of client cache in BE, but currently we use the
861
// same cache size configuration.
862
// TODO(cmy): use different config to set different client cache if necessary.
863
DEFINE_Int32(max_client_cache_size_per_host, "10");
864
865
DEFINE_Int32(max_master_fe_client_cache_size, "10");
866
867
// Dir to save files downloaded by SmallFileMgr
868
DEFINE_String(small_file_dir, "${DORIS_HOME}/lib/small_file/");
869
// path gc
870
DEFINE_Bool(path_gc_check, "true");
871
DEFINE_mInt32(path_gc_check_interval_second, "86400");
872
DEFINE_mInt32(path_gc_check_step, "1000");
873
DEFINE_mInt32(path_gc_check_step_interval_ms, "10");
874
875
// The following 2 configs limit the max usage of disk capacity of a data dir.
876
// If both of these 2 threshold reached, no more data can be writen into that data dir.
877
// The percent of max used capacity of a data dir
878
DEFINE_mInt32(storage_flood_stage_usage_percent, "90"); // 90%
879
// The min bytes that should be left of a data dir
880
DEFINE_mInt64(storage_flood_stage_left_capacity_bytes, "1073741824"); // 1GB
881
// number of thread for flushing memtable per store
882
DEFINE_mInt32(flush_thread_num_per_store, "6");
883
// number of thread for flushing memtable per store, for high priority load task
884
DEFINE_mInt32(high_priority_flush_thread_num_per_store, "6");
885
// number of threads = min(flush_thread_num_per_store * num_store,
886
//                         max_flush_thread_num_per_cpu * num_cpu)
887
DEFINE_mInt32(max_flush_thread_num_per_cpu, "4");
888
889
// minimum flush threads per cpu when adaptive flush is enabled (default 0.5)
890
DEFINE_mDouble(min_flush_thread_num_per_cpu, "0.5");
891
892
// Whether to enable adaptive flush thread adjustment
893
DEFINE_mBool(enable_adaptive_flush_threads, "true");
894
895
// Whether to block writes when one table has too many pending flush memtables on this BE.
896
DEFINE_mBool(enable_table_memtable_flush_backpressure, "true");
897
// Max pending flush memtables for one table on this BE before blocking new writes.
898
DEFINE_mInt32(table_memtable_flush_pending_count_limit, "10");
899
900
// config for tablet meta checkpoint
901
DEFINE_mInt32(tablet_meta_checkpoint_min_new_rowsets_num, "10");
902
DEFINE_mInt32(tablet_meta_checkpoint_min_interval_secs, "600");
903
DEFINE_Int32(generate_tablet_meta_checkpoint_tasks_interval_secs, "600");
904
905
// config for default rowset type
906
// Valid configs: ALPHA, BETA
907
DEFINE_String(default_rowset_type, "BETA");
908
909
// Maximum size of a single message body in all protocols
910
DEFINE_Int64(brpc_max_body_size, "3147483648");
911
DEFINE_Int64(brpc_socket_max_unwritten_bytes, "-1");
912
DEFINE_mBool(brpc_usercode_in_pthread, "false");
913
914
// TODO(zxy): expect to be true in v1.3
915
// Whether to embed the ProtoBuf Request serialized string together with Tuple/Block data into
916
// Controller Attachment and send it through http brpc when the length of the Tuple/Block data
917
// is greater than 1.8G. This is to avoid the error of Request length overflow (2G).
918
DEFINE_mBool(transfer_large_data_by_brpc, "true");
919
920
// max number of txns for every txn_partition_map in txn manager
921
// this is a self protection to avoid too many txns saving in manager
922
DEFINE_mInt64(max_runnings_transactions_per_txn_map, "2000");
923
924
// tablet_map_lock shard size, the value is 2^n, n=0,1,2,3,4
925
// this is a an enhancement for better performance to manage tablet
926
DEFINE_Int32(tablet_map_shard_size, "256");
927
928
// txn_map_lock shard size, the value is 2^n, n=0,1,2,3,4
929
// this is a an enhancement for better performance to manage txn
930
DEFINE_Int32(txn_map_shard_size, "1024");
931
932
// txn_lock shard size, the value is 2^n, n=0,1,2,3,4
933
// this is a an enhancement for better performance to commit and publish txn
934
DEFINE_Int32(txn_shard_size, "1024");
935
936
// Whether to continue to start be when load tablet from header failed.
937
DEFINE_Bool(ignore_load_tablet_failure, "true");
938
939
// Whether to continue to start be when load tablet from header failed.
940
DEFINE_mBool(ignore_rowset_stale_unconsistent_delete, "false");
941
942
// Set max cache's size of query results, the unit is M byte
943
DEFINE_Int32(query_cache_max_size_mb, "256");
944
945
// Cache memory is pruned when reach query_cache_max_size_mb + query_cache_elasticity_size_mb
946
DEFINE_Int32(query_cache_elasticity_size_mb, "128");
947
948
// Maximum number of cache partitions corresponding to a SQL
949
DEFINE_Int32(query_cache_max_partition_count, "1024");
950
951
// Maximum number of version of a tablet. If the version num of a tablet exceed limit,
952
// the load process will reject new incoming load job of this tablet.
953
// This is to avoid too many version num.
954
DEFINE_mInt32(max_tablet_version_num, "2000");
955
956
DEFINE_mInt32(time_series_max_tablet_version_num, "20000");
957
958
// the max sleep time when meeting high pressure load task
959
DEFINE_mInt64(max_load_back_pressure_version_wait_time_ms, "3000");
960
// the threshold of rowset number gap that triggers back pressure
961
DEFINE_mInt64(load_back_pressure_version_threshold, "80"); // 80%
962
963
// Frontend mainly use two thrift sever type: THREAD_POOL, THREADED_SELECTOR. if fe use THREADED_SELECTOR model for thrift server,
964
// the thrift_server_type_of_fe should be set THREADED_SELECTOR to make be thrift client to fe constructed with TFramedTransport
965
DEFINE_String(thrift_server_type_of_fe, "THREAD_POOL");
966
967
// disable zone map index when page row is too few
968
DEFINE_mInt32(zone_map_row_num_threshold, "20");
969
970
// Maximum number of IN values checked exactly against a zone map. For larger sets, only the
971
// IN-set min/max range is checked.
972
DEFINE_mInt32(in_zonemap_point_check_threshold, "8192");
973
974
// aws sdk log level
975
//    Off = 0,
976
//    Fatal = 1,
977
//    Error = 2,
978
//    Warn = 3,
979
//    Info = 4,
980
//    Debug = 5,
981
//    Trace = 6
982
DEFINE_Int32(aws_log_level, "2");
983
DEFINE_Validator(aws_log_level,
984
                 [](const int config) -> bool { return config >= 0 && config <= 6; });
985
986
// azure sdk log level
987
//    Verbose = 1,
988
//    Informational = 2,
989
//    Warning = 3,
990
//    Error = 4
991
DEFINE_Int32(azure_log_level, "4");
992
DEFINE_Validator(azure_log_level,
993
                 [](const int config) -> bool { return config >= 1 && config <= 4; });
994
995
// the buffer size when read data from remote storage like s3
996
DEFINE_mInt32(remote_storage_read_buffer_mb, "16");
997
998
// The minimum length when TCMalloc Hook consumes/releases MemTracker, consume size
999
// smaller than this value will continue to accumulate. specified as number of bytes.
1000
// Decreasing this value will increase the frequency of consume/release.
1001
// Increasing this value will cause MemTracker statistics to be inaccurate.
1002
DEFINE_mInt32(mem_tracker_consume_min_size_bytes, "1048576");
1003
1004
// The version information of the tablet will be stored in the memory
1005
// in an adjacency graph data structure.
1006
// And as the new version is written and the old version is deleted,
1007
// the data structure will begin to have empty vertex with no edge associations(orphan vertex).
1008
// This config is used to control that when the proportion of orphan vertex is greater than the threshold,
1009
// the adjacency graph will be rebuilt to ensure that the data structure will not expand indefinitely.
1010
// This config usually only needs to be modified during testing.
1011
// In most cases, it does not need to be modified.
1012
DEFINE_mDouble(tablet_version_graph_orphan_vertex_ratio, "0.1");
1013
1014
// share delta writers when memtable_on_sink_node = true
1015
DEFINE_Bool(share_delta_writers, "true");
1016
// timeout for open load stream rpc in ms
1017
DEFINE_Int64(open_load_stream_timeout_ms, "60000"); // 60s
1018
// enable write background when using brpc stream
1019
DEFINE_mBool(enable_brpc_stream_write_background, "true");
1020
1021
// brpc streaming max_buf_size in bytes
1022
DEFINE_Int64(load_stream_max_buf_size, "20971520"); // 20MB
1023
// brpc streaming messages_in_batch
1024
DEFINE_Int32(load_stream_messages_in_batch, "128");
1025
// brpc streaming StreamWait seconds on EAGAIN
1026
DEFINE_Int32(load_stream_eagain_wait_seconds, "600");
1027
// max tasks per flush token in load stream
1028
DEFINE_Int32(load_stream_flush_token_max_tasks, "15");
1029
// max wait flush token time in load stream
1030
DEFINE_Int32(load_stream_max_wait_flush_token_time_ms, "600000");
1031
// number of send batch thread pool size
1032
DEFINE_Int32(send_batch_thread_pool_thread_num, "64");
1033
// number of send batch thread pool queue size
1034
DEFINE_Int32(send_batch_thread_pool_queue_size, "102400");
1035
1036
// Limit the number of segment of a newly created rowset.
1037
// The newly created rowset may to be compacted after loading,
1038
// so if there are too many segment in a rowset, the compaction process
1039
// will run out of memory.
1040
// When doing compaction, each segment may take at least 1MB buffer.
1041
DEFINE_mInt32(max_segment_num_per_rowset, "1000");
1042
DEFINE_mInt32(segment_compression_threshold_kb, "256");
1043
1044
// Global bitmap cache capacity for aggregation cache, size in bytes
1045
DEFINE_Int64(delete_bitmap_agg_cache_capacity, "104857600");
1046
// The default delete bitmap cache is set to 100MB,
1047
// which can be insufficient and cause performance issues when the amount of user data is large.
1048
// To mitigate the problem of an inadequate cache,
1049
// we will take the larger of 1.0% of the total memory and 100MB as the delete bitmap cache size.
1050
DEFINE_String(delete_bitmap_dynamic_agg_cache_limit, "1.0%");
1051
DEFINE_mInt32(delete_bitmap_agg_cache_stale_sweep_time_sec, "1800");
1052
1053
// reference https://github.com/edenhill/librdkafka/blob/master/INTRODUCTION.md#broker-version-compatibility
1054
// If the dependent kafka broker version older than 0.10.0.0,
1055
// the value of kafka_api_version_request should be false, and the
1056
// value set by the fallback version kafka_broker_version_fallback will be used,
1057
// and the valid values are: 0.9.0.x, 0.8.x.y.
1058
DEFINE_String(kafka_api_version_request, "true");
1059
DEFINE_String(kafka_broker_version_fallback, "0.10.0");
1060
DEFINE_String(kafka_debug, "disable");
1061
1062
// The number of pool siz of routine load consumer.
1063
// If you meet the error describe in https://github.com/edenhill/librdkafka/issues/3608
1064
// Change this size to 0 to fix it temporarily.
1065
DEFINE_mInt32(routine_load_consumer_pool_size, "1024");
1066
1067
// Used in single-stream-multi-table load. When receive a batch of messages from kafka,
1068
// if the size of batch is more than this threshold, we will request plans for all related tables.
1069
DEFINE_Int32(multi_table_batch_plan_threshold, "200");
1070
1071
// Used in single-stream-multi-table load. When receiving a batch of messages from Kafka,
1072
// if the size of the table wait for plan is more than this threshold, we will request plans for all related tables.
1073
// The param is aimed to avoid requesting and executing too many plans at once.
1074
// Performing small batch processing on multiple tables during the loaded process can reduce the pressure of a single RPC
1075
// and improve the real-time processing of data.
1076
DEFINE_Int32(multi_table_max_wait_tables, "5");
1077
1078
// When the timeout of a load task is less than this threshold,
1079
// Doris treats it as a high priority task.
1080
// high priority tasks use a separate thread pool for flush and do not block rpc by memory cleanup logic.
1081
// this threshold is mainly used to identify routine load tasks and should not be modified if not necessary.
1082
DEFINE_mInt32(load_task_high_priority_threshold_second, "600");
1083
1084
// The min timeout of load rpc (add batch, close, etc.)
1085
// Because a load rpc may be blocked for a while.
1086
// Increase this config may avoid rpc timeout.
1087
DEFINE_mInt32(min_load_rpc_timeout_ms, "20000");
1088
1089
// use which protocol to access function service, candicate is baidu_std/h2:grpc
1090
DEFINE_String(function_service_protocol, "h2:grpc");
1091
1092
// use which load balancer to select server to connect
1093
DEFINE_String(rpc_load_balancer, "rr");
1094
1095
// a soft limit of string type length, the hard limit is 2GB - 4, but if too long will cause very low performance,
1096
// so we set a soft limit, default is 10MB
1097
DEFINE_Int32(string_type_length_soft_limit_bytes, "10485760");
1098
1099
DEFINE_Validator(string_type_length_soft_limit_bytes,
1100
                 [](const int config) -> bool { return config > 0 && config <= 2147483643; });
1101
1102
// Threshold of reading a small file into memory
1103
DEFINE_mInt32(in_memory_file_size, "1048576"); // 1MB
1104
1105
// Max size of parquet page header in bytes
1106
DEFINE_mInt32(parquet_header_max_size_mb, "1");
1107
// Max size of parquet file metadata in bytes
1108
DEFINE_mInt64(parquet_metadata_size_limit, "268435456");
1109
DEFINE_Validator(parquet_metadata_size_limit,
1110
                 [](const int64_t config) -> bool { return config > 0; });
1111
// Max buffer size for parquet row group
1112
DEFINE_mInt32(parquet_rowgroup_max_buffer_mb, "128");
1113
// Max buffer size for parquet chunk column
1114
DEFINE_mInt32(parquet_column_max_buffer_mb, "8");
1115
DEFINE_mDouble(max_amplified_read_ratio, "0.8");
1116
DEFINE_mInt32(merged_oss_min_io_size, "1048576");
1117
DEFINE_mInt32(merged_hdfs_min_io_size, "8192");
1118
1119
// OrcReader
1120
DEFINE_mInt32(orc_natural_read_size_mb, "8");
1121
DEFINE_Validator(orc_natural_read_size_mb,
1122
                 [](const int config) -> bool { return config > 0 && config <= 1024; });
1123
// Perform the always_true check at intervals determined by runtime_filter_sampling_frequency
1124
DEFINE_mInt32(runtime_filter_sampling_frequency, "32");
1125
DEFINE_mInt32(execution_max_rpc_timeout_sec, "3600");
1126
DEFINE_mBool(execution_ignore_eovercrowded, "true");
1127
// cooldown task configs
1128
DEFINE_Int32(cooldown_thread_num, "5");
1129
DEFINE_mInt64(generate_cooldown_task_interval_sec, "20");
1130
DEFINE_mInt32(remove_unused_remote_files_interval_sec, "21600"); // 6h
1131
DEFINE_mInt32(confirm_unused_remote_files_interval_sec, "60");
1132
DEFINE_Int32(cold_data_compaction_thread_num, "2");
1133
DEFINE_mInt32(cold_data_compaction_interval_sec, "1800");
1134
DEFINE_mInt32(cold_data_compaction_score_threshold, "100");
1135
1136
DEFINE_String(tmp_file_dir, "tmp");
1137
1138
DEFINE_Int32(min_s3_file_system_thread_num, "16");
1139
DEFINE_Int32(max_s3_file_system_thread_num, "64");
1140
1141
DEFINE_Int32(min_peer_race_s3_thread_num, "0");
1142
DEFINE_Int32(max_peer_race_s3_thread_num, "32"); // aligned with default max_concurrent_peer_races
1143
1144
DEFINE_Bool(enable_time_lut, "true");
1145
1146
DEFINE_mBool(enable_query_like_bloom_filter, "true");
1147
// number of s3 scanner thread pool size
1148
DEFINE_Int32(doris_remote_scanner_thread_pool_thread_num, "48");
1149
// number of s3 scanner thread pool queue size
1150
DEFINE_Int32(doris_remote_scanner_thread_pool_queue_size, "102400");
1151
DEFINE_mInt64(block_cache_wait_timeout_ms, "1000");
1152
1153
// limit the queue of pending batches which will be sent by a single nodechannel
1154
DEFINE_mInt64(nodechannel_pending_queue_max_bytes, "67108864");
1155
1156
// The batch size for sending data by brpc streaming client
1157
DEFINE_mInt64(brpc_streaming_client_batch_bytes, "262144");
1158
1159
DEFINE_mInt32(fragment_mgr_cancel_worker_interval_seconds, "1");
1160
1161
// Node role tag for backend. Mix role is the default role, and computation role have no
1162
// any tablet.
1163
DEFINE_String(be_node_role, "mix");
1164
1165
// Hide webserver page for safety.
1166
// Hide the be config page for webserver.
1167
DEFINE_Bool(hide_webserver_config_page, "false");
1168
1169
DEFINE_Bool(enable_segcompaction, "true");
1170
1171
// Max number of segments allowed in a single segcompaction task.
1172
DEFINE_mInt32(segcompaction_batch_size, "10");
1173
1174
// Max row count allowed in a single source segment, bigger segments will be skipped.
1175
DEFINE_Int32(segcompaction_candidate_max_rows, "1048576");
1176
1177
// Max file size allowed in a single source segment, bigger segments will be skipped.
1178
DEFINE_Int64(segcompaction_candidate_max_bytes, "104857600");
1179
1180
// Max total row count allowed in a single segcompaction task.
1181
DEFINE_Int32(segcompaction_task_max_rows, "1572864");
1182
1183
// Max total file size allowed in a single segcompaction task.
1184
DEFINE_Int64(segcompaction_task_max_bytes, "157286400");
1185
1186
// Global segcompaction thread pool size.
1187
DEFINE_mInt32(segcompaction_num_threads, "5");
1188
1189
// enable java udf and jdbc scannode
1190
DEFINE_Bool(enable_java_support, "true");
1191
1192
// enable python udf
1193
DEFINE_Bool(enable_python_udf_support, "false");
1194
// python env mode, options: conda, venv
1195
DEFINE_String(python_env_mode, "");
1196
// root path of conda runtime, python_env_mode should be conda
1197
DEFINE_String(python_conda_root_path, "");
1198
// root path of venv runtime, python_env_mode should be venv
1199
DEFINE_String(python_venv_root_path, "${DORIS_HOME}/lib/udf/python");
1200
// python interpreter paths used by venv, e.g. /usr/bin/python3.7:/usr/bin/python3.6
1201
DEFINE_String(python_venv_interpreter_paths, "");
1202
// max python processes in global shared pool, each version can have up to this many processes
1203
// 0 means use CPU core count as default, otherwise use the specified value
1204
DEFINE_mInt32(max_python_process_num, "0");
1205
// Memory limit in bytes for all Python UDF processes; warning is logged when exceeded
1206
// default is 10GB
1207
DEFINE_mInt64(python_udf_processes_memory_limit_bytes, "10737418240");
1208
1209
// Set config randomly to check more issues in github workflow
1210
DEFINE_Bool(enable_fuzzy_mode, "false");
1211
1212
DEFINE_Bool(enable_graceful_exit_check, "false");
1213
1214
DEFINE_Bool(enable_debug_points, "false");
1215
1216
DEFINE_Int32(pipeline_executor_size, "0");
1217
DEFINE_Int32(blocking_pipeline_executor_size, "0");
1218
DEFINE_mInt32(variant_max_json_key_length, "255");
1219
// Controls storage-layer parse target for plain non-doc VARIANT columns:
1220
// 0 = auto, 1 = force parse-time subcolumns, 2 = force doc-value KV staging.
1221
// NestedGroup, deprecated flatten-nested, and persistent doc mode keep their required paths.
1222
DEFINE_mInt32(variant_storage_parse_mode, "0");
1223
DEFINE_mBool(enable_vertical_compact_variant_subcolumns, "true");
1224
DEFINE_mBool(enable_variant_doc_sparse_write_subcolumns, "true");
1225
// Maximum depth of nested arrays to track with NestedGroup
1226
// Reserved for future use when NestedGroup expansion moves to storage layer
1227
// Deeper arrays will be stored as JSONB
1228
DEFINE_mInt32(variant_nested_group_max_depth, "10");
1229
DEFINE_mBool(variant_nested_group_discard_scalar_on_conflict, "true");
1230
1231
DEFINE_Validator(variant_max_json_key_length,
1232
                 [](const int config) -> bool { return config > 0 && config <= 65535; });
1233
DEFINE_Validator(variant_storage_parse_mode,
1234
                 [](const int config) -> bool { return config >= 0 && config <= 2; });
1235
1236
// block file cache
1237
DEFINE_Bool(enable_file_cache, "true");
1238
// ATTENTION: For test only. Keep this enabled in production.
1239
// Whether S3 storage write paths populate file cache while writing data to object storage.
1240
// Disable this for tests that need load and compaction output to bypass file cache while keeping
1241
// query-side file cache writes enabled.
1242
DEFINE_mBool(enable_file_cache_write_from_s3_file_writer, "true");
1243
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240}]
1244
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240},{"path":"/path/to/file_cache2","total_size":21474836480,"query_limit":10737418240}]
1245
// format: {"path": "/path/to/file_cache", "total_size":53687091200, "ttl_percent":50, "normal_percent":40, "disposable_percent":5, "index_percent":5}
1246
// format: [{"path": "xxx", "total_size":53687091200, "storage": "memory"}]
1247
// Note1: storage is "disk" by default
1248
// Note2: when the storage is "memory", the path is ignored. So you can set xxx to anything you like
1249
// and doris will just reset the path to "memory" internally.
1250
// In a very wierd case when your storage is disk, and the directory, by accident, is named
1251
// "memory" for some reason, you should write the path as:
1252
//     {"path": "memory", "total_size":53687091200, "storage": "disk"}
1253
// or use the default storage value:
1254
//     {"path": "memory", "total_size":53687091200}
1255
// Both will use the directory "memory" on the disk instead of the real RAM.
1256
DEFINE_String(file_cache_path, "[{\"path\":\"${DORIS_HOME}/file_cache\"}]");
1257
DEFINE_Int64(file_cache_each_block_size, "1048576"); // 1MB
1258
1259
DEFINE_Bool(clear_file_cache, "false");
1260
DEFINE_mBool(enable_file_cache_query_limit, "false");
1261
// Whether segment footer and segment metadata count toward file cache query limit.
1262
DEFINE_mBool(enable_file_cache_query_limit_segment_meta, "false");
1263
DEFINE_mInt32(file_cache_enter_disk_resource_limit_mode_percent, "90");
1264
DEFINE_mInt32(file_cache_exit_disk_resource_limit_mode_percent, "88");
1265
DEFINE_mBool(enable_evict_file_cache_in_advance, "true");
1266
DEFINE_mInt32(file_cache_enter_need_evict_cache_in_advance_percent, "88");
1267
DEFINE_mInt32(file_cache_exit_need_evict_cache_in_advance_percent, "85");
1268
DEFINE_mInt32(file_cache_evict_in_advance_interval_ms, "1000");
1269
DEFINE_mInt64(file_cache_evict_in_advance_batch_bytes, "31457280"); // 30MB
1270
DEFINE_mInt64(file_cache_evict_in_advance_recycle_keys_num_threshold, "1000");
1271
1272
DEFINE_mBool(enable_read_cache_file_directly, "true");
1273
DEFINE_mBool(file_cache_enable_evict_from_other_queue_by_size, "true");
1274
DEFINE_mBool(enbale_dump_error_file, "false");
1275
// limit the max size of error log on disk
1276
DEFINE_mInt64(file_cache_error_log_limit_bytes, "209715200"); // 200MB
1277
DEFINE_mInt64(cache_lock_wait_long_tail_threshold_us, "30000000");
1278
DEFINE_mInt64(cache_lock_held_long_tail_threshold_us, "30000000");
1279
1280
// enable_file_cache_keep_base_compaction_output true means force base compaction output rowsets
1281
// write to file cache, enable_file_cache_adaptive_write true means when file cache is enough, it
1282
// will write to file cache; satisfying any of the two conditions will write to file cache.
1283
DEFINE_mBool(enable_file_cache_keep_base_compaction_output, "false");
1284
DEFINE_mBool(enable_file_cache_adaptive_write, "true");
1285
DEFINE_mDouble(file_cache_keep_base_compaction_output_min_hit_ratio, "0.7");
1286
// if difference below this threshold, we consider cache's progressive upgrading (2.0->3.0) successful
1287
DEFINE_mDouble(file_cache_meta_store_vs_file_system_diff_num_threshold, "0.3");
1288
DEFINE_mDouble(file_cache_keep_schema_change_output_min_hit_ratio, "0.7");
1289
DEFINE_mDouble(file_cache_leak_fs_to_meta_ratio_threshold, "1.3");
1290
DEFINE_mInt64(file_cache_leak_scan_interval_seconds, "86400");
1291
DEFINE_mInt32(file_cache_leak_scan_batch_files, "2048");
1292
DEFINE_mInt32(file_cache_leak_scan_pause_ms, "500");
1293
DEFINE_mInt64(file_cache_leak_grace_seconds, "3600");
1294
1295
DEFINE_mInt64(file_cache_remove_block_qps_limit, "1000");
1296
DEFINE_mInt64(file_cache_background_gc_interval_ms, "100");
1297
DEFINE_mInt64(file_cache_background_block_lru_update_interval_ms, "5000");
1298
DEFINE_mInt64(file_cache_background_block_lru_update_qps_limit, "1000");
1299
DEFINE_mInt64(file_cache_background_block_lru_update_queue_max_size, "500000");
1300
DEFINE_mBool(enable_file_cache_async_touch_on_get_or_set, "false");
1301
DEFINE_mBool(enable_reader_dryrun_when_download_file_cache, "true");
1302
DEFINE_mInt64(file_cache_background_monitor_interval_ms, "5000");
1303
DEFINE_mInt64(file_cache_background_ttl_gc_interval_ms, "180000");
1304
DEFINE_mInt64(file_cache_background_ttl_info_update_interval_ms, "180000");
1305
DEFINE_mInt64(file_cache_background_tablet_id_flush_interval_ms, "1000");
1306
DEFINE_mInt64(file_cache_background_lru_dump_interval_ms, "60000");
1307
// dump queue only if the queue update specific times through several dump intervals
1308
DEFINE_mInt64(file_cache_background_lru_dump_update_cnt_threshold, "1000");
1309
// Disabled by default. The restored LRU order can be worse than no order at all: restored blocks
1310
// are put at the cold end while blocks missing from the dump are appended to the hot end, and the
1311
// restore itself can overflow the bounded LRU log queue and drop the hottest part of the dump.
1312
DEFINE_mInt64(file_cache_background_lru_dump_tail_record_num, "0");
1313
DEFINE_mInt64(file_cache_background_lru_log_queue_max_size, "500000");
1314
DEFINE_mInt64(file_cache_background_lru_log_replay_interval_ms, "1");
1315
DEFINE_mBool(enable_evaluate_shadow_queue_diff, "false");
1316
1317
DEFINE_mBool(file_cache_enable_only_warm_up_idx, "false");
1318
1319
DEFINE_Int32(file_cache_downloader_thread_num_min, "32");
1320
DEFINE_Int32(file_cache_downloader_thread_num_max, "32");
1321
1322
// async file cache write
1323
DEFINE_mBool(enable_async_file_cache_write, "false");
1324
DEFINE_mInt32(async_file_cache_write_workers_per_disk, "16");
1325
// A positive value is the BE-wide queued+active task ownership limit. The successfully initialized
1326
// cache instances receive equal shares. -1 selects max(1 GiB, 1% of the BE memory limit) before
1327
// that split.
1328
DEFINE_mInt64(async_file_cache_write_max_pending_bytes, "-1");
1329
DEFINE_mBool(enable_async_file_cache_write_inflight_write_buffer_index, "true");
1330
DEFINE_Int32(async_file_cache_write_inflight_write_buffer_index_shard_count, "64");
1331
DEFINE_Validator(async_file_cache_write_workers_per_disk,
1332
                 [](int32_t value) { return value > 0 && value <= 128; });
1333
DEFINE_Validator(async_file_cache_write_max_pending_bytes,
1334
                 [](int64_t value) { return value == -1 || value > 0; });
1335
DEFINE_Validator(async_file_cache_write_inflight_write_buffer_index_shard_count,
1336
                 [](int32_t value) { return value > 0; });
1337
1338
DEFINE_mInt32(index_cache_entry_stay_time_after_lookup_s, "1800");
1339
DEFINE_mInt32(inverted_index_cache_stale_sweep_time_sec, "600");
1340
DEFINE_mBool(enable_write_index_searcher_cache, "false");
1341
// inverted index searcher cache size
1342
DEFINE_String(inverted_index_searcher_cache_limit, "10%");
1343
DEFINE_Bool(enable_inverted_index_cache_check_timestamp, "true");
1344
DEFINE_mBool(enable_inverted_index_correct_term_write, "true");
1345
DEFINE_Int32(inverted_index_fd_number_limit_percent, "20"); // 20%
1346
DEFINE_Int32(inverted_index_query_cache_shards, "256");
1347
DEFINE_mDouble(inverted_index_candidate_pushdown_ratio, "0.3");
1348
DEFINE_Validator(inverted_index_candidate_pushdown_ratio,
1349
                 [](const double v) -> bool { return std::isfinite(v) && v <= 1.0; });
1350
static std::atomic<double> published_inverted_index_candidate_pushdown_ratio {0.0};
1351
DEFINE_ON_UPDATE(inverted_index_candidate_pushdown_ratio, [](double, double value) {
1352
    published_inverted_index_candidate_pushdown_ratio.store(value);
1353
});
1354
1355
4.78k
double get_inverted_index_candidate_pushdown_ratio() {
1356
4.78k
    return published_inverted_index_candidate_pushdown_ratio.load();
1357
4.78k
}
1358
1359
// inverted index match bitmap cache size
1360
DEFINE_String(inverted_index_query_cache_limit, "10%");
1361
1362
namespace {
1363
1364
1
bool valid_gram_index_candidate_ratio(int32_t value) {
1365
1
    return value >= 0;
1366
1
}
1367
1368
1
bool valid_gram_index_candidate_min_rows(int32_t value) {
1369
1
    return value >= 0;
1370
1
}
1371
1372
4
bool valid_gram_index_min_literal_bytes(int32_t value) {
1373
4
    return value >= 1;
1374
4
}
1375
1376
// A share of windows: (0, 1000]. 0 would ask for nothing and a negative value used to reach
1377
// the writer's checked cast and fail every gram-index load until the config was repaired.
1378
6
bool valid_gram_index_density_coverage_permille(int32_t value) {
1379
6
    return value >= 1 && value <= 1000;
1380
6
}
1381
1382
4
bool valid_gram_index_density_sample_bytes(int64_t value) {
1383
4
    return value >= 0;
1384
4
}
1385
1386
} // namespace
1387
1388
// Whether LIKE/REGEXP tries to compile a constant pattern into a gram boolean query pushed down
1389
// to a gram-family inverted index (master switch).
1390
DEFINE_mBool(enable_gram_index_regexp, "true");
1391
1392
// Cost gate for the gram boolean query: give up pruning above this share (in basis points) of a
1393
// segment's rows, and only on segments of at least this many rows. Giving up returns the segment's
1394
// whole docid range, so it can never drop a candidate row.
1395
DEFINE_mInt32(gram_index_max_candidate_ratio_bp, "15");
1396
DEFINE_Validator(gram_index_max_candidate_ratio_bp, valid_gram_index_candidate_ratio);
1397
DEFINE_mInt32(gram_index_candidate_ratio_min_rows, "65536");
1398
1399
// On by default: a configured density is wrong on every column but the one it was chosen for,
1400
// and the solve costs one pass over a bounded sample.
1401
DEFINE_mBool(enable_gram_index_adaptive_density, "true");
1402
// 12 bytes at 95% of windows. Both are the promise rather than a tuning pair -- what a user
1403
// may reasonably change is how short a literal they expect to find, not the boundary rate.
1404
// A literal shorter than the scheme's max_gram cannot hold a whole gram, so the writer
1405
// raises the promise to max_gram where a tokenizer sets a longer one.
1406
DEFINE_mInt32(gram_index_min_literal_bytes, "12");
1407
DEFINE_mInt32(gram_index_density_coverage_permille, "950");
1408
DEFINE_mInt64(gram_index_density_sample_bytes, "4194304");
1409
DEFINE_Validator(gram_index_candidate_ratio_min_rows, valid_gram_index_candidate_min_rows);
1410
DEFINE_Validator(gram_index_min_literal_bytes, valid_gram_index_min_literal_bytes);
1411
DEFINE_Validator(gram_index_density_coverage_permille, valid_gram_index_density_coverage_permille);
1412
DEFINE_Validator(gram_index_density_sample_bytes, valid_gram_index_density_sample_bytes);
1413
1414
// condition cache limit
1415
DEFINE_Int16(condition_cache_limit, "512");
1416
1417
// ANN index topn result cache
1418
DEFINE_String(ann_index_result_cache_limit, "10%");
1419
DEFINE_Int32(ann_index_result_cache_shards, "16");
1420
DEFINE_Int32(ann_index_result_cache_stale_sweep_time_sec, "1800");
1421
1422
// inverted index
1423
DEFINE_mDouble(inverted_index_ram_buffer_size, "512");
1424
// -1 indicates not working.
1425
// Normally we should not change this, it's useful for testing.
1426
DEFINE_mInt32(inverted_index_max_buffered_docs, "-1");
1427
// Zstd levels for SNII DICT blocks and .prx windows. These affect writes; each segment records its compression mode.
1428
DEFINE_mInt32(snii_dict_block_zstd_level, "3");
1429
DEFINE_mInt32(snii_prx_zstd_level, "3");
1430
// Zstd level for direct-load .prx regions. Compaction rewrites them using snii_prx_zstd_level.
1431
DEFINE_mInt32(snii_prx_zstd_level_direct_load, "3");
1432
// G16-d: target SNII dict block size in bytes; 0 uses the format default
1433
// (64 KiB). Larger blocks compress better under the per-block zstd (the dict
1434
// is the dominant physical section on high-cardinality corpora) at the cost
1435
// of a larger fetch+decompress unit per cold dict-block miss. Write side
1436
// only; the block size is self-described by the on-disk directory.
1437
DEFINE_mInt32(snii_target_dict_block_bytes, "0");
1438
// SNII's index-build share of the process memory limit, as a percent -- the
1439
// index-build analogue of load_process_max_memory_limit_percent. Once live SNII
1440
// index-build memory crosses this share, the largest reclaimable posting arenas
1441
// are asked to spill early. Derived from the process limit rather than an
1442
// absolute number so it scales with the BE. Only the RECLAIMABLE population
1443
// counts against it: index-merge compaction charges the same observation
1444
// tracker but registers no spillable writer, so its bytes are excluded from the
1445
// comparison (its own hard reservation cap bounds them instead).
1446
//
1447
// 0 disables SNII's OWN share trigger; the process-level backstops (system
1448
// available memory below its warning water mark, process usage above the soft
1449
// limit) still apply. The share is deliberately well below those backstops so
1450
// SNII sheds its own memory before the global valve -- the global valve trips
1451
// late by design and would be a worse trigger than none. The derived share is
1452
// floored at four times inverted_index_ram_buffer_size so a small BE is not
1453
// permanently over it the moment two writers exist.
1454
DEFINE_mInt32(snii_index_build_max_memory_limit_percent, "10");
1455
// Minimum reclaimable posting-arena bytes before a G09 forced spill is honored
1456
// (and before a writer is eligible as a spill victim): forced spills reclaim
1457
// ONLY the arena, so smaller triggers cut tiny runs for near-zero relief.
1458
// Default 64 MiB.
1459
DEFINE_mInt64(snii_forced_spill_min_arena_bytes, "67108864");
1460
// Historical run-file cap: spill ranges now share one append-only spool, so
1461
// ingestion does not accumulate one physical file per run. This knob additionally
1462
// limits active inputs per final/intermediate merge group (minimum two). Workspace
1463
// and fd limits also constrain fan-in; 0 uses those bounds without an extra cap.
1464
DEFINE_mInt32(snii_spill_max_run_files_per_buffer, "64");
1465
// Hard budget shared by a logical writer's posting spill, merge, and encoding
1466
// buffers. Captured when an ingestion writer or compaction reporter is created.
1467
// High ZSTD levels may require a larger budget for the compression context.
1468
DEFINE_mInt64(snii_postings_workspace_bytes, "33554432");
1469
DEFINE_Validator(snii_postings_workspace_bytes,
1470
                 [](const int64_t value) -> bool { return value > 0; });
1471
// dict path for chinese analyzer
1472
DEFINE_String(inverted_index_dict_path, "${DORIS_HOME}/dict");
1473
// The kuromoji (Japanese) analyzer
1474
DEFINE_mBool(enable_kuromoji_analyzer, "false");
1475
DEFINE_Int32(inverted_index_read_buffer_size, "4096");
1476
// tree depth for bkd index
1477
DEFINE_Int32(max_depth_in_bkd_tree, "32");
1478
// index compaction
1479
DEFINE_mBool(inverted_index_compaction_enable, "true");
1480
// Only for debug, do not use in production
1481
DEFINE_mBool(debug_inverted_index_compaction, "false");
1482
// index by RAM directory
1483
DEFINE_mBool(inverted_index_ram_dir_enable, "true");
1484
// wheather index by RAM directory when base compaction
1485
DEFINE_mBool(inverted_index_ram_dir_enable_when_base_compaction, "true");
1486
// Norms cost one byte per segment row, including rows that hold no value for the field. A segment
1487
// holds one index per variant path, so writing norms for them costs rows * paths bytes. Turn this on
1488
// to leave norms out of every index on a variant path, whatever its "norms" property says; BM25
1489
// scoring (score()) on those indexes then fails.
1490
DEFINE_mBool(inverted_index_skip_norms_for_variant, "false");
1491
// use num_broadcast_buffer blocks as buffer to do broadcast
1492
DEFINE_Int32(num_broadcast_buffer, "32");
1493
1494
// max depth of expression tree allowed.
1495
DEFINE_Int32(max_depth_of_expr_tree, "600");
1496
1497
// Report a tablet as bad when io errors occurs more than this value.
1498
DEFINE_mInt64(max_tablet_io_errors, "-1");
1499
1500
// Report a tablet as bad when its path not found
1501
DEFINE_Int32(tablet_path_check_interval_seconds, "-1");
1502
DEFINE_mInt32(tablet_path_check_batch_size, "1000");
1503
1504
// it must be larger than or equal to 5MB
1505
DEFINE_mInt64(s3_write_buffer_size, "5242880");
1506
// Log interval when doing s3 upload task
1507
DEFINE_mInt32(s3_file_writer_log_interval_second, "60");
1508
DEFINE_mInt64(file_cache_max_file_reader_cache_size, "1000000");
1509
// When file cache is enabled, the configured bytes must be divisible by
1510
// file_cache_each_block_size so every non-EOF HDFS cache block is canonical.
1511
DEFINE_mInt64(hdfs_write_batch_buffer_size_mb, "1"); // 1MB
1512
1513
//disable shrink memory by default
1514
DEFINE_mBool(enable_shrink_memory, "false");
1515
1516
// max number of segment cache, default -1 for backward compatibility fd_number*2/5
1517
DEFINE_Int32(segment_cache_capacity, "-1");
1518
DEFINE_Int32(segment_cache_fd_percentage, "20");
1519
DEFINE_mInt32(estimated_mem_per_column_reader, "512");
1520
DEFINE_Int32(segment_cache_memory_percentage, "5");
1521
DEFINE_Bool(enable_segment_cache_prune, "false");
1522
1523
// enable feature binlog, default false
1524
DEFINE_Bool(enable_feature_binlog, "false");
1525
// enable feature changelog, default false
1526
// ATTN(changelog-rename): formerly "enable_feature_binlog" (non-CCR uses)
1527
DEFINE_Bool(enable_feature_changelog, "false");
1528
1529
// enable set in BitmapValue
1530
DEFINE_Bool(enable_set_in_bitmap_value, "true");
1531
1532
// Enable compact integer tags in row-store JSONB. Once enabled and compact data is written,
1533
// rollback to code without compact row-store JSONB reader support is not safe.
1534
DEFINE_Bool(enable_row_store_compact_jsonb, "false");
1535
1536
DEFINE_Int64(max_hdfs_file_handle_cache_num, "20000");
1537
DEFINE_Int32(max_hdfs_file_handle_cache_time_sec, "28800");
1538
DEFINE_Int64(max_external_file_meta_cache_num, "1000");
1539
DEFINE_mInt32(common_obj_lru_cache_stale_sweep_time_sec, "900");
1540
// Apply delete pred in cumu compaction
1541
DEFINE_mBool(enable_delete_when_cumu_compaction, "false");
1542
1543
// max_write_buffer_number for rocksdb
1544
DEFINE_Int32(rocksdb_max_write_buffer_number, "5");
1545
1546
DEFINE_mBool(allow_zero_date, "false");
1547
DEFINE_Bool(allow_invalid_decimalv2_literal, "false");
1548
DEFINE_mString(kerberos_ccache_path, "/tmp/");
1549
DEFINE_mString(kerberos_krb5_conf_path, "/etc/krb5.conf");
1550
// JDK-8153057: avoid StackOverflowError thrown from the UncaughtExceptionHandler in thread "process reaper"
1551
DEFINE_mBool(jdk_process_reaper_use_default_stack_size, "true");
1552
1553
DEFINE_mString(dwarf_location_info_mode, "FAST");
1554
DEFINE_mBool(enable_address_sanitizers_with_stack_trace, "true");
1555
1556
// the ratio of _prefetch_size/_batch_size in AutoIncIDBuffer
1557
DEFINE_mInt64(auto_inc_prefetch_size_ratio, "10");
1558
1559
// the ratio of _low_level_water_level_mark/_batch_size in AutoIncIDBuffer
1560
DEFINE_mInt64(auto_inc_low_water_level_mark_size_ratio, "3");
1561
1562
// number of threads that fetch auto-inc ranges from FE
1563
DEFINE_mInt64(auto_inc_fetch_thread_num, "3");
1564
// default max to 2048 connections
1565
DEFINE_mInt64(lookup_connection_cache_capacity, "2048");
1566
// Number of reusable result blocks retained by each point lookup cache entry, in [1, 32].
1567
DEFINE_mInt32(lookup_connection_cache_block_pool_size, "1");
1568
DEFINE_Validator(lookup_connection_cache_block_pool_size,
1569
                 [](int32_t value) -> bool { return value >= 1 && value <= 32; });
1570
static std::atomic<size_t> atomic_lookup_connection_cache_block_pool_size {1};
1571
DEFINE_ON_UPDATE(lookup_connection_cache_block_pool_size, [](int32_t, int32_t value) {
1572
    atomic_lookup_connection_cache_block_pool_size.store(static_cast<size_t>(value),
1573
                                                         std::memory_order_relaxed);
1574
});
1575
1576
9
size_t get_lookup_connection_cache_block_pool_size() {
1577
9
    return atomic_lookup_connection_cache_block_pool_size.load(std::memory_order_relaxed);
1578
9
}
1579
1580
// level of compression when using LZ4_HC, whose defalut value is LZ4HC_CLEVEL_DEFAULT
1581
DEFINE_mInt64(LZ4_HC_compression_level, "9");
1582
1583
DEFINE_mBool(enable_merge_on_write_correctness_check, "true");
1584
// USED FOR DEBUGING
1585
// core directly if the compaction found there's duplicate key on mow table
1586
DEFINE_mBool(enable_mow_compaction_correctness_check_core, "false");
1587
// USED FOR DEBUGING
1588
// let compaction fail if the compaction found there's duplicate key on mow table
1589
DEFINE_mBool(enable_mow_compaction_correctness_check_fail, "false");
1590
// rowid conversion correctness check when compaction for mow table
1591
DEFINE_mBool(enable_rowid_conversion_correctness_check, "false");
1592
// missing rows correctness check when compaction for mow table
1593
DEFINE_mBool(enable_missing_rows_correctness_check, "false");
1594
// When the number of missing versions is more than this value, do not directly
1595
// retry the publish and handle it through async publish.
1596
DEFINE_mInt32(mow_publish_max_discontinuous_version_num, "20");
1597
// When the size of primary keys in memory exceeds this value, finish current segment
1598
// and create a new segment, used in compaction. Default 50MB.
1599
DEFINE_mInt64(mow_primary_key_index_max_size_in_memory, "52428800");
1600
// When the version is not continuous for MOW table in publish phase and the gap between
1601
// current txn's publishing version and the max version of the tablet exceeds this value,
1602
// don't print warning log
1603
DEFINE_mInt32(publish_version_gap_logging_threshold, "200");
1604
// get agg by cache for mow table
1605
DEFINE_mBool(enable_mow_get_agg_by_cache, "true");
1606
// get agg correctness check for mow table
1607
DEFINE_mBool(enable_mow_get_agg_correctness_check_core, "false");
1608
DEFINE_mBool(enable_agg_and_remove_pre_rowsets_delete_bitmap, "true");
1609
DEFINE_mBool(enable_check_agg_and_remove_pre_rowsets_delete_bitmap, "false");
1610
// Remove pre-rowset delete bitmaps in [end_version, end_version] before writing aggregated delete
1611
// bitmaps. True: point delete; false: range delete.
1612
DEFINE_mBool(enable_remove_agg_pre_rowsets_delete_bitmap_by_keys, "true");
1613
// Remove pre-rowset delete bitmaps in [start_version, end_version). True: point delete; false:
1614
// range delete.
1615
DEFINE_mBool(enable_remove_pre_rowsets_delete_bitmap_by_keys, "true");
1616
1617
// The secure path with user files, used in the `local` table function.
1618
DEFINE_String(user_files_secure_path, "${DORIS_HOME}");
1619
1620
DEFINE_Int32(fe_expire_duration_seconds, "60");
1621
1622
DEFINE_Int32(grace_shutdown_wait_seconds, "120");
1623
DEFINE_Int32(grace_shutdown_post_delay_seconds, "30");
1624
1625
DEFINE_Int16(bitmap_serialize_version, "1");
1626
1627
// group commit config
1628
DEFINE_String(group_commit_wal_path, "");
1629
DEFINE_Int32(group_commit_replay_wal_retry_num, "10");
1630
DEFINE_Int32(group_commit_replay_wal_retry_interval_seconds, "5");
1631
DEFINE_Int32(group_commit_replay_wal_retry_interval_max_seconds, "1800");
1632
DEFINE_Int32(group_commit_relay_wal_threads, "10");
1633
// This config can be set to limit thread number in group commit request fragment thread pool.
1634
DEFINE_Int32(group_commit_insert_threads, "10");
1635
DEFINE_Int32(group_commit_memory_rows_for_max_filter_ratio, "10000");
1636
DEFINE_Bool(wait_internal_group_commit_finish, "false");
1637
// Max size(bytes) of group commit queues, used for mem back pressure, defult 64M.
1638
DEFINE_mInt32(group_commit_queue_mem_limit, "67108864");
1639
// Max size(bytes) or percentage(%) of wal disk usage, used for disk space back pressure, default 10% of the disk available space.
1640
// group_commit_wal_max_disk_limit=1024 or group_commit_wal_max_disk_limit=10% can be automatically identified.
1641
DEFINE_String(group_commit_wal_max_disk_limit, "10%");
1642
DEFINE_Bool(group_commit_wait_replay_wal_finish, "false");
1643
// Max WAL count for one table before rejecting async group commit loads.
1644
// 0 means no limit.
1645
DEFINE_mInt32(group_commit_max_wal_num_per_table, "10");
1646
// Max time(ms) to wait for creating group commit plan fragment.
1647
// 0 means no timeout, default 2min.
1648
DEFINE_mInt32(group_commit_create_plan_timeout_ms, "120000");
1649
1650
DEFINE_mInt32(scan_thread_nice_value, "0");
1651
DEFINE_mInt32(tablet_schema_cache_recycle_interval, "3600");
1652
DEFINE_mInt32(tablet_schema_cache_capacity, "102400");
1653
1654
DEFINE_Bool(exit_on_exception, "false");
1655
// This config controls whether the s3 file writer would flush cache asynchronously
1656
DEFINE_Bool(enable_flush_file_cache_async, "true");
1657
1658
// cgroup
1659
DEFINE_String(doris_cgroup_cpu_path, "");
1660
1661
DEFINE_mBool(enable_be_proc_monitor, "false");
1662
DEFINE_mInt32(be_proc_monitor_interval_ms, "10000");
1663
1664
DEFINE_Int32(workload_group_metrics_interval_ms, "5000");
1665
DEFINE_Int32(workload_policy_check_interval_ms, "500");
1666
1667
// Ingest binlog work pool size, -1 is disable, 0 is hardware concurrency
1668
DEFINE_Int32(ingest_binlog_work_pool_size, "-1");
1669
1670
// Ingest binlog with persistent connection
1671
DEFINE_Bool(enable_ingest_binlog_with_persistent_connection, "false");
1672
1673
// Log ingest binlog elapsed threshold, -1 is disabled
1674
DEFINE_mInt64(ingest_binlog_elapsed_threshold_ms, "-1");
1675
1676
// Download binlog rate limit, unit is KB/s, 0 means no limit
1677
DEFINE_Int32(download_binlog_rate_limit_kbs, "0");
1678
1679
DEFINE_mInt32(buffered_reader_read_timeout_ms, "600000");
1680
1681
DEFINE_Bool(enable_snapshot_action, "false");
1682
1683
DEFINE_mInt32(variant_max_merged_tablet_schema_size, "2048");
1684
1685
DEFINE_mBool(enable_column_type_check, "true");
1686
// 128 MB
1687
DEFINE_mInt64(local_exchange_buffer_mem_limit, "134217728");
1688
1689
// Tolerance for the number of partition id 0 in rowset, default 0
1690
DEFINE_Int32(ignore_invalid_partition_id_rowset_num, "0");
1691
1692
DEFINE_mInt32(report_query_statistics_interval_ms, "3000");
1693
// 30s
1694
DEFINE_mInt32(query_statistics_reserve_timeout_ms, "30000");
1695
1696
DEFINE_mInt32(report_exec_status_thread_num, "5");
1697
1698
// consider two high usage disk at the same available level if they do not exceed this diff.
1699
DEFINE_mDouble(high_disk_avail_level_diff_usages, "0.15");
1700
1701
// create tablet in partition random robin idx lru size, default 10000
1702
DEFINE_Int32(partition_disk_index_lru_size, "10000");
1703
// limit the storage space that query spill files can use
1704
DEFINE_String(spill_storage_root_path, "");
1705
DEFINE_String(spill_storage_limit, "20%"); // 20%
1706
DEFINE_mInt64(spill_storage_limit_bytes, "0");
1707
DEFINE_Validator(spill_storage_limit_bytes, [](int64_t config) -> bool { return config >= 0; });
1708
DEFINE_mInt32(spill_gc_interval_ms, "2000");             // 2s
1709
DEFINE_mInt32(spill_gc_work_time_ms, "2000");            // 2s
1710
DEFINE_mInt64(spill_file_part_size_bytes, "1073741824"); // 1GB
1711
DEFINE_String(spill_storage_type, "local");
1712
// s3: cloud mode only; spill is written to the S3 storage vault under
1713
// spill/{ip}_{port}/{query_id}/, where ip is the address of this BE and port its
1714
// heartbeat_service_port.
1715
// The BE deletes the objects of a spill file when the query is done with it. What a BE that
1716
// crashed left behind is not deleted by Doris: give the bucket a lifecycle rule that expires
1717
// the keys under <vault prefix>/spill/ and aborts incomplete multipart uploads.
1718
// Incomplete multipart uploads from failed or cancelled queries also rely on that rule.
1719
DEFINE_Validator(spill_storage_type, [](const std::string& config) -> bool {
1720
    return config == "local" || config == "s3";
1721
});
1722
DEFINE_String(spill_s3_storage_vault_id, "");
1723
DEFINE_mInt64(spill_s3_max_inflight_upload_bytes, "268435456"); // 256MB
1724
DEFINE_Validator(spill_s3_max_inflight_upload_bytes,
1725
                 [](int64_t config) -> bool { return config > 0; });
1726
// The footer probe is bounded by it as well; the rest of a block offset array that does not fit
1727
// in the probe is read whole, like a single block larger than it.
1728
DEFINE_mInt64(spill_s3_read_coalesce_bytes, "8388608"); // 8MB
1729
DEFINE_Validator(spill_s3_read_coalesce_bytes, [](int64_t config) -> bool { return config >= 0; });
1730
1731
// paused query in queue timeout(ms) will be resumed or canceled
1732
DEFINE_Int64(spill_in_paused_queue_timeout_ms, "60000");
1733
1734
DEFINE_Int64(wait_cancel_release_memory_ms, "5000");
1735
1736
DEFINE_mBool(check_segment_when_build_rowset_meta, "false");
1737
1738
DEFINE_mInt32(max_s3_client_retry, "10");
1739
DEFINE_mInt32(s3_read_base_wait_time_ms, "100");
1740
DEFINE_mInt32(s3_read_max_wait_time_ms, "800");
1741
DEFINE_mBool(enable_s3_object_check_after_upload, "true");
1742
DEFINE_mInt32(aws_client_request_timeout_ms, "30000");
1743
1744
DEFINE_mBool(enable_s3_rate_limiter, "false");
1745
DEFINE_mInt64(s3_get_bucket_tokens, "1000000000000000000");
1746
DEFINE_Validator(s3_get_bucket_tokens, [](int64_t config) -> bool { return config > 0; });
1747
1748
DEFINE_mInt64(s3_get_token_per_second, "1000000000000000000");
1749
DEFINE_Validator(s3_get_token_per_second, [](int64_t config) -> bool { return config > 0; });
1750
1751
DEFINE_mInt64(s3_get_token_limit, "0");
1752
1753
DEFINE_mInt64(s3_put_bucket_tokens, "1000000000000000000");
1754
DEFINE_Validator(s3_put_bucket_tokens, [](int64_t config) -> bool { return config > 0; });
1755
1756
DEFINE_mInt64(s3_put_token_per_second, "1000000000000000000");
1757
DEFINE_Validator(s3_put_token_per_second, [](int64_t config) -> bool { return config > 0; });
1758
1759
DEFINE_mInt64(s3_put_token_limit, "0");
1760
// Log active S3 rate limiter every N throttled/rejected requests, 0 means no log.
1761
DEFINE_mInt64(s3_rate_limiter_log_interval, "1000");
1762
DEFINE_Validator(s3_rate_limiter_log_interval, [](int64_t config) -> bool { return config >= 0; });
1763
1764
// CPU-aware S3 rate limiter. Effective GET/PUT requests per second =
1765
// requests_per_second_per_core * BE cpu cores, capped by the corresponding
1766
// requests_per_second_max. A negative value means unset: fall back to the legacy absolute
1767
// s3_{get,put}_token_* configs above. 0 disables request-rate limiting for that operation.
1768
DEFINE_mInt64(s3_get_requests_per_second_per_core, "-1");
1769
DEFINE_mInt64(s3_put_requests_per_second_per_core, "-1");
1770
// Hard caps for the CPU-derived GET/PUT QPS. A non-positive value means no cap.
1771
DEFINE_mInt64(s3_get_requests_per_second_max, "0");
1772
DEFINE_mInt64(s3_put_requests_per_second_max, "0");
1773
1774
// CPU-aware S3 bandwidth limiter. Effective GET/PUT bytes/s = bytes_per_second_per_core *
1775
// BE cpu cores, capped by the corresponding bytes_per_second_max. A non-positive value disables
1776
// byte-rate limiting for that operation (there is no legacy fallback for bandwidth).
1777
// Note: the derived per-BE bytes/s should not be set below the single IO upper bound
1778
// per second (s3_write_buffer_size, 5MB by default). A single IO larger than 1 second
1779
// of quota only reserves 1 second worth of tokens; the excess bytes are not accounted
1780
// (reservation clamp in S3RateLimitGuard).
1781
DEFINE_mInt64(s3_get_bytes_per_second_per_core, "-1");
1782
DEFINE_mInt64(s3_put_bytes_per_second_per_core, "-1");
1783
// Hard caps for the CPU-derived GET/PUT bytes/s. A non-positive value means no cap.
1784
DEFINE_mInt64(s3_get_bytes_per_second_max, "0");
1785
DEFINE_mInt64(s3_put_bytes_per_second_max, "0");
1786
1787
// Override the CPU cores used to derive the effective S3 rate limits. A non-positive value
1788
// means auto-detect from the cgroup cpu quota (fall back to physical cores); the control plane
1789
// can push a positive value via /api/update_config when resizing a serverless BE.
1790
DEFINE_mInt32(s3_rate_limiter_cpu_cores_override, "0");
1791
1792
// The dir TrinoConnectorPluginLoader loads Trino's own plugins from, used verbatim. Keep the default
1793
// in sync with FE Config.trino_connector_plugin_dir: FE and BE load the same plugins and an operator
1794
// who leaves both untouched expects both to find them.
1795
DEFINE_String(trino_connector_plugin_dir, "${DORIS_HOME}/plugins/trino_plugins");
1796
1797
// The directory BE loads its Java plugins from. Each subdirectory is one plugin, named by the
1798
// directory: that name is what BE addresses it by and what appears in "is not deployed".
1799
// It lives under plugins/ rather than lib/ because lib/ is the engine tree a package upgrade
1800
// replaces wholesale - a plugin deployed there would not survive one.
1801
DEFINE_String(jni_plugin_dir, "${DORIS_HOME}/plugins/jni");
1802
1803
// The hadoop configuration files (core-site.xml, hdfs-site.xml, ...) that Java plugins can read.
1804
// A plugin's classloader deliberately cannot reach BE's own classpath, and conf/ is on that
1805
// classpath - so a hadoop Configuration built inside a plugin sees nothing dropped into conf/,
1806
// which is where it came from before plugins were isolated. This directory is the drop point that
1807
// replaces it, and it is a directory of its own rather than conf/ so that what BE reads and what
1808
// plugins read stay two separate lists. FE has always had the same directory for the XML its
1809
// catalogs name through hadoop.config.resources (FE config hadoop_config_dir).
1810
//
1811
// Nothing has to be here: a catalog that carries its hadoop properties explicitly needs no file.
1812
DEFINE_String(jni_plugin_hadoop_conf_dir, "${DORIS_HOME}/plugins/hadoop_conf");
1813
1814
// Third-party hadoop FileSystem implementations shared by every Java plugin: JindoFS for oss://
1815
// and oss-hdfs://, JuiceFS for jfs://. One subdirectory per filesystem, each holding its jars.
1816
//
1817
// Shared rather than bundled into each plugin because no plugin declares them - hadoop reaches a
1818
// filesystem by class name out of a Configuration, so nothing links against them - and because
1819
// the JuiceFS Hadoop SDK is a 180 MB fat jar that would have to be copied into every plugin that
1820
// might read a table on it. PluginRuntime appends the jars found here to each plugin's own
1821
// classpath, AFTER the plugin's jars, so a plugin's own hadoop still wins; each plugin loads its
1822
// own copy in its own classloader, so the isolation is unchanged. This is also the directory
1823
// bin/start_be.sh puts on the system class path for the native libhdfs reader, which needs the
1824
// same jars for the same schemes - one copy on disk serves both, and both honour this config:
1825
// the script reads it out of be.conf by hand (the export loop there only picks up UPPERCASE
1826
// keys), and JvmLauncher passes it to the JVM as -Ddoris.jni.fs.dir. Every subdirectory holding
1827
// jars is taken, on both sides.
1828
//
1829
// Nothing has to be here: both filesystems are opt-in build flags (DISABLE_BUILD_JINDOFS=OFF,
1830
// DISABLE_BUILD_JUICEFS=OFF), and a build without them leaves this directory absent.
1831
DEFINE_String(jni_plugin_fs_dir, "${DORIS_HOME}/plugins/jni_fs");
1832
1833
// Whether to load every deployed plugin at startup rather than on the query that first needs
1834
// one. Off by default: warming a plugin keeps its whole jar closure open for the life of the
1835
// process - one classloader per plugin, holding every jar in its directory - which is several
1836
// hundred file descriptors on a BE that may never read a Java table format at all. That budget
1837
// is shared with everything else the process opens, and on macOS a descriptor numbered past
1838
// FD_SETSIZE breaks every libcurl transfer, because curl is built without poll() there and its
1839
// select() fallback cannot name one. Turning this on buys the opposite trade: a broken
1840
// deployment is found in the log at startup rather than in a user's query.
1841
// It is not a reason to create a JVM either way: with no plugin deployed there is nothing to
1842
// warm, and a BE that reads no Java table format still starts without one.
1843
DEFINE_Bool(java_plugin_warmup, "false");
1844
1845
// ca_cert_file is in this path by default, Normally no modification is required
1846
// ca cert default path is different from different OS
1847
DEFINE_mString(ca_cert_file_paths,
1848
               "/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;"
1849
               "/etc/ssl/ca-bundle.pem");
1850
1851
/** Table sink configurations(currently contains only external table types) **/
1852
// Minimum data processed to scale writers in exchange when non partition writing
1853
DEFINE_mInt64(table_sink_non_partition_write_scaling_data_processed_threshold,
1854
              "26214400"); // 25MB
1855
// Minimum data processed to trigger skewed partition rebalancing in exchange when partition writing
1856
DEFINE_mInt64(table_sink_partition_write_min_data_processed_rebalance_threshold,
1857
              "26214400"); // 25MB
1858
// Minimum partition data processed to rebalance writers in exchange when partition writing
1859
DEFINE_mInt64(table_sink_partition_write_min_partition_data_processed_rebalance_threshold,
1860
              "15728640"); // 15MB
1861
// Maximum processed partition nums of per writer when partition writing
1862
DEFINE_mInt32(table_sink_partition_write_max_partition_nums_per_writer, "128");
1863
1864
/** Hive sink configurations **/
1865
DEFINE_mInt64(hive_sink_max_file_size, "1073741824"); // 1GB
1866
1867
/** Iceberg sink configurations **/
1868
DEFINE_mInt64(iceberg_sink_max_file_size, "1073741824"); // 1GB
1869
1870
/** Paimon sink configurations **/
1871
DEFINE_mInt64(paimon_jni_writer_memory_pool_limit_bytes, "536870912"); // 512MB
1872
DEFINE_Validator(paimon_jni_writer_memory_pool_limit_bytes,
1873
                 [](int64_t bytes) -> bool { return bytes > 0; });
1874
1875
DEFINE_mInt32(thrift_client_open_num_tries, "1");
1876
1877
// Default HTTP scheme used by S3Client when the endpoint has no scheme.
1878
DEFINE_String(s3_client_http_scheme, "https");
1879
DEFINE_Validator(s3_client_http_scheme, [](const std::string& config) -> bool {
1880
    return config == "http" || config == "https";
1881
});
1882
1883
DEFINE_mBool(ignore_schema_change_check, "false");
1884
1885
// The min thread num for BufferedReaderPrefetchThreadPool
1886
DEFINE_Int64(num_buffered_reader_prefetch_thread_pool_min_thread, "16");
1887
// The max thread num for BufferedReaderPrefetchThreadPool
1888
DEFINE_Int64(num_buffered_reader_prefetch_thread_pool_max_thread, "64");
1889
1890
DEFINE_mBool(enable_segment_prefetch_verbose_log, "false");
1891
// The thread num for SegmentPrefetchThreadPool
1892
DEFINE_Int64(segment_prefetch_thread_pool_thread_num_min, "32");
1893
DEFINE_Int64(segment_prefetch_thread_pool_thread_num_max, "2000");
1894
1895
DEFINE_mInt32(segment_file_cache_consume_rowids_batch_size, "8000");
1896
// Enable segment file cache block prefetch for query
1897
DEFINE_mBool(enable_query_segment_file_cache_prefetch, "false");
1898
// Number of blocks to prefetch ahead in segment iterator for query
1899
DEFINE_mInt32(query_segment_file_cache_prefetch_block_size, "2");
1900
// Enable exact range read-ahead for query data pages
1901
DEFINE_mBool(enable_query_read_ahead, "false");
1902
DEFINE_mBool(enable_read_io_trace, "false");
1903
// Separate diagnostic files; empty uses the BE log directory's read_io_trace subdirectory.
1904
DEFINE_String(read_io_trace_dir, "");
1905
DEFINE_Int64(read_io_trace_flush_bytes, "1048576"); // 1 MiB
1906
DEFINE_Validator(read_io_trace_flush_bytes, [](int64_t value) { return value > 0; });
1907
DEFINE_Int32(read_io_trace_flush_interval_ms, "1000");
1908
DEFINE_Validator(read_io_trace_flush_interval_ms, [](int32_t value) { return value > 0; });
1909
// Query-level resident read-ahead buffer limit
1910
DEFINE_Int64(read_ahead_max_bytes_per_query, "268435456"); // 256 MiB
1911
DEFINE_Validator(read_ahead_max_bytes_per_query, [](int64_t value) { return value > 0; });
1912
// BE-level resident read-ahead buffer limit
1913
DEFINE_Int64(read_ahead_max_bytes_per_be, "1073741824"); // 1 GiB
1914
DEFINE_Validator(read_ahead_max_bytes_per_be, [](int64_t value) { return value > 0; });
1915
// Compressed page bytes per eager read-ahead window; entering its trigger page appends the next.
1916
DEFINE_mInt64(read_ahead_eager_window_bytes, "4194304"); // 4 MiB
1917
DEFINE_Validator(read_ahead_eager_window_bytes, [](int64_t value) { return value > 0; });
1918
// Compressed page bytes per lazy read-ahead window.
1919
DEFINE_mInt64(read_ahead_lazy_window_bytes, "1048576"); // 1 MiB
1920
DEFINE_Validator(read_ahead_lazy_window_bytes, [](int64_t value) { return value > 0; });
1921
// Foreground file-range coalescing and cache-block completion policy
1922
DEFINE_mInt64(read_ahead_max_gap_bytes, "65536"); // 64 KiB
1923
DEFINE_Validator(read_ahead_max_gap_bytes, [](int64_t value) { return value >= 0; });
1924
DEFINE_mInt64(read_ahead_max_range_bytes, "2097152"); // 2 MiB
1925
DEFINE_Validator(read_ahead_max_range_bytes, [](int64_t value) { return value > 0; });
1926
DEFINE_mDouble(read_ahead_max_read_amplification_ratio, "1.0");
1927
DEFINE_Validator(read_ahead_max_read_amplification_ratio,
1928
                 [](double value) { return std::isfinite(value) && value >= 1.0; });
1929
DEFINE_mDouble(read_ahead_block_fill_min_coverage, "1.0");
1930
DEFINE_Validator(read_ahead_block_fill_min_coverage,
1931
                 [](double value) { return std::isfinite(value) && value > 0.0 && value <= 1.0; });
1932
// Background completion policy and BE-wide resource limits for partial File Cache blocks
1933
DEFINE_Int64(hole_fill_max_gap_bytes, "32768"); // 32 KiB
1934
DEFINE_Validator(hole_fill_max_gap_bytes, [](int64_t value) { return value >= 0; });
1935
DEFINE_Int64(hole_fill_max_range_bytes, "1048576"); // 1 MiB
1936
DEFINE_Validator(hole_fill_max_range_bytes, [](int64_t value) { return value > 0; });
1937
DEFINE_Double(hole_fill_max_read_amplification_ratio, "1.0");
1938
DEFINE_Validator(hole_fill_max_read_amplification_ratio,
1939
                 [](double value) { return std::isfinite(value) && value >= 1.0; });
1940
DEFINE_Int64(hole_fill_max_pending_bytes_per_be, "4294967296"); // 4 GiB
1941
DEFINE_Validator(hole_fill_max_pending_bytes_per_be, [](int64_t value) { return value > 0; });
1942
DEFINE_mInt32(hole_fill_workers_per_be, "32");
1943
DEFINE_Validator(hole_fill_workers_per_be, [](int32_t value) { return value > 0 && value <= 128; });
1944
// With 32 block workers, allow two pooled hole reads per active block on average.
1945
DEFINE_mInt32(hole_fill_remote_read_threads_per_be, "64");
1946
DEFINE_Validator(hole_fill_remote_read_threads_per_be, [](int32_t value) { return value > 0; });
1947
// Minimum aggregation time from first partial-block admission; zero disables the delay.
1948
DEFINE_mInt32(hole_fill_merge_delay_ms, "2000"); // 2000 ms
1949
DEFINE_Validator(hole_fill_merge_delay_ms, [](int32_t value) { return value >= 0; });
1950
// Enable segment file cache block prefetch for compaction
1951
DEFINE_mBool(enable_compaction_segment_file_cache_prefetch, "false");
1952
// Number of blocks to prefetch ahead in segment iterator for compaction
1953
DEFINE_mInt32(compaction_segment_file_cache_prefetch_block_size, "2");
1954
// The min thread num for S3FileUploadThreadPool
1955
DEFINE_Int64(num_s3_file_upload_thread_pool_min_thread, "16");
1956
// The max thread num for S3FileUploadThreadPool
1957
DEFINE_Int64(num_s3_file_upload_thread_pool_max_thread, "64");
1958
// The maximum jvm heap usage ratio for hdfs write workload
1959
DEFINE_mDouble(max_hdfs_wirter_jni_heap_usage_ratio, "0.5");
1960
// The sleep milliseconds duration when hdfs write exceeds the maximum usage
1961
DEFINE_mInt64(hdfs_jni_write_sleep_milliseconds, "300");
1962
// The max retry times when hdfs write failed
1963
DEFINE_mInt64(hdfs_jni_write_max_retry_time, "3");
1964
1965
// The min thread num for NonBlockCloseThreadPool
1966
DEFINE_Int64(min_nonblock_close_thread_num, "12");
1967
// The max thread num for NonBlockCloseThreadPool
1968
DEFINE_Int64(max_nonblock_close_thread_num, "64");
1969
// The possibility that mem allocator throws an exception during memory allocation
1970
// This config is for test usage, be careful when changing it.
1971
DEFINE_mDouble(mem_alloc_fault_probability, "0.0");
1972
// The time out milliseconds for remote fetch schema RPC, default 60s
1973
DEFINE_mInt64(fetch_remote_schema_rpc_timeout_ms, "60000");
1974
1975
DEFINE_Int64(s3_file_system_local_upload_buffer_size, "5242880");
1976
1977
//JVM monitoring enable. To prevent be from crashing due to jvm compatibility issues. The default setting is off.
1978
DEFINE_Bool(enable_jvm_monitor, "true");
1979
1980
DEFINE_Int32(load_data_dirs_threads, "-1");
1981
1982
// Skip loading stale rowset meta when initializing `TabletMeta` from protobuf
1983
DEFINE_mBool(skip_loading_stale_rowset_meta, "false");
1984
1985
DEFINE_Bool(enable_file_logger, "true");
1986
1987
// Enable partition column fallback when partition columns are missing from file
1988
DEFINE_Bool(enable_iceberg_partition_column_fallback, "true");
1989
1990
// The minimum row group size when exporting Parquet files. default 128MB
1991
DEFINE_Int64(min_row_group_size, "134217728");
1992
1993
DEFINE_mInt64(compaction_memory_bytes_limit, "1073741824");
1994
1995
DEFINE_mInt64(compaction_batch_size, "-1");
1996
1997
// If set to false, the parquet reader will not use page index to filter data.
1998
// This is only for debug purpose, in case sometimes the page index
1999
// filter wrong data.
2000
DEFINE_mBool(enable_parquet_page_index, "true");
2001
2002
DEFINE_mBool(ignore_not_found_file_in_external_table, "true");
2003
2004
DEFINE_mBool(enable_hdfs_mem_limiter, "true");
2005
2006
DEFINE_mInt16(topn_agg_limit_multiplier, "2");
2007
2008
// Tablet meta size limit after serialization, 1.5GB
2009
DEFINE_mInt64(tablet_meta_serialize_size_limit, "1610612736");
2010
// Protobuf supports a maximum of 2GB, so the size of the tablet meta after serialization must be less than 2GB
2011
// 1717986918 = 2GB * 0.8
2012
DEFINE_Validator(tablet_meta_serialize_size_limit,
2013
                 [](const int64_t config) -> bool { return config < 1717986918; });
2014
2015
DEFINE_mInt64(pipeline_task_leakage_detect_period_secs, "60");
2016
DEFINE_mInt32(snappy_compression_block_size, "262144");
2017
DEFINE_mInt32(lz4_compression_block_size, "262144");
2018
2019
DEFINE_mBool(enable_pipeline_task_leakage_detect, "false");
2020
2021
DEFINE_mInt32(check_score_rounds_num, "1000");
2022
2023
DEFINE_Int32(query_cache_size, "512");
2024
// Max number of incremental merges accumulated on one query cache entry before
2025
// a full recompute is forced. Each incremental merge appends the delta partial
2026
// blocks to the entry, so the entry gets more fragmented (and the upstream merge
2027
// aggregation does more work) as deltas accumulate; a periodic full recompute
2028
// compacts the entry back to a minimal set of blocks.
2029
DEFINE_mInt32(query_cache_max_incremental_merge_count, "8");
2030
2031
// Enable validation to check the correctness of table size.
2032
DEFINE_Bool(enable_table_size_correctness_check, "false");
2033
DEFINE_Bool(force_regenerate_rowsetid_on_start_error, "false");
2034
DEFINE_mBool(enable_sleep_between_delete_cumu_compaction, "false");
2035
2036
// The number of compaction tasks generated each time.
2037
// -1 means automatic number, other values mean fixed number.
2038
DEFINE_mInt32(compaction_num_per_round, "-1");
2039
// Max automatic compaction task generated num per round.
2040
// Only valid if "compaction_num_per_round = 0"
2041
DEFINE_mInt32(max_automatic_compaction_num_per_round, "64");
2042
2043
DEFINE_mInt32(check_tablet_delete_bitmap_interval_seconds, "300");
2044
DEFINE_mInt32(check_tablet_delete_bitmap_score_top_n, "10");
2045
DEFINE_mBool(enable_check_tablet_delete_bitmap_score, "true");
2046
// whether to prune rows with delete sign = 1 in base compaction
2047
// ATTN: this config is only for test
2048
DEFINE_mBool(enable_prune_delete_sign_when_base_compaction, "true");
2049
2050
DEFINE_mBool(enable_mow_verbose_log, "false");
2051
2052
DEFINE_mInt32(tablet_sched_delay_time_ms, "5000");
2053
DEFINE_mInt32(load_trigger_compaction_version_percent, "66");
2054
DEFINE_mInt64(base_compaction_interval_seconds_since_last_operation, "86400");
2055
DEFINE_mBool(enable_compaction_pause_on_high_memory, "false");
2056
2057
DEFINE_mBool(enable_quorum_success_write, "true");
2058
DEFINE_mDouble(quorum_success_max_wait_multiplier, "0.2");
2059
DEFINE_mInt64(quorum_success_min_wait_seconds, "60");
2060
DEFINE_mInt32(quorum_success_remaining_timeout_seconds, "30");
2061
2062
DEFINE_mBool(enable_calc_delete_bitmap_between_segments_concurrently, "false");
2063
2064
DEFINE_mBool(enable_update_delete_bitmap_kv_check_core, "false");
2065
2066
DEFINE_mBool(enable_fetch_rowsets_from_peer_replicas, "false");
2067
// the max length of segments key bounds, in bytes
2068
// ATTENTION: as long as this conf has ever been enabled, cluster downgrade and backup recovery will no longer be supported.
2069
DEFINE_mInt32(segments_key_bounds_truncation_threshold, "36");
2070
// ATTENTION: for test only, use random segments key bounds truncation threshold every time
2071
DEFINE_mBool(random_segments_key_bounds_truncation, "false");
2072
2073
// If true, non-MOW rowsets store a single aggregated [rowset_min, rowset_max]
2074
// key-bounds entry instead of per-segment bounds, to reduce meta size on cloud FDB.
2075
DEFINE_mBool(enable_aggregate_non_mow_key_bounds, "true");
2076
// p0, daily, rqg, external
2077
DEFINE_String(fuzzy_test_type, "");
2078
2079
DEFINE_mBool(enable_auto_clone_on_compaction_missing_version, "false");
2080
2081
DEFINE_mBool(enable_auto_clone_on_mow_publish_missing_version, "false");
2082
2083
// The maximum csv line reader output buffer size
2084
DEFINE_mInt64(max_csv_line_reader_output_buffer_size, "4294967296");
2085
2086
// The maximum bytes of a single block returned by load file readers (CsvReader, NewJsonReader,
2087
// ParquetReader, OrcReader). Default is 64MB. Set to 0 to disable the limit.
2088
DEFINE_mInt64(load_reader_max_block_bytes, "67108864");
2089
2090
// Maximum number of OpenMP threads allowed for concurrent vector index builds.
2091
// -1 means auto: use 80% of the available CPU cores.
2092
DEFINE_Int32(omp_threads_limit, "-1");
2093
2094
// The capacity of segment partial column cache, used to cache column readers for each segment.
2095
DEFINE_mInt32(max_segment_partial_column_cache_size, "100");
2096
2097
DEFINE_mBool(enable_prefill_output_dbm_agg_cache_after_compaction, "true");
2098
DEFINE_mBool(enable_prefill_all_dbm_agg_cache_after_compaction, "true");
2099
2100
// Cache for ANN index IVF on-disk list data.
2101
// "70%" means 70% of the process available memory, not 70% of total machine memory.
2102
// With default mem_limit="90%", this is effectively about 63% (90% * 70%) of physical memory
2103
// visible to the process (considering cgroup limits).
2104
DEFINE_String(ann_index_ivf_list_cache_limit, "70%");
2105
// Stale sweep time for ANN index IVF list cache in seconds. 3600s is 1 hour.
2106
DEFINE_mInt32(ann_index_ivf_list_cache_stale_sweep_time_sec, "3600");
2107
// Minimum segment rows required to persist an ANN index. 0 keeps the default behavior.
2108
DEFINE_mInt64(ann_index_build_min_segment_rows, "0");
2109
DEFINE_Validator(ann_index_build_min_segment_rows,
2110
                 [](const int64_t config) -> bool { return config >= 0; });
2111
2112
DEFINE_mBool(enable_wal_tde, "false");
2113
2114
DEFINE_mBool(print_stack_when_cache_miss, "false");
2115
2116
DEFINE_mBool(read_cluster_cache_opt_verbose_log, "false");
2117
2118
DEFINE_String(aws_credentials_provider_version, "v2");
2119
DEFINE_Validator(aws_credentials_provider_version, [](const std::string& config) -> bool {
2120
    return config == "v1" || config == "v2";
2121
});
2122
2123
// Concurrency stats dump configuration
2124
DEFINE_mBool(enable_concurrency_stats_dump, "false");
2125
DEFINE_mInt32(concurrency_stats_dump_interval_ms, "100");
2126
DEFINE_Validator(concurrency_stats_dump_interval_ms,
2127
                 [](const int32_t config) -> bool { return config >= 10; });
2128
2129
DEFINE_mBool(cloud_mow_sync_rowsets_when_load_txn_begin, "true");
2130
2131
DEFINE_mBool(enable_cloud_make_rs_visible_on_be, "false");
2132
DEFINE_mBool(enable_cloud_random_segment_id, "false");
2133
DEFINE_mInt32(file_handles_deplenish_frequency_times, "3");
2134
2135
// clang-format off
2136
#ifdef BE_TEST
2137
DEFINE_String(test_s3_ak, "ak");
2138
DEFINE_String(test_s3_sk, "sk");
2139
DEFINE_String(test_s3_endpoint, "endpoint");
2140
DEFINE_String(test_s3_region, "region");
2141
DEFINE_String(test_s3_bucket, "bucket");
2142
DEFINE_String(test_s3_prefix, "prefix");
2143
#endif
2144
// clang-format on
2145
2146
std::map<std::string, Register::Field>* Register::_s_field_map = nullptr;
2147
std::map<std::string, std::function<bool()>>* RegisterConfValidator::_s_field_validator = nullptr;
2148
std::map<std::string, RegisterConfUpdateCallback::CallbackFunc>*
2149
        RegisterConfUpdateCallback::_s_field_update_callback = nullptr;
2150
std::map<std::string, std::string>* full_conf_map = nullptr;
2151
2152
std::mutex custom_conf_lock;
2153
2154
std::mutex mutable_string_config_lock;
2155
2156
// trim string
2157
5.28k
std::string& trim(std::string& s) {
2158
    // rtrim
2159
5.28k
    s.erase(std::find_if(s.rbegin(), s.rend(), [](unsigned char c) { return !std::isspace(c); })
2160
5.28k
                    .base(),
2161
5.28k
            s.end());
2162
    // ltrim
2163
5.28k
    s.erase(s.begin(),
2164
5.28k
            std::find_if(s.begin(), s.end(), [](unsigned char c) { return !std::isspace(c); }));
2165
5.28k
    return s;
2166
5.28k
}
2167
2168
// split string by '='
2169
28
void splitkv(const std::string& s, std::string& k, std::string& v) {
2170
28
    const char sep = '=';
2171
28
    int start = 0;
2172
28
    int end = 0;
2173
28
    if ((end = s.find(sep, start)) != std::string::npos) {
2174
28
        k = s.substr(start, end - start);
2175
28
        v = s.substr(end + 1);
2176
28
    } else {
2177
0
        k = s;
2178
0
        v = "";
2179
0
    }
2180
28
}
2181
2182
// replace env variables
2183
5.07k
bool replaceenv(std::string& s) {
2184
5.07k
    std::size_t pos = 0;
2185
5.07k
    std::size_t start = 0;
2186
5.09k
    while ((start = s.find("${", pos)) != std::string::npos) {
2187
15
        std::size_t end = s.find('}', start + 2);
2188
15
        if (end == std::string::npos) {
2189
0
            return false;
2190
0
        }
2191
15
        std::string envkey = s.substr(start + 2, end - start - 2);
2192
15
        const char* envval = std::getenv(envkey.c_str());
2193
15
        if (envval == nullptr) {
2194
0
            return false;
2195
0
        }
2196
15
        s.erase(start, end - start + 1);
2197
15
        s.insert(start, envval);
2198
15
        pos = start + strlen(envval);
2199
15
    }
2200
5.07k
    return true;
2201
5.07k
}
2202
2203
bool strtox(const std::string& valstr, bool& retval);
2204
bool strtox(const std::string& valstr, int16_t& retval);
2205
bool strtox(const std::string& valstr, int32_t& retval);
2206
bool strtox(const std::string& valstr, int64_t& retval);
2207
bool strtox(const std::string& valstr, double& retval);
2208
bool strtox(const std::string& valstr, std::string& retval);
2209
2210
template <typename T>
2211
7
bool strtox(const std::string& valstr, std::vector<T>& retval) {
2212
7
    std::stringstream ss(valstr);
2213
7
    std::string item;
2214
7
    T t;
2215
26
    while (std::getline(ss, item, ',')) {
2216
19
        if (!strtox(trim(item), t)) {
2217
0
            return false;
2218
0
        }
2219
19
        retval.push_back(t);
2220
19
    }
2221
7
    return true;
2222
7
}
_ZN5doris6config6strtoxIbEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERSt6vectorIT_SaISB_EE
Line
Count
Source
2211
1
bool strtox(const std::string& valstr, std::vector<T>& retval) {
2212
1
    std::stringstream ss(valstr);
2213
1
    std::string item;
2214
1
    T t;
2215
4
    while (std::getline(ss, item, ',')) {
2216
3
        if (!strtox(trim(item), t)) {
2217
0
            return false;
2218
0
        }
2219
3
        retval.push_back(t);
2220
3
    }
2221
1
    return true;
2222
1
}
_ZN5doris6config6strtoxIsEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERSt6vectorIT_SaISB_EE
Line
Count
Source
2211
1
bool strtox(const std::string& valstr, std::vector<T>& retval) {
2212
1
    std::stringstream ss(valstr);
2213
1
    std::string item;
2214
1
    T t;
2215
4
    while (std::getline(ss, item, ',')) {
2216
3
        if (!strtox(trim(item), t)) {
2217
0
            return false;
2218
0
        }
2219
3
        retval.push_back(t);
2220
3
    }
2221
1
    return true;
2222
1
}
_ZN5doris6config6strtoxIiEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERSt6vectorIT_SaISB_EE
Line
Count
Source
2211
1
bool strtox(const std::string& valstr, std::vector<T>& retval) {
2212
1
    std::stringstream ss(valstr);
2213
1
    std::string item;
2214
1
    T t;
2215
4
    while (std::getline(ss, item, ',')) {
2216
3
        if (!strtox(trim(item), t)) {
2217
0
            return false;
2218
0
        }
2219
3
        retval.push_back(t);
2220
3
    }
2221
1
    return true;
2222
1
}
_ZN5doris6config6strtoxIlEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERSt6vectorIT_SaISB_EE
Line
Count
Source
2211
1
bool strtox(const std::string& valstr, std::vector<T>& retval) {
2212
1
    std::stringstream ss(valstr);
2213
1
    std::string item;
2214
1
    T t;
2215
4
    while (std::getline(ss, item, ',')) {
2216
3
        if (!strtox(trim(item), t)) {
2217
0
            return false;
2218
0
        }
2219
3
        retval.push_back(t);
2220
3
    }
2221
1
    return true;
2222
1
}
_ZN5doris6config6strtoxIdEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERSt6vectorIT_SaISB_EE
Line
Count
Source
2211
1
bool strtox(const std::string& valstr, std::vector<T>& retval) {
2212
1
    std::stringstream ss(valstr);
2213
1
    std::string item;
2214
1
    T t;
2215
4
    while (std::getline(ss, item, ',')) {
2216
3
        if (!strtox(trim(item), t)) {
2217
0
            return false;
2218
0
        }
2219
3
        retval.push_back(t);
2220
3
    }
2221
1
    return true;
2222
1
}
_ZN5doris6config6strtoxINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEbRKS7_RSt6vectorIT_SaISB_EE
Line
Count
Source
2211
2
bool strtox(const std::string& valstr, std::vector<T>& retval) {
2212
2
    std::stringstream ss(valstr);
2213
2
    std::string item;
2214
2
    T t;
2215
6
    while (std::getline(ss, item, ',')) {
2216
4
        if (!strtox(trim(item), t)) {
2217
0
            return false;
2218
0
        }
2219
4
        retval.push_back(t);
2220
4
    }
2221
2
    return true;
2222
2
}
2223
2224
231
bool strtox(const std::string& valstr, bool& retval) {
2225
231
    if (valstr == "true") {
2226
111
        retval = true;
2227
120
    } else if (valstr == "false") {
2228
119
        retval = false;
2229
119
    } else {
2230
1
        return false;
2231
1
    }
2232
230
    return true;
2233
231
}
2234
2235
template <typename T>
2236
683
bool strtointeger(const std::string& valstr, T& retval) {
2237
683
    if (valstr.length() == 0) {
2238
0
        return false; // empty-string is only allowed for string type.
2239
0
    }
2240
683
    char* end;
2241
683
    errno = 0;
2242
683
    const char* valcstr = valstr.c_str();
2243
683
    int64_t ret64 = strtoll(valcstr, &end, 10);
2244
683
    if (errno || end != valcstr + strlen(valcstr)) {
2245
0
        return false; // bad parse
2246
0
    }
2247
683
    T tmp = retval;
2248
683
    retval = static_cast<T>(ret64);
2249
683
    if (retval != ret64) {
2250
1
        retval = tmp;
2251
1
        return false;
2252
1
    }
2253
682
    return true;
2254
683
}
_ZN5doris6config12strtointegerIsEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2236
18
bool strtointeger(const std::string& valstr, T& retval) {
2237
18
    if (valstr.length() == 0) {
2238
0
        return false; // empty-string is only allowed for string type.
2239
0
    }
2240
18
    char* end;
2241
18
    errno = 0;
2242
18
    const char* valcstr = valstr.c_str();
2243
18
    int64_t ret64 = strtoll(valcstr, &end, 10);
2244
18
    if (errno || end != valcstr + strlen(valcstr)) {
2245
0
        return false; // bad parse
2246
0
    }
2247
18
    T tmp = retval;
2248
18
    retval = static_cast<T>(ret64);
2249
18
    if (retval != ret64) {
2250
0
        retval = tmp;
2251
0
        return false;
2252
0
    }
2253
18
    return true;
2254
18
}
_ZN5doris6config12strtointegerIiEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2236
463
bool strtointeger(const std::string& valstr, T& retval) {
2237
463
    if (valstr.length() == 0) {
2238
0
        return false; // empty-string is only allowed for string type.
2239
0
    }
2240
463
    char* end;
2241
463
    errno = 0;
2242
463
    const char* valcstr = valstr.c_str();
2243
463
    int64_t ret64 = strtoll(valcstr, &end, 10);
2244
463
    if (errno || end != valcstr + strlen(valcstr)) {
2245
0
        return false; // bad parse
2246
0
    }
2247
463
    T tmp = retval;
2248
463
    retval = static_cast<T>(ret64);
2249
463
    if (retval != ret64) {
2250
1
        retval = tmp;
2251
1
        return false;
2252
1
    }
2253
462
    return true;
2254
463
}
_ZN5doris6config12strtointegerIlEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2236
202
bool strtointeger(const std::string& valstr, T& retval) {
2237
202
    if (valstr.length() == 0) {
2238
0
        return false; // empty-string is only allowed for string type.
2239
0
    }
2240
202
    char* end;
2241
202
    errno = 0;
2242
202
    const char* valcstr = valstr.c_str();
2243
202
    int64_t ret64 = strtoll(valcstr, &end, 10);
2244
202
    if (errno || end != valcstr + strlen(valcstr)) {
2245
0
        return false; // bad parse
2246
0
    }
2247
202
    T tmp = retval;
2248
202
    retval = static_cast<T>(ret64);
2249
202
    if (retval != ret64) {
2250
0
        retval = tmp;
2251
0
        return false;
2252
0
    }
2253
202
    return true;
2254
202
}
2255
2256
18
bool strtox(const std::string& valstr, int16_t& retval) {
2257
18
    return strtointeger(valstr, retval);
2258
18
}
2259
2260
463
bool strtox(const std::string& valstr, int32_t& retval) {
2261
463
    return strtointeger(valstr, retval);
2262
463
}
2263
2264
202
bool strtox(const std::string& valstr, int64_t& retval) {
2265
202
    return strtointeger(valstr, retval);
2266
202
}
2267
2268
4.07k
bool strtox(const std::string& valstr, double& retval) {
2269
4.07k
    if (valstr.length() == 0) {
2270
1
        return false; // empty-string is only allowed for string type.
2271
1
    }
2272
4.07k
    char* end = nullptr;
2273
4.07k
    errno = 0;
2274
4.07k
    const char* valcstr = valstr.c_str();
2275
4.07k
    retval = strtod(valcstr, &end);
2276
4.07k
    if (errno || end != valcstr + strlen(valcstr)) {
2277
0
        return false; // bad parse
2278
0
    }
2279
4.07k
    return true;
2280
4.07k
}
2281
2282
98
bool strtox(const std::string& valstr, std::string& retval) {
2283
98
    retval = valstr;
2284
98
    return true;
2285
98
}
2286
2287
template <typename T>
2288
5.07k
bool convert(const std::string& value, T& retval) {
2289
5.07k
    std::string valstr(value);
2290
5.07k
    trim(valstr);
2291
5.07k
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
5.07k
    return strtox(valstr, retval);
2295
5.07k
}
_ZN5doris6config7convertISt6vectorIbSaIbEEEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
1
bool convert(const std::string& value, T& retval) {
2289
1
    std::string valstr(value);
2290
1
    trim(valstr);
2291
1
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
1
    return strtox(valstr, retval);
2295
1
}
_ZN5doris6config7convertISt6vectorIsSaIsEEEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
1
bool convert(const std::string& value, T& retval) {
2289
1
    std::string valstr(value);
2290
1
    trim(valstr);
2291
1
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
1
    return strtox(valstr, retval);
2295
1
}
_ZN5doris6config7convertISt6vectorIiSaIiEEEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
1
bool convert(const std::string& value, T& retval) {
2289
1
    std::string valstr(value);
2290
1
    trim(valstr);
2291
1
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
1
    return strtox(valstr, retval);
2295
1
}
_ZN5doris6config7convertISt6vectorIlSaIlEEEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
1
bool convert(const std::string& value, T& retval) {
2289
1
    std::string valstr(value);
2290
1
    trim(valstr);
2291
1
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
1
    return strtox(valstr, retval);
2295
1
}
_ZN5doris6config7convertISt6vectorIdSaIdEEEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
1
bool convert(const std::string& value, T& retval) {
2289
1
    std::string valstr(value);
2290
1
    trim(valstr);
2291
1
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
1
    return strtox(valstr, retval);
2295
1
}
_ZN5doris6config7convertISt6vectorINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEESaIS8_EEEEbRKS8_RT_
Line
Count
Source
2288
2
bool convert(const std::string& value, T& retval) {
2289
2
    std::string valstr(value);
2290
2
    trim(valstr);
2291
2
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
2
    return strtox(valstr, retval);
2295
2
}
_ZN5doris6config7convertIbEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
228
bool convert(const std::string& value, T& retval) {
2289
228
    std::string valstr(value);
2290
228
    trim(valstr);
2291
228
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
228
    return strtox(valstr, retval);
2295
228
}
_ZN5doris6config7convertIsEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
15
bool convert(const std::string& value, T& retval) {
2289
15
    std::string valstr(value);
2290
15
    trim(valstr);
2291
15
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
15
    return strtox(valstr, retval);
2295
15
}
_ZN5doris6config7convertIiEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
460
bool convert(const std::string& value, T& retval) {
2289
460
    std::string valstr(value);
2290
460
    trim(valstr);
2291
460
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
460
    return strtox(valstr, retval);
2295
460
}
_ZN5doris6config7convertIlEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
199
bool convert(const std::string& value, T& retval) {
2289
199
    std::string valstr(value);
2290
199
    trim(valstr);
2291
199
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
199
    return strtox(valstr, retval);
2295
199
}
_ZN5doris6config7convertIdEEbRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERT_
Line
Count
Source
2288
4.07k
bool convert(const std::string& value, T& retval) {
2289
4.07k
    std::string valstr(value);
2290
4.07k
    trim(valstr);
2291
4.07k
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
4.07k
    return strtox(valstr, retval);
2295
4.07k
}
_ZN5doris6config7convertINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEbRKS7_RT_
Line
Count
Source
2288
94
bool convert(const std::string& value, T& retval) {
2289
94
    std::string valstr(value);
2290
94
    trim(valstr);
2291
94
    if (!replaceenv(valstr)) {
2292
0
        return false;
2293
0
    }
2294
94
    return strtox(valstr, retval);
2295
94
}
2296
2297
// load conf file
2298
12
bool Properties::load(const char* conf_file, bool must_exist) {
2299
    // if conf_file is null, use the empty props
2300
12
    if (conf_file == nullptr) {
2301
2
        return true;
2302
2
    }
2303
2304
    // open the conf file
2305
10
    std::ifstream input(conf_file);
2306
10
    if (!input.is_open()) {
2307
3
        if (must_exist) {
2308
0
            std::cerr << "config::load() failed to open the file:" << conf_file << std::endl;
2309
0
            return false;
2310
0
        }
2311
3
        return true;
2312
3
    }
2313
2314
    // load properties
2315
7
    std::string line;
2316
7
    std::string key;
2317
7
    std::string value;
2318
7
    line.reserve(512);
2319
137
    while (input) {
2320
        // read one line at a time
2321
130
        std::getline(input, line);
2322
2323
        // remove left and right spaces
2324
130
        trim(line);
2325
2326
        // ignore comments
2327
130
        if (line.empty() || line[0] == '#') {
2328
102
            continue;
2329
102
        }
2330
2331
        // read key and value
2332
28
        splitkv(line, key, value);
2333
28
        trim(key);
2334
28
        trim(value);
2335
2336
        // insert into file_conf_map
2337
28
        file_conf_map[key] = value;
2338
28
    }
2339
2340
    // close the conf file
2341
7
    input.close();
2342
2343
7
    return true;
2344
10
}
2345
2346
template <typename T>
2347
bool Properties::get_or_default(const char* key, const char* defstr, T& retval, bool* is_retval_set,
2348
1.99k
                                std::string& rawval) const {
2349
1.99k
    const auto& it = file_conf_map.find(std::string(key));
2350
1.99k
    std::string valstr;
2351
1.99k
    if (it == file_conf_map.end()) {
2352
1.97k
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
1.02k
            *is_retval_set = false;
2355
1.02k
            return true;
2356
1.02k
        } else {
2357
951
            valstr = std::string(defstr);
2358
951
        }
2359
1.97k
    } else {
2360
18
        valstr = it->second;
2361
18
    }
2362
969
    rawval = valstr;
2363
969
    *is_retval_set = true;
2364
969
    return convert(valstr, retval);
2365
1.99k
}
_ZNK5doris6config10Properties14get_or_defaultIbEEbPKcS4_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
432
                                std::string& rawval) const {
2349
432
    const auto& it = file_conf_map.find(std::string(key));
2350
432
    std::string valstr;
2351
432
    if (it == file_conf_map.end()) {
2352
431
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
216
            *is_retval_set = false;
2355
216
            return true;
2356
216
        } else {
2357
215
            valstr = std::string(defstr);
2358
215
        }
2359
431
    } else {
2360
1
        valstr = it->second;
2361
1
    }
2362
216
    rawval = valstr;
2363
216
    *is_retval_set = true;
2364
216
    return convert(valstr, retval);
2365
432
}
_ZNK5doris6config10Properties14get_or_defaultIsEEbPKcS4_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
14
                                std::string& rawval) const {
2349
14
    const auto& it = file_conf_map.find(std::string(key));
2350
14
    std::string valstr;
2351
14
    if (it == file_conf_map.end()) {
2352
12
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
5
            *is_retval_set = false;
2355
5
            return true;
2356
7
        } else {
2357
7
            valstr = std::string(defstr);
2358
7
        }
2359
12
    } else {
2360
2
        valstr = it->second;
2361
2
    }
2362
9
    rawval = valstr;
2363
9
    *is_retval_set = true;
2364
9
    return convert(valstr, retval);
2365
14
}
_ZNK5doris6config10Properties14get_or_defaultIiEEbPKcS4_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
898
                                std::string& rawval) const {
2349
898
    const auto& it = file_conf_map.find(std::string(key));
2350
898
    std::string valstr;
2351
898
    if (it == file_conf_map.end()) {
2352
891
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
471
            *is_retval_set = false;
2355
471
            return true;
2356
471
        } else {
2357
420
            valstr = std::string(defstr);
2358
420
        }
2359
891
    } else {
2360
7
        valstr = it->second;
2361
7
    }
2362
427
    rawval = valstr;
2363
427
    *is_retval_set = true;
2364
427
    return convert(valstr, retval);
2365
898
}
_ZNK5doris6config10Properties14get_or_defaultIlEEbPKcS4_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
393
                                std::string& rawval) const {
2349
393
    const auto& it = file_conf_map.find(std::string(key));
2350
393
    std::string valstr;
2351
393
    if (it == file_conf_map.end()) {
2352
393
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
205
            *is_retval_set = false;
2355
205
            return true;
2356
205
        } else {
2357
188
            valstr = std::string(defstr);
2358
188
        }
2359
393
    } else {
2360
0
        valstr = it->second;
2361
0
    }
2362
188
    rawval = valstr;
2363
188
    *is_retval_set = true;
2364
188
    return convert(valstr, retval);
2365
393
}
_ZNK5doris6config10Properties14get_or_defaultIdEEbPKcS4_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
69
                                std::string& rawval) const {
2349
69
    const auto& it = file_conf_map.find(std::string(key));
2350
69
    std::string valstr;
2351
69
    if (it == file_conf_map.end()) {
2352
69
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
35
            *is_retval_set = false;
2355
35
            return true;
2356
35
        } else {
2357
34
            valstr = std::string(defstr);
2358
34
        }
2359
69
    } else {
2360
0
        valstr = it->second;
2361
0
    }
2362
34
    rawval = valstr;
2363
34
    *is_retval_set = true;
2364
34
    return convert(valstr, retval);
2365
69
}
_ZNK5doris6config10Properties14get_or_defaultINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEbPKcSA_RT_PbRS8_
Line
Count
Source
2348
183
                                std::string& rawval) const {
2349
183
    const auto& it = file_conf_map.find(std::string(key));
2350
183
    std::string valstr;
2351
183
    if (it == file_conf_map.end()) {
2352
175
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
95
            *is_retval_set = false;
2355
95
            return true;
2356
95
        } else {
2357
80
            valstr = std::string(defstr);
2358
80
        }
2359
175
    } else {
2360
8
        valstr = it->second;
2361
8
    }
2362
88
    rawval = valstr;
2363
88
    *is_retval_set = true;
2364
88
    return convert(valstr, retval);
2365
183
}
_ZNK5doris6config10Properties14get_or_defaultISt6vectorIbSaIbEEEEbPKcS7_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
1
                                std::string& rawval) const {
2349
1
    const auto& it = file_conf_map.find(std::string(key));
2350
1
    std::string valstr;
2351
1
    if (it == file_conf_map.end()) {
2352
1
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
0
            *is_retval_set = false;
2355
0
            return true;
2356
1
        } else {
2357
1
            valstr = std::string(defstr);
2358
1
        }
2359
1
    } else {
2360
0
        valstr = it->second;
2361
0
    }
2362
1
    rawval = valstr;
2363
1
    *is_retval_set = true;
2364
1
    return convert(valstr, retval);
2365
1
}
_ZNK5doris6config10Properties14get_or_defaultISt6vectorIsSaIsEEEEbPKcS7_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
1
                                std::string& rawval) const {
2349
1
    const auto& it = file_conf_map.find(std::string(key));
2350
1
    std::string valstr;
2351
1
    if (it == file_conf_map.end()) {
2352
1
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
0
            *is_retval_set = false;
2355
0
            return true;
2356
1
        } else {
2357
1
            valstr = std::string(defstr);
2358
1
        }
2359
1
    } else {
2360
0
        valstr = it->second;
2361
0
    }
2362
1
    rawval = valstr;
2363
1
    *is_retval_set = true;
2364
1
    return convert(valstr, retval);
2365
1
}
_ZNK5doris6config10Properties14get_or_defaultISt6vectorIiSaIiEEEEbPKcS7_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
1
                                std::string& rawval) const {
2349
1
    const auto& it = file_conf_map.find(std::string(key));
2350
1
    std::string valstr;
2351
1
    if (it == file_conf_map.end()) {
2352
1
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
0
            *is_retval_set = false;
2355
0
            return true;
2356
1
        } else {
2357
1
            valstr = std::string(defstr);
2358
1
        }
2359
1
    } else {
2360
0
        valstr = it->second;
2361
0
    }
2362
1
    rawval = valstr;
2363
1
    *is_retval_set = true;
2364
1
    return convert(valstr, retval);
2365
1
}
_ZNK5doris6config10Properties14get_or_defaultISt6vectorIlSaIlEEEEbPKcS7_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
1
                                std::string& rawval) const {
2349
1
    const auto& it = file_conf_map.find(std::string(key));
2350
1
    std::string valstr;
2351
1
    if (it == file_conf_map.end()) {
2352
1
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
0
            *is_retval_set = false;
2355
0
            return true;
2356
1
        } else {
2357
1
            valstr = std::string(defstr);
2358
1
        }
2359
1
    } else {
2360
0
        valstr = it->second;
2361
0
    }
2362
1
    rawval = valstr;
2363
1
    *is_retval_set = true;
2364
1
    return convert(valstr, retval);
2365
1
}
_ZNK5doris6config10Properties14get_or_defaultISt6vectorIdSaIdEEEEbPKcS7_RT_PbRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
Line
Count
Source
2348
1
                                std::string& rawval) const {
2349
1
    const auto& it = file_conf_map.find(std::string(key));
2350
1
    std::string valstr;
2351
1
    if (it == file_conf_map.end()) {
2352
1
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
0
            *is_retval_set = false;
2355
0
            return true;
2356
1
        } else {
2357
1
            valstr = std::string(defstr);
2358
1
        }
2359
1
    } else {
2360
0
        valstr = it->second;
2361
0
    }
2362
1
    rawval = valstr;
2363
1
    *is_retval_set = true;
2364
1
    return convert(valstr, retval);
2365
1
}
_ZNK5doris6config10Properties14get_or_defaultISt6vectorINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEESaIS9_EEEEbPKcSD_RT_PbRS9_
Line
Count
Source
2348
3
                                std::string& rawval) const {
2349
3
    const auto& it = file_conf_map.find(std::string(key));
2350
3
    std::string valstr;
2351
3
    if (it == file_conf_map.end()) {
2352
3
        if (defstr == nullptr) {
2353
            // Not found in conf map, and no default value need to be set, just return
2354
1
            *is_retval_set = false;
2355
1
            return true;
2356
2
        } else {
2357
2
            valstr = std::string(defstr);
2358
2
        }
2359
3
    } else {
2360
0
        valstr = it->second;
2361
0
    }
2362
2
    rawval = valstr;
2363
2
    *is_retval_set = true;
2364
2
    return convert(valstr, retval);
2365
3
}
2366
2367
0
void Properties::set(const std::string& key, const std::string& val) {
2368
0
    file_conf_map.emplace(key, val);
2369
0
}
2370
2371
7
void Properties::set_force(const std::string& key, const std::string& val) {
2372
7
    file_conf_map[key] = val;
2373
7
}
2374
2375
7
Status Properties::dump(const std::string& conffile) {
2376
7
    std::string conffile_tmp = conffile + ".tmp";
2377
7
    io::FileWriterPtr file_writer;
2378
7
    RETURN_IF_ERROR(io::global_local_filesystem()->create_file(conffile_tmp, &file_writer));
2379
5
    RETURN_IF_ERROR(file_writer->append("# THIS IS AN AUTO GENERATED CONFIG FILE.\n"));
2380
5
    RETURN_IF_ERROR(file_writer->append(
2381
5
            "# You can modify this file manually, and the configurations in this file\n"));
2382
5
    RETURN_IF_ERROR(file_writer->append("# will overwrite the configurations in be.conf\n\n"));
2383
2384
5
    for (auto const& iter : file_conf_map) {
2385
5
        RETURN_IF_ERROR(file_writer->append(iter.first));
2386
5
        RETURN_IF_ERROR(file_writer->append(" = "));
2387
5
        RETURN_IF_ERROR(file_writer->append(iter.second));
2388
5
        RETURN_IF_ERROR(file_writer->append("\n"));
2389
5
    }
2390
2391
5
    RETURN_IF_ERROR(file_writer->close());
2392
2393
5
    return io::global_local_filesystem()->rename(conffile_tmp, conffile);
2394
5
}
2395
2396
template <typename T>
2397
6
std::ostream& operator<<(std::ostream& out, const std::vector<T>& v) {
2398
6
    size_t last = v.size() - 1;
2399
25
    for (size_t i = 0; i < v.size(); ++i) {
2400
19
        out << v[i];
2401
19
        if (i != last) {
2402
13
            out << ", ";
2403
13
        }
2404
19
    }
2405
6
    return out;
2406
6
}
_ZN5doris6configlsIbEERSoS2_RKSt6vectorIT_SaIS4_EE
Line
Count
Source
2397
1
std::ostream& operator<<(std::ostream& out, const std::vector<T>& v) {
2398
1
    size_t last = v.size() - 1;
2399
4
    for (size_t i = 0; i < v.size(); ++i) {
2400
3
        out << v[i];
2401
3
        if (i != last) {
2402
2
            out << ", ";
2403
2
        }
2404
3
    }
2405
1
    return out;
2406
1
}
_ZN5doris6configlsIsEERSoS2_RKSt6vectorIT_SaIS4_EE
Line
Count
Source
2397
1
std::ostream& operator<<(std::ostream& out, const std::vector<T>& v) {
2398
1
    size_t last = v.size() - 1;
2399
4
    for (size_t i = 0; i < v.size(); ++i) {
2400
3
        out << v[i];
2401
3
        if (i != last) {
2402
2
            out << ", ";
2403
2
        }
2404
3
    }
2405
1
    return out;
2406
1
}
_ZN5doris6configlsIiEERSoS2_RKSt6vectorIT_SaIS4_EE
Line
Count
Source
2397
1
std::ostream& operator<<(std::ostream& out, const std::vector<T>& v) {
2398
1
    size_t last = v.size() - 1;
2399
4
    for (size_t i = 0; i < v.size(); ++i) {
2400
3
        out << v[i];
2401
3
        if (i != last) {
2402
2
            out << ", ";
2403
2
        }
2404
3
    }
2405
1
    return out;
2406
1
}
_ZN5doris6configlsIlEERSoS2_RKSt6vectorIT_SaIS4_EE
Line
Count
Source
2397
1
std::ostream& operator<<(std::ostream& out, const std::vector<T>& v) {
2398
1
    size_t last = v.size() - 1;
2399
4
    for (size_t i = 0; i < v.size(); ++i) {
2400
3
        out << v[i];
2401
3
        if (i != last) {
2402
2
            out << ", ";
2403
2
        }
2404
3
    }
2405
1
    return out;
2406
1
}
_ZN5doris6configlsIdEERSoS2_RKSt6vectorIT_SaIS4_EE
Line
Count
Source
2397
1
std::ostream& operator<<(std::ostream& out, const std::vector<T>& v) {
2398
1
    size_t last = v.size() - 1;
2399
4
    for (size_t i = 0; i < v.size(); ++i) {
2400
3
        out << v[i];
2401
3
        if (i != last) {
2402
2
            out << ", ";
2403
2
        }
2404
3
    }
2405
1
    return out;
2406
1
}
_ZN5doris6configlsINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEERSoS8_RKSt6vectorIT_SaISA_EE
Line
Count
Source
2397
1
std::ostream& operator<<(std::ostream& out, const std::vector<T>& v) {
2398
1
    size_t last = v.size() - 1;
2399
5
    for (size_t i = 0; i < v.size(); ++i) {
2400
4
        out << v[i];
2401
4
        if (i != last) {
2402
3
            out << ", ";
2403
3
        }
2404
4
    }
2405
1
    return out;
2406
1
}
2407
2408
#define SET_FIELD(FIELD, TYPE, FILL_CONF_MAP, SET_TO_DEFAULT)                                  \
2409
6.25k
    if (strcmp((FIELD).type, #TYPE) == 0) {                                                    \
2410
1.99k
        TYPE new_value = TYPE();                                                               \
2411
1.99k
        bool is_newval_set = false;                                                            \
2412
1.99k
        std::string raw_value;                                                                 \
2413
1.99k
        if (!props.get_or_default((FIELD).name, ((SET_TO_DEFAULT) ? (FIELD).defval : nullptr), \
2414
1.99k
                                  new_value, &is_newval_set, raw_value)) {                     \
2415
0
            std::cerr << "config field error: " << (FIELD).name << " = \"" << raw_value << '"' \
2416
0
                      << std::endl;                                                            \
2417
0
            return false;                                                                      \
2418
0
        }                                                                                      \
2419
1.99k
        if (!is_newval_set) {                                                                  \
2420
1.02k
            continue;                                                                          \
2421
1.02k
        }                                                                                      \
2422
1.99k
        TYPE& ref_conf_value = *reinterpret_cast<TYPE*>((FIELD).storage);                      \
2423
969
        TYPE old_value = ref_conf_value;                                                       \
2424
969
        ref_conf_value = new_value;                                                            \
2425
969
        if (RegisterConfValidator::_s_field_validator != nullptr) {                            \
2426
969
            auto validator = RegisterConfValidator::_s_field_validator->find((FIELD).name);    \
2427
969
            if (validator != RegisterConfValidator::_s_field_validator->end() &&               \
2428
969
                !(validator->second)()) {                                                      \
2429
1
                ref_conf_value = old_value;                                                    \
2430
1
                std::cerr << "validate " << (FIELD).name << "=" << new_value << " failed"      \
2431
1
                          << std::endl;                                                        \
2432
1
                return false;                                                                  \
2433
1
            }                                                                                  \
2434
969
        }                                                                                      \
2435
969
        if (FILL_CONF_MAP) {                                                                   \
2436
20
            std::ostringstream oss;                                                            \
2437
20
            oss << ref_conf_value;                                                             \
2438
20
            (*full_conf_map)[(FIELD).name] = oss.str();                                        \
2439
20
        }                                                                                      \
2440
968
        continue;                                                                              \
2441
969
    }
2442
2443
// Keys that start with an uppercase letter and consist only of uppercase letters,
2444
// digits and underscores (e.g. JAVA_OPTS, LOG_DIR) are exported as environment
2445
// variables by bin/start_be.sh and are not BE config fields, so they must not be
2446
// reported as unknown.
2447
6
static bool is_env_style_key(const std::string& key) {
2448
6
    if (key.empty() || key[0] < 'A' || key[0] > 'Z') {
2449
0
        return false;
2450
0
    }
2451
92
    for (char c : key) {
2452
92
        if (!((c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c == '_')) {
2453
0
            return false;
2454
0
        }
2455
92
    }
2456
6
    return true;
2457
6
}
2458
2459
// init conf fields
2460
5
bool init(const char* conf_file, bool fill_conf_map, bool must_exist, bool set_to_default) {
2461
5
    Properties props;
2462
    // load properties file
2463
5
    if (!props.load(conf_file, must_exist)) {
2464
0
        return false;
2465
0
    }
2466
    // fill full_conf_map ?
2467
5
    if (fill_conf_map && full_conf_map == nullptr) {
2468
1
        full_conf_map = new std::map<std::string, std::string>();
2469
1
    }
2470
2471
    // set conf fields
2472
1.99k
    for (const auto& it : *Register::_s_field_map) {
2473
1.99k
        SET_FIELD(it.second, bool, fill_conf_map, set_to_default);
2474
1.56k
        SET_FIELD(it.second, int16_t, fill_conf_map, set_to_default);
2475
1.55k
        SET_FIELD(it.second, int32_t, fill_conf_map, set_to_default);
2476
653
        SET_FIELD(it.second, int64_t, fill_conf_map, set_to_default);
2477
260
        SET_FIELD(it.second, double, fill_conf_map, set_to_default);
2478
191
        SET_FIELD(it.second, std::string, fill_conf_map, set_to_default);
2479
8
        SET_FIELD(it.second, std::vector<bool>, fill_conf_map, set_to_default);
2480
7
        SET_FIELD(it.second, std::vector<int16_t>, fill_conf_map, set_to_default);
2481
6
        SET_FIELD(it.second, std::vector<int32_t>, fill_conf_map, set_to_default);
2482
5
        SET_FIELD(it.second, std::vector<int64_t>, fill_conf_map, set_to_default);
2483
4
        SET_FIELD(it.second, std::vector<double>, fill_conf_map, set_to_default);
2484
3
        SET_FIELD(it.second, std::vector<std::string>, fill_conf_map, set_to_default);
2485
0
    }
2486
4
    published_inverted_index_candidate_pushdown_ratio.store(
2487
4
            inverted_index_candidate_pushdown_ratio);
2488
4
    atomic_lookup_connection_cache_block_pool_size.store(
2489
4
            static_cast<size_t>(lookup_connection_cache_block_pool_size),
2490
4
            std::memory_order_relaxed);
2491
2492
    // Emit a warning for every key present in the conf file that does not correspond to a
2493
    // registered BE config field. Such keys (typos or configs removed in a newer version)
2494
    // are silently ignored above, so without this warning operators would have no feedback
2495
    // that the value is not taking effect. BE startup is not affected.
2496
23
    for (const auto& kv : props.conf_map()) {
2497
23
        const std::string& key = kv.first;
2498
23
        if (Register::_s_field_map->find(key) != Register::_s_field_map->end()) {
2499
17
            continue;
2500
17
        }
2501
6
        if (is_env_style_key(key)) {
2502
6
            continue;
2503
6
        }
2504
6
        LOG(WARNING) << fmt::format(
2505
0
                "Unknown config '{}' in {} is ignored, please check whether it is a typo "
2506
0
                "or has been removed in this version.",
2507
0
                key, conf_file);
2508
0
    }
2509
2510
4
    if (config::is_cloud_mode()) {
2511
0
        auto st = config::set_config("enable_file_cache", "true", true, true);
2512
0
        LOG(INFO) << "set config enable_file_cache "
2513
0
                  << "true"
2514
0
                  << " " << st;
2515
0
    }
2516
2517
4
    return true;
2518
5
}
2519
2520
#define UPDATE_FIELD(FIELD, VALUE, TYPE, PERSIST)                                                  \
2521
20.4k
    if (strcmp((FIELD).type, #TYPE) == 0) {                                                        \
2522
4.11k
        TYPE new_value;                                                                            \
2523
4.11k
        if (!convert((VALUE), new_value)) {                                                        \
2524
3
            return Status::Error<ErrorCode::INVALID_ARGUMENT, false>("convert '{}' as {} failed",  \
2525
3
                                                                     VALUE, #TYPE);                \
2526
3
        }                                                                                          \
2527
4.11k
        TYPE& ref_conf_value = *reinterpret_cast<TYPE*>((FIELD).storage);                          \
2528
4.10k
        TYPE old_value = ref_conf_value;                                                           \
2529
4.10k
        ref_conf_value = new_value;                                                                \
2530
4.10k
        if (RegisterConfValidator::_s_field_validator != nullptr) {                                \
2531
4.10k
            auto validator = RegisterConfValidator::_s_field_validator->find((FIELD).name);        \
2532
4.10k
            if (validator != RegisterConfValidator::_s_field_validator->end() &&                   \
2533
4.10k
                !(validator->second)()) {                                                          \
2534
2.01k
                ref_conf_value = old_value;                                                        \
2535
2.01k
                return Status::Error<ErrorCode::INVALID_ARGUMENT, false>("validate {}={} failed",  \
2536
2.01k
                                                                         (FIELD).name, new_value); \
2537
2.01k
            }                                                                                      \
2538
4.10k
        }                                                                                          \
2539
4.10k
        if (PERSIST) {                                                                             \
2540
7
            Status persist_status = persist_config(std::string((FIELD).name), VALUE);              \
2541
7
            if (!persist_status.ok()) {                                                            \
2542
2
                ref_conf_value = old_value;                                                        \
2543
2
                return persist_status;                                                             \
2544
2
            }                                                                                      \
2545
7
        }                                                                                          \
2546
2.09k
        if (full_conf_map != nullptr) {                                                            \
2547
2.08k
            std::ostringstream oss;                                                                \
2548
2.08k
            oss << new_value;                                                                      \
2549
2.08k
            (*full_conf_map)[(FIELD).name] = oss.str();                                            \
2550
2.08k
        }                                                                                          \
2551
2.08k
        if (RegisterConfUpdateCallback::_s_field_update_callback != nullptr) {                     \
2552
2.08k
            auto callback_it =                                                                     \
2553
2.08k
                    RegisterConfUpdateCallback::_s_field_update_callback->find((FIELD).name);      \
2554
2.08k
            if (callback_it != RegisterConfUpdateCallback::_s_field_update_callback->end()) {      \
2555
2.06k
                callback_it->second(&old_value, &new_value);                                       \
2556
2.06k
            }                                                                                      \
2557
2.08k
        }                                                                                          \
2558
2.08k
        update_config(std::string((FIELD).name), VALUE);                                           \
2559
2.08k
        return Status::OK();                                                                       \
2560
2.09k
    }
2561
2562
// write config to be_custom.conf
2563
// the caller need to make sure that the given config is valid
2564
7
Status persist_config(const std::string& field, const std::string& value) {
2565
    // lock to make sure only one thread can modify the be_custom.conf
2566
7
    std::lock_guard<std::mutex> l(custom_conf_lock);
2567
2568
7
    const std::string conffile = config::custom_config_dir + "/be_custom.conf";
2569
2570
7
    Properties tmp_props;
2571
7
    if (!tmp_props.load(conffile.c_str(), false)) {
2572
0
        LOG(WARNING) << "failed to load " << conffile;
2573
0
        return Status::InternalError("failed to load conf file: {}", conffile);
2574
0
    }
2575
2576
7
    tmp_props.set_force(field, value);
2577
7
    return tmp_props.dump(conffile);
2578
7
}
2579
2580
Status set_config(const std::string& field, const std::string& value, bool need_persist,
2581
4.11k
                  bool force) {
2582
4.11k
    auto it = Register::_s_field_map->find(field);
2583
4.11k
    if (it == Register::_s_field_map->end()) {
2584
1
        return Status::Error<ErrorCode::NOT_FOUND, false>("'{}' is not found", field);
2585
1
    }
2586
2587
4.11k
    if (!force && !it->second.valmutable) {
2588
2
        return Status::Error<ErrorCode::NOT_IMPLEMENTED_ERROR, false>(
2589
2
                "'{}' is not support to modify", field);
2590
2
    }
2591
2592
    // Keep the value, config map, and callback in the same update order.
2593
4.11k
    std::lock_guard<std::mutex> lock(mutable_string_config_lock);
2594
4.11k
    UPDATE_FIELD(it->second, value, bool, need_persist);
2595
4.09k
    UPDATE_FIELD(it->second, value, int16_t, need_persist);
2596
4.09k
    UPDATE_FIELD(it->second, value, int32_t, need_persist);
2597
4.05k
    UPDATE_FIELD(it->second, value, int64_t, need_persist);
2598
4.04k
    UPDATE_FIELD(it->second, value, double, need_persist);
2599
6
    UPDATE_FIELD(it->second, value, std::string, need_persist);
2600
2601
    // The other types are not thread safe to change dynamically.
2602
0
    return Status::Error<ErrorCode::NOT_IMPLEMENTED_ERROR, false>(
2603
0
            "'{}' is type of '{}' which is not support to modify", field, it->second.type);
2604
6
}
2605
2606
2.08k
void update_config(const std::string& field, const std::string& value) {
2607
2.08k
    if ("sys_log_level" == field) {
2608
        // update log level
2609
0
        update_logging(field, value);
2610
2.08k
    } else if ("flush_thread_num_per_store" == field ||
2611
2.08k
               "high_priority_flush_thread_num_per_store" == field ||
2612
2.08k
               "max_flush_thread_num_per_cpu" == field) {
2613
        // update memtable flush thread pool size
2614
1
        auto* exec_env = ExecEnv::GetInstance();
2615
1
        if (exec_env != nullptr) {
2616
1
            auto* flush_executor = exec_env->storage_engine().memtable_flush_executor();
2617
1
            if (flush_executor != nullptr) {
2618
1
                flush_executor->update_memtable_flush_threads();
2619
1
            }
2620
            // update workload groups' memtable flush thread pools
2621
1
            auto* wg_mgr = exec_env->workload_group_mgr();
2622
1
            if (wg_mgr != nullptr) {
2623
0
                wg_mgr->update_memtable_flush_threads();
2624
0
            }
2625
1
        }
2626
1
    }
2627
2.08k
}
2628
2629
0
Status set_fuzzy_configs() {
2630
0
    std::unordered_map<std::string, std::string> fuzzy_field_and_value;
2631
0
    std::shared_ptr<std::mt19937_64> generator(new std::mt19937_64());
2632
0
    generator->seed(std::random_device()());
2633
0
    std::uniform_int_distribution<int64_t> distribution(0, 100);
2634
2635
    // if have set enable_fuzzy_mode=true in be.conf, will fuzzy those field and values
2636
0
    fuzzy_field_and_value["disable_storage_page_cache"] =
2637
0
            ((distribution(*generator) % 2) == 0) ? "true" : "false";
2638
0
    fuzzy_field_and_value["disable_segment_cache"] =
2639
0
            ((distribution(*generator) % 2) == 0) ? "true" : "false";
2640
0
    fuzzy_field_and_value["enable_system_metrics"] =
2641
0
            ((distribution(*generator) % 2) == 0) ? "true" : "false";
2642
0
    fuzzy_field_and_value["enable_set_in_bitmap_value"] =
2643
0
            ((distribution(*generator) % 2) == 0) ? "true" : "false";
2644
0
    fuzzy_field_and_value["enable_shrink_memory"] =
2645
0
            ((distribution(*generator) % 2) == 0) ? "true" : "false";
2646
0
    fuzzy_field_and_value["skip_writing_empty_rowset_metadata"] =
2647
0
            ((distribution(*generator) % 2) == 0) ? "true" : "false";
2648
0
    fuzzy_field_and_value["enable_packed_file"] =
2649
0
            ((distribution(*generator) % 2) == 0) ? "true" : "false";
2650
0
    fuzzy_field_and_value["max_segment_partial_column_cache_size"] =
2651
0
            ((distribution(*generator) % 2) == 0) ? "5" : "10";
2652
2653
0
    std::uniform_int_distribution<int64_t> distribution2(-2, 10);
2654
0
    fuzzy_field_and_value["segments_key_bounds_truncation_threshold"] =
2655
0
            std::to_string(distribution2(*generator));
2656
2657
0
    fuzzy_field_and_value["enable_query_segment_file_cache_prefetch"] =
2658
0
            ((distribution(*generator) % 2) == 0) ? "true" : "false";
2659
0
    fuzzy_field_and_value["enable_compaction_segment_file_cache_prefetch"] =
2660
0
            ((distribution(*generator) % 2) == 0) ? "true" : "false";
2661
2662
    // external
2663
0
    if (config::fuzzy_test_type == "external") {
2664
0
        std::uniform_int_distribution<int64_t> distribution3(0, 2);
2665
2666
0
        int64_t idx = distribution3(*generator);
2667
0
        fuzzy_field_and_value["max_hdfs_file_handle_cache_num"] =
2668
0
                (idx == 0) ? "0" : ((idx == 1) ? "10" : "20000");
2669
2670
0
        idx = distribution3(*generator);
2671
0
        fuzzy_field_and_value["max_hdfs_file_handle_cache_time_sec"] =
2672
0
                (idx == 0) ? "1" : ((idx == 1) ? "10" : "28800");
2673
2674
0
        idx = distribution3(*generator);
2675
0
        fuzzy_field_and_value["max_external_file_meta_cache_num"] =
2676
0
                (idx == 0) ? "0" : ((idx == 1) ? "10" : "1000");
2677
2678
0
        idx = distribution3(*generator);
2679
0
        fuzzy_field_and_value["common_obj_lru_cache_stale_sweep_time_sec"] =
2680
0
                (idx == 0) ? "0" : ((idx == 1) ? "10" : "900");
2681
2682
0
        idx = distribution3(*generator);
2683
0
        fuzzy_field_and_value["max_amplified_read_ratio"] =
2684
0
                (idx == 0) ? "0.1" : ((idx == 1) ? "0.8" : "1");
2685
2686
0
        idx = distribution3(*generator);
2687
0
        fuzzy_field_and_value["merged_oss_min_io_size"] =
2688
0
                (idx == 0) ? "4096" : ((idx == 1) ? "8192" : "1048576");
2689
2690
0
        idx = distribution3(*generator);
2691
0
        fuzzy_field_and_value["merged_hdfs_min_io_size"] =
2692
0
                (idx == 0) ? "4096" : ((idx == 1) ? "8192" : "1048576");
2693
0
    }
2694
2695
0
    fmt::memory_buffer buf;
2696
0
    for (auto& it : fuzzy_field_and_value) {
2697
0
        const auto& field = it.first;
2698
0
        const auto& value = it.second;
2699
0
        RETURN_IF_ERROR(set_config(field, value, false, true));
2700
0
        fmt::format_to(buf, "{}={}, ", field, value);
2701
0
    }
2702
0
    LOG(INFO) << fmt::format("FUZZY MODE IN BE: those variables have been changed: ({}).",
2703
0
                             fmt::to_string(buf));
2704
0
    return Status::OK();
2705
0
}
2706
2707
456
std::mutex* get_mutable_string_config_lock() {
2708
456
    return &mutable_string_config_lock;
2709
456
}
2710
2711
0
std::vector<std::vector<std::string>> get_config_info() {
2712
0
    std::vector<std::vector<std::string>> configs;
2713
0
    std::lock_guard<std::mutex> lock(mutable_string_config_lock);
2714
0
    for (const auto& it : *full_conf_map) {
2715
0
        auto field_it = Register::_s_field_map->find(it.first);
2716
0
        if (field_it == Register::_s_field_map->end()) {
2717
0
            continue;
2718
0
        }
2719
2720
0
        std::vector<std::string> _config;
2721
0
        _config.push_back(it.first);
2722
2723
0
        std::string config_val = it.second;
2724
        // For compatibility, this PR #32933 change the log dir's config logic,
2725
        // and deprecate the `sys_log_dir` config.
2726
0
        if (it.first == "sys_log_dir" && config_val == "") {
2727
0
            config_val = fmt::format("{}/log", std::getenv("DORIS_HOME"));
2728
0
        }
2729
0
        if (it.first == "tls_private_key_password") {
2730
0
            config_val = "******";
2731
0
        }
2732
2733
0
        _config.emplace_back(field_it->second.type);
2734
0
        if (0 == strcmp(field_it->second.type, "bool")) {
2735
0
            _config.emplace_back(config_val == "1" ? "true" : "false");
2736
0
        } else {
2737
0
            _config.push_back(config_val);
2738
0
        }
2739
0
        _config.emplace_back(field_it->second.valmutable ? "true" : "false");
2740
2741
0
        configs.push_back(_config);
2742
0
    }
2743
0
    return configs;
2744
0
}
2745
2746
#include "common/compile_check_avoid_end.h"
2747
} // namespace doris::config