named checks if verbose is used

Signed-off-by: Imran Pochi <[email protected]>

Author: ipochi

cmd/agent/app/server.go

@@ -17,6 +17,7 @@ limitations under the License.
 package app
 
 import (
+	"bytes"
 	"context"
 	"crypto/tls"
 	"fmt"
@@ -26,6 +27,7 @@ import (
 	"runtime"
 	runpprof "runtime/pprof"
 	"strconv"
+	"strings"
 	"time"
 
 	"github.com/prometheus/client_golang/prometheus/promhttp"
@@ -107,14 +109,38 @@ func (a *Agent) runHealthServer(o *options.GrpcProxyAgentOptions, cs agent.Readi
 	livenessHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		fmt.Fprintf(w, "ok")
 	})
+
+	checks := []agent.HealthChecker{agent.Ping, agent.NewServerConnected(cs)}
 	readinessHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		if cs.Ready() {
-			w.WriteHeader(http.StatusOK)
-			fmt.Fprintf(w, "ok")
-		} else {
+		var failedChecks []string
+		var individualCheckOutput bytes.Buffer
+		for _, check := range checks {
+			if err := check.Check(r); err != nil {
+				fmt.Fprintf(&individualCheckOutput, "[-]%s failed: %v\n", check.Name(), err)
+				failedChecks = append(failedChecks, check.Name())
+			} else {
+				fmt.Fprintf(&individualCheckOutput, "[+]%s ok\n", check.Name())
+			}
+		}
+
+		// Always be verbose if the check has failed
+		if len(failedChecks) > 0 {
+			klog.V(0).Infoln("%s check failed: \n%v", strings.Join(failedChecks, ","), individualCheckOutput.String())
 			w.WriteHeader(http.StatusServiceUnavailable)
-			fmt.Fprintf(w, "not ready")
+			fmt.Fprintf(w, individualCheckOutput.String())
+			return
 		}
+
+		if _, found := r.URL.Query()["verbose"]; !found {
+			w.WriteHeader(http.StatusOK)
+			fmt.Fprint(w, "ok")
+			return
+		}
+
+		fmt.Fprintf(&individualCheckOutput, "check passed\n")
+
+		w.WriteHeader(http.StatusOK)
+		fmt.Fprint(w, individualCheckOutput.String())
 	})
 
 	muxHandler := http.NewServeMux()

pkg/agent/readiness.go

@@ -16,6 +16,11 @@ limitations under the license.
 
 package agent
 
+import (
+	"fmt"
+	"net/http"
+)
+
 // ReadinessManager supports checking if the agent is ready.
 type ReadinessManager interface {
 	// Ready returns true the proxy server is ready.
@@ -28,3 +33,46 @@ func (cs *ClientSet) Ready() bool {
 	// Returns true if the agent is connected to at least one server.
 	return cs.HealthyClientsCount() > 0
 }
+
+// HealthChecker represents an entity capable of performing health checks.
+type HealthChecker interface {
+	Name() string
+	Check(req *http.Request) error
+}
+
+// ping implements the simplest possible healthz checker.
+type ping struct{}
+
+var Ping HealthChecker = &ping{}
+
+func (p *ping) Name() string {
+	return "ping"
+}
+
+func (p *ping) Check(_ *http.Request) error {
+	return nil
+}
+
+type serverConnected struct {
+	rm ReadinessManager
+}
+
+var ServerConnected HealthChecker = &serverConnected{}
+
+func NewServerConnected(cs ReadinessManager) HealthChecker {
+	return &serverConnected{
+		rm: cs,
+	}
+}
+
+func (s *serverConnected) Name() string {
+	return "server-connected"
+}
+
+func (s *serverConnected) Check(_ *http.Request) error {
+	if s.rm.Ready() {
+		return nil
+	}
+
+	return fmt.Errorf("no servers connected")
+}