pr review comment changes

Ashesh Vidyut · Ashesh Vidyut · commit 5c2a58799340 · 2023-06-08T21:05:57.000+05:30
diff --git a/.changelog/17582.txt b/.changelog/17582.txt
@@ -1,5 +1,3 @@
 ```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
+raft list-peers shows the number of commits each follower is trailing the leader by to aid in troubleshooting.
 ```
diff --git a/api/operator_raft.go b/api/operator_raft.go
@@ -122,20 +122,3 @@ 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
-}
diff --git a/api/operator_raft_test.go b/api/operator_raft_test.go
@@ -57,22 +57,3 @@ 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)
-	}
-}
diff --git a/command/operator/raft/listpeers/operator_raft_list.go b/command/operator/raft/listpeers/operator_raft_list.go
@@ -70,7 +70,7 @@ 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)
+	autoPilotReply, err := client.Operator().AutopilotServerHealth(q)
 	if err != nil {
 		return "", fmt.Errorf("Failed to retrieve autopilot health: %v", err)
 	}
@@ -107,17 +107,17 @@ func raftListPeers(client *api.Client, stale bool) (string, error) {
 		serverHealthData, ok := serverHealthDataMap[s.ID]
 		if ok {
 			trailsLeaderBy := leaderLastCommitIndex - serverHealthData.LastIndex
-			trailsLeaderByText := fmt.Sprintf("%d Commits", trailsLeaderBy)
+			trailsLeaderByText := fmt.Sprintf("%d commits", trailsLeaderBy)
 			if s.Leader {
-				trailsLeaderByText = "_"
+				trailsLeaderByText = "-"
 			} else if trailsLeaderBy <= 1 {
-				trailsLeaderByText = fmt.Sprintf("%d Commit", trailsLeaderBy)
+				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, "_"))
+				s.Node, s.ID, s.Address, state, s.Voter, raftProtocol, "-"))
 		}
 	}
 
diff --git a/command/operator/raft/listpeers/operator_raft_list_test.go b/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             1             _",
+	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

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ func raftListPeers(client *api.Client, stale bool) (string, error) {`
`70`	`70`	`return "", fmt.Errorf("Failed to retrieve raft configuration: %v", err)`
`71`	`71`	`}`
`72`	`72`
`73`		`- autoPilotReply, err := client.Operator().GetAutoPilotHealth(q)`
	`73`	`+ autoPilotReply, err := client.Operator().AutopilotServerHealth(q)`
`74`	`74`	`if err != nil {`
`75`	`75`	`return "", fmt.Errorf("Failed to retrieve autopilot health: %v", err)`
`76`	`76`	`}`
`@@ -107,17 +107,17 @@ func raftListPeers(client *api.Client, stale bool) (string, error) {`
`107`	`107`	`serverHealthData, ok := serverHealthDataMap[s.ID]`
`108`	`108`	`if ok {`
`109`	`109`	`trailsLeaderBy := leaderLastCommitIndex - serverHealthData.LastIndex`
`110`		`- trailsLeaderByText := fmt.Sprintf("%d Commits", trailsLeaderBy)`
	`110`	`+ trailsLeaderByText := fmt.Sprintf("%d commits", trailsLeaderBy)`
`111`	`111`	`if s.Leader {`
`112`		`- trailsLeaderByText = "_"`
	`112`	`+ trailsLeaderByText = "-"`
`113`	`113`	`} else if trailsLeaderBy <= 1 {`
`114`		`- trailsLeaderByText = fmt.Sprintf("%d Commit", trailsLeaderBy)`
	`114`	`+ trailsLeaderByText = fmt.Sprintf("%d commit", trailsLeaderBy)`
`115`	`115`	`}`
`116`	`116`	`result = append(result, fmt.Sprintf("%s\x1f%s\x1f%s\x1f%s\x1f%v\x1f%s\x1f%v\x1f%s",`
`117`	`117`	`s.Node, s.ID, s.Address, state, s.Voter, raftProtocol, serverHealthData.LastIndex, trailsLeaderByText))`
`118`	`118`	`} else {`
`119`	`119`	`result = append(result, fmt.Sprintf("%s\x1f%s\x1f%s\x1f%s\x1f%v\x1f%s\x1f%v",`
`120`		`- s.Node, s.ID, s.Address, state, s.Voter, raftProtocol, "_"))`
	`120`	`+ s.Node, s.ID, s.Address, state, s.Voter, raftProtocol, "-"))`
`121`	`121`	`}`
`122`	`122`	`}`
`123`	`123`