Coverage Report

Created: 2026-01-11 16:12

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