Skip to content

Commit

Permalink
Docs: multi-metrics throttler (#1786)
Browse files Browse the repository at this point in the history
* 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
shlomi-noach and mattlord authored Jul 15, 2024
1 parent 43779e9 commit 4086e7d
Show file tree
Hide file tree
Showing 157 changed files with 982 additions and 409 deletions.
915 changes: 659 additions & 256 deletions content/en/docs/21.0/reference/features/tablet-throttler.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtctldclient
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient

Expand Down Expand Up @@ -43,6 +43,7 @@ vtctldclient [flags]
* [vtctldclient Backup](./vtctldclient_backup/) - Uses the BackupStorage service on the given tablet to create and store a new backup.
* [vtctldclient BackupShard](./vtctldclient_backupshard/) - Finds the most up-to-date REPLICA, RDONLY, or SPARE tablet in the given shard and uses the BackupStorage service on that tablet to create and store a new backup.
* [vtctldclient ChangeTabletType](./vtctldclient_changetablettype/) - Changes the db type for the specified tablet, if possible.
* [vtctldclient CheckThrottler](./vtctldclient_checkthrottler/) - Issue a throttler check on the given tablet.
* [vtctldclient CreateKeyspace](./vtctldclient_createkeyspace/) - Creates the specified keyspace in the topology.
* [vtctldclient CreateShard](./vtctldclient_createshard/) - Creates the specified shard in the topology.
* [vtctldclient DeleteCellInfo](./vtctldclient_deletecellinfo/) - Deletes the CellInfo for the provided cell.
Expand All @@ -66,6 +67,7 @@ vtctldclient [flags]
* [vtctldclient GetKeyspace](./vtctldclient_getkeyspace/) - Returns information about the given keyspace from the topology.
* [vtctldclient GetKeyspaceRoutingRules](./vtctldclient_getkeyspaceroutingrules/) - Displays the currently active keyspace routing rules.
* [vtctldclient GetKeyspaces](./vtctldclient_getkeyspaces/) - Returns information about every keyspace in the topology.
* [vtctldclient GetMirrorRules](./vtctldclient_getmirrorrules/) - Displays the VSchema mirror rules.
* [vtctldclient GetPermissions](./vtctldclient_getpermissions/) - Displays the permissions for a tablet.
* [vtctldclient GetRoutingRules](./vtctldclient_getroutingrules/) - Displays the VSchema routing rules.
* [vtctldclient GetSchema](./vtctldclient_getschema/) - Displays the full schema for a tablet, optionally restricted to the specified tables/views.
Expand All @@ -79,6 +81,7 @@ vtctldclient [flags]
* [vtctldclient GetTablet](./vtctldclient_gettablet/) - Outputs a JSON structure that contains information about the tablet.
* [vtctldclient GetTabletVersion](./vtctldclient_gettabletversion/) - Print the version of a tablet from its debug vars.
* [vtctldclient GetTablets](./vtctldclient_gettablets/) - Looks up tablets according to filter criteria.
* [vtctldclient GetThrottlerStatus](./vtctldclient_getthrottlerstatus/) - Get the throttler status for the given tablet.
* [vtctldclient GetTopologyPath](./vtctldclient_gettopologypath/) - Gets the value associated with the particular path (key) in the topology server.
* [vtctldclient GetVSchema](./vtctldclient_getvschema/) - Prints a JSON representation of a keyspace's topo record.
* [vtctldclient GetWorkflows](./vtctldclient_getworkflows/) - Gets all vreplication workflows (Reshard, MoveTables, etc) in the given keyspace.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellInfo
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient AddCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellsAlias
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient AddCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyKeyspaceRoutingRules
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ApplyKeyspaceRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyRoutingRules
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ApplyRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplySchema
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ApplySchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyShardRoutingRules
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ApplyShardRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyVSchema
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ApplyVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Backup
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient Backup

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: BackupShard
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient BackupShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ChangeTabletType
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ChangeTabletType

Expand Down
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.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateKeyspace
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient CreateKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateShard
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient CreateShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellInfo
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient DeleteCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellsAlias
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient DeleteCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteKeyspace
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient DeleteKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteShards
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient DeleteShards

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteSrvVSchema
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient DeleteSrvVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteTablets
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient DeleteTablets

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: EmergencyReparentShard
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient EmergencyReparentShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsApp
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ExecuteFetchAsApp

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsDBA
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ExecuteFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteHook
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ExecuteHook

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteMultiFetchAsDBA
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient ExecuteMultiFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: FindAllShardsInKeyspace
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient FindAllShardsInKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GenerateShardRanges
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient GenerateShardRanges

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetBackups
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient GetBackups

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfo
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient GetCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfoNames
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient GetCellInfoNames

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellsAliases
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient GetCellsAliases

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetFullStatus
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient GetFullStatus

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspace
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient GetKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspaceRoutingRules
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient GetKeyspaceRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspaces
series: vtctldclient
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
commit: cd0c2b594b2d5178a9c8ac081eaee7d1b7eef28a
---
## vtctldclient GetKeyspaces

Expand Down
Loading

0 comments on commit 4086e7d

Please sign in to comment.