Coverage Report

Created: 2025-04-23 20:57

/root/doris/be/src/common/config.h
Line
Count
Source
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
18
#pragma once
19
20
#include <cstdint>
21
#include <functional>
22
#include <map>
23
#include <mutex>
24
#include <string>
25
#include <utility>
26
#include <vector>
27
28
#define DECLARE_FIELD(FIELD_TYPE, FIELD_NAME) extern FIELD_TYPE FIELD_NAME
29
30
#define DECLARE_Bool(name) DECLARE_FIELD(bool, name)
31
#define DECLARE_Int16(name) DECLARE_FIELD(int16_t, name)
32
#define DECLARE_Int32(name) DECLARE_FIELD(int32_t, name)
33
#define DECLARE_Int64(name) DECLARE_FIELD(int64_t, name)
34
#define DECLARE_Double(name) DECLARE_FIELD(double, name)
35
#define DECLARE_String(name) DECLARE_FIELD(std::string, name)
36
#define DECLARE_Bools(name) DECLARE_FIELD(std::vector<bool>, name)
37
#define DECLARE_Int16s(name) DECLARE_FIELD(std::vector<int16_t>, name)
38
#define DECLARE_Int32s(name) DECLARE_FIELD(std::vector<int32_t>, name)
39
#define DECLARE_Int64s(name) DECLARE_FIELD(std::vector<int64_t>, name)
40
#define DECLARE_Doubles(name) DECLARE_FIELD(std::vector<double>, name)
41
#define DECLARE_Strings(name) DECLARE_FIELD(std::vector<std::string>, name)
42
#define DECLARE_mBool(name) DECLARE_FIELD(bool, name)
43
#define DECLARE_mInt16(name) DECLARE_FIELD(int16_t, name)
44
#define DECLARE_mInt32(name) DECLARE_FIELD(int32_t, name)
45
#define DECLARE_mInt64(name) DECLARE_FIELD(int64_t, name)
46
#define DECLARE_mDouble(name) DECLARE_FIELD(double, name)
47
#define DECLARE_mString(name) DECLARE_FIELD(std::string, name)
48
49
#define DEFINE_FIELD(FIELD_TYPE, FIELD_NAME, FIELD_DEFAULT, VALMUTABLE)                      \
50
21
    FIELD_TYPE FIELD_NAME;                                                                   \
51
21
    static Register reg_##FIELD_NAME(#FIELD_TYPE, #FIELD_NAME, &(FIELD_NAME), FIELD_DEFAULT, \
52
21
                                     VALMUTABLE);
53
54
#define DEFINE_VALIDATOR(FIELD_NAME, VALIDATOR)              \
55
    static auto validator_##FIELD_NAME = VALIDATOR;          \
56
    static RegisterConfValidator reg_validator_##FIELD_NAME( \
57
            #FIELD_NAME, []() -> bool { return validator_##FIELD_NAME(FIELD_NAME); });
58
59
1
#define DEFINE_Int16(name, defaultstr) DEFINE_FIELD(int16_t, name, defaultstr, false)
60
1
#define DEFINE_Bools(name, defaultstr) DEFINE_FIELD(std::vector<bool>, name, defaultstr, false)
61
1
#define DEFINE_Doubles(name, defaultstr) DEFINE_FIELD(std::vector<double>, name, defaultstr, false)
62
1
#define DEFINE_Int16s(name, defaultstr) DEFINE_FIELD(std::vector<int16_t>, name, defaultstr, false)
63
1
#define DEFINE_Int32s(name, defaultstr) DEFINE_FIELD(std::vector<int32_t>, name, defaultstr, false)
64
1
#define DEFINE_Int64s(name, defaultstr) DEFINE_FIELD(std::vector<int64_t>, name, defaultstr, false)
65
3
#define DEFINE_Bool(name, defaultstr) DEFINE_FIELD(bool, name, defaultstr, false)
66
1
#define DEFINE_Double(name, defaultstr) DEFINE_FIELD(double, name, defaultstr, false)
67
1
#define DEFINE_Int32(name, defaultstr) DEFINE_FIELD(int32_t, name, defaultstr, false)
68
1
#define DEFINE_Int64(name, defaultstr) DEFINE_FIELD(int64_t, name, defaultstr, false)
69
2
#define DEFINE_String(name, defaultstr) DEFINE_FIELD(std::string, name, defaultstr, false)
70
#define DEFINE_Strings(name, defaultstr) \
71
1
    DEFINE_FIELD(std::vector<std::string>, name, defaultstr, false)
