Coverage Report

Created: 2025-11-28 03:24

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