Coverage Report

Created: 2026-01-20 23:31

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