Coverage Report

Created: 2025-12-10 19:21

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