72
1
#define DEFINE_mBool(name, defaultstr) DEFINE_FIELD(bool, name, defaultstr, true)
73
1
#define DEFINE_mInt16(name, defaultstr) DEFINE_FIELD(int16_t, name, defaultstr, true)
74
1
#define DEFINE_mInt32(name, defaultstr) DEFINE_FIELD(int32_t, name, defaultstr, true)
75
1
#define DEFINE_mInt64(name, defaultstr) DEFINE_FIELD(int64_t, name, defaultstr, true)
76
1
#define DEFINE_mDouble(name, defaultstr) DEFINE_FIELD(double, name, defaultstr, true)
77
1
#define DEFINE_mString(name, defaultstr) DEFINE_FIELD(std::string, name, defaultstr, true)
78
#define DEFINE_Validator(name, validator) DEFINE_VALIDATOR(name, validator)
79
80
namespace doris {
81
class Status;
82
83
// If you want to modify the value of config, please go to common/config.cpp to modify.
84
namespace config {
85
// Dir of custom config file
86
DECLARE_String(custom_config_dir);
87
88
// Dir of jdbc drivers
89
DECLARE_String(jdbc_drivers_dir);
90
91
// cluster id
92
DECLARE_Int32(cluster_id);
93
// port on which BackendService is exported
94
DECLARE_Int32(be_port);
95
96
// port for brpc
97
DECLARE_Int32(brpc_port);
98
99
// port for arrow flight sql
100
// Default -1, do not start arrow flight sql server.
101
DECLARE_Int32(arrow_flight_sql_port);
102
103
// If the external client cannot directly access priority_networks, set public_host to be accessible
104
// to external client.
105
// There are usually two usage scenarios:
106
// 1. in production environment, it is often inconvenient to expose Doris BE nodes to the external network.
107
// However, a reverse proxy (such as Nginx) can be added to all Doris BE nodes, and the external client will be
108
// randomly routed to a Doris BE node when connecting to Nginx. set public_host to the host of Nginx.
109
// 2. if priority_networks is an internal network IP, and BE node has its own independent external IP,
110
// but Doris currently does not support modifying priority_networks, setting public_host to the real external IP.
111
DECLARE_mString(public_host);
112
113
// If the BE node is connected to the external network through a reverse proxy like Nginx
114
// and need to use Arrow Flight SQL, should add a server in Nginx to reverse proxy
115
// `Nginx:arrow_flight_sql_proxy_port` to `BE_priority_networks:arrow_flight_sql_port`. For example:
116
// upstream arrowflight {
117
//    server 10.16.10.8:8069;
118
//    server 10.16.10.8:8068;
119
//}
120
// server {
121
//    listen 8167 http2;
122
//    listen [::]:8167 http2;
123
//    server_name doris.arrowflight.com;
124
// }
125
DECLARE_Int32(arrow_flight_sql_proxy_port);
126
127
// the number of bthreads for brpc, the default value is set to -1,
128
// which means the number of bthreads is #cpu-cores
129
DECLARE_Int32(brpc_num_threads);
130
DECLARE_Int32(brpc_idle_timeout_sec);
131
132
// Declare a selection strategy for those servers have many ips.
133
// Note that there should at most one ip match this list.
134
// This is a list in semicolon-delimited format, in CIDR notation, e.g. 10.10.10.0/24
135
// If no ip match this rule, will choose one randomly.
136
DECLARE_String(priority_networks);
137
138
// performance moderate or compact, only tcmalloc compile
139
DECLARE_String(memory_mode);
140
141
// if true, process memory limit and memory usage based on cgroup memory info.
142
DECLARE_mBool(enable_use_cgroup_memory_info);
143
144
// process memory limit specified as number of bytes
145
// ('<int>[bB]?'), megabytes ('<float>[mM]'), gigabytes ('<float>[gG]'),
146
// or percentage of the physical memory ('<int>%').
147
// defaults to bytes if no unit is given"
148
// must larger than 0. and if larger than physical memory size,
149
// it will be set to physical memory size.
150
DECLARE_String(mem_limit);
151
152
// Soft memory limit as a fraction of hard memory limit.
153
DECLARE_Double(soft_mem_limit_frac);
154
155
// Cache capacity reduce mem limit as a fraction of soft mem limit.
156
DECLARE_mDouble(cache_capacity_reduce_mem_limit_frac);
157
158
// Schema change memory limit as a fraction of soft memory limit.
159
DECLARE_Double(schema_change_mem_limit_frac);
160
161
// Many modern allocators (for example) do not do a mremap for
162
// realloc, even in case of large enough chunks of memory. Although this allows
163
// you to increase performance and reduce memory consumption during realloc.
164
// To fix this, we do mremap manually if the chunk of memory is large enough.
165
//
166
// The threshold (128 MB, 128 * (1ULL << 20)) is chosen quite large, since changing the address
167
// space is very slow, especially in the case of a large number of threads. We
168
// expect that the set of operations mmap/something to do/mremap can only be
169
// performed about 1000 times per second.
170
//
171
// P.S. This is also required, because tcmalloc can not allocate a chunk of
172
// memory greater than 16 GB.
173
DECLARE_mInt64(mmap_threshold); // bytes
174
175
// When hash table capacity is greater than 2^double_grow_degree(default 2G), grow when 75% of the capacity is satisfied.
176
// Increase can reduce the number of hash table resize, but may waste more memory.
177
DECLARE_mInt32(hash_table_double_grow_degree);
178
179
// The max fill rate for hash table
180
DECLARE_mInt32(max_fill_rate);
181
182
DECLARE_mInt32(double_resize_threshold);
183
184
// The maximum low water mark of the system `/proc/meminfo/MemAvailable`, Unit byte, default -1.
185
// if it is -1, then low water mark = min(MemTotal - MemLimit, MemTotal * 5%), which is 3.2G on a 64G machine.
186
// Turn up max. more memory buffers will be reserved for Memory GC.
187
// Turn down max. will use as much memory as possible.
188
// note that: `max_` prefix should be removed, but keep it for compatibility.
189
DECLARE_Int64(max_sys_mem_available_low_water_mark_bytes);
190
191
// reserve a small amount of memory so we do not trigger MinorGC
192
DECLARE_Int64(memtable_limiter_reserved_memory_bytes);
193
194
// The size of the memory that gc wants to release each time, as a percentage of the mem limit.
195
DECLARE_mString(process_minor_gc_size);
196
DECLARE_mString(process_full_gc_size);
197
198
// If true, when the process does not exceed the soft mem limit, the query memory will not be limited;
199
// when the process memory exceeds the soft mem limit, the query with the largest ratio between the currently
200
// used memory and the exec_mem_limit will be canceled.
201
// If false, cancel query when the memory used exceeds exec_mem_limit, same as before.
202
DECLARE_mBool(enable_query_memory_overcommit);
203
204
// gc will release cache, cancel task, and task will wait for gc to release memory,
205
// default gc strategy is conservative, if you want to exclude the interference of gc, let it be true
206
DECLARE_mBool(disable_memory_gc);
207
208
// for the query being canceled,
209
// if (current time - cancel start time) < revoke_memory_max_tolerance_ms, the query memory is counted in `freed_memory`,
210
// and the query memory is expected to be released soon.
211
// if > revoke_memory_max_tolerance_ms, the query memory will not be counted in `freed_memory`,
212
// and the query may be blocked during the cancel process. skip this query and continue to cancel other queries.
213
DECLARE_mInt64(revoke_memory_max_tolerance_ms);
214
215
// if false, turn off all stacktrace
216
DECLARE_mBool(enable_stacktrace);
217
218
// when alloc memory larger than stacktrace_in_alloc_large_memory_bytes, default 2G,
219
// if alloc successful, will print a warning with stacktrace, but not prevent memory alloc.
220
// if alloc failed using Doris Allocator, will print stacktrace in error log.
221
// if is -1, disable print stacktrace when alloc large memory.
222
DECLARE_mInt64(stacktrace_in_alloc_large_memory_bytes);
223
224
// when alloc memory larger than crash_in_alloc_large_memory_bytes will crash, default -1 means disabled.
225
// if you need a core dump to analyze large memory allocation,
226
// modify this parameter to crash when large memory allocation occur will help
227
DECLARE_mInt64(crash_in_alloc_large_memory_bytes);
228
229
// The actual meaning of this parameter is `debug_memory`.
230
// 1. crash in memory tracker inaccurate, if memory tracker value is inaccurate, BE will crash.
231
//    usually used in test environments, default value is false.
232
// 2. print more memory logs.
233
DECLARE_mBool(crash_in_memory_tracker_inaccurate);
234
235
// default is true. if any memory tracking in Orphan mem tracker will report error.
236
// !! not modify the default value of this conf!! otherwise memory errors cannot be detected in time.
237
// allocator free memory not need to check, because when the thread memory tracker label is Orphan,
238
// use the tracker saved in Allocator.
239
DECLARE_mBool(enable_memory_orphan_check);
240
241
// The maximum time a thread waits for a full GC. Currently only query will wait for full gc.
242
DECLARE_mInt32(thread_wait_gc_max_milliseconds);
243
244
// reach mem limit, don't serialize in batch
245
DECLARE_mInt64(pre_serialize_keys_limit_bytes);
246
247
// the port heartbeat service used
248
DECLARE_Int32(heartbeat_service_port);
249
// the count of heart beat service
250
DECLARE_Int32(heartbeat_service_thread_count);
251
// the count of thread to create table
252
DECLARE_Int32(create_tablet_worker_count);
253
// the count of thread to drop table
254
DECLARE_Int32(drop_tablet_worker_count);
255
// the count of thread to batch load
256
DECLARE_Int32(push_worker_count_normal_priority);
257
// the count of thread to high priority batch load
258
DECLARE_Int32(push_worker_count_high_priority);
259
// the count of thread to publish version
260
DECLARE_Int32(publish_version_worker_count);
261
// the count of tablet thread to publish version
262
DECLARE_Int32(tablet_publish_txn_max_thread);
263
// the timeout of EnginPublishVersionTask
264
DECLARE_Int32(publish_version_task_timeout_s);
265
// the count of thread to calc delete bitmap
266
DECLARE_Int32(calc_delete_bitmap_max_thread);
267
// the count of thread to calc delete bitmap worker, only used for cloud
268
DECLARE_Int32(calc_delete_bitmap_worker_count);
269
// the count of thread to calc tablet delete bitmap task, only used for cloud
270
DECLARE_Int32(calc_tablet_delete_bitmap_task_max_thread);
271
// the count of thread to clear transaction task
272
DECLARE_Int32(clear_transaction_task_worker_count);
273
// the count of thread to delete
274
DECLARE_Int32(delete_worker_count);
275
// the count of thread to alter table
276
DECLARE_Int32(alter_tablet_worker_count);
277
// the count of thread to alter index
278
DECLARE_Int32(alter_index_worker_count);
279
// the count of thread to clone
280
DECLARE_Int32(clone_worker_count);
281
// the count of thread to clone
282
DECLARE_Int32(storage_medium_migrate_count);
283
// the count of thread to check consistency
284
DECLARE_Int32(check_consistency_worker_count);
285
// the count of thread to upload
286
DECLARE_Int32(upload_worker_count);
287
// the count of thread to download
288
DECLARE_Int32(download_worker_count);
289
// the count of thread to make snapshot
290
DECLARE_Int32(make_snapshot_worker_count);
291
// the count of thread to release snapshot
292
DECLARE_Int32(release_snapshot_worker_count);
293
// report random wait a little time to avoid FE receiving multiple be reports at the same time.
294
// do not set it to false for production environment
295
DECLARE_mBool(report_random_wait);
296
// the interval time(seconds) for agent report tasks signature to FE
297
DECLARE_mInt32(report_task_interval_seconds);
298
// the interval time(seconds) for agent report disk state to FE
299
DECLARE_mInt32(report_disk_state_interval_seconds);
300
// the interval time(seconds) for agent report olap table to FE
301
DECLARE_mInt32(report_tablet_interval_seconds);
302
// the max download speed(KB/s)
303
DECLARE_mInt32(max_download_speed_kbps);
304
// download low speed limit(KB/s)
305
DECLARE_mInt32(download_low_speed_limit_kbps);
306
// download low speed time(seconds)
307
DECLARE_mInt32(download_low_speed_time);
308
// whether to download small files in batch.
309
DECLARE_mBool(enable_batch_download);
310
// whether to check md5sum when download
311
DECLARE_mBool(enable_download_md5sum_check);
312
// download binlog meta timeout
313
DECLARE_mInt32(download_binlog_meta_timeout_ms);
314
315
// deprecated, use env var LOG_DIR in be.conf
316
DECLARE_String(sys_log_dir);
317
// for udf
318
DECLARE_String(user_function_dir);
319
// INFO, WARNING, ERROR, FATAL
320
DECLARE_String(sys_log_level);
321
// TIME-DAY, TIME-HOUR, SIZE-MB-nnn
322
DECLARE_String(sys_log_roll_mode);
323
// log roll num
324
DECLARE_Int32(sys_log_roll_num);
325
// verbose log
326
DECLARE_Strings(sys_log_verbose_modules);
327
// verbose log level
328
DECLARE_Int32(sys_log_verbose_level);
329
// verbose log FLAGS_v
330
DECLARE_Int32(sys_log_verbose_flags_v);
331
// log buffer level
332
DECLARE_String(log_buffer_level);
333
// log enable custom date time format
334
DECLARE_Bool(sys_log_enable_custom_date_time_format);
335
// log custom date time format (https://en.cppreference.com/w/cpp/io/manip/put_time)
336
DECLARE_String(sys_log_custom_date_time_format);
337
// log custom date time milliseconds format (fmt::format)
338
DECLARE_String(sys_log_custom_date_time_ms_format);
339
340
// number of threads available to serve backend execution requests
341
DECLARE_Int32(be_service_threads);
342
343
// interval between profile reports; in seconds
344
DECLARE_mInt32(pipeline_status_report_interval);
345
// Time slice for pipeline task execution (ms)
346
DECLARE_mInt32(pipeline_task_exec_time_slice);
347
// number of scanner thread pool size for olap table
348
// and the min thread num of remote scanner thread pool
349
DECLARE_mInt32(doris_scanner_thread_pool_thread_num);
350
DECLARE_mInt32(doris_scanner_min_thread_pool_thread_num);
351
// number of batch size to fetch the remote split source
352
DECLARE_mInt32(remote_split_source_batch_size);
353
// max number of remote scanner thread pool size
354
// if equal to -1, value is std::max(512, CpuInfo::num_cores() * 10)
355
DECLARE_Int32(doris_max_remote_scanner_thread_pool_thread_num);
356
// number of olap scanner thread pool queue size
357
DECLARE_Int32(doris_scanner_thread_pool_queue_size);
358
// default thrift client connect timeout(in seconds)
359
DECLARE_mInt32(thrift_connect_timeout_seconds);
360
DECLARE_mInt32(fetch_rpc_timeout_seconds);
361
// default thrift client retry interval (in milliseconds)
362
DECLARE_mInt64(thrift_client_retry_interval_ms);
363
// max message size of thrift request
364
// default: 100 * 1024 * 1024
365
DECLARE_mInt64(thrift_max_message_size);
366
// max bytes number for single scan range, used in segmentv2
367
DECLARE_mInt32(doris_scan_range_max_mb);
368
// single read execute fragment row number
369
DECLARE_mInt32(doris_scanner_row_num);
370
// single read execute fragment row bytes
371
DECLARE_mInt32(doris_scanner_row_bytes);
372
// single read execute fragment max run time millseconds
373
DECLARE_mInt32(doris_scanner_max_run_time_ms);
374
// (Advanced) Maximum size of per-query receive-side buffer
375
DECLARE_mInt32(exchg_node_buffer_size_bytes);
376
DECLARE_mInt32(exchg_buffer_queue_capacity_factor);
377
378
// memory_limitation_per_thread_for_schema_change_bytes unit bytes
379
DECLARE_mInt64(memory_limitation_per_thread_for_schema_change_bytes);
380
381
// all cache prune interval, used by GC and periodic thread.
382
DECLARE_mInt32(cache_prune_interval_sec);
383
DECLARE_mInt32(cache_periodic_prune_stale_sweep_sec);
384
// the clean interval of tablet lookup cache
385
DECLARE_mInt32(tablet_lookup_cache_stale_sweep_time_sec);
386
DECLARE_mInt32(point_query_row_cache_stale_sweep_time_sec);
387
DECLARE_mInt32(disk_stat_monitor_interval);
388
DECLARE_mInt32(unused_rowset_monitor_interval);
389
DECLARE_mInt32(quering_rowsets_evict_interval);
390
DECLARE_String(storage_root_path);
391
DECLARE_mString(broken_storage_path);
392
393
// Config is used to check incompatible old format hdr_ format
394
// whether doris uses strict way. When config is true, process will log fatal
395
// and exit. When config is false, process will only log warning.
396
DECLARE_Bool(storage_strict_check_incompatible_old_format);
397
398
// BE process will exit if the percentage of error disk reach this value.
399
DECLARE_mInt32(max_percentage_of_error_disk);
400
DECLARE_mInt32(default_num_rows_per_column_file_block);
401
// pending data policy
402
DECLARE_mInt32(pending_data_expire_time_sec);
403
// inc_rowset snapshot rs sweep time interval
404
DECLARE_mInt32(tablet_rowset_stale_sweep_time_sec);
405
// tablet stale rowset sweep by threshold size
406
DECLARE_Bool(tablet_rowset_stale_sweep_by_size);
407
DECLARE_mInt32(tablet_rowset_stale_sweep_threshold_size);
408
// garbage sweep policy
409
DECLARE_Int32(max_garbage_sweep_interval);
410
DECLARE_Int32(min_garbage_sweep_interval);
411
// garbage sweep every batch will sleep 1ms
412
DECLARE_mInt32(garbage_sweep_batch_size);
413
DECLARE_mInt32(snapshot_expire_time_sec);
414
// It is only a recommended value. When the disk space is insufficient,
415
// the file storage period under trash dose not have to comply with this parameter.
416
DECLARE_mInt32(trash_file_expire_time_sec);
417
// minimum file descriptor number
418
// modify them upon necessity
419
DECLARE_Int32(min_file_descriptor_number);
420
DECLARE_mBool(disable_segment_cache);
421
DECLARE_String(row_cache_mem_limit);
422
423
// Cache for storage page size
424
DECLARE_String(storage_page_cache_limit);
425
// Shard size for page cache, the value must be power of two.
426
// It's recommended to set it to a value close to the number of BE cores in order to reduce lock contentions.
427
DECLARE_Int32(storage_page_cache_shard_size);
428
// Percentage for index page cache
429
// all storage page cache will be divided into data_page_cache and index_page_cache
430
DECLARE_Int32(index_page_cache_percentage);
431
// whether to disable page cache feature in storage
432
// TODO delete it. Divided into Data page, Index page, pk index page
433
DECLARE_Bool(disable_storage_page_cache);
434
// whether to disable row cache feature in storage
435
DECLARE_mBool(disable_storage_row_cache);
436
// whether to disable pk page cache feature in storage
437
DECLARE_Bool(disable_pk_storage_page_cache);
438
439
// Cache for mow primary key storage page size, it's seperated from
440
// storage_page_cache_limit
441
DECLARE_String(pk_storage_page_cache_limit);
442
// data page size for primary key index
443
DECLARE_Int32(primary_key_data_page_size);
444
445
// inc_rowset snapshot rs sweep time interval
446
DECLARE_mInt32(data_page_cache_stale_sweep_time_sec);
447
DECLARE_mInt32(index_page_cache_stale_sweep_time_sec);
448
// great impact on the performance of MOW, so it can be longer.
449
DECLARE_mInt32(pk_index_page_cache_stale_sweep_time_sec);
450
451
DECLARE_Bool(enable_low_cardinality_optimize);
452
DECLARE_Bool(enable_low_cardinality_cache_code);
453
454
// be policy
455
// whether check compaction checksum
456
DECLARE_mBool(enable_compaction_checksum);
457
// whether disable automatic compaction task
458
DECLARE_mBool(disable_auto_compaction);
459
// whether enable vertical compaction
460
DECLARE_mBool(enable_vertical_compaction);
461
// whether enable ordered data compaction
462
DECLARE_mBool(enable_ordered_data_compaction);
463
// In vertical compaction, column number for every group
464
DECLARE_mInt32(vertical_compaction_num_columns_per_group);
465
// In vertical compaction, max memory usage for row_source_buffer
466
DECLARE_Int32(vertical_compaction_max_row_source_memory_mb);
467
// In vertical compaction, max dest segment file size
468
DECLARE_mInt64(vertical_compaction_max_segment_size);
469
470
// If enabled, segments will be flushed column by column
471
DECLARE_mBool(enable_vertical_segment_writer);
472
473
// In ordered data compaction, min segment size for input rowset
474
DECLARE_mInt32(ordered_data_compaction_min_segment_size);
475
476
// This config can be set to limit thread number in compaction thread pool.
477
DECLARE_mInt32(max_base_compaction_threads);
478
DECLARE_mInt32(max_cumu_compaction_threads);
479
DECLARE_mInt32(max_single_replica_compaction_threads);
480
481
DECLARE_Bool(enable_base_compaction_idle_sched);
482
DECLARE_mInt64(base_compaction_min_rowset_num);
483
DECLARE_mInt64(base_compaction_max_compaction_score);
484
DECLARE_mDouble(base_compaction_min_data_ratio);
485
DECLARE_mInt64(base_compaction_dup_key_max_file_size_mbytes);
486
487
DECLARE_Bool(enable_skip_tablet_compaction);
488
DECLARE_mInt32(skip_tablet_compaction_second);
489
// output rowset of cumulative compaction total disk size exceed this config size,
490
// this rowset will be given to base compaction, unit is m byte.
491
DECLARE_mInt64(compaction_promotion_size_mbytes);
492
493
// output rowset of cumulative compaction total disk size exceed this config ratio of
494
// base rowset's total disk size, this rowset will be given to base compaction. The value must be between
495
// 0 and 1.
496
DECLARE_mDouble(compaction_promotion_ratio);
497
498
// the smallest size of rowset promotion. When the rowset is less than this config, this
499
// rowset will be not given to base compaction. The unit is m byte.
500
DECLARE_mInt64(compaction_promotion_min_size_mbytes);
501
502
// When output rowset of cumulative compaction total version count (end_version - start_version)
503
// exceed this config count, the rowset will be moved to base compaction
504
// NOTE: this config will work for unique key merge-on-write table only, to reduce version count
505
// related cost on delete bitmap more effectively.
506
DECLARE_mInt64(compaction_promotion_version_count);
507
508
// The lower bound size to do cumulative compaction. When total disk size of candidate rowsets is less than
509
// this size, size_based policy may not do to cumulative compaction. The unit is m byte.
510
DECLARE_mInt64(compaction_min_size_mbytes);
511
512
// cumulative compaction policy: min and max delta file's number
513
DECLARE_mInt64(cumulative_compaction_min_deltas);
514
DECLARE_mInt64(cumulative_compaction_max_deltas);
515
DECLARE_mInt32(cumulative_compaction_max_deltas_factor);
516
517
// This config can be set to limit thread number in  multiget thread pool.
518
DECLARE_mInt32(multi_get_max_threads);
519
520
// The upper limit of "permits" held by all compaction tasks. This config can be set to limit memory consumption for compaction.
521
DECLARE_mInt64(total_permits_for_compaction_score);
522
523
// sleep interval in ms after generated compaction tasks
524
DECLARE_mInt32(generate_compaction_tasks_interval_ms);
525
// sleep interval in second after update replica infos
526
DECLARE_mInt32(update_replica_infos_interval_seconds);
527
528
// Compaction task number per disk.
529
// Must be greater than 2, because Base compaction and Cumulative compaction have at least one thread each.
530
DECLARE_mInt32(compaction_task_num_per_disk);
531
// compaction thread num for fast disk(typically .SSD), must be greater than 2.
532
DECLARE_mInt32(compaction_task_num_per_fast_disk);
533
534
// How many rounds of cumulative compaction for each round of base compaction when compaction tasks generation.
535
DECLARE_mInt32(cumulative_compaction_rounds_for_each_base_compaction_round);
536
537
// Minimum number of threads required in the thread pool to activate the large cumu compaction delay strategy.
538
// The delay strategy is only applied when the thread pool has at least this many threads.
539
DECLARE_mInt32(large_cumu_compaction_task_min_thread_num);
540
// Maximum size threshold (in bytes) for input rowsets. Compaction tasks with input size
541
// exceeding this threshold will be delayed when thread pool is near capacity. Default 100MB.
542
DECLARE_mInt32(large_cumu_compaction_task_bytes_threshold);
543
// Maximum row count threshold for compaction input. Compaction tasks with row count
544
// exceeding this threshold will be delayed when thread pool is near capacity. Default 1 million.
545
DECLARE_mInt32(large_cumu_compaction_task_row_num_threshold);
546
547
// Not compact the invisible versions, but with some limitations:
548
// if not timeout, keep no more than compaction_keep_invisible_version_max_count versions;
549
// if timeout, keep no more than compaction_keep_invisible_version_min_count versions.
550
DECLARE_mInt32(compaction_keep_invisible_version_timeout_sec);
551
DECLARE_mInt32(compaction_keep_invisible_version_min_count);
552
DECLARE_mInt32(compaction_keep_invisible_version_max_count);
553
554
// Threshold to logging compaction trace, in seconds.
555
DECLARE_mInt32(base_compaction_trace_threshold);
556
DECLARE_mInt32(cumulative_compaction_trace_threshold);
557
DECLARE_mBool(disable_compaction_trace_log);
558
559
// Interval to picking rowset to compact, in seconds
560
DECLARE_mInt64(pick_rowset_to_compact_interval_sec);
561
562
// Compaction priority schedule
563
DECLARE_mBool(enable_compaction_priority_scheduling);
564
DECLARE_mInt32(low_priority_compaction_task_num_per_disk);
565
DECLARE_mInt32(low_priority_compaction_score_threshold);
566
567
// Thread count to do tablet meta checkpoint, -1 means use the data directories count.
568
DECLARE_Int32(max_meta_checkpoint_threads);
569
570
// Threshold to logging agent task trace, in seconds.
571
DECLARE_mInt32(agent_task_trace_threshold_sec);
572
573
// This config can be set to limit thread number in tablet migration thread pool.
574
DECLARE_Int32(min_tablet_migration_threads);
575
DECLARE_Int32(max_tablet_migration_threads);
576
577
DECLARE_mInt32(finished_migration_tasks_size);
578
// If size less than this, the remaining rowsets will be force to complete
579
DECLARE_mInt32(migration_remaining_size_threshold_mb);
580
// If the task runs longer than this time, the task will be terminated, in seconds.
581
// timeout = std::max(migration_task_timeout_secs,  tablet size / 1MB/s)
582
DECLARE_mInt32(migration_task_timeout_secs);
583
// timeout for try_lock migration lock
584
DECLARE_Int64(migration_lock_timeout_ms);
585
586
// Port to start debug webserver on
587
DECLARE_Int32(webserver_port);
588
// Https enable flag
589
DECLARE_Bool(enable_https);
590
// Path of certificate
591
DECLARE_String(ssl_certificate_path);
592
// Path of private key
593
DECLARE_String(ssl_private_key_path);
594
// Whether to check authorization
595
DECLARE_Bool(enable_all_http_auth);
596
// Number of webserver workers
597
DECLARE_Int32(webserver_num_workers);
598
599
DECLARE_Bool(enable_single_replica_load);
600
// Number of download workers for single replica load
601
DECLARE_Int32(single_replica_load_download_num_workers);
602
603
// Used for mini Load. mini load data file will be removed after this time.
604
DECLARE_Int64(load_data_reserve_hours);
605
// log error log will be removed after this time
606
DECLARE_mInt64(load_error_log_reserve_hours);
607
// error log size limit, default 200MB
608
DECLARE_mInt64(load_error_log_limit_bytes);
609
610
// be brpc interface is classified into two categories: light and heavy
611
// each category has diffrent thread number
612
// threads to handle heavy api interface, such as transmit_block etc
613
DECLARE_Int32(brpc_heavy_work_pool_threads);
614
// threads to handle light api interface, such as exec_plan_fragment_prepare/exec_plan_fragment_start
615
DECLARE_Int32(brpc_light_work_pool_threads);
616
DECLARE_Int32(brpc_heavy_work_pool_max_queue_size);
617
DECLARE_Int32(brpc_light_work_pool_max_queue_size);
618
DECLARE_mBool(enable_bthread_transmit_block);
619
DECLARE_Int32(brpc_arrow_flight_work_pool_threads);
620
DECLARE_Int32(brpc_arrow_flight_work_pool_max_queue_size);
621
622
// The maximum amount of data that can be processed by a stream load
623
DECLARE_mInt64(streaming_load_max_mb);
624
// Some data formats, such as JSON, cannot be streamed.
625
// Therefore, it is necessary to limit the maximum number of
626
// such data when using stream load to prevent excessive memory consumption.
627
DECLARE_mInt64(streaming_load_json_max_mb);
628
// the alive time of a TabletsChannel.
629
// If the channel does not receive any data till this time,
630
// the channel will be removed.
631
DECLARE_mInt32(streaming_load_rpc_max_alive_time_sec);
632
// the timeout of a rpc to open the tablet writer in remote BE.
633
// short operation time, can set a short timeout
634
DECLARE_Int32(tablet_writer_open_rpc_timeout_sec);
635
// You can ignore brpc error '[E1011]The server is overcrowded' when writing data.
636
DECLARE_mBool(tablet_writer_ignore_eovercrowded);
637
DECLARE_mInt32(slave_replica_writer_rpc_timeout_sec);
638
// Whether to enable stream load record function, the default is false.
639
// False: disable stream load record
640
DECLARE_mBool(enable_stream_load_record);
641
// batch size of stream load record reported to FE
642
DECLARE_mInt32(stream_load_record_batch_size);
643
// expire time of stream load record in rocksdb.
644
DECLARE_Int32(stream_load_record_expire_time_secs);
645
// time interval to clean expired stream load records
646
DECLARE_mInt64(clean_stream_load_record_interval_secs);
647
// enable stream load commit txn on BE directly, bypassing FE. Only for cloud.
648
DECLARE_mBool(enable_stream_load_commit_txn_on_be);
649
// The buffer size to store stream table function schema info
650
DECLARE_Int64(stream_tvf_buffer_size);
651
652
// OlapTableSink sender's send interval, should be less than the real response time of a tablet writer rpc.
653
// You may need to lower the speed when the sink receiver bes are too busy.
654
DECLARE_mInt32(olap_table_sink_send_interval_microseconds);
655
// For auto partition, the send interval will multiply the factor
656
DECLARE_mDouble(olap_table_sink_send_interval_auto_partition_factor);
657
658
// Fragment thread pool
659
DECLARE_Int32(fragment_mgr_asynic_work_pool_thread_num_min);
660
DECLARE_Int32(fragment_mgr_asynic_work_pool_thread_num_max);
661
DECLARE_Int32(fragment_mgr_asynic_work_pool_queue_size);
662
663
// Control the number of disks on the machine.  If 0, this comes from the system settings.
664
DECLARE_Int32(num_disks);
665
// The read size is the size of the reads sent to os.
666
// There is a trade off of latency and throughout, trying to keep disks busy but
667
// not introduce seeks.  The literature seems to agree that with 8 MB reads, random
668
// io and sequential io perform similarly.
669
DECLARE_Int32(read_size);       // 8 * 1024 * 1024, Read Size (in bytes)
670
DECLARE_Int32(min_buffer_size); // 1024, The minimum read buffer size (in bytes)
671
672
// for pprof
673
DECLARE_String(pprof_profile_dir);
674
// for jeprofile in jemalloc
675
DECLARE_mString(jeprofile_dir);
676
// Purge all unused dirty pages for all arenas.
677
DECLARE_mBool(enable_je_purge_dirty_pages);
678
// Jemalloc `arenas.dirty_decay_ms`, equal to `dirty_decay_ms` in JEMALLOC_CONF in be.conf.
679
DECLARE_mInt32(je_dirty_decay_ms);
680
681
// to forward compatibility, will be removed later
682
DECLARE_mBool(enable_token_check);
683
684
// to open/close system metrics
685
DECLARE_Bool(enable_system_metrics);
686
687
// Number of cores Doris will used, this will effect only when it's greater than 0.
688
// Otherwise, Doris will use all cores returned from "/proc/cpuinfo".
689
DECLARE_Int32(num_cores);
690
691
// When BE start, If there is a broken disk, BE process will exit by default.
692
// Otherwise, we will ignore the broken disk,
693
DECLARE_Bool(ignore_broken_disk);
694
695
// Sleep time in milliseconds between memory maintenance iterations
696
DECLARE_mInt32(memory_maintenance_sleep_time_ms);
697
698
// Memory gc are expensive, wait a while to avoid too frequent.
699
DECLARE_mInt32(memory_gc_sleep_time_ms);
700
701
// max write buffer size before flush, default 200MB
702
DECLARE_mInt64(write_buffer_size);
703
// max buffer size used in memtable for the aggregated table, default 400MB
704
DECLARE_mInt64(write_buffer_size_for_agg);
705
// max parallel flush task per memtable writer
706
DECLARE_mInt32(memtable_flush_running_count_limit);
707
708
DECLARE_Int32(load_process_max_memory_limit_percent); // 50%
709
710
// If the memory consumption of load jobs exceed load_process_max_memory_limit,
711
// all load jobs will hang there to wait for memtable flush. We should have a
712
// soft limit which can trigger the memtable flush for the load channel who
713
// consumes lagest memory size before we reach the hard limit. The soft limit
714
// might avoid all load jobs hang at the same time.
715
DECLARE_Int32(load_process_soft_mem_limit_percent);
716
717
// If load memory consumption is within load_process_safe_mem_permit_percent,
718
// memtable memory limiter will do nothing.
719
DECLARE_Int32(load_process_safe_mem_permit_percent);
720
721
// If there are a lot of memtable memory, then wait them flush finished.
722
DECLARE_mDouble(load_max_wg_active_memtable_percent);
723
724
// result buffer cancelled time (unit: second)
725
DECLARE_mInt32(result_buffer_cancelled_interval_time);
726
727
// arrow flight result sink buffer rows size, default 4096 * 8
728
DECLARE_mInt32(arrow_flight_result_sink_buffer_size_rows);
729
// The timeout for ADBC Client to wait for data using arrow flight reader.
730
// If the query is very complex and no result is generated after this time, consider increasing this timeout.
731
DECLARE_mInt32(arrow_flight_reader_brpc_controller_timeout_ms);
732
733
// the increased frequency of priority for remaining tasks in BlockingPriorityQueue
734
DECLARE_mInt32(priority_queue_remaining_tasks_increased_frequency);
735
736
// sync tablet_meta when modifying meta
737
DECLARE_mBool(sync_tablet_meta);
738
739
// sync a file writer when it is closed
740
DECLARE_mBool(sync_file_on_close);
741
742
// default thrift rpc timeout ms
743
DECLARE_mInt32(thrift_rpc_timeout_ms);
744
745
// txn commit rpc timeout
746
DECLARE_mInt32(txn_commit_rpc_timeout_ms);
747
748
// If set to true, metric calculator will run
749
DECLARE_Bool(enable_metric_calculator);
750
751
// max consumer num in one data consumer group, for routine load
752
DECLARE_mInt32(max_consumer_num_per_group);
753
754
// the max size of thread pool for routine load task.
755
// this should be larger than FE config 'max_routine_load_task_num_per_be' (default 5)
756
DECLARE_Int32(max_routine_load_thread_pool_size);
757
758
// max external scan cache batch count, means cache max_memory_cache_batch_count * batch_size row
759
// default is 20, batch_size's default value is 1024 means 20 * 1024 rows will be cached
760
DECLARE_mInt32(max_memory_sink_batch_count);
761
762
// This configuration is used for the context gc thread schedule period
763
// note: unit is minute, default is 5min
764
DECLARE_mInt32(scan_context_gc_interval_min);
765
766
// es scroll keep-alive
767
DECLARE_String(es_scroll_keepalive);
768
769
// HTTP connection timeout for es
770
DECLARE_mInt32(es_http_timeout_ms);
771
772
// the max client cache number per each host
773
// There are variety of client cache in BE, but currently we use the
774
// same cache size configuration.
775
// TODO(cmy): use different config to set different client cache if necessary.
776
DECLARE_Int32(max_client_cache_size_per_host);
777
778
DECLARE_Int32(max_master_fe_client_cache_size);
779
780
// Dir to save files downloaded by SmallFileMgr
781
DECLARE_String(small_file_dir);
782
// path gc
783
DECLARE_Bool(path_gc_check);
784
DECLARE_mInt32(path_gc_check_interval_second);
785
DECLARE_mInt32(path_gc_check_step);
786
DECLARE_mInt32(path_gc_check_step_interval_ms);
787
788
// The following 2 configs limit the max usage of disk capacity of a data dir.
789
// If both of these 2 threshold reached, no more data can be writen into that data dir.
790
// The percent of max used capacity of a data dir
791
DECLARE_mInt32(storage_flood_stage_usage_percent); // 90%
792
// The min bytes that should be left of a data dir
793
DECLARE_mInt64(storage_flood_stage_left_capacity_bytes); // 1GB
794
// number of thread for flushing memtable per store
795
DECLARE_Int32(flush_thread_num_per_store);
796
// number of thread for flushing memtable per store, for high priority load task
797
DECLARE_Int32(high_priority_flush_thread_num_per_store);
798
// number of threads = min(flush_thread_num_per_store * num_store,
799
//                         max_flush_thread_num_per_cpu * num_cpu)
800
DECLARE_Int32(max_flush_thread_num_per_cpu);
801
802
// workload group flush pool params
803
DECLARE_mInt32(wg_flush_thread_num_per_store);
804
DECLARE_mInt32(wg_flush_thread_num_per_cpu);
805
806
// config for tablet meta checkpoint
807
DECLARE_mInt32(tablet_meta_checkpoint_min_new_rowsets_num);
808
DECLARE_mInt32(tablet_meta_checkpoint_min_interval_secs);
809
DECLARE_Int32(generate_tablet_meta_checkpoint_tasks_interval_secs);
810
811
// config for default rowset type
812
// Valid configs: ALPHA, BETA
813
DECLARE_String(default_rowset_type);
814
815
// Maximum size of a single message body in all protocols
816
DECLARE_Int64(brpc_max_body_size);
817
// Max unwritten bytes in each socket, if the limit is reached, Socket.Write fails with EOVERCROWDED
818
// Default, if the physical memory is less than or equal to 64G, the value is 1G
819
//          if the physical memory is greater than 64G, the value is physical memory * mem_limit(0.8) / 1024 * 20
820
DECLARE_Int64(brpc_socket_max_unwritten_bytes);
821
// TODO(zxy): expect to be true in v1.3
822
// Whether to embed the ProtoBuf Request serialized string together with Tuple/Block data into
823
// Controller Attachment and send it through http brpc when the length of the Tuple/Block data
824
// is greater than 1.8G. This is to avoid the error of Request length overflow (2G).
825
DECLARE_mBool(transfer_large_data_by_brpc);
826
827
// max number of txns for every txn_partition_map in txn manager
828
// this is a self protection to avoid too many txns saving in manager
829
DECLARE_mInt64(max_runnings_transactions_per_txn_map);
830
831
// tablet_map_lock shard size, the value is 2^n, n=0,1,2,3,4
832
// this is a an enhancement for better performance to manage tablet
833
DECLARE_Int32(tablet_map_shard_size);
834
835
// txn_map_lock shard size, the value is 2^n, n=0,1,2,3,4
836
// this is a an enhancement for better performance to manage txn
837
DECLARE_Int32(txn_map_shard_size);
838
839
// txn_lock shard size, the value is 2^n, n=0,1,2,3,4
840
// this is a an enhancement for better performance to commit and publish txn
841
DECLARE_Int32(txn_shard_size);
842
843
// Whether to continue to start be when load tablet from header failed.
844
DECLARE_Bool(ignore_load_tablet_failure);
845
846
// Whether to continue to start be when load tablet from header failed.
847
DECLARE_mBool(ignore_rowset_stale_unconsistent_delete);
848
849
// Set max cache's size of query results, the unit is M byte
850
DECLARE_Int32(query_cache_max_size_mb);
851
852
// Cache memory is pruned when reach query_cache_max_size_mb + query_cache_elasticity_size_mb
853
DECLARE_Int32(query_cache_elasticity_size_mb);
854
855
// Maximum number of cache partitions corresponding to a SQL
856
DECLARE_Int32(query_cache_max_partition_count);
857
858
// Maximum number of version of a tablet. If the version num of a tablet exceed limit,
859
// the load process will reject new incoming load job of this tablet.
860
// This is to avoid too many version num.
861
DECLARE_mInt32(max_tablet_version_num);
862
863
// Frontend mainly use two thrift sever type: THREAD_POOL, THREADED_SELECTOR. if fe use THREADED_SELECTOR model for thrift server,
864
// the thrift_server_type_of_fe should be set THREADED_SELECTOR to make be thrift client to fe constructed with TFramedTransport
865
DECLARE_String(thrift_server_type_of_fe);
866
867
// disable zone map index when page row is too few
868
DECLARE_mInt32(zone_map_row_num_threshold);
869
870
// aws sdk log level
871
//    Off = 0,
872
//    Fatal = 1,
873
//    Error = 2,
874
//    Warn = 3,
875
//    Info = 4,
876
//    Debug = 5,
877
//    Trace = 6
878
DECLARE_Int32(aws_log_level);
879
880
// the buffer size when read data from remote storage like s3
881
DECLARE_mInt32(remote_storage_read_buffer_mb);
882
883
// The minimum length when TCMalloc Hook consumes/releases MemTracker, consume size
884
// smaller than this value will continue to accumulate. specified as number of bytes.
885
// Decreasing this value will increase the frequency of consume/release.
886
// Increasing this value will cause MemTracker statistics to be inaccurate.
887
DECLARE_mInt32(mem_tracker_consume_min_size_bytes);
888
889
// The version information of the tablet will be stored in the memory
890
// in an adjacency graph data structure.
891
// And as the new version is written and the old version is deleted,
892
// the data structure will begin to have empty vertex with no edge associations(orphan vertex).
893
// This config is used to control that when the proportion of orphan vertex is greater than the threshold,
894
// the adjacency graph will be rebuilt to ensure that the data structure will not expand indefinitely.
895
// This config usually only needs to be modified during testing.
896
// In most cases, it does not need to be modified.
897
DECLARE_mDouble(tablet_version_graph_orphan_vertex_ratio);
898
899
// share delta writers when memtable_on_sink_node = true
900
DECLARE_Bool(share_delta_writers);
901
// timeout for open load stream rpc in ms
902
DECLARE_Int64(open_load_stream_timeout_ms);
903
// enable write background when using brpc stream
904
DECLARE_mBool(enable_brpc_stream_write_background);
905
906
// brpc streaming max_buf_size in bytes
907
DECLARE_Int64(load_stream_max_buf_size);
908
// brpc streaming messages_in_batch
909
DECLARE_Int32(load_stream_messages_in_batch);
910
// brpc streaming StreamWait seconds on EAGAIN
911
DECLARE_Int32(load_stream_eagain_wait_seconds);
912
// max tasks per flush token in load stream
913
DECLARE_Int32(load_stream_flush_token_max_tasks);
914
// max wait flush token time in load stream
915
DECLARE_Int32(load_stream_max_wait_flush_token_time_ms);
916
// number of send batch thread pool size
917
DECLARE_Int32(send_batch_thread_pool_thread_num);
918
// number of send batch thread pool queue size
919
DECLARE_Int32(send_batch_thread_pool_queue_size);
920
921
// Limit the number of segment of a newly created rowset.
922
// The newly created rowset may to be compacted after loading,
923
// so if there are too many segment in a rowset, the compaction process
924
// will run out of memory.
925
// When doing compaction, each segment may take at least 1MB buffer.
926
DECLARE_mInt32(max_segment_num_per_rowset);
927
928
// Store segment without compression if a segment is smaller than
929
// segment_compression_threshold_kb.
930
DECLARE_mInt32(segment_compression_threshold_kb);
931
932
// The connection timeout when connecting to external table such as odbc table.
933
DECLARE_mInt32(external_table_connect_timeout_sec);
934
935
// Time to clean up useless JDBC connection pool cache
936
DECLARE_mInt32(jdbc_connection_pool_cache_clear_time_sec);
937
938
// Global bitmap cache capacity for aggregation cache, size in bytes
939
DECLARE_Int64(delete_bitmap_agg_cache_capacity);
940
DECLARE_String(delete_bitmap_dynamic_agg_cache_limit);
941
DECLARE_mInt32(delete_bitmap_agg_cache_stale_sweep_time_sec);
942
943
// A common object cache depends on an Sharded LRU Cache.
944
DECLARE_mInt32(common_obj_lru_cache_stale_sweep_time_sec);
945
946
// reference https://github.com/edenhill/librdkafka/blob/master/INTRODUCTION.md#broker-version-compatibility
947
// If the dependent kafka broker version older than 0.10.0.0,
948
// the value of kafka_api_version_request should be false, and the
949
// value set by the fallback version kafka_broker_version_fallback will be used,
950
// and the valid values are: 0.9.0.x, 0.8.x.y.
951
DECLARE_String(kafka_api_version_request);
952
DECLARE_String(kafka_broker_version_fallback);
953
DECLARE_mString(kafka_debug);
954
955
// The number of pool siz of routine load consumer.
956
// If you meet the error describe in https://github.com/edenhill/librdkafka/issues/3608
957
// Change this size to 0 to fix it temporarily.
958
DECLARE_mInt32(routine_load_consumer_pool_size);
959
960
// Used in single-stream-multi-table load. When receive a batch of messages from kafka,
961
// if the size of batch is more than this threshold, we will request plans for all related tables.
962
DECLARE_Int32(multi_table_batch_plan_threshold);
963
964
// Used in single-stream-multi-table load. When receiving a batch of messages from Kafka,
965
// if the size of the table wait for plan is more than this threshold, we will request plans for all related tables.
966
// The param is aimed to avoid requesting and executing too many plans at once.
967
// Performing small batch processing on multiple tables during the loaded process can reduce the pressure of a single RPC
968
// and improve the real-time processing of data.
969
DECLARE_Int32(multi_table_max_wait_tables);
970
971
// When the timeout of a load task is less than this threshold,
972
// Doris treats it as a high priority task.
973
// high priority tasks use a separate thread pool for flush and do not block rpc by memory cleanup logic.
974
// this threshold is mainly used to identify routine load tasks and should not be modified if not necessary.
975
DECLARE_mInt32(load_task_high_priority_threshold_second);
976
977
// The min timeout of load rpc (add batch, close)
978
// Because a load rpc may be blocked for a while.
979
// Increase this config may avoid rpc timeout.
980
DECLARE_mInt32(min_load_rpc_timeout_ms);
981
982
// use which protocol to access function service, candicate is baidu_std/h2:grpc
983
DECLARE_String(function_service_protocol);
984
985
// use which load balancer to select server to connect
986
DECLARE_String(rpc_load_balancer);
987
988
// a soft limit of string type length, the hard limit is 2GB - 4, but if too long will cause very low performance,
989
// so we set a soft limit, default is 1MB
990
DECLARE_mInt32(string_type_length_soft_limit_bytes);
991
992
// Threshold fo reading a small file into memory
993
DECLARE_mInt32(in_memory_file_size);
994
995
// Max size of parquet page header in bytes
996
DECLARE_mInt32(parquet_header_max_size_mb);
997
// Max buffer size for parquet row group
998
DECLARE_mInt32(parquet_rowgroup_max_buffer_mb);
999
// Max buffer size for parquet chunk column
1000
DECLARE_mInt32(parquet_column_max_buffer_mb);
1001
// Merge small IO, the max amplified read ratio
1002
DECLARE_mDouble(max_amplified_read_ratio);
1003
// Equivalent min size of each IO that can reach the maximum storage speed limit
1004
// 1MB for oss, 8KB for hdfs
1005
DECLARE_mInt32(merged_oss_min_io_size);
1006
DECLARE_mInt32(merged_hdfs_min_io_size);
1007
1008
// OrcReader
1009
DECLARE_mInt32(orc_natural_read_size_mb);
1010
DECLARE_mInt64(big_column_size_buffer);
1011
DECLARE_mInt64(small_column_size_buffer);
1012
1013
DECLARE_mInt32(runtime_filter_sampling_frequency);
1014
DECLARE_mInt32(execution_max_rpc_timeout_sec);
1015
DECLARE_mBool(execution_ignore_eovercrowded);
1016
1017
// cooldown task configs
1018
DECLARE_Int32(cooldown_thread_num);
1019
DECLARE_mInt64(generate_cooldown_task_interval_sec);
1020
DECLARE_mInt32(remove_unused_remote_files_interval_sec); // 6h
1021
DECLARE_mInt32(confirm_unused_remote_files_interval_sec);
1022
DECLARE_Int32(cold_data_compaction_thread_num);
1023
DECLARE_mInt32(cold_data_compaction_interval_sec);
1024
1025
DECLARE_Int32(min_s3_file_system_thread_num);
1026
DECLARE_Int32(max_s3_file_system_thread_num);
1027
1028
DECLARE_Bool(enable_time_lut);
1029
DECLARE_mBool(enable_simdjson_reader);
1030
1031
DECLARE_mBool(enable_query_like_bloom_filter);
1032
// number of s3 scanner thread pool size
1033
DECLARE_Int32(doris_remote_scanner_thread_pool_thread_num);
1034
// number of s3 scanner thread pool queue size
1035
DECLARE_Int32(doris_remote_scanner_thread_pool_queue_size);
1036
1037
// limit the queue of pending batches which will be sent by a single nodechannel
1038
DECLARE_mInt64(nodechannel_pending_queue_max_bytes);
1039
1040
// The batch size for sending data by brpc streaming client
1041
DECLARE_mInt64(brpc_streaming_client_batch_bytes);
1042
DECLARE_mInt64(block_cache_wait_timeout_ms);
1043
1044
DECLARE_Bool(enable_brpc_builtin_services);
1045
1046
DECLARE_Bool(enable_brpc_connection_check);
1047
1048
DECLARE_mInt64(brpc_connection_check_timeout_ms);
1049
1050
// Max waiting time to wait the "plan fragment start" rpc.
1051
// If timeout, the fragment will be cancelled.
1052
// This parameter is usually only used when the FE loses connection,
1053
// and the BE can automatically cancel the relevant fragment after the timeout,
1054
// so as to avoid occupying the execution thread for a long time.
1055
DECLARE_mInt32(max_fragment_start_wait_time_seconds);
1056
1057
DECLARE_Int32(fragment_mgr_cancel_worker_interval_seconds);
1058
1059
// Node role tag for backend. Mix role is the default role, and computation role have no
1060
// any tablet.
1061
DECLARE_String(be_node_role);
1062
1063
// Hide webserver page for safety.
1064
// Hide the be config page for webserver.
1065
DECLARE_Bool(hide_webserver_config_page);
1066
1067
DECLARE_Bool(enable_segcompaction);
1068
1069
// Max number of segments allowed in a single segcompaction task.
1070
DECLARE_mInt32(segcompaction_batch_size);
1071
1072
// Max row count allowed in a single source segment, bigger segments will be skipped.
1073
DECLARE_Int32(segcompaction_candidate_max_rows);
1074
1075
// Max file size allowed in a single source segment, bigger segments will be skipped.
1076
DECLARE_Int64(segcompaction_candidate_max_bytes);
1077
1078
// Max total row count allowed in a single segcompaction task.
1079
DECLARE_Int32(segcompaction_task_max_rows);
1080
1081
// Max total file size allowed in a single segcompaction task.
1082
DECLARE_Int64(segcompaction_task_max_bytes);
1083
1084
// Global segcompaction thread pool size.
1085
DECLARE_mInt32(segcompaction_num_threads);
1086
1087
// enable java udf and jdbc scannode
1088
DECLARE_Bool(enable_java_support);
1089
1090
// enable prefetch tablets before opening
1091
DECLARE_mBool(enable_prefetch_tablet);
1092
1093
// Set config randomly to check more issues in github workflow
1094
DECLARE_Bool(enable_fuzzy_mode);
1095
1096
DECLARE_Bool(enable_debug_points);
1097
1098
DECLARE_Int32(pipeline_executor_size);
1099
1100
// block file cache
1101
DECLARE_Bool(enable_file_cache);
1102
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240}]
1103
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240},{"path":"/path/to/file_cache2","total_size":21474836480,"query_limit":10737418240}]
1104
// format: [{"path":"/path/to/file_cache","total_size":21474836480,"query_limit":10737418240, "ttl_percent":50, "normal_percent":40, "disposable_percent":5, "index_percent":5}]
1105
// format: [{"path": "xxx", "total_size":53687091200, "storage": "memory"}]
1106
// Note1: storage is "disk" by default
1107
// Note2: when the storage is "memory", the path is ignored. So you can set xxx to anything you like
1108
// and doris will just reset the path to "memory" internally.
1109
// In a very wierd case when your storage is disk, and the directory, by accident, is named
1110
// "memory" for some reason, you should write the path as:
1111
//     {"path": "memory", "total_size":53687091200, "storage": "disk"}
1112
// or use the default storage value:
1113
//     {"path": "memory", "total_size":53687091200}
1114
// Both will use the directory "memory" on the disk instead of the real RAM.
1115
DECLARE_String(file_cache_path);
1116
DECLARE_Int64(file_cache_each_block_size);
1117
DECLARE_Bool(clear_file_cache);
1118
DECLARE_Bool(enable_file_cache_query_limit);
1119
DECLARE_Int32(file_cache_enter_disk_resource_limit_mode_percent);
1120
DECLARE_Int32(file_cache_exit_disk_resource_limit_mode_percent);
1121
DECLARE_mBool(enable_evict_file_cache_in_advance);
1122
DECLARE_mInt32(file_cache_enter_need_evict_cache_in_advance_percent);
1123
DECLARE_mInt32(file_cache_exit_need_evict_cache_in_advance_percent);
1124
DECLARE_mInt32(file_cache_evict_in_advance_interval_ms);
1125
DECLARE_mInt64(file_cache_evict_in_advance_batch_bytes);
1126
DECLARE_mInt64(file_cache_evict_in_advance_recycle_keys_num_threshold);
1127
DECLARE_mBool(enable_read_cache_file_directly);
1128
DECLARE_Bool(file_cache_enable_evict_from_other_queue_by_size);
1129
// If true, evict the ttl cache using LRU when full.
1130
// Otherwise, only expiration can evict ttl and new data won't add to cache when full.
1131
DECLARE_Bool(enable_ttl_cache_evict_using_lru);
1132
DECLARE_mBool(enbale_dump_error_file);
1133
// limit the max size of error log on disk
1134
DECLARE_mInt64(file_cache_error_log_limit_bytes);
1135
DECLARE_mInt64(cache_lock_wait_long_tail_threshold_us);
1136
DECLARE_mInt64(cache_lock_held_long_tail_threshold_us);
1137
// Base compaction may retrieve and produce some less frequently accessed data,
1138
// potentially affecting the file cache hit rate.
1139
// This configuration determines whether to retain the output within the file cache.
1140
// Make your choice based on the following considerations:
1141
// If your file cache is ample enough to accommodate all the data in your database,
1142
// enable this option; otherwise, it is recommended to leave it disabled.
1143
DECLARE_mBool(enable_file_cache_keep_base_compaction_output);
1144
DECLARE_mInt64(file_cache_remove_block_qps_limit);
1145
DECLARE_mInt64(file_cache_background_gc_interval_ms);
1146
DECLARE_mInt64(file_cache_background_monitor_interval_ms);
1147
DECLARE_mInt64(file_cache_background_ttl_gc_interval_ms);
1148
// inverted index searcher cache
1149
// cache entry stay time after lookup
1150
DECLARE_mInt32(index_cache_entry_stay_time_after_lookup_s);
1151
// cache entry that have not been visited for a certain period of time can be cleaned up by GC thread
1152
DECLARE_mInt32(inverted_index_cache_stale_sweep_time_sec);
1153
// inverted index searcher cache size
1154
DECLARE_String(inverted_index_searcher_cache_limit);
1155
DECLARE_mBool(enable_write_index_searcher_cache);
1156
DECLARE_Bool(enable_inverted_index_cache_check_timestamp);
1157
DECLARE_mBool(enable_inverted_index_correct_term_write);
1158
DECLARE_Int32(inverted_index_fd_number_limit_percent); // 50%
1159
DECLARE_Int32(inverted_index_query_cache_shards);
1160
1161
// inverted index match bitmap cache size
1162
DECLARE_String(inverted_index_query_cache_limit);
1163
1164
// inverted index
1165
DECLARE_mDouble(inverted_index_ram_buffer_size);
1166
DECLARE_mInt32(inverted_index_max_buffered_docs);
1167
// dict path for chinese analyzer
1168
DECLARE_String(inverted_index_dict_path);
1169
DECLARE_Int32(inverted_index_read_buffer_size);
1170
// tree depth for bkd index
1171
DECLARE_Int32(max_depth_in_bkd_tree);
1172
// index compaction
1173
DECLARE_mBool(inverted_index_compaction_enable);
1174
// Only for debug, do not use in production
1175
DECLARE_mBool(debug_inverted_index_compaction);
1176
// index by RAM directory
1177
DECLARE_mBool(inverted_index_ram_dir_enable);
1178
// wheather index by RAM directory when base compaction
1179
DECLARE_mBool(inverted_index_ram_dir_enable_when_base_compaction);
1180
// use num_broadcast_buffer blocks as buffer to do broadcast
1181
DECLARE_Int32(num_broadcast_buffer);
1182
1183
// max depth of expression tree allowed.
1184
DECLARE_Int32(max_depth_of_expr_tree);
1185
1186
// Report a tablet as bad when io errors occurs more than this value.
1187
DECLARE_mInt64(max_tablet_io_errors);
1188
1189
// Report a tablet as bad when its path not found
1190
DECLARE_Int32(tablet_path_check_interval_seconds);
1191
DECLARE_mInt32(tablet_path_check_batch_size);
1192
1193
// it must be larger than or equal to 5MB
1194
DECLARE_mInt64(s3_write_buffer_size);
1195
// Log interval when doing s3 upload task
1196
DECLARE_mInt32(s3_file_writer_log_interval_second);
1197
// the max number of cached file handle for block segemnt
1198
DECLARE_mInt64(file_cache_max_file_reader_cache_size);
1199
DECLARE_mInt64(hdfs_write_batch_buffer_size_mb);
1200
//enable shrink memory
1201
DECLARE_mBool(enable_shrink_memory);
1202
// enable cache for high concurrent point query work load
1203
DECLARE_mInt32(schema_cache_capacity);
1204
DECLARE_mInt32(schema_cache_sweep_time_sec);
1205
1206
// max number of segment cache
1207
DECLARE_Int32(segment_cache_capacity);
1208
DECLARE_Int32(segment_cache_fd_percentage);
1209
DECLARE_Int32(segment_cache_memory_percentage);
1210
DECLARE_mInt32(estimated_mem_per_column_reader);
1211
1212
// enable binlog
1213
DECLARE_Bool(enable_feature_binlog);
1214
1215
// enable set in BitmapValue
1216
DECLARE_Bool(enable_set_in_bitmap_value);
1217
1218
// max number of hdfs file handle in cache
1219
DECLARE_Int64(max_hdfs_file_handle_cache_num);
1220
DECLARE_Int32(max_hdfs_file_handle_cache_time_sec);
1221
1222
// max number of meta info of external files, such as parquet footer
1223
DECLARE_Int64(max_external_file_meta_cache_num);
1224
// Apply delete pred in cumu compaction
1225
DECLARE_mBool(enable_delete_when_cumu_compaction);
1226
1227
// max_write_buffer_number for rocksdb
1228
DECLARE_Int32(rocksdb_max_write_buffer_number);
1229
1230
// Convert date 0000-00-00 to 0000-01-01. It's recommended to set to false.
1231
DECLARE_mBool(allow_zero_date);
1232
// Allow invalid decimalv2 literal for compatible with old version. Recommend set it false strongly.
1233
DECLARE_mBool(allow_invalid_decimalv2_literal);
1234
// Allow to specify kerberos credentials cache path.
1235
DECLARE_mString(kerberos_ccache_path);
1236
// set krb5.conf path, use "/etc/krb5.conf" by default
1237
DECLARE_mString(kerberos_krb5_conf_path);
1238
// the interval for renew kerberos ticket cache
1239
DECLARE_mInt32(kerberos_refresh_interval_second);
1240
1241
// Values include `none`, `glog`, `boost`, `glibc`, `libunwind`
1242
DECLARE_mString(get_stack_trace_tool);
1243
DECLARE_mBool(enable_address_sanitizers_with_stack_trace);
1244
1245
// DISABLED: Don't resolve location info.
1246
// FAST: Perform CU lookup using .debug_aranges (might be incomplete).
1247
// FULL: Scan all CU in .debug_info (slow!) on .debug_aranges lookup failure.
1248
// FULL_WITH_INLINE: Scan .debug_info (super slower, use with caution) for inline functions in addition to FULL.
1249
DECLARE_mString(dwarf_location_info_mode);
1250
1251
// the ratio of _prefetch_size/_batch_size in AutoIncIDBuffer
1252
DECLARE_mInt64(auto_inc_prefetch_size_ratio);
1253
1254
// the ratio of _low_level_water_level_mark/_batch_size in AutoIncIDBuffer
1255
DECLARE_mInt64(auto_inc_low_water_level_mark_size_ratio);
1256
1257
// number of threads that fetch auto-inc ranges from FE
1258
DECLARE_mInt64(auto_inc_fetch_thread_num);
1259
// Max connection cache num for point lookup queries
1260
DECLARE_mInt64(lookup_connection_cache_capacity);
1261
1262
// level of compression when using LZ4_HC, whose defalut value is LZ4HC_CLEVEL_DEFAULT
1263
DECLARE_mInt64(LZ4_HC_compression_level);
1264
// Threshold of a column as sparse column
1265
// Notice: TEST ONLY
1266
DECLARE_mDouble(variant_ratio_of_defaults_as_sparse_column);
1267
DECLARE_mBool(variant_use_cloud_schema_dict_cache);
1268
// Threshold to estimate a column is sparsed
1269
// Notice: TEST ONLY
1270
DECLARE_mInt64(variant_threshold_rows_to_estimate_sparse_column);
1271
// Treat invalid json format str as string, instead of throwing exception if false
1272
DECLARE_mBool(variant_throw_exeception_on_invalid_json);
1273
1274
DECLARE_mBool(enable_merge_on_write_correctness_check);
1275
// USED FOR DEBUGING
1276
// core directly if the compaction found there's duplicate key on mow table
1277
DECLARE_mBool(enable_mow_compaction_correctness_check_core);
1278
// rowid conversion correctness check when compaction for mow table
1279
DECLARE_mBool(enable_rowid_conversion_correctness_check);
1280
// missing rows correctness check when compaction for mow table
1281
DECLARE_mBool(enable_missing_rows_correctness_check);
1282
// When the number of missing versions is more than this value, do not directly
1283
// retry the publish and handle it through async publish.
1284
DECLARE_mInt32(mow_publish_max_discontinuous_version_num);
1285
// When the size of primary keys in memory exceeds this value, finish current segment
1286
// and create a new segment, used in compaction.
1287
DECLARE_mInt64(mow_primary_key_index_max_size_in_memory);
1288
// When the version is not continuous for MOW table in publish phase and the gap between
1289
// current txn's publishing version and the max version of the tablet exceeds this value,
1290
// don't print warning log
1291
DECLARE_mInt32(publish_version_gap_logging_threshold);
1292
// get agg by cache for mow table
1293
DECLARE_mBool(enable_mow_get_agg_by_cache);
1294
// get agg correctness check for mow table
1295
DECLARE_mBool(enable_mow_get_agg_correctness_check_core);
1296
1297
// The secure path with user files, used in the `local` table function.
1298
DECLARE_mString(user_files_secure_path);
1299
1300
// If fe's frontend info has not been updated for more than fe_expire_duration_seconds, it will be regarded
1301
// as an abnormal fe, this will cause be to cancel this fe's related query.
1302
DECLARE_Int32(fe_expire_duration_seconds);
1303
1304
// If use stop_be.sh --grace, then BE has to wait all running queries to stop to avoiding running query failure
1305
// , but if the waiting time exceed the limit, then be will exit directly.
1306
// During this period, FE will not send any queries to BE and waiting for all running queries to stop.
1307
DECLARE_Int32(grace_shutdown_wait_seconds);
1308
1309
// BitmapValue serialize version.
1310
DECLARE_Int16(bitmap_serialize_version);
1311
1312
// group commit config
1313
DECLARE_String(group_commit_wal_path);
1314
DECLARE_Int32(group_commit_replay_wal_retry_num);
1315
DECLARE_Int32(group_commit_replay_wal_retry_interval_seconds);
1316
DECLARE_Int32(group_commit_replay_wal_retry_interval_max_seconds);
1317
DECLARE_mInt32(group_commit_relay_wal_threads);
1318
// This config can be set to limit thread number in group commit request fragment thread pool.
1319
DECLARE_mInt32(group_commit_insert_threads);
1320
DECLARE_mInt32(group_commit_memory_rows_for_max_filter_ratio);
1321
DECLARE_Bool(wait_internal_group_commit_finish);
1322
// Max size(bytes) of group commit queues, used for mem back pressure.
1323
DECLARE_mInt32(group_commit_queue_mem_limit);
1324
// Max size(bytes) or percentage(%) of wal disk usage, used for disk space back pressure, default 10% of the disk available space.
1325
// group_commit_wal_max_disk_limit=1024 or group_commit_wal_max_disk_limit=10% can be automatically identified.
1326
DECLARE_mString(group_commit_wal_max_disk_limit);
1327
DECLARE_Bool(group_commit_wait_replay_wal_finish);
1328
1329
// The configuration item is used to lower the priority of the scanner thread,
1330
// typically employed to ensure CPU scheduling for write operations.
1331
// Default is 0, which is default value of thread nice value, increase this value
1332
// to lower the priority of scan threads
1333
DECLARE_Int32(scan_thread_nice_value);
1334
// Used to modify the recycle interval of tablet schema cache
1335
DECLARE_mInt32(tablet_schema_cache_recycle_interval);
1336
// Granularity is at the column level
1337
DECLARE_mInt32(tablet_schema_cache_capacity);
1338
1339
// Use `LOG(FATAL)` to replace `throw` when true
1340
DECLARE_mBool(exit_on_exception);
1341
1342
// cgroup
1343
DECLARE_String(doris_cgroup_cpu_path);
1344
DECLARE_mBool(enable_be_proc_monitor);
1345
DECLARE_mInt32(be_proc_monitor_interval_ms);
1346
DECLARE_Int32(workload_group_metrics_interval_ms);
1347
1348
// This config controls whether the s3 file writer would flush cache asynchronously
1349
DECLARE_Bool(enable_flush_file_cache_async);
1350
1351
// Remove predicate that is always true for a segment.
1352
DECLARE_Bool(ignore_always_true_predicate_for_segment);
1353
1354
// Ingest binlog work pool size
1355
DECLARE_Int32(ingest_binlog_work_pool_size);
1356
1357
// Ingest binlog with persistent connection
1358
DECLARE_Bool(enable_ingest_binlog_with_persistent_connection);
1359
1360
// Log ingest binlog elapsed threshold, -1 means no log
1361
DECLARE_mInt64(ingest_binlog_elapsed_threshold_ms);
1362
1363
// Download binlog rate limit, unit is KB/s
1364
DECLARE_Int32(download_binlog_rate_limit_kbs);
1365
1366
DECLARE_mInt32(buffered_reader_read_timeout_ms);
1367
1368
// whether to enable /api/snapshot api
1369
DECLARE_Bool(enable_snapshot_action);
1370
1371
// The max columns size for a tablet schema
1372
DECLARE_mInt32(variant_max_merged_tablet_schema_size);
1373
1374
DECLARE_mInt64(local_exchange_buffer_mem_limit);
1375
1376
DECLARE_mInt64(enable_debug_log_timeout_secs);
1377
1378
DECLARE_mBool(enable_column_type_check);
1379
1380
// Tolerance for the number of partition id 0 in rowset, default 0
1381
DECLARE_Int32(ignore_invalid_partition_id_rowset_num);
1382
1383
DECLARE_mInt32(report_query_statistics_interval_ms);
1384
DECLARE_mInt32(query_statistics_reserve_timeout_ms);
1385
DECLARE_mInt32(report_exec_status_thread_num);
1386
1387
// consider two high usage disk at the same available level if they do not exceed this diff.
1388
DECLARE_mDouble(high_disk_avail_level_diff_usages);
1389
1390
// create tablet in partition random robin idx lru size, default 10000
1391
DECLARE_Int32(partition_disk_index_lru_size);
1392
DECLARE_String(spill_storage_root_path);
1393
// Spill storage limit specified as number of bytes
1394
// ('<int>[bB]?'), megabytes ('<float>[mM]'), gigabytes ('<float>[gG]'),
1395
// or percentage of capaity ('<int>%').
1396
// Defaults to bytes if no unit is given.
1397
// Must larger than 0.
1398
// If specified as percentage, the final limit value is:
1399
//   disk_capacity_bytes * storage_flood_stage_usage_percent * spill_storage_limit
1400
DECLARE_String(spill_storage_limit);
1401
DECLARE_mInt32(spill_gc_interval_ms);
1402
DECLARE_mInt32(spill_gc_work_time_ms);
1403
DECLARE_Int32(spill_io_thread_pool_thread_num);
1404
DECLARE_Int32(spill_io_thread_pool_queue_size);
1405
DECLARE_Int64(spill_in_paused_queue_timeout_ms);
1406
1407
DECLARE_mBool(check_segment_when_build_rowset_meta);
1408
1409
DECLARE_Int32(num_query_ctx_map_partitions);
1410
1411
DECLARE_mBool(force_azure_blob_global_endpoint);
1412
1413
DECLARE_mBool(enable_s3_rate_limiter);
1414
DECLARE_mInt64(s3_get_bucket_tokens);
1415
DECLARE_mInt64(s3_get_token_per_second);
1416
DECLARE_mInt64(s3_get_token_limit);
1417
1418
DECLARE_mInt64(s3_put_bucket_tokens);
1419
DECLARE_mInt64(s3_put_token_per_second);
1420
DECLARE_mInt64(s3_put_token_limit);
1421
// max s3 client retry times
1422
DECLARE_mInt32(max_s3_client_retry);
1423
// When meet s3 429 error, the "get" request will
1424
// sleep s3_read_base_wait_time_ms (*1, *2, *3, *4) ms
1425
// get try again.
1426
// The max sleep time is s3_read_max_wait_time_ms
1427
// and the max retry time is max_s3_client_retry
1428
DECLARE_mInt32(s3_read_base_wait_time_ms);
1429
DECLARE_mInt32(s3_read_max_wait_time_ms);
1430
DECLARE_mBool(enable_s3_object_check_after_upload);
1431
1432
// write as inverted index tmp directory
1433
DECLARE_String(tmp_file_dir);
1434
1435
// the directory for storing the trino-connector plugins.
1436
DECLARE_String(trino_connector_plugin_dir);
1437
1438
// the file paths(one or more) of CA cert, splite using ";" aws s3 lib use it to init s3client
1439
DECLARE_mString(ca_cert_file_paths);
1440
1441
/** Table sink configurations(currently contains only external table types) **/
1442
// Minimum data processed to scale writers in exchange when non partition writing
1443
DECLARE_mInt64(table_sink_non_partition_write_scaling_data_processed_threshold);
1444
// Minimum data processed to trigger skewed partition rebalancing in exchange when partition writing
1445
DECLARE_mInt64(table_sink_partition_write_min_data_processed_rebalance_threshold);
1446
// Minimum partition data processed to rebalance writers in exchange when partition writing
1447
DECLARE_mInt64(table_sink_partition_write_min_partition_data_processed_rebalance_threshold);
1448
// Maximum processed partition nums of per writer when partition writing
1449
DECLARE_mInt32(table_sink_partition_write_max_partition_nums_per_writer);
1450
1451
/** Hive sink configurations **/
1452
DECLARE_mInt64(hive_sink_max_file_size);
1453
1454
/** Iceberg sink configurations **/
1455
DECLARE_mInt64(iceberg_sink_max_file_size);
1456
1457
// Number of open tries, default 1 means only try to open once.
1458
// Retry the Open num_retries time waiting 100 milliseconds between retries.
1459
DECLARE_mInt32(thrift_client_open_num_tries);
1460
1461
// http scheme in S3Client to use. E.g. http or https
1462
DECLARE_String(s3_client_http_scheme);
1463
1464
DECLARE_mBool(ignore_schema_change_check);
1465
1466
/** Only use in fuzzy test **/
1467
DECLARE_mInt64(string_overflow_size);
1468
1469
// The min thread num for BufferedReaderPrefetchThreadPool
1470
DECLARE_Int64(num_buffered_reader_prefetch_thread_pool_min_thread);
1471
// The max thread num for BufferedReaderPrefetchThreadPool
1472
DECLARE_Int64(num_buffered_reader_prefetch_thread_pool_max_thread);
1473
// The min thread num for S3FileUploadThreadPool
1474
DECLARE_Int64(num_s3_file_upload_thread_pool_min_thread);
1475
// The max thread num for S3FileUploadThreadPool
1476
DECLARE_Int64(num_s3_file_upload_thread_pool_max_thread);
1477
// The maximum jvm heap usage ratio for hdfs write workload
1478
DECLARE_mDouble(max_hdfs_wirter_jni_heap_usage_ratio);
1479
// The sleep milliseconds duration when hdfs write exceeds the maximum usage
1480
DECLARE_mInt64(hdfs_jni_write_sleep_milliseconds);
1481
// The max retry times when hdfs write failed
1482
DECLARE_mInt64(hdfs_jni_write_max_retry_time);
1483
1484
// The min thread num for NonBlockCloseThreadPool
1485
DECLARE_Int64(min_nonblock_close_thread_num);
1486
// The max thread num for NonBlockCloseThreadPool
1487
DECLARE_Int64(max_nonblock_close_thread_num);
1488
// The possibility that mem allocator throws an exception during memory allocation
1489
// This config is for test usage, be careful when changing it.
1490
DECLARE_mDouble(mem_alloc_fault_probability);
1491
// The time out milliseconds for remote fetch schema RPC
1492
DECLARE_mInt64(fetch_remote_schema_rpc_timeout_ms);
1493
// The size of the local buffer for S3FileSytem's upload function
1494
1495
DECLARE_Int64(s3_file_system_local_upload_buffer_size);
1496
1497
//JVM monitoring enable. To prevent be from crashing due to jvm compatibility issues.
1498
DECLARE_Bool(enable_jvm_monitor);
1499
1500
// Num threads to load data dirs, default value -1 indicates the same number of threads as the number of data dirs
1501
DECLARE_Int32(load_data_dirs_threads);
1502
1503
// Skip loading stale rowset meta when initializing `TabletMeta` from protobuf
1504
DECLARE_mBool(skip_loading_stale_rowset_meta);
1505
// Whether to use file to record log. When starting BE with --console,
1506
// all logs will be written to both standard output and file.
1507
// Disable this option will no longer use file to record log.
1508
// Only works when starting BE with --console.
1509
DECLARE_Bool(enable_file_logger);
1510
1511
// The minimum row group size when exporting Parquet files.
1512
DECLARE_Int64(min_row_group_size);
1513
1514
DECLARE_mInt64(compaction_memory_bytes_limit);
1515
1516
DECLARE_mInt64(compaction_batch_size);
1517
1518
DECLARE_mBool(enable_parquet_page_index);
1519
1520
// Wheather to ignore not found file in external teble(eg, hive)
1521
// Default is true, if set to false, the not found file will result in query failure.
1522
DECLARE_mBool(ignore_not_found_file_in_external_table);
1523
1524
DECLARE_mBool(enable_hdfs_mem_limiter);
1525
1526
// Define how many percent data in hashtable bigger than limit
1527
// we should do agg limit opt
1528
DECLARE_mInt16(topn_agg_limit_multiplier);
1529
1530
DECLARE_mInt64(tablet_meta_serialize_size_limit);
1531
1532
DECLARE_mInt64(pipeline_task_leakage_detect_period_secs);
1533
// To be compatible with hadoop's block compression
1534
DECLARE_mInt32(snappy_compression_block_size);
1535
DECLARE_mInt32(lz4_compression_block_size);
1536
1537
DECLARE_mBool(enable_pipeline_task_leakage_detect);
1538
1539
DECLARE_mInt32(check_score_rounds_num);
1540
1541
// MB
1542
DECLARE_Int32(query_cache_size);
1543
DECLARE_Bool(force_regenerate_rowsetid_on_start_error);
1544
1545
DECLARE_mBool(enable_delete_bitmap_merge_on_compaction);
1546
// Enable validation to check the correctness of table size.
1547
DECLARE_Bool(enable_table_size_correctness_check);
1548
// Enable sleep 5s between delete cumulative compaction.
1549
DECLARE_mBool(enable_sleep_between_delete_cumu_compaction);
1550
1551
DECLARE_mInt32(compaction_num_per_round);
1552
1553
DECLARE_mInt32(check_tablet_delete_bitmap_interval_seconds);
1554
DECLARE_mInt32(check_tablet_delete_bitmap_score_top_n);
1555
DECLARE_mBool(enable_check_tablet_delete_bitmap_score);
1556
DECLARE_mInt32(schema_dict_cache_capacity);
1557
1558
// whether to prune rows with delete sign = 1 in base compaction
1559
// ATTN: this config is only for test
1560
DECLARE_mBool(enable_prune_delete_sign_when_base_compaction);
1561
1562
DECLARE_mBool(enable_mow_verbose_log);
1563
1564
DECLARE_mInt32(tablet_sched_delay_time_ms);
1565
DECLARE_mInt32(load_trigger_compaction_version_percent);
1566
DECLARE_mInt64(base_compaction_interval_seconds_since_last_operation);
1567
DECLARE_mBool(enable_compaction_pause_on_high_memory);
1568
1569
#ifdef BE_TEST
1570
// test s3
1571
DECLARE_String(test_s3_resource);
1572
DECLARE_String(test_s3_ak);
1573
DECLARE_String(test_s3_sk);
1574
DECLARE_String(test_s3_endpoint);
1575
DECLARE_String(test_s3_region);
1576
DECLARE_String(test_s3_bucket);
1577
DECLARE_String(test_s3_prefix);
1578
#endif
1579
1580
class Register {
1581
public:
1582
    struct Field {
1583
        const char* type = nullptr;
1584
        const char* name = nullptr;
1585
        void* storage = nullptr;
1586
        const char* defval = nullptr;
1587
        bool valmutable = false;
1588
        Field(const char* ftype, const char* fname, void* fstorage, const char* fdefval,
1589
              bool fvalmutable)
1590
                : type(ftype),
1591
                  name(fname),
1592
                  storage(fstorage),
1593
                  defval(fdefval),
1594
666
                  valmutable(fvalmutable) {}
1595
    };
1596
1597
public:
1598
    static std::map<std::string, Field>* _s_field_map;
1599
1600
public:
1601
    Register(const char* ftype, const char* fname, void* fstorage, const char* fdefval,
1602
662
             bool fvalmutable) {
1603
662
        if (_s_field_map == nullptr) {
1604
1
            _s_field_map = new std::map<std::string, Field>();
1605
1
        }
1606
662
        Field field(ftype, fname, fstorage, fdefval, fvalmutable);
1607
662
        _s_field_map->insert(std::make_pair(std::string(fname), field));
1608
662
    }
1609
};
1610
1611
// RegisterConfValidator class is used to store validator function of registered config fields in
1612
// Register::_s_field_map.
1613
// If any validator return false when BE bootstart, the bootstart will be terminated.
1614
// If validator return false when use http API to update some config, the config will not
1615
// be modified and the API will return failure.
1616
class RegisterConfValidator {
1617
public:
1618
    // Validator for each config name.
1619
    static std::map<std::string, std::function<bool()>>* _s_field_validator;
1620
1621
public:
1622
    RegisterConfValidator(const char* fname, const std::function<bool()>& validator) {
1623
        if (_s_field_validator == nullptr) {
1624
            _s_field_validator = new std::map<std::string, std::function<bool()>>();
1625
        }
1626
        // register validator to _s_field_validator
1627
        _s_field_validator->insert(std::make_pair(std::string(fname), validator));
1628
    }
1629
};
1630
1631
// configuration properties load from config file.
1632
class Properties {
1633
public:
1634
    // load conf from file, if must_exist is true and file does not exist, return false
1635
    bool load(const char* conf_file, bool must_exist = true);
1636
1637
    // Find the config value by key from `file_conf_map`.
1638
    // If found, set `retval` to the config value,
1639
    // or set `retval` to `defstr`
1640
    // if retval is not set(in case defstr is nullptr), set is_retval_set to false
1641
    template <typename T>
1642
    bool get_or_default(const char* key, const char* defstr, T& retval, bool* is_retval_set,
1643
                        std::string& rawval) const;
1644
1645
    void set(const std::string& key, const std::string& val);
1646
1647
    void set_force(const std::string& key, const std::string& val);
1648
1649
    // dump props to conf file
1650
    Status dump(const std::string& conffile);
1651
1652
private:
1653
    std::map<std::string, std::string> file_conf_map;
1654
};
1655
1656
// full configurations.
1657
extern std::map<std::string, std::string>* full_conf_map;
1658
1659
extern std::mutex custom_conf_lock;
1660
1661
// Init the config from `conf_file`.
1662
// If fill_conf_map is true, the updated config will also update the `full_conf_map`.
1663
// If must_exist is true and `conf_file` does not exist, this function will return false.
1664
// If set_to_default is true, the config value will be set to default value if not found in `conf_file`.
1665
bool init(const char* conf_file, bool fill_conf_map = false, bool must_exist = true,
1666
          bool set_to_default = true);
1667
1668
Status set_config(const std::string& field, const std::string& value, bool need_persist = false,
1669
                  bool force = false);
1670
1671
Status persist_config(const std::string& field, const std::string& value);
1672
1673
std::mutex* get_mutable_string_config_lock();
1674
1675
std::vector<std::vector<std::string>> get_config_info();
1676
1677
Status set_fuzzy_configs();
1678
1679
void update_config(const std::string& field, const std::string& value);
1680
1681
} // namespace config
1682
} // namespace doris