Coverage Report

Created: 2026-10-16 08:30

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