Coverage Report

Created: 2026-01-16 14:06

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