-
Notifications
You must be signed in to change notification settings - Fork 208
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: multi-metrics throttler (#1786)
* Update tablet throttler docs: throttler multi metrics Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * Note about v20->v21 multi metrics Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * do not discuss SrvKeyspace Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * add 'shell' directive. Unify sh/shell Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * Update content/en/docs/21.0/reference/features/tablet-throttler.md Co-authored-by: Matt Lord <mattalord@gmail.com> Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * remove unrelated text Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * wording per review Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * remove '--heartbeat_enable' suggestion. Also, remove excessive note about not having to configure heartbeat Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * add links to GetKeyspace and UpdateThrottlerConfig Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * link to CheckThrottler Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * adding docs for CheckThrottler, updating docs for GetThrottlerStatus Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * add docs for GetMirrorRules Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * update docs for UpdateThrottlerConfig Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * update docs (sha) Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * Add docs for MoveTables mirrortrafic Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * Link to GetThrottlerStatus Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> * fix link + grammar Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> --------- Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com> Co-authored-by: Matt Lord <mattalord@gmail.com>
- Loading branch information
1 parent
43779e9
commit 4086e7d
Showing
157 changed files
with
982 additions
and
409 deletions.
There are no files selected for viewing
915 changes: 659 additions & 256 deletions
915
content/en/docs/21.0/reference/features/tablet-throttler.md
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
.../21.0/reference/programs/vtctldclient/vtctldclient_ApplyKeyspaceRoutingRules.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_Backup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
44 changes: 44 additions & 0 deletions
44
...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CheckThrottler.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
title: CheckThrottler | ||
series: vtctldclient | ||
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a | ||
--- | ||
## vtctldclient CheckThrottler | ||
|
||
Issue a throttler check on the given tablet. | ||
|
||
``` | ||
vtctldclient CheckThrottler [--app-name <name>] <tablet alias> | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
CheckThrottler --app-name online-ddl zone1-0000000101 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--app-name string app name to check (default "vitess") | ||
-h, --help help for CheckThrottler | ||
--ok-if-not-exists return OK even if metric does not exist | ||
--request-heartbeats request heartbeat lease | ||
--scope string check scope ('shard', 'self' or leave empty for per-metric defaults) | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--action_timeout duration timeout to use for the command (default 1h0m0s) | ||
--compact use compact format for otherwise verbose outputs | ||
--server string server to use for the connection (required) | ||
--topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global") | ||
--topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379]) | ||
--topo-implementation string the topology implementation to use (default "etcd2") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. | ||
|
2 changes: 1 addition & 1 deletion
2
...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteSrvVSchema.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ocs/21.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteMultiFetchAsDBA.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...cs/21.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...n/docs/21.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...nt/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetKeyspace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...cs/21.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaceRoutingRules.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaces.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.