[NET-3865] [Supportability] Additional Information in the output of 'consul operator raft list-peers'

.changelog/17582.txt

@@ -0,0 +1,5 @@
+```release-note:feature
+improved consul operator raft list-peers command added CommitIndex as well as Trails Leader By in the output table
+Commit Index is the LastIndex from /v1/operator/autopilot/health and Trails Leader By is the difference from leader
+last index and followers last index
+```

api/operator_raft.go

@@ -122,3 +122,20 @@ func (op *Operator) RaftRemovePeerByID(id string, q *WriteOptions) error {
 	}
 	return nil
 }
+
+// GetAutoPilotHealth is used to query the autopilot health.
+func (op *Operator) GetAutoPilotHealth(q *QueryOptions) (*OperatorHealthReply, error) {
+	r := op.c.newRequest("GET", "/v1/operator/autopilot/health")
+	r.setQueryOptions(q)
+	_, resp, err := op.c.doRequest(r)
+	if err != nil {
+		return nil, err
+	}
+	defer closeResponseBody(resp)
+
+	var out OperatorHealthReply
+	if err := decodeBody(resp, &out); err != nil {
+		return nil, err
+	}
+	return &out, nil
+}

api/operator_raft_test.go

@@ -57,3 +57,22 @@ func TestAPI_OperatorRaftLeaderTransfer(t *testing.T) {
 		t.Fatalf("err:%v", transfer)
 	}
 }
+
+func TestAPI_GetAutoPilotHealth(t *testing.T) {
+	t.Parallel()
+	c, s := makeClient(t)
+	defer s.Stop()
+
+	operator := c.Operator()
+	out, err := operator.GetAutoPilotHealth(nil)
+	if err != nil {
+		t.Fatalf("err: %v", err)
+	}
+
+	if len(out.Servers) != 1 ||
+		!out.Servers[0].Leader ||
+		!out.Servers[0].Voter ||
+		out.Servers[0].LastIndex <= 0 {
+		t.Fatalf("bad: %v", out)
+	}
+}

command/operator/raft/listpeers/operator_raft_list.go

@@ -70,8 +70,29 @@ func raftListPeers(client *api.Client, stale bool) (string, error) {
 		return "", fmt.Errorf("Failed to retrieve raft configuration: %v", err)
 	}
 
+	autoPilotReply, err := client.Operator().GetAutoPilotHealth(q)
+	if err != nil {
+		return "", fmt.Errorf("Failed to retrieve autopilot health: %v", err)
+	}
+
+	serverHealthDataMap := make(map[string]api.ServerHealth)
+	leaderLastCommitIndex := uint64(0)
+
+	for _, serverHealthData := range autoPilotReply.Servers {
+		serverHealthDataMap[serverHealthData.ID] = serverHealthData
+	}
+
+	for _, s := range reply.Servers {
+		if s.Leader {
+			serverHealthDataLeader, ok := serverHealthDataMap[s.ID]
+			if ok {
+				leaderLastCommitIndex = serverHealthDataLeader.LastIndex
+			}
+		}
+	}
+
 	// Format it as a nice table.
-	result := []string{"Node\x1fID\x1fAddress\x1fState\x1fVoter\x1fRaftProtocol"}
+	result := []string{"Node\x1fID\x1fAddress\x1fState\x1fVoter\x1fRaftProtocol\x1fCommit Index\x1fTrails Leader By"}
 	for _, s := range reply.Servers {
 		raftProtocol := s.ProtocolVersion
 
@@ -82,8 +103,22 @@ func raftListPeers(client *api.Client, stale bool) (string, error) {
 		if s.Leader {
 			state = "leader"
 		}
-		result = append(result, fmt.Sprintf("%s\x1f%s\x1f%s\x1f%s\x1f%v\x1f%s",
-			s.Node, s.ID, s.Address, state, s.Voter, raftProtocol))
+
+		serverHealthData, ok := serverHealthDataMap[s.ID]
+		if ok {
+			trailsLeaderBy := leaderLastCommitIndex - serverHealthData.LastIndex
+			trailsLeaderByText := fmt.Sprintf("%d Commits", trailsLeaderBy)
+			if s.Leader {
+				trailsLeaderByText = "_"
+			} else if trailsLeaderBy <= 1 {
+				trailsLeaderByText = fmt.Sprintf("%d Commit", trailsLeaderBy)
+			}
+			result = append(result, fmt.Sprintf("%s\x1f%s\x1f%s\x1f%s\x1f%v\x1f%s\x1f%v\x1f%s",
+				s.Node, s.ID, s.Address, state, s.Voter, raftProtocol, serverHealthData.LastIndex, trailsLeaderByText))
+		} else {
+			result = append(result, fmt.Sprintf("%s\x1f%s\x1f%s\x1f%s\x1f%v\x1f%s\x1f%v",
+				s.Node, s.ID, s.Address, state, s.Voter, raftProtocol, "_"))
+		}
 	}
 
 	return columnize.Format(result, &columnize.Config{Delim: string([]byte{0x1f})}), nil

command/operator/raft/listpeers/operator_raft_list_test.go

@@ -28,7 +28,7 @@ func TestOperatorRaftListPeersCommand(t *testing.T) {
 	a := agent.NewTestAgent(t, ``)
 	defer a.Shutdown()
 
-	expected := fmt.Sprintf("%s  %s  127.0.0.1:%d  leader  true   3",
+	expected := fmt.Sprintf("%s  %s  127.0.0.1:%d  leader  true   3             1             _",
 		a.Config.NodeName, a.Config.NodeID, a.Config.ServerPort)
 
 	// Test the list-peers subcommand directly

website/content/commands/operator/raft.mdx

@@ -70,7 +70,7 @@ configuration.
 
 - `-stale` - Enables non-leader servers to provide cluster state information.
   If the cluster is in an outage state without a leader,
-  we recommend setting this option to `true.
+  we recommend setting this option to `true`.
   Default is `false`.
 
 ## remove-peer