package resource_manager

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc AcquireTokenBuckets (stream TokenBucketsRequest, stream TokenBucketsResponse)

  resource_manager.proto:27

  message TokenBucketsRequest

  resource_manager.proto:94

  • repeated TokenBucketRequest requests = 1

  • uint64 target_request_period_ms = 2

  • uint64 client_unique_id = 3

  message TokenBucketsResponse

  resource_manager.proto:128

  • optional Error error = 1

  • repeated TokenBucketResponse responses = 2

• rpc AddResourceGroup (PutResourceGroupRequest, PutResourceGroupResponse)

  resource_manager.proto:21

• rpc DeleteResourceGroup (DeleteResourceGroupRequest, DeleteResourceGroupResponse)

  resource_manager.proto:25

  message DeleteResourceGroupRequest

  resource_manager.proto:71

  • string resource_group_name = 1

  • optional KeyspaceIDValue keyspace_id = 2

    There're two cases for this field: - If the keyspace is not set, it means this may be a message from an older version. To maintain compatibility, we will treat it as a null keyspace ID, which is uint32.Max. - If the keyspace is set, it will try to delete the resource group within the given keyspace.

  message DeleteResourceGroupResponse

  resource_manager.proto:80

  • optional Error error = 1

  • string body = 2

• rpc GetResourceGroup (GetResourceGroupRequest, GetResourceGroupResponse)

  resource_manager.proto:19

  message GetResourceGroupRequest

  resource_manager.proto:56

  • string resource_group_name = 1

  • bool with_ru_stats = 2

  • optional KeyspaceIDValue keyspace_id = 3

    There're two cases for this field: - If the keyspace is not set, it means this may be a message from an older version. To maintain compatibility, we will treat it as a null keyspace ID, which is uint32.Max. - If the keyspace is set, it will try to get the resource group within the given keyspace.

  message GetResourceGroupResponse

  resource_manager.proto:66

  • optional Error error = 1

  • optional ResourceGroup group = 2

• rpc ListResourceGroups (ListResourceGroupsRequest, ListResourceGroupsResponse)

  resource_manager.proto:17

  message ListResourceGroupsRequest

  resource_manager.proto:42

  • bool with_ru_stats = 1

  • optional KeyspaceIDValue keyspace_id = 2

    There're two cases for this field: - If the keyspace is not set, it means this may be a message from an older version. To maintain compatibility, we will treat it as a null keyspace ID, which is uint32.Max. - If the keyspace is set, the listed resource groups will be filtered by the given keyspace.

  message ListResourceGroupsResponse

  resource_manager.proto:51

  • optional Error error = 1

  • repeated ResourceGroup groups = 2

• rpc ModifyResourceGroup (PutResourceGroupRequest, PutResourceGroupResponse)

  resource_manager.proto:23

Used in: ResourceGroup

• repeated string job_types = 1

  background task types.

• uint64 utilization_limit = 2

  the percentage limit of total resource(cpu/io) that background tasks can use.

Used in: kvrpcpb.ResourceControlContext, ResourceGroup, TokenBucketRequest

• double r_r_u = 1

• double w_r_u = 2

• double read_bytes = 3

• double write_bytes = 4

• double total_cpu_time_ms = 5

• double sql_layer_cpu_time_ms = 6

• double kv_read_rpc_count = 7

• double kv_write_rpc_count = 8

• uint64 read_cross_az_traffic_bytes = 9

• uint64 write_cross_az_traffic_bytes = 10

• double tikv_r_u_v2 = 11

  RUv2 is an experimental v2 RU calculation. For now it only records the consumption without actual token deduction.

• double tidb_r_u_v2 = 12

• double tiflash_r_u_v2 = 13

  tiflash_r_u_v2 equals tiflash RRU + tiflash WRU.

Used in: DeleteResourceGroupResponse, GetResourceGroupResponse, ListResourceGroupsResponse, PutResourceGroupResponse, TokenBucketsResponse

• string message = 1

Used in: TokenBucketResponse

• RequestUnitType type = 1

• optional TokenBucket granted_tokens = 2

• int64 trickle_time_ms = 3

Used in: TokenBucketResponse

• RawResourceType type = 1

• optional TokenBucket granted_tokens = 2

• int64 trickle_time_ms = 3

Used in: ResourceGroup

• Unknown = 0

• RUMode = 1

• RawMode = 2

Used in: ResourceGroup

• optional TokenBucket cpu = 1

• optional TokenBucket io_read = 2

• optional TokenBucket io_write = 3

Used in: ResourceGroup

• optional TokenBucket r_u = 1

KeyspaceIDValue carries the versioned identity of a keyspace. The message name is retained for compatibility with existing ResourceManager APIs.

Used in: DeleteResourceGroupRequest, GetResourceGroupRequest, ListResourceGroupsRequest, ResourceGroup, TokenBucketRequest, TokenBucketResponse

