*: add alarm/health information in endpoint status

Update to remove raftIndex and document the Alarms() interface Fix formatting Fix typo
etcd-io · Jan 24, 2018 · db822ed · db822ed
1 parent 7331949
commit db822ed
Show file tree

Hide file tree

Showing 6 changed files with 319 additions and 235 deletions.
diff --git a/Documentation/dev-guide/apispec/swagger/rpc.swagger.json b/Documentation/dev-guide/apispec/swagger/rpc.swagger.json
@@ -2168,6 +2168,13 @@
           "type": "string",
           "format": "int64"
         },
+        "errors": {
+          "type": "array",
+          "title": "errors contains alarm/health information and status",
+          "items": {
+            "type": "string"
+          }
+        },
         "header": {
           "$ref": "#/definitions/etcdserverpbResponseHeader"
         },
@@ -2410,4 +2417,4 @@
       "ApiKey": []
     }
   ]
-}
+}
diff --git a/etcdctl/ctlv3/command/printer.go b/etcdctl/ctlv3/command/printer.go
@@ -174,7 +174,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", "raft applied index"}
+	hdr = []string{"endpoint", "ID", "version", "db size", "is leader", "raft term", "raft index", "raft applied index", "errors"}
 	for _, status := range statusList {
 		rows = append(rows, []string{
 			status.Ep,
@@ -185,6 +185,7 @@ func makeEndpointStatusTable(statusList []epStatus) (hdr []string, rows [][]stri
 			fmt.Sprint(status.Resp.RaftTerm),
 			fmt.Sprint(status.Resp.RaftIndex),
 			fmt.Sprint(status.Resp.RaftAppliedIndex),
+			fmt.Sprint(strings.Join(status.Resp.Errors, ", ")),
 		})
 	}
 	return hdr, rows

diff --git a/etcdctl/ctlv3/command/printer_fields.go b/etcdctl/ctlv3/command/printer_fields.go
@@ -150,6 +150,7 @@ func (p *fieldsPrinter) EndpointStatus(eps []epStatus) {
 		fmt.Println(`"RaftIndex" :`, ep.Resp.RaftIndex)
 		fmt.Println(`"RaftTerm" :`, ep.Resp.RaftTerm)
 		fmt.Println(`"RaftAppliedIndex" :`, ep.Resp.RaftAppliedIndex)
+		fmt.Println(`"Errors" :`, ep.Resp.Errors)
 		fmt.Printf("\"Endpoint\" : %q\n", ep.Ep)
 		fmt.Println()
 	}

diff --git a/etcdserver/api/v3rpc/maintenance.go b/etcdserver/api/v3rpc/maintenance.go
@@ -26,6 +26,7 @@ import (
 	"github.com/coreos/etcd/mvcc"
 	"github.com/coreos/etcd/mvcc/backend"
 	"github.com/coreos/etcd/pkg/types"
+	"github.com/coreos/etcd/raft"
 	"github.com/coreos/etcd/version"
 )
 
@@ -38,6 +39,9 @@ type BackendGetter interface {
 }
 
 type Alarmer interface {
+	// Alarms is implemented in Server interface located in etcdserver/server.go
+	// It returns a list of alarms present in the AlarmStore
+	Alarms() []*pb.AlarmMember
 	Alarm(ctx context.Context, ar *pb.AlarmRequest) (*pb.AlarmResponse, error)
 }
 
@@ -161,6 +165,15 @@ func (ms *maintenanceServer) Status(ctx context.Context, ar *pb.StatusRequest) (
 		RaftTerm:         ms.rg.Term(),
 		RaftAppliedIndex: ms.rg.AppliedIndex(),
 	}
+	if uint64(ms.rg.Leader()) == raft.None {
+		resp.Errors = append(resp.Errors, etcdserver.ErrNoLeader.Error())
+	}
+	alarms := ms.a.Alarms()
+	if len(alarms) > 0 {
+		for _, alarm := range alarms {
+			resp.Errors = append(resp.Errors, alarm.String())
+		}
+	}
 	ms.hdr.fill(resp.Header)
 	return resp, nil
 }