api/etcdhttp: serve error information in '/health', marshal health in…

… JSON Signed-off-by: Gyu-Ho Lee <gyuhox@gmail.com>
etcd-io · Jul 26, 2017 · 943ae95 · 943ae95
1 parent 2a348fb
commit 943ae95
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 7 deletions.
diff --git a/e2e/ctl_v3_alarm_test.go b/e2e/ctl_v3_alarm_test.go
@@ -53,7 +53,7 @@ func alarmTest(cx ctlCtx) {
 	}
 
 	// '/health' handler should return 'false'
-	if err := cURLGet(cx.epc, cURLReq{endpoint: "/health", expected: `{"health": "false"}`}); err != nil {
+	if err := cURLGet(cx.epc, cURLReq{endpoint: "/health", expected: `{"health":false,"errors":["NOSPACE"]}`}); err != nil {
 		cx.t.Fatalf("failed get with curl (%v)", err)
 	}
 

diff --git a/e2e/metrics_test.go b/e2e/metrics_test.go
@@ -41,7 +41,7 @@ func metricsTest(cx ctlCtx) {
 	if err := cURLGet(cx.epc, cURLReq{endpoint: "/metrics", expected: `etcd_debugging_mvcc_keys_total 1`, metricsURLScheme: cx.cfg.metricsURLScheme}); err != nil {
 		cx.t.Fatalf("failed get with curl (%v)", err)
 	}
-	if err := cURLGet(cx.epc, cURLReq{endpoint: "/health", expected: `{"health": "true"}`, metricsURLScheme: cx.cfg.metricsURLScheme}); err != nil {
+	if err := cURLGet(cx.epc, cURLReq{endpoint: "/health", expected: `{"health":true}`, metricsURLScheme: cx.cfg.metricsURLScheme}); err != nil {
 		cx.t.Fatalf("failed get with curl (%v)", err)
 	}
 }
diff --git a/etcdserver/api/etcdhttp/metrics.go b/etcdserver/api/etcdhttp/metrics.go
@@ -16,11 +16,12 @@ package etcdhttp
 
 import (
 	"context"
-	"fmt"
+	"encoding/json"
 	"net/http"
 	"time"
 
 	"github.com/coreos/etcd/etcdserver"
+	"github.com/coreos/etcd/etcdserver/api/v3rpc/rpctypes"
 	"github.com/coreos/etcd/etcdserver/etcdserverpb"
 	"github.com/coreos/etcd/raft"
 
@@ -57,7 +58,7 @@ func newHealthHandler(srv *etcdserver.EtcdServer) http.HandlerFunc {
 			return
 		}
 		h := checkHealth(srv)
-		d := []byte(fmt.Sprintf(`{"health": "%v"}`, h.Health))
+		d, _ := json.Marshal(h)
 		if !h.Health {
 			http.Error(w, string(d), http.StatusServiceUnavailable)
 			return
@@ -68,23 +69,32 @@ func newHealthHandler(srv *etcdserver.EtcdServer) http.HandlerFunc {
 }
 
 type health struct {
-	Health bool `json:"health"`
+	Health bool     `json:"health"`
+	Errors []string `json:"errors,omitempty"`
 }
 
 func checkHealth(srv *etcdserver.EtcdServer) health {
 	h := health{Health: false}
-	if len(srv.Alarms()) > 0 {
-		// TODO: provide alarm lists
+
+	as := srv.Alarms()
+	if len(as) > 0 {
+		for _, v := range as {
+			h.Errors = append(h.Errors, v.Alarm.String())
+		}
 		return h
 	}
 
 	if uint64(srv.Leader()) == raft.None {
+		h.Errors = append(h.Errors, rpctypes.ErrNoLeader.Error())
 		return h
 	}
 
 	ctx, cancel := context.WithTimeout(context.Background(), time.Second)
 	_, err := srv.Do(ctx, etcdserverpb.Request{Method: "QGET"})
 	cancel()
+	if err != nil {
+		h.Errors = append(h.Errors, err.Error())
+	}
 
 	h.Health = err == nil
 	return h