diff --git a/content/en/docs/18.0/reference/features/tablet-throttler.md b/content/en/docs/18.0/reference/features/tablet-throttler.md index 21617c6f3..8a0c5b958 100644 --- a/content/en/docs/18.0/reference/features/tablet-throttler.md +++ b/content/en/docs/18.0/reference/features/tablet-throttler.md @@ -211,7 +211,13 @@ Throttle a specific app, `vreplication`, so that `80%` of its eligible requests $ vtctldclient UpdateThrottlerConfig --throttle-app "vreplication" --throttle-app-ratio=0.8 --throttle-app-duration "30m" commerce ``` -Force expire now (unthrottle): +Unthrottle an app: + +```sh +$ vtctldclient UpdateThrottlerConfig --unthrottle-app "vreplication" commerce +``` + +An altrnative method to unthrottle is to set a throttling rule that expires immediately: ```sh $ vtctldclient UpdateThrottlerConfig --throttle-app "vreplication" --throttle-app-duration 0 commerce diff --git a/content/en/docs/18.0/reference/programs/vtctl/_index.md b/content/en/docs/18.0/reference/programs/vtctl/_index.md index 48d287653..53eca97e7 100644 --- a/content/en/docs/18.0/reference/programs/vtctl/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctl/_index.md @@ -157,7 +157,7 @@ Note that wherever `vtctl` commands produced master or MASTER for tablet type, t | Name | Example Usage | | :-------- | :--------------- | -| [UpdateThrottlerConfig](../vtctl/throttler#updatethrottlerconfig) | `UpdateThrottlerConfig -- [--enable\|--disable] [--threshold=] [--custom-query=] [--check-as-check-self\|--check-as-check-shard] [--throttle-app=] [--throttle-app-ratio=] [--throttle-app-duration=] ` +| [UpdateThrottlerConfig](../vtctl/throttler#updatethrottlerconfig) | `UpdateThrottlerConfig -- [--enable\|--disable] [--threshold=] [--custom-query=] [--check-as-check-self\|--check-as-check-shard] [--throttle-app|unthrottle-app=] [--throttle-app-ratio=] [--throttle-app-duration=] ` ## Options diff --git a/content/en/docs/18.0/reference/programs/vtctl/throttler.md b/content/en/docs/18.0/reference/programs/vtctl/throttler.md index f3624592a..49cd192d9 100644 --- a/content/en/docs/18.0/reference/programs/vtctl/throttler.md +++ b/content/en/docs/18.0/reference/programs/vtctl/throttler.md @@ -14,7 +14,7 @@ Update tablet throttler configuration for all tablets of a given keyspace. #### Usage -
UpdateThrottlerConfig -- [--enable|--disable] [--threshold=<float64>] [--custom-query=<query>] [--check-as-check-self|--check-as-check-shard] [--throttle-app=<name>] [--throttle-app-ratio=<float, range [0..1]>] [--throttle-app-duration=<duration>] <keyspace>
+
UpdateThrottlerConfig -- [--enable|--disable] [--threshold=<float64>] [--custom-query=<query>] [--check-as-check-self|--check-as-check-shard] [--throttle-app|unthrottle-app=<name>] [--throttle-app-ratio=<float, range [0..1]>] [--throttle-app-duration=<duration>] <keyspace>
#### Examples @@ -24,6 +24,8 @@ Update tablet throttler configuration for all tablets of a given keyspace. ```UpdateThrottlerConfig -- --throttle-app="vreplication" --throttle-app-ratio=0.5 --throttle-app-duration="30m" commerce``` +```UpdateThrottlerConfig -- --unthrottle-app="vreplication" commerce``` + #### Flags diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md index dc8e6974c..9c56e516c 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md @@ -7,7 +7,7 @@ series: vtctldclient Update the tablet throttler configuration for all tablets in the given keyspace (across all cells) ``` -vtctldclient UpdateThrottlerConfig [--enable|--disable] [--threshold=] [--custom-query=] [--check-as-check-self|--check-as-check-shard] [--throttle-app=] [--throttle-app-ratio=] [--throttle-app-duration=] +vtctldclient UpdateThrottlerConfig [--enable|--disable] [--threshold=] [--custom-query=] [--check-as-check-self|--check-as-check-shard] [--throttle-app|unthrottle-app=] [--throttle-app-ratio=] [--throttle-app-duration=] ``` ### Options @@ -23,6 +23,7 @@ vtctldclient UpdateThrottlerConfig [--enable|--disable] [--threshold=] --throttle-app string an app name to throttle --throttle-app-duration duration duration after which throttled app rule expires (app specififed in --throttled-app) (default 1h0m0s) --throttle-app-ratio float ratio to throttle app (app specififed in --throttled-app) (default 1) + --unthrottle-app string expire any throttling rule for the given app ``` ### Options inherited from parent commands