Coverage Report

Created: 2025-07-26 08:06

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