MEDIUM: health: add health check for haproxy service

Author: mjuraga

configuration/configuration.go

@@ -40,6 +40,7 @@ type HAProxyConfiguration struct {
 	ReloadDelay          int    `short:"d" long:"reload-delay" description:"Minimum delay between two reloads (in s)" default:"5" group:"reload"`
 	ReloadCmd            string `short:"r" long:"reload-cmd" description:"Reload command" group:"reload"`
 	RestartCmd           string `short:"s" long:"restart-cmd" description:"Restart command" group:"reload"`
+	StatusCmd            string `long:"status-cmd" description:"Status command" group:"reload"`
 	ReloadRetention      int    `long:"reload-retention" description:"Reload retention in days, every older reload id will be deleted" default:"1" group:"reload"`
 	TransactionDir       string `short:"t" long:"transaction-dir" description:"Path to the transaction directory" default:"/tmp/haproxy" group:"transaction"`
 	BackupsNumber        int    `short:"n" long:"backups-number" description:"Number of backup configuration files you want to keep, stored in the config dir with version number suffix" default:"0" group:"transaction"`
@@ -156,9 +157,7 @@ type Configuration struct {
 	reloadSignal           chan os.Signal
 }
 
-var (
-	cfgInitOnce sync.Once
-)
+var cfgInitOnce sync.Once
 
 // Get returns pointer to configuration
 func Get() *Configuration {
@@ -249,7 +248,7 @@ func (c *Configuration) Load() error {
 
 func (c *Configuration) LoadRuntimeVars(swaggerJSON json.RawMessage, host string, port int) error {
 	var m map[string]interface{}
-	var json = jsoniter.ConfigCompatibleWithStandardLibrary
+	json := jsoniter.ConfigCompatibleWithStandardLibrary
 	err := json.Unmarshal(swaggerJSON, &m)
 	if err != nil {
 		return err

configuration/configuration_storage.go

@@ -74,8 +74,9 @@ haproxy {
 
   reload {
     reload_delay = 5
-    reload_cmd = "null"
-    restart_cmd = "null"
+    reload_cmd = "systemctl reload haproxy"
+    restart_cmd = "systemctl restart haproxy"
+    status_cmd = "systemctl status haproxy"
     reload_retention = 1
     validate_cmd = "null"
   }

configuration/examples/example-full.hcl

@@ -60,8 +60,9 @@ haproxy:
   master_worker_mode: false # bool
   reload:
     reload_delay: 5 # int 2
-    reload_cmd: null # string 2
-    restart_cmd: null # string 2
+    reload_cmd: "systemctl reload haproxy"
+    restart_cmd: "systemctl restart haproxy"
+    status_cmd: "systemctl status haproxy"
     reload_retention: 1 # int 2
     validate_cmd: null # string 2
 cluster:

configuration/examples/example-full.yaml

@@ -211,6 +211,7 @@ func configureAPI(api *operations.DataPlaneAPI) http.Handler {
 		Delay:      haproxyOptions.ReloadDelay,
 		ReloadCmd:  haproxyOptions.ReloadCmd,
 		RestartCmd: haproxyOptions.RestartCmd,
+		StatusCmd:  haproxyOptions.StatusCmd,
 		ConfigFile: haproxyOptions.ConfigFile,
 		BackupDir:  haproxyOptions.BackupsDir,
 		Retention:  haproxyOptions.ReloadRetention,
@@ -754,6 +755,9 @@ func configureAPI(api *operations.DataPlaneAPI) http.Handler {
 		}
 	}()
 
+	// Health
+	api.HealthGetHealthHandler = &handlers.GetHealthHandlerImpl{HAProxy: ra}
+
 	// middlewares
 	var adpts []adapters.Adapter
 	adpts = append(adpts,

configure_data_plane.go

@@ -66,6 +66,7 @@ swagger generate server -f $SPEC_DIR/haproxy_spec.yaml \
     --tags=Discovery \
     --tags=ServiceDiscovery \
     --tags=Information \
+    --tags=Health \
     --tags=Specification \
     --tags=SpecificationOpenapiv3 \
     --tags=Transactions \

embedded_spec.go

@@ -22,7 +22,7 @@ require (
 	github.com/go-openapi/validate v0.19.8
 	github.com/google/renameio v1.0.1
 	github.com/google/uuid v1.2.0
-	github.com/haproxytech/client-native/v3 v3.1.1-0.20220706134924-687bc1e4fcfd
+	github.com/haproxytech/client-native/v3 v3.1.1-0.20220706141425-f4b9bd8b7913
 	github.com/haproxytech/config-parser/v4 v4.0.0-rc2.0.20220705063916-e4e79c6d3321
 	github.com/hashicorp/consul/api v1.6.0
 	github.com/hashicorp/hcl v1.0.0

generate/swagger/script.sh

@@ -175,8 +175,8 @@ github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+
 github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.2.0 h1:qJYtXnJRWmpe7m/3XlyhrsLrEURqHRM2kxzoxXqyUDs=
 github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/haproxytech/client-native/v3 v3.1.1-0.20220706134924-687bc1e4fcfd h1:jwufMmcdi5zd5p+Ll5k7D6EBcm7gMkbYobGnJnY+jhU=
-github.com/haproxytech/client-native/v3 v3.1.1-0.20220706134924-687bc1e4fcfd/go.mod h1:PSYFdp1t3h2MJGdJ4cr7jVQtSn0bT5MkYITdDuDvSdA=
+github.com/haproxytech/client-native/v3 v3.1.1-0.20220706141425-f4b9bd8b7913 h1:qhRsHGWaGgU18Y7PRwxtW9F5jAOgK4X6ZkmGiTl+dNM=
+github.com/haproxytech/client-native/v3 v3.1.1-0.20220706141425-f4b9bd8b7913/go.mod h1:PSYFdp1t3h2MJGdJ4cr7jVQtSn0bT5MkYITdDuDvSdA=
 github.com/haproxytech/config-parser/v4 v4.0.0-rc2.0.20220705063916-e4e79c6d3321 h1:Jzl5PJuFhNU8HWjE6CRwikvZ7is0I3G7+FlSBk4u/Zs=
 github.com/haproxytech/config-parser/v4 v4.0.0-rc2.0.20220705063916-e4e79c6d3321/go.mod h1:7V8tKWPnQGC7tANP3uoMc5tU42fEQOe3fdQWkPdjU4o=
 github.com/haproxytech/go-logger v1.1.0 h1:HgGtYaI1ApkvbQdsm7f9AzQQoxTB7w37criTflh7IQE=

go.mod

@@ -0,0 +1,29 @@
+package handlers
+
+import (
+	"github.com/go-openapi/runtime/middleware"
+	"github.com/haproxytech/client-native/v3/models"
+	"github.com/haproxytech/dataplaneapi/haproxy"
+	"github.com/haproxytech/dataplaneapi/operations/health"
+)
+
+// GetHaproxyProcessInfoHandlerImpl implementation of the GetHaproxyProcessInfoHandler interface using client-native client
+type GetHealthHandlerImpl struct {
+	HAProxy haproxy.IReloadAgent
+}
+
+func (h *GetHealthHandlerImpl) Handle(health.GetHealthParams, interface{}) middleware.Responder {
+	data := models.Health{}
+	status, err := h.HAProxy.Status()
+	if err == nil {
+		if status {
+			data.Haproxy = models.HealthHaproxyUp
+		} else {
+			data.Haproxy = models.HealthHaproxyDown
+		}
+	} else {
+		data.Haproxy = models.HealthHaproxyUnknown
+	}
+
+	return health.NewGetHealthOK().WithPayload(&data)
+}