• oneof keyspace

  • uint32 value = 1

    V1/V2 compatibility keyspace ID. The wrapper distinguishes a valid zero value from an unset keyspace, which represents the null keyspace ID.

  • apipb.KeyspaceIdentity keyspace_identity = 2

    V3 keyspace identity.

• string name = 1

  name is the unique name of the resource manager participant.

• uint64 id = 2

  id is the unique id of the resource manager participant.

• repeated string listen_urls = 3

  listen_urls is the serivce endpoint list in the url format. listen_urls[0] is primary service endpoint.

Used as request type in: ResourceManager.AddResourceGroup, ResourceManager.ModifyResourceGroup

• optional ResourceGroup group = 1

Used as response type in: ResourceManager.AddResourceGroup, ResourceManager.ModifyResourceGroup

• optional Error error = 1

• string body = 2

Used in: TokenBucketRequest.RequestRawResource

• RawResourceType type = 1

• double value = 2

Used in: GrantedRawResourceTokenBucket, RawResourceItem

• CPU = 0

• IOReadFlow = 1

• IOWriteFlow = 2

Used in: TokenBucketRequest.RequestRU

• RequestUnitType type = 1

• double value = 2

Used in: GrantedRUTokenBucket, RequestUnitItem

• RU = 0

ResourceGroup the settings definitions.

Used in: GetResourceGroupResponse, ListResourceGroupsResponse, PutResourceGroupRequest

• string name = 1

• GroupMode mode = 2

• optional GroupRequestUnitSettings r_u_settings = 3

  Used in RU mode, group settings with WRU/RRU etc resource abstract unit.

• optional GroupRawResourceSettings raw_resource_settings = 4

  Used in Raw mode, group settings with CPU/IO etc resource unit.

• uint32 priority = 5

  The task scheduling priority

• optional RunawaySettings runaway_settings = 6

  Runaway queries settings

• optional BackgroundSettings background_settings = 7

  Background task control settings.

• optional Consumption RUStats = 8

  RU consumption statistics.

• optional KeyspaceIDValue keyspace_id = 9

  The keyspace that the resource group belongs to. There're two cases for this field: - If the keyspace is not set, it means this may be a message from an older version. To maintain compatibility, we will treat it as a null keyspace ID, which is uint32.Max. - If the keyspace is set, it will directly be used.

Used in: RunawaySettings

• NoneAction = 0

• DryRun = 1

  do nothing

• CoolDown = 2

  deprioritize the task

• Kill = 3

  kill the task

• SwitchGroup = 4

  switch the task to another group

Used in: RunawaySettings

• uint64 exec_elapsed_time_ms = 1

• int64 processed_keys = 2

• int64 request_unit = 3

Used in: ResourceGroup

• optional RunawayRule rule = 1

• RunawayAction action = 2

• optional RunawayWatch watch = 3

• string switch_group_name = 4

  When the runaway action is `SwitchGroup`, this field will be used to indicate which group to switch.

Used in: RunawaySettings

• int64 lasting_duration_ms = 1

  how long would the watch last

• RunawayWatchType type = 2

Used in: RunawayWatch

• NoneWatch = 0

• Exact = 1

• Similar = 2

• Plan = 3

Used in: GrantedRUTokenBucket, GrantedRawResourceTokenBucket, GroupRawResourceSettings, GroupRequestUnitSettings

• optional TokenLimitSettings settings = 1

• double tokens = 2

  Once used to reconfigure, the tokens is delta tokens.

Used in: TokenBucketsRequest

• string resource_group_name = 1

• oneof request

  • TokenBucketRequest.RequestRU ru_items = 2

    RU mode, group settings with WRU/RRU etc resource abstract unit.

  • TokenBucketRequest.RequestRawResource raw_resource_items = 3

    Raw mode, group settings with CPU/IO etc resource unit.

• optional Consumption consumption_since_last_request = 4

  Aggregate statistics in group level.

• bool is_background = 5

  label background request.

• bool is_tiflash = 6

• optional KeyspaceIDValue keyspace_id = 7

  There're two cases for this field: - If the keyspace is not set, it means this may be a message from an older version. To maintain compatibility, we will treat it as a null keyspace ID, which is uint32.Max. - If the keyspace is set, it will try to request the token bucket from the resource group within the given keyspace.

Used in: TokenBucketRequest

• repeated RequestUnitItem request_r_u = 1

Used in: TokenBucketRequest

• repeated RawResourceItem request_raw_resource = 1

Used in: TokenBucketsResponse

• string resource_group_name = 1

• repeated GrantedRUTokenBucket granted_r_u_tokens = 2

  RU mode

• repeated GrantedRawResourceTokenBucket granted_resource_tokens = 3

  Raw mode

• optional KeyspaceIDValue keyspace_id = 4

  There're two cases for this field: - If the keyspace is not set, it means this may be a message from an older version, which can be safely ignored to keep compatibility. - If the keyspace is set, it means this response is from the resource group within this keyspace.

Used in: TokenBucket

• uint64 fill_rate = 1

• int64 burst_limit = 2

• double max_tokens = 3