Coverage Report

Created: 2026-07-01 14:50

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