hcq/MaxScale
hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add network throttling documentation

Browse Source 
Added documentation for MXS-1690.
This commit is contained in:
Markus Mäkelä 2018-06-12 12:42:13 +03:00
parent d2e7be2ca0
commit 9dd8043359
No known key found for this signature in database
GPG Key ID: 72D48FCE664F7B19
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/Getting-Started/Configuration-Guide.md
View File

@ -708,6 +708,26 @@ Note that you need to specify with `retain_last_statements` how many statements
MaxScale should retain for each session. Unless it has been set to another value
than `0`, this configuration setting will not have an effect.
#### `writeq_high_water`
High water mark for network write buffer. Controls when network traffic
throtting is started.
More specifically, if the client side write queue is above this value, it will
block traffic coming from backend servers. If the backend side write queue is
above this value, it will block traffic from client. the minimum allowed size is
4096 bytes.
Only when both `writeq_high_water` and `writeq_low_water` are set, traffic
throtting is enabled. By default, traffic throttling is disabled.
#### `writeq_low_water`
Low water mark for network write buffer. Once the traffic throttling is enabled,
it will only be disabled when the write queue is below `writeq_high_water`. The
minimum allowed size is 512 bytes. `writeq_high_water` must always be greater
than `writeq_low_water`.
### REST API Configuration
The MaxScale REST API is an HTTP interface that provides JSON format data