Coverage Report

Created: 2025-08-22 12:00

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