Coverage Report

Created: 2026-02-06 17:34

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