Coverage Report

Created: 2026-07-19 14:22

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