Coverage Report

Created: 2025-04-14 17:04

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