Skip to content

Docs: UpdateThrottlerConfig --unthrottle-app #1539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shlomi-noach merged 4 commits into from
Jul 31, 2023
Merged

Docs: UpdateThrottlerConfig --unthrottle-app #1539

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
818a6c1
Docs: UpdateThrottlerConfig --unthrottle-app
shlomi-noach Jul 13, 2023
4e261fe
resolved conflict
shlomi-noach Jul 31, 2023
a1c8c7e
again resolve conflict
shlomi-noach Jul 31, 2023
1e5bacf
again resolve conflict, one last time
shlomi-noach Jul 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion content/en/docs/18.0/reference/features/tablet-throttler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/18.0/reference/programs/vtctl/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=<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](../vtctl/throttler#updatethrottlerconfig) | `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>`

## Options

Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/18.0/reference/programs/vtctl/throttler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Update tablet throttler configuration for all tablets of a given keyspace.

#### Usage

<pre class="command-example">UpdateThrottlerConfig -- [--enable|--disable] [--threshold=&lt;float64&gt;] [--custom-query=&lt;query&gt;] [--check-as-check-self|--check-as-check-shard] [--throttle-app=&lt;name&gt;] [--throttle-app-ratio=&lt;float, range [0..1]&gt;] [--throttle-app-duration=&lt;duration&gt;] &lt;keyspace&gt;</pre>
<pre class="command-example">UpdateThrottlerConfig -- [--enable|--disable] [--threshold=&lt;float64&gt;] [--custom-query=&lt;query&gt;] [--check-as-check-self|--check-as-check-shard] [--throttle-app|unthrottle-app=&lt;name&gt;] [--throttle-app-ratio=&lt;float, range [0..1]&gt;] [--throttle-app-duration=&lt;duration&gt;] &lt;keyspace&gt;</pre>

#### Examples

Expand All @@ -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

Expand Down
3 changes: 2 additions & 1 deletion ...docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=<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>
vtctldclient 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>

@mattlord mattlord Jul 17, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if you updated these by hand or not, but you can build the vtctldclient docs from source using the Makefile in the website repo. For example (skipping the Makefile and its env vars):

go run ./tools/vtctldclientdocs/ --vitess-dir "/Users/matt/git/vitess" --version-pairs "vtctldclient_movetables:18.0"

@shlomi-noach shlomi-noach Jul 18, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know that. Thanks!

```

### Options
Expand All @@ -23,6 +23,7 @@ vtctldclient UpdateThrottlerConfig [--enable|--disable] [--threshold=<float64>]
--throttle-app string set a specific throttling rule for the given app
--throttle-app-ratio float set a throttling ratio for app indicated by --throttle-app. 0 means not throttled, 1.0 means fully throttled.
--throttle-app-duration duration time limit after which throttling rule expires. Set as 0 to cancel an existing rule
--unthrottle-app string expire any throttling rule for the given app
```

### Options inherited from parent commands
Expand Down