Coverage Report

Created: 2025-04-24 11:05

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