kvflowcontrol: add inspectz pages for replication ac v2 #128091

kvoli · 2024-08-01T15:14:27Z

There are existing inspectz structures in place for querying replication admission control. This issue is to extend, or add new structure such that the v2 implementation supports the same functionality.

See https://github.com/sumeerbhola/cockroach/blob/5c2a50ec4d0dcf2502d742ac9036d39995886abc/pkg/kv/kvserver/kvflowcontrol/kvflowinspectpb/kvflowinspect.proto#L21 for v1.

Jira issue: CRDB-40795

Epic CRDB-37515

The `kvflowinspectpb.Stream` represents a replication stream state and is used in tests and `inspectz` related observability. `kvflowinspectpb.Stream` used to contain two available token fields, broken into work class. As rac2 is being added, two additional token fields are required, accounting for send tokens. Rename the existing fields with `Eval` added and introduce two more fields, mirroring the existing ones as `Send`. Part of: cockroachdb#128091 Release note: None

Implement `Inspect` methods on the `RangeController`, `TokenTracker` and `StreamTokenCounterProvider`. These methods will be used to power the `inspectz` endpoint (mostly unused) and `crdb_internal` tables (primarily testing). `RangeController.Inspect` returns a `kvflowinspectpb.Handle`, identical to the `Handle` abstraction in v1, containing all streams and their token deductions/state. `TokenTracker.Inspect` returns the tracked deduction.s `StreamTokenCounterProvider.Inspect` returns the token state of all streams, where `StreamTokenCounterProvider.InspectStream` returns the token state of the given stream. Part of: cockroachdb#128091 Release note: None

The previous patch introduced `Inspect` methods mapping to `Handle`, `ConnectedStream`, `TrackedDeduction` and `Stream`. Extract the `Inspect` methods into their own interfaces which are implemented by rac2. The methods are then hooked into `storesForRAC2`, which can be accessed in a similar manner to the v1 methods. Part of: cockroachdb#128091 Release note: None

Rename the existing `inspectz/(kvflowhandles|kvflowcontroller)` endpoint to `inspectz/v1/(kvflowhandles|kvflowcontroller)`, and introduce the v2 endpoint serving the same types, `inspectz/v2/(kvflowhandles|kvflowcontroller)`. Note that these endpoints are not used internally in any webpages or testing and are not relied upon. Internal tables call `KVFlowHandles(V1)` or `KVFlowController(V1)` directly to populate themselves. Part of: cockroachdb#128091 Release note: None

The existing flow control tables are: ``` crdb_internal.kv_flow_controller crdb_internal.kv_flow_control_handles crdb_internal.kv_flow_token_deductions ``` Which are used in testing to assert on flow control stream state and transitions. Introduce another set of three tables, most of which are identical to the exsting tables but populating the table data using rac2. ``` crdb_internal.kv_flow_controller_v2 crdb_internal.kv_flow_control_handles_v2 crdb_internal.kv_flow_token_deductions_v2 ``` `crdb_internal.kv_flow_controller_v2` has two additional columns, tracking the amount of available (regular|elastic) send tokens. The schema is: ``` CREATE TABLE crdb_internal.kv_flow_controller_v2 ( tenant_id INT NOT NULL, store_id INT NOT NULL, available_eval_regular_tokens INT NOT NULL, available_eval_elastic_tokens INT NOT NULL, available_send_regular_tokens INT NOT NULL, available_send_elastic_tokens INT NOT NULL ); ``` Note that unless rac2 is enabled, the tables are unlikely to show anything interesting. Both tables (v1 and v2) are kept for compatibility, with an intent to replace the v1 tables with the v2 ones after v1 replication flow control is removed entirely from the code. Resolves: cockroachdb#128091 Release note: None

The `kvflowinspectpb.Stream` represents a replication stream state and is used in tests and `inspectz` related observability. `kvflowinspectpb.Stream` used to contain two available token fields, broken into work class. As rac2 is being added, two additional token fields are required, accounting for send tokens. Rename the existing fields with `Eval` added and introduce two more fields, mirroring the existing ones as `Send`. Part of: cockroachdb#128091 Release note: None

Implement `Inspect` methods on the `RangeController`, `TokenTracker` and `StreamTokenCounterProvider`. These methods will be used to power the `inspectz` endpoint (mostly unused) and `crdb_internal` tables (primarily testing). `RangeController.Inspect` returns a `kvflowinspectpb.Handle`, identical to the `Handle` abstraction in v1, containing all streams and their token deductions/state. `TokenTracker.Inspect` returns the tracked deductions. `StreamTokenCounterProvider.Inspect` returns the token state of all streams, where `StreamTokenCounterProvider.InspectStream` returns the token state of the given stream. Part of: cockroachdb#128091 Release note: None

The previous patch introduced `Inspect` methods mapping to `Handle`, `ConnectedStream`, `TrackedDeduction` and `Stream`. Extract the `Inspect` methods into their own interfaces which are implemented by rac2. The methods are then hooked into `storesForRAC2`, which can be accessed in a similar manner to the v1 methods. Part of: cockroachdb#128091 Release note: None

