Coverage Report

Created: 2026-09-10 16:25

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