[CASSANDRA-15399] Add ability to track state in repair

• Type: Improvement
• Status: Resolved
• Priority: Normal
• Resolution: Fixed
• Fix Version/s: 4.1-alpha1, 4.1
• Component/s: Consistency/Repair
• Labels: pull-request-available
• Change Category: Operability
• Complexity: Normal
• Platform: All

Source Control Link

https://github.com/apache/cassandra/commit/ffa1e9cf5a5646707da282460fe765d56fa78cb0

Test and Documentation Plan

tests

• Assignee: David Capwell
• Reporter: David Capwell

Authors

David Capwell

Reviewers

Zhao Yang

• Created: 05/Nov/19 23:41
• Updated: 17/Jun/22 07:46
• Resolved: 01/Apr/22 17:12

Description

To enhance the visibility in repair, we should expose internal state via virtual tables; the state should include coordinator as well as participant state (validation, sync, etc.)

I propose the following tables:

repairs - high level summary of the global state of repair; this should be called on the coordinator.

CREATE TABLE repairs (
  id uuid,
  keyspace_name text,
  table_names frozen<list<text>>,
  ranges frozen<list<text>>,
  coordinator text,
  participants frozen<list<text>>,

  state text,
  progress_percentage float,
  last_updated_at_millis bigint,
  duration_micro bigint,
  failure_cause text,

  PRIMARY KEY ( (id) )
)

repair_tasks - represents RepairJob and participants state. This will show if validations are running on participants and the progress they are making; this should be called on the coordinator.

CREATE TABLE repair_tasks (
  id uuid,
  session_id uuid,
  keyspace_name text,
  table_name text,
  ranges frozen<list<text>>,
  coordinator text,
  participant text,

  state text,
  state_description text,
  progress_percentage float, -- between 0.0 and 100.0
  last_updated_at_millis bigint,
  duration_micro bigint,
  failure_cause text,

  PRIMARY KEY ( (id), session_id, table_name, participant )
)

repair_validations - shows the state of the validation task and updated periodically while validation is running; this should be called on the participants.

CREATE TABLE repair_validations (
  id uuid,
  session_id uuid,
  ranges frozen<list<text>>,
  keyspace_name text,
  table_name text,
  initiator text,
  state text,
  progress_percentage float,
  queue_duration_ms bigint,
  runtime_duration_ms bigint,
  total_duration_ms bigint,
  estimated_partitions bigint,
  partitions_processed bigint,
  estimated_total_bytes bigint,
  failure_cause text,

  PRIMARY KEY ( (id), session_id, table_name )
)

The main reason for exposing virtual tables rather than exposing through durable tables is to make sure what is exposed is accurate. In cases of write failures or node failures, the durable tables could become in-accurate and could add edge cases where the repair is not running but the tables say it is; by relying on repair's internal in-memory bookkeeping, these problems go away.

This jira does not try to solve the following:
1) repair resiliency - there are edge cases where repair hits an error and runs forever (at least from nodetool's perspective).
2) repair stream tracking - I have not learned the streaming side yet and what I see is multiple implementations exist, so seems like high scope. My hope is to punt from this jira and tackle separately.

Issue Links

• is related to: CASSANDRA-15566 Repair coordinator can hang under some cases
• relates to: CASSANDRA-16909 ☂ Medium Term Repair Improvements
• relates to: CASSANDRA-14453 Improve visibility into repair state
• links to: CI: trunk
• links to: GH PR: trunk (attempt 2)
• links to: GitHub Pull Request #380