Rename the existing `inspectz/(kvflowhandles|kvflowcontroller)` endpoint to `inspectz/v1/(kvflowhandles|kvflowcontroller)`, and introduce the v2 endpoint serving the same types, `inspectz/v2/(kvflowhandles|kvflowcontroller)`. Note that these endpoints are not used internally in any webpages or testing and are not relied upon. Internal tables call `KVFlowHandles(V1)` or `KVFlowController(V1)` directly to populate themselves. Part of: cockroachdb#128091 Release note: None

The existing flow control tables are: ``` crdb_internal.kv_flow_controller crdb_internal.kv_flow_control_handles crdb_internal.kv_flow_token_deductions ``` Which are used in testing to assert on flow control stream state and transitions. Introduce another set of three tables, most of which are identical to the existing tables but populating the table data using rac2. ``` crdb_internal.kv_flow_controller_v2 crdb_internal.kv_flow_control_handles_v2 crdb_internal.kv_flow_token_deductions_v2 ``` `crdb_internal.kv_flow_controller_v2` has two additional columns, tracking the amount of available (regular|elastic) send tokens. The schema is: ``` CREATE TABLE crdb_internal.kv_flow_controller_v2 ( tenant_id INT NOT NULL, store_id INT NOT NULL, available_eval_regular_tokens INT NOT NULL, available_eval_elastic_tokens INT NOT NULL, available_send_regular_tokens INT NOT NULL, available_send_elastic_tokens INT NOT NULL ); ``` Note that unless rac2 is enabled, the tables are unlikely to show anything interesting. Both tables (v1 and v2) are kept for compatibility, with an intent to replace the v1 tables with the v2 ones after v1 replication flow control is removed entirely from the code. Resolves: cockroachdb#128091 Release note: None

The previous patch introduced `Inspect` methods mapping to `Handle`, `ConnectedStream`, `TrackedDeduction` and `Stream`. Extract the `Inspect` methods into their own interfaces which are implemented by rac2. The methods are then hooked into `storesForRAC2`, which can be accessed in a similar manner to the v1 methods. Part of: cockroachdb#128091 Release note: None

Rename the existing `inspectz/(kvflowhandles|kvflowcontroller)` endpoint to `inspectz/v1/(kvflowhandles|kvflowcontroller)`, and introduce the v2 endpoint serving the same types, `inspectz/v2/(kvflowhandles|kvflowcontroller)`. Note that these endpoints are not used internally in any webpages or testing and are not relied upon. Internal tables call `KVFlowHandles(V1)` or `KVFlowController(V1)` directly to populate themselves. Part of: cockroachdb#128091 Release note: None

The existing flow control tables are: ``` crdb_internal.kv_flow_controller crdb_internal.kv_flow_control_handles crdb_internal.kv_flow_token_deductions ``` Which are used in testing to assert on flow control stream state and transitions. Introduce another set of three tables, most of which are identical to the existing tables but populating the table data using rac2. ``` crdb_internal.kv_flow_controller_v2 crdb_internal.kv_flow_control_handles_v2 crdb_internal.kv_flow_token_deductions_v2 ``` `crdb_internal.kv_flow_controller_v2` has two additional columns, tracking the amount of available (regular|elastic) send tokens. The schema is: ``` CREATE TABLE crdb_internal.kv_flow_controller_v2 ( tenant_id INT NOT NULL, store_id INT NOT NULL, available_eval_regular_tokens INT NOT NULL, available_eval_elastic_tokens INT NOT NULL, available_send_regular_tokens INT NOT NULL, available_send_elastic_tokens INT NOT NULL ); ``` Note that unless rac2 is enabled, the tables are unlikely to show anything interesting. Both tables (v1 and v2) are kept for compatibility, with an intent to replace the v1 tables with the v2 ones after v1 replication flow control is removed entirely from the code. Resolves: cockroachdb#128091 Release note: None

The `kvflowinspectpb.Stream` represents a replication stream state and is used in tests and `inspectz` related observability. `kvflowinspectpb.Stream` used to contain two available token fields, broken into work class. As rac2 is being added, two additional token fields are required, accounting for send tokens. Rename the existing fields with `Eval` added and introduce two more fields, mirroring the existing ones as `Send`. Part of: cockroachdb#128091 Release note: None

Implement `Inspect` methods on the `RangeController`, `TokenTracker` and `StreamTokenCounterProvider`. These methods will be used to power the `inspectz` endpoint (mostly unused) and `crdb_internal` tables (primarily testing). `RangeController.Inspect` returns a `kvflowinspectpb.Handle`, identical to the `Handle` abstraction in v1, containing all streams and their token deductions/state. `TokenTracker.Inspect` returns the tracked deductions. `StreamTokenCounterProvider.Inspect` returns the token state of all streams, where `StreamTokenCounterProvider.InspectStream` returns the token state of the given stream. Part of: cockroachdb#128091 Release note: None

