|
| 1 | +--- |
| 2 | +sidebar_position: 2 |
| 3 | +--- |
| 4 | + |
| 5 | +# Configuration |
| 6 | + |
| 7 | +You can configure SpringQL in TOML format. |
| 8 | + |
| 9 | +Default values are used if you don't set the key-value in TOML. |
| 10 | + |
| 11 | +Here shows the default values and what they mean. |
| 12 | + |
| 13 | +```toml title="Default configuration values" |
| 14 | +[worker] |
| 15 | +# Number of generic worker threads. Generic worker threads deal with internal and sink tasks. |
| 16 | +# Setting this to > 1 may improve throughput but lead to out-of-order stream processing. |
| 17 | +n_generic_worker_threads = 1 |
| 18 | + |
| 19 | +# Number of source worker threads. Source worker threads collect rows from foreign source. |
| 20 | +# Too many number may may cause row fraud in runtime. |
| 21 | +# Setting this to > 1 may improve throughput but lead to out-of-order stream processing. |
| 22 | +n_source_worker_threads = 1 |
| 23 | + |
| 24 | +[memory] |
| 25 | +# How much memory is allowed to be used in SpringQL streaming runtime. |
| 26 | +upper_limit_bytes = 10_000_000 |
| 27 | + |
| 28 | +# Percentage over `upper_limit_bytes` to transit from Moderate state to Severe. |
| 29 | +# In Severe state, internal scheduler is changed to exhibit memory-resilience. |
| 30 | +moderate_to_severe_percent = 60 |
| 31 | + |
| 32 | +# Percentage over `upper_limit_bytes` to transit from Severe state to Critical. |
| 33 | +# In Critical state, all intermediate rows are purged to release memory. |
| 34 | +severe_to_critical_percent = 95 |
| 35 | + |
| 36 | +critical_to_severe_percent = 80 |
| 37 | +severe_to_moderate_percent = 40 |
| 38 | + |
| 39 | +# Interval for MemoryStateMachineWorker to publish TransitPerformanceMetricsSummary event. |
| 40 | +memory_state_transition_interval_msec = 10 |
| 41 | + |
| 42 | +# Interval for PerformanceMonitorWorker to publish ReportMetricsSummary event. |
| 43 | +performance_metrics_summary_report_interval_msec = 10 |
| 44 | + |
| 45 | +[web_console] |
| 46 | +# Whether to enable POST API request to web console. |
| 47 | +enable_report_post = false |
| 48 | + |
| 49 | +report_interval_msec = 3_000 |
| 50 | + |
| 51 | +host = "127.0.0.1" |
| 52 | +port = 8050 |
| 53 | + |
| 54 | +timeout_msec = 3_000 |
| 55 | + |
| 56 | +[source_reader] |
| 57 | +net_connect_timeout_msec = 1_000 |
| 58 | +net_read_timeout_msec = 100 |
| 59 | + |
| 60 | +[sink_writer] |
| 61 | +net_connect_timeout_msec = 1_000 |
| 62 | +net_write_timeout_msec = 100 |
| 63 | +``` |
0 commit comments