Merge pull request #9176 from dvonthenen/feature/issue9123

Expose Raft Applied Index through to "etcdctl endpoint status"

Documentation/dev-guide/apispec/swagger/rpc.swagger.json

@@ -2176,6 +2176,11 @@
           "type": "string",
           "format": "uint64"
         },
+        "raftAppliedIndex": {
+          "description": "appliedIndex is the current raft applied index of the responding member.",
+          "type": "string",
+          "format": "uint64"
+        },
         "raftIndex": {
           "description": "raftIndex is the current raft index of the responding member.",
           "type": "string",

etcdctl/ctlv3/command/printer.go

@@ -173,7 +173,7 @@ func makeMemberListTable(r v3.MemberListResponse) (hdr []string, rows [][]string
 }
 
 func makeEndpointStatusTable(statusList []epStatus) (hdr []string, rows [][]string) {
-	hdr = []string{"endpoint", "ID", "version", "db size", "is leader", "raft term", "raft index"}
+	hdr = []string{"endpoint", "ID", "version", "db size", "is leader", "raft term", "raft index", "raft applied index"}
 	for _, status := range statusList {
 		rows = append(rows, []string{
 			status.Ep,
@@ -183,6 +183,7 @@ func makeEndpointStatusTable(statusList []epStatus) (hdr []string, rows [][]stri
 			fmt.Sprint(status.Resp.Leader == status.Resp.Header.MemberId),
 			fmt.Sprint(status.Resp.RaftTerm),
 			fmt.Sprint(status.Resp.RaftIndex),
+			fmt.Sprint(status.Resp.RaftAppliedIndex),
 		})
 	}
 	return hdr, rows

etcdctl/ctlv3/command/printer_fields.go

@@ -148,6 +148,7 @@ func (p *fieldsPrinter) EndpointStatus(eps []epStatus) {
 		fmt.Println(`"Leader" :`, ep.Resp.Leader)
 		fmt.Println(`"RaftIndex" :`, ep.Resp.RaftIndex)
 		fmt.Println(`"RaftTerm" :`, ep.Resp.RaftTerm)
+		fmt.Println(`"RaftAppliedIndex" :`, ep.Resp.RaftAppliedIndex)
 		fmt.Printf("\"Endpoint\" : %q\n", ep.Ep)
 		fmt.Println()
 	}

etcdserver/api/v3rpc/maintenance.go

@@ -153,12 +153,13 @@ func (ms *maintenanceServer) Alarm(ctx context.Context, ar *pb.AlarmRequest) (*p
 
 func (ms *maintenanceServer) Status(ctx context.Context, ar *pb.StatusRequest) (*pb.StatusResponse, error) {
 	resp := &pb.StatusResponse{
-		Header:    &pb.ResponseHeader{Revision: ms.hdr.rev()},
-		Version:   version.Version,
-		DbSize:    ms.bg.Backend().Size(),
-		Leader:    uint64(ms.rg.Leader()),
-		RaftIndex: ms.rg.Index(),
-		RaftTerm:  ms.rg.Term(),
+		Header:           &pb.ResponseHeader{Revision: ms.hdr.rev()},
+		Version:          version.Version,
+		DbSize:           ms.bg.Backend().Size(),
+		Leader:           uint64(ms.rg.Leader()),
+		RaftIndex:        ms.rg.Index(),
+		RaftTerm:         ms.rg.Term(),
+		RaftAppliedIndex: ms.rg.AppliedIndex(),
 	}
 	ms.hdr.fill(resp.Header)
 	return resp, nil

etcdserver/etcdserverpb/rpc.proto

@@ -907,6 +907,8 @@ message StatusResponse {
   uint64 raftIndex = 5;
   // raftTerm is the current raft term of the responding member.
   uint64 raftTerm = 6;
+  // raftAppliedIndex is the current raft applied index of the responding member.
+  uint64 raftAppliedIndex = 7;
 }
 
 message AuthEnableRequest {

etcdserver/raft.go

@@ -73,6 +73,7 @@ func init() {
 
 type RaftTimer interface {
 	Index() uint64
+	AppliedIndex() uint64
 	Term() uint64
 }
 
@@ -91,9 +92,10 @@ type raftNode struct {
 	// Cache of the latest raft index and raft term the server has seen.
 	// These three unit64 fields must be the first elements to keep 64-bit
 	// alignment for atomic access to the fields.
-	index uint64
-	term  uint64
-	lead  uint64
+	index        uint64
+	appliedindex uint64
+	term         uint64
+	lead         uint64
 
 	raftNodeConfig
 

etcdserver/server.go

@@ -1170,6 +1170,8 @@ func (s *EtcdServer) UpdateMember(ctx context.Context, memb membership.Member) (
 
 func (s *EtcdServer) Index() uint64 { return atomic.LoadUint64(&s.r.index) }
 
+func (s *EtcdServer) AppliedIndex() uint64 { return atomic.LoadUint64(&s.r.appliedindex) }
+
 func (s *EtcdServer) Term() uint64 { return atomic.LoadUint64(&s.r.term) }
 
 // Lead is only for testing purposes.
@@ -1667,6 +1669,7 @@ func (s *EtcdServer) getAppliedIndex() uint64 {
 
 func (s *EtcdServer) setAppliedIndex(v uint64) {
 	atomic.StoreUint64(&s.appliedIndex, v)
+	atomic.StoreUint64(&s.r.appliedindex, v)
 }
 
 func (s *EtcdServer) getCommittedIndex() uint64 {