The previous patch introduced `Inspect` methods mapping to `Handle`, `ConnectedStream`, `TrackedDeduction` and `Stream`. Extract the `Inspect` methods into their own interfaces which are implemented by rac2. The methods are then hooked into `storesForRAC2`, which can be accessed in a similar manner to the v1 methods. Part of: cockroachdb#128091 Release note: None

Rename the existing `inspectz/(kvflowhandles|kvflowcontroller)` endpoint to `inspectz/v1/(kvflowhandles|kvflowcontroller)`, and introduce the v2 endpoint serving the same types, `inspectz/v2/(kvflowhandles|kvflowcontroller)`. Note that these endpoints are not used internally in any webpages or testing and are not relied upon. Internal tables call `KVFlowHandles(V1)` or `KVFlowController(V1)` directly to populate themselves. Part of: cockroachdb#128091 Release note: None

130270: kvserver,inspectz: add rac2 inspectz support r=sumeerbhola a=kvoli The existing flow control tables are: ``` crdb_internal.kv_flow_controller crdb_internal.kv_flow_control_handles crdb_internal.kv_flow_token_deductions ``` Which are used in testing to assert on flow control stream state and transitions. Introduce another set of three tables, most of which are identical to the exsting tables but populating the table data using rac2. ``` crdb_internal.kv_flow_controller_v2 crdb_internal.kv_flow_control_handles_v2 crdb_internal.kv_flow_token_deductions_v2 ``` `crdb_internal.kv_flow_controller_v2` has two additional columns, tracking the amount of available (regular|elastic) send tokens. The schema is: ``` CREATE TABLE crdb_internal.kv_flow_controller_v2 ( tenant_id INT NOT NULL, store_id INT NOT NULL, available_eval_regular_tokens INT NOT NULL, available_eval_elastic_tokens INT NOT NULL, available_send_regular_tokens INT NOT NULL, available_send_elastic_tokens INT NOT NULL ); ``` Note that unless rac2 is enabled, the tables are unlikely to show anything interesting. Both tables (v1 and v2) are kept for compatibility, with an intent to replace the v1 tables with the v2 ones after v1 replication flow control is removed entirely from the code. Resolves: #128091 Release note: None Co-authored-by: Austen McClernon <[email protected]>

130270: kvserver,inspectz: add rac2 inspectz support r=sumeerbhola a=kvoli The existing flow control tables are: ``` crdb_internal.kv_flow_controller crdb_internal.kv_flow_control_handles crdb_internal.kv_flow_token_deductions ``` Which are used in testing to assert on flow control stream state and transitions. Introduce another set of three tables, most of which are identical to the exsting tables but populating the table data using rac2. ``` crdb_internal.kv_flow_controller_v2 crdb_internal.kv_flow_control_handles_v2 crdb_internal.kv_flow_token_deductions_v2 ``` `crdb_internal.kv_flow_controller_v2` has two additional columns, tracking the amount of available (regular|elastic) send tokens. The schema is: ``` CREATE TABLE crdb_internal.kv_flow_controller_v2 ( tenant_id INT NOT NULL, store_id INT NOT NULL, available_eval_regular_tokens INT NOT NULL, available_eval_elastic_tokens INT NOT NULL, available_send_regular_tokens INT NOT NULL, available_send_elastic_tokens INT NOT NULL ); ``` Note that unless rac2 is enabled, the tables are unlikely to show anything interesting. Both tables (v1 and v2) are kept for compatibility, with an intent to replace the v1 tables with the v2 ones after v1 replication flow control is removed entirely from the code. Resolves: cockroachdb#128091 Release note: None Co-authored-by: Austen McClernon <[email protected]>

kvoli added C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) A-replication-admission-control-v2 Related to introduction of replication AC v2 labels Aug 1, 2024

blathers-crl bot added the T-kv KV Team label Aug 1, 2024

kvoli mentioned this issue Aug 13, 2024

admission,replication: replication admission control for regular work #123509

Open

26 tasks

github-project-automation bot added this to KV Aug 28, 2024

github-project-automation bot moved this to Incoming in KV Aug 28, 2024

kvoli mentioned this issue Sep 5, 2024

kvserver: port existing rac v1 integration unit tests to v2 #130187

Closed

kvoli mentioned this issue Sep 6, 2024

kvserver,inspectz: add rac2 inspectz support #130270

Merged

kvoli self-assigned this Sep 6, 2024

craig bot closed this as completed in c0a5058 Sep 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

kvflowcontrol: add inspectz pages for replication ac v2 #128091

kvflowcontrol: add inspectz pages for replication ac v2 #128091

kvoli commented Aug 1, 2024 •

edited by exalate-issue-sync bot

Loading

kvflowcontrol: add inspectz pages for replication ac v2 #128091

kvflowcontrol: add inspectz pages for replication ac v2 #128091

Comments

kvoli commented Aug 1, 2024 • edited by exalate-issue-sync bot Loading

kvoli commented Aug 1, 2024 •

edited by exalate-issue-sync bot

Loading