vtctl Resharding Throttler Command Reference
The following vtctl commands are available for administering Resharding Throttler.
Commands #
ThrottlerMaxRates #
Returns the current max rate of all active resharding throttlers on the server.
Example #
ThrottlerMaxRates -server <vtworker or vttablet>
Flags #
| Name | Type | Definition |
|---|---|---|
| server | string | vtworker or vttablet to connect to |
Arguments #
<vtworker or vttablet>– Required.
Errors #
- the ThrottlerSetMaxRate command does not accept any positional parameters This error occurs if the command is not called with exactly 0 arguments.
- error creating a throttler client for
<server>‘%v’: %v - failed to get the throttler rate from
<server>‘%v’: %v
ThrottlerSetMaxRate #
Sets the max rate for all active resharding throttlers on the server.
Example #
ThrottlerSetMaxRate -server <vtworker or vttablet> <rate>
Flags #
| Name | Type | Definition |
|---|---|---|
| server | string | vtworker or vttablet to connect to |
Arguments #
<vtworker or vttablet>– Required.<rate>– Required.
Errors #
- the
<rate>argument is required for the<ThrottlerSetMaxRate>command This error occurs if the command is not called with exactly one argument. - failed to parse rate ‘%v’ as integer value: %v
- error creating a throttler client for
<server>‘%v’: %v - failed to set the throttler rate on
<server>‘%v’: %v
GetThrottlerConfiguration #
Returns the current configuration of the MaxReplicationLag module. If no throttler name is specified, the configuration of all throttlers will be returned.
Example #
GetThrottlerConfiguration -server <vtworker or vttablet> [<throttler name>]
Flags #
| Name | Type | Definition |
|---|---|---|
| server | string | vtworker or vttablet to connect to |
Arguments #
<vtworker or vttablet>– Required.<throttler name>– Optional.
Errors #
- the
<GetThrottlerConfiguration>command accepts only<throttler name>as optional positional parameter This error occurs if the command is not called with more than 1 arguments. - error creating a throttler client for
<server>‘%v’: %v - failed to get the throttler configuration from
<server>‘%v’: %v
UpdateThrottlerConfiguration #
Updates the configuration of the MaxReplicationLag module. The configuration must be specified as protobuf text. If a field is omitted or has a zero value, it will be ignored unless -copy_zero_values is specified. If no throttler name is specified, all throttlers will be updated.
Example #
UpdateThrottlerConfiguration `-server <vtworker or vttablet> [-copy_zero_values] "<configuration protobuf text>" [<throttler name>]`
Flags #
| Name | Type | Definition |
|---|---|---|
| copy_zero_values | Boolean | If true, fields with zero values will be copied as well |
| server | string | vtworker or vttablet to connect to |
Arguments #
<vtworker or vttablet>– Required.<throttler name>– Optional.
Errors #
- Failed to unmarshal the configuration protobuf text (%v) into a protobuf instance: %v
- error creating a throttler client for
<server>‘%v’: %v - failed to update the throttler configuration on
<server>‘%v’: %v
ResetThrottlerConfiguration #
Resets the current configuration of the MaxReplicationLag module. If no throttler name is specified, the configuration of all throttlers will be reset.
Example #
ResetThrottlerConfiguration -server <vtworker or vttablet> [<throttler name>]
Flags #
| Name | Type | Definition |
|---|---|---|
| server | string | vtworker or vttablet to connect to |
Arguments #
<vtworker or vttablet>– Required.<throttler name>– Optional.
Errors #
- the
<ResetThrottlerConfiguration>command accepts only<throttler name>as optional positional parameter This error occurs if the command is not called with more than 1 arguments. - error creating a throttler client for
<server>‘%v’: %v - failed to get the throttler configuration from
<server>‘%v’: %v