Coverage Report

Created: 2025-06-09 22:36

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