Coverage Report

Created: 2026-06-03 09:05

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