From 86b943f17a15989fc645fc481d4ef67ed1480d1a Mon Sep 17 00:00:00 2001 From: XiaoxiWang Date: Sun, 23 Aug 2020 18:24:45 +0000 Subject: [PATCH] update documentation --- .../sphinx/source/command-line-interface.rst | 14 +++++++++----- .../sphinx/source/mr-status-json-schemas.rst.inc | 15 +++++++++++---- documentation/sphinx/source/mr-status.rst | 10 ++++++++++ 3 files changed, 30 insertions(+), 9 deletions(-) diff --git a/documentation/sphinx/source/command-line-interface.rst b/documentation/sphinx/source/command-line-interface.rst index 6c75b64869..a051f5cbad 100644 --- a/documentation/sphinx/source/command-line-interface.rst +++ b/documentation/sphinx/source/command-line-interface.rst @@ -456,16 +456,20 @@ disable ``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:: - -> throttle off auto +Disables cluster auto-throttling for busy transaction tags. This may not disable currently active throttles immediately, seconds of delay is expected. 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. diff --git a/documentation/sphinx/source/mr-status-json-schemas.rst.inc b/documentation/sphinx/source/mr-status-json-schemas.rst.inc index 294ddc560c..46086caead 100644 --- a/documentation/sphinx/source/mr-status-json-schemas.rst.inc +++ b/documentation/sphinx/source/mr-status-json-schemas.rst.inc @@ -313,11 +313,18 @@ "batch_released_transactions_per_second":0, "released_transactions_per_second":0, "throttled_tags":{ - "auto":{ - "count":0 + "auto" : { + "busy_read" : 0, + "busy_write" : 0, + "count" : 0 }, - "manual":{ - "count":0 + "manual" : { + "count" : 1 + }, + "recommend" : { + "busy_read" : 0, + "busy_write" : 0, + "count" : 0 } }, "limiting_queue_bytes_storage_server":0, diff --git a/documentation/sphinx/source/mr-status.rst b/documentation/sphinx/source/mr-status.rst index 6ba4537285..5eb404bbd4 100644 --- a/documentation/sphinx/source/mr-status.rst +++ b/documentation/sphinx/source/mr-status.rst @@ -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). 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 +=================================== ==================================================== \ No newline at end of file