BE Configuration - Statistics and Storage
Some BE configuration items are dynamic parameters which you can set interactively when BE nodes are online. The rest of them are static parameters. You can only set the static parameters of a BE node by changing them in the corresponding configuration file be.conf and restarting the BE node to allow the change to take effect.
View BE configuration itemsβ
You can view the BE configuration items using the following command:
SELECT * FROM information_schema.be_configs [WHERE NAME LIKE "%<name_pattern>%"]
Configure BE parametersβ
Configure BE dynamic parametersβ
You can configure a dynamic parameter of a BE node by updating the value in information_schema.be_configs.
Setting an invalid value may cause unknown behaviors. Check twice before you run the command to update the configuration.
-- Replace <config_key> with the key of the configuration and <config_value> with the value.
UPDATE information_schema.be_configs SET VALUE = <config_value> WHERE name = "<config_key>";
Configure BE static parametersβ
You can only set the static parameters of a BE by changing them in the corresponding configuration file be.conf, and restarting the BE to allow the changes to take effect.
This topic introduces the following types of BE configurations:
Statistic reportβ
enable_metric_calculatorβ
- Default: true
- Type: boolean
- Unit: -
- Is mutable: No
- Description: When true, the BE process launches a background "metrics_daemon" thread (started in Daemon::init on non-Apple platforms) that runs every ~15 seconds to invoke
StarRocksMetrics::instance()->metrics()->trigger_hook()and compute derived/system metrics (e.g., push/query bytes/sec, max disk I/O util, max network send/receive rates), log memory breakdowns and run table metrics cleanup. When false, those hooks are executed synchronously insideMetricRegistry::collectat metric collection time, which can increase metric-scrape latency. Requires process restart to take effect. - Introduced in: v3.2.0
enable_system_metricsβ
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: No
- Description: When true, StarRocks initializes system-level monitoring during startup: it discovers disk devices from the configured store paths and enumerates network interfaces, then passes this information into the metrics subsystem to enable collection of disk I/O, network traffic and memory-related system metrics. If device or interface discovery fails, initialization logs a warning and aborts system metrics setup. This flag only controls whether system metrics are initialized; periodic metric aggregation threads are controlled separately by
enable_metric_calculator, and JVM metrics initialization is controlled byenable_jvm_metrics. Changing this value requires a restart. - Introduced in: v3.2.0
profile_report_intervalβ
- Default: 30
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: Interval in seconds that the ProfileReportWorker uses to (1) decide when to report per-fragment profile information for LOAD queries and (2) sleep between reporting cycles. The worker compares current time against each task's last_report_time using (profile_report_interval * 1000) ms to determine if a profile should be re-reported for both non-pipeline and pipeline load tasks. At each loop the worker reads the current value (mutable at runtime); if the configured value is less than or euqual to 0 the worker forces it to 1 and emits a warning. Changing this value affects the next reporting decision and sleep duration.
- Introduced in: v3.2.0
report_disk_state_interval_secondsβ
- Default: 60
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The time interval at which to report the storage volume state, which includes the size of data within the volume.
- Introduced in: -
report_resource_usage_interval_msβ
- Default: 1000
- Type: Int
- Unit: Milliseconds
- Is mutable: Yes
- Description: Interval, in milliseconds, between periodic resource-usage reports sent by the BE agent to the FE (master). The agent worker thread collects TResourceUsage (number of running queries, memory used/limit, CPU used permille, and resource-group usages) and calls report_task, then sleeps for this configured interval (see task_worker_pool). Lower values increase reporting timeliness but raise CPU, network, and master load; higher values reduce overhead but make resource information less current. The reporting updates related metrics (report_resource_usage_requests_total, report_resource_usage_requests_failed). Tune according to cluster scale and FE load.
- Introduced in: v3.2.0
report_tablet_interval_secondsβ
- Default: 60
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The time interval at which to report the most updated version of all tablets.
- Introduced in: -
report_task_interval_secondsβ
- Default: 10
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The time interval at which to report the state of a task. A task can be creating a table, dropping a table, loading data, or changing a table schema.
- Introduced in: -
report_workgroup_interval_secondsβ
- Default: 5
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The time interval at which to report the most updated version of all workgroups.
- Introduced in: -
Storageβ
alter_tablet_worker_countβ
- Default: 3
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The number of threads used for Schema Change.
- Introduced in: -
automatic_partition_thread_pool_thread_numβ
- Default: 1000
- Type: Int
- Unit: -
- Is mutable: No
- Description: The number of threads in the automatic partition thread pool used for automatic partition creation during loading. The queue size of the pool is automatically set to 10 times the thread count.
- Introduced in: -
avro_ignore_union_type_tagβ
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to strip the type tag from the JSON string serialized from the Avro Union data type.
- Introduced in: v3.3.7, v3.4
base_compaction_check_interval_secondsβ
- Default: 60
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The time interval of thread polling for a Base Compaction.
- Introduced in: -
base_compaction_interval_seconds_since_last_operationβ
- Default: 86400
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The time interval since the last Base Compaction. This configuration item is one of the conditions that trigger a Base Compaction.
- Introduced in: -