Coverage Report

Created: 2026-07-27 11:22

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