Coverage Report

Created: 2026-08-21 21:10

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