apple/foundationdb
1
0
Fork 0
mirror of https://github.com/apple/foundationdb.git synced 2025-05-14 01:42:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
XiaoxiWang 2020-08-23 18:24:45 +00:00
parent d8a508ce7e
commit 86b943f17a
3 changed files with 30 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
documentation/sphinx/source/command-line-interface.rst
View File

@ -456,16 +456,20 @@ disable
``throttle disable auto`` ``throttle disable auto``
Disables cluster auto-throttling for busy transaction tags. This does not disable any currently active throttles. To do so, run the following command after disabling auto-throttling:: Disables cluster auto-throttling for busy transaction tags. This may not disable currently active throttles immediately, seconds of delay is expected.
> throttle off auto
list list
^^^^ ^^^^
``throttle list [LIMIT]`` ``throttle list [throttled|recommended|all] [LIMIT]``
Prints a list of currently active transaction tag throttles. Prints a list of currently active transaction tag throttles, or recommended transaction tag throttles if auto-throttling is disabled.
``throttled`` - list active transaction tag throttles.
``recommended`` - list transaction tag throttles recommended by the ratekeeper, but not active yet.
``all`` - list both active and recommended transaction tag throttles.
``LIMIT`` - The number of throttles to print. Defaults to 100. ``LIMIT`` - The number of throttles to print. Defaults to 100.

15
documentation/sphinx/source/mr-status-json-schemas.rst.inc
View File

@ -313,11 +313,18 @@
"batch_released_transactions_per_second":0, "batch_released_transactions_per_second":0,
"released_transactions_per_second":0, "released_transactions_per_second":0,
"throttled_tags":{ "throttled_tags":{
"auto":{ "auto" : {
"count":0 "busy_read" : 0,
"busy_write" : 0,
"count" : 0
}, },
"manual":{ "manual" : {
"count":0 "count" : 1
},
"recommend" : {
"busy_read" : 0,
"busy_write" : 0,
"count" : 0
} }
}, },
"limiting_queue_bytes_storage_server":0, "limiting_queue_bytes_storage_server":0,

10
documentation/sphinx/source/mr-status.rst
View File

@ -132,3 +132,13 @@ log_server_min_free_space Log server running out of space (approaching
log_server_min_free_space_ratio Log server running out of space (approaching 5% limit). log_server_min_free_space_ratio Log server running out of space (approaching 5% limit).
storage_server_durability_lag Storage server durable version falling behind. storage_server_durability_lag Storage server durable version falling behind.
=================================== ==================================================== =================================== ====================================================
The JSON path ``cluster.qos.throttled_tags``, when it exists, is an Object containing ``"auto"`` , ``"manual"`` and ``"recommended"``. The possible fields for those object are in the following table:
=================================== ====================================================
Name Description
=================================== ====================================================
count How many tags are throttled
busy_read How many tags are throttled because of busy read
busy_write How many tags are throttled because of busy write
=================================== ====================================================