Coverage Report

Created: 2026-11-04 13:36

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