MF-1308 - Use IETF Health Check standard

auth/api/http/transport.go

@@ -15,12 +15,13 @@ import (
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 )
 
+// MakeHandler returns a HTTP handler for API endpoints.
 func MakeHandler(svc auth.Service, tracer opentracing.Tracer) http.Handler {
 	mux := bone.New()
 	mux = keys.MakeHandler(svc, mux, tracer)
 	mux = groups.MakeHandler(svc, mux, tracer)
 	mux = policies.MakeHandler(svc, mux, tracer)
-	mux.GetFunc("/version", mainflux.Version("auth"))
+	mux.GetFunc("/health", mainflux.Health("auth"))
 	mux.Handle("/metrics", promhttp.Handler())
 	return mux
 }

bootstrap/api/transport.go

@@ -100,7 +100,7 @@ func MakeHandler(svc bootstrap.Service, reader bootstrap.ConfigReader) http.Hand
 		encodeResponse,
 		opts...))
 
-	r.GetFunc("/version", mainflux.Version("bootstrap"))
+	r.GetFunc("/health", mainflux.Health("bootstrap"))
 	r.Handle("/metrics", promhttp.Handler())
 
 	return r

certs/api/transport.go

@@ -68,7 +68,7 @@ func MakeHandler(svc certs.Service) http.Handler {
 	))
 
 	r.Handle("/metrics", promhttp.Handler())
-	r.GetFunc("/version", mainflux.Version("certs"))
+	r.GetFunc("/health", mainflux.Health("certs"))
 
 	return r
 }

coap/api/transport.go

@@ -43,7 +43,7 @@ var (
 //MakeHTTPHandler creates handler for version endpoint.
 func MakeHTTPHandler() http.Handler {
 	b := bone.New()
-	b.GetFunc("/version", mainflux.Version(protocol))
+	b.GetFunc("/health", mainflux.Health(protocol))
 	b.Handle("/metrics", promhttp.Handler())
 
 	return b

consumers/notifiers/api/transport.go

@@ -59,7 +59,7 @@ func MakeHandler(svc notifiers.Service, tracer opentracing.Tracer) http.Handler
 		opts...,
 	))
 
-	mux.GetFunc("/version", mainflux.Version("notifier"))
+	mux.GetFunc("/health", mainflux.Health("notifier"))
 	mux.Handle("/metrics", promhttp.Handler())
 
 	return mux

consumers/writers/api/transport.go

@@ -1,6 +1,7 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
 // +build !test
 
 package api
@@ -16,7 +17,7 @@ import (
 // MakeHandler returns a HTTP API handler with version and metrics.
 func MakeHandler(svcName string) http.Handler {
 	r := bone.New()
-	r.GetFunc("/version", mainflux.Version(svcName))
+	r.GetFunc("/health", mainflux.Health(svcName))
 	r.Handle("/metrics", promhttp.Handler())
 
 	return r

docker/nginx/nginx-key.conf

@@ -89,7 +89,7 @@ http {
             proxy_pass http://auth:${MF_AUTH_HTTP_PORT};
         }
 
-        location /version {
+        location /health {
             include snippets/proxy-headers.conf;
             proxy_pass http://things:${MF_THINGS_HTTP_PORT};
         }

docker/nginx/nginx-x509.conf

@@ -97,7 +97,7 @@ http {
             proxy_pass http://auth:${MF_AUTH_HTTP_PORT};
         }
 
-        location /version {
+        location /health {
             include snippets/proxy-headers.conf;
             proxy_pass http://things:${MF_THINGS_HTTP_PORT};
         }

health.go

@@ -0,0 +1,49 @@
+// Copyright (c) Mainflux
+// SPDX-License-Identifier: Apache-2.0
+
+package mainflux
+
+import (
+	"encoding/json"
+	"net/http"
+
+	"github.com/nelkinda/http-go/header"
+)
+
+const (
+	version     string = "0.12.1"
+	contentType string = "application/json"
+	svcStatus   string = "pass"
+)
+
+// HealthInfo contains version endpoint response.
+type HealthInfo struct {
+	// Status contains service status.
+	Status string `json:"status"`
+
+	// Version contains service current version.
+	Version string `json:"version"`
+
+	// Description contains service description.
+	Description string `json:"description"`
+}
+
+// Health exposes an HTTP handler for retrieving service health.
+func Health(service string) http.HandlerFunc {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Add(header.ContentType, contentType)
+		if r.Method != http.MethodGet && r.Method != http.MethodHead {
+			w.WriteHeader(http.StatusMethodNotAllowed)
+			return
+		}
+
+		res := HealthInfo{
+			Status:      svcStatus,
+			Description: service,
+			Version:     version,
+		}
+
+		w.WriteHeader(http.StatusOK)
+		_ = json.NewEncoder(w).Encode(res)
+	})
+}

http/api/transport.go

@@ -57,7 +57,7 @@ func MakeHandler(svc adapter.Service, tracer opentracing.Tracer) http.Handler {
 		opts...,
 	))
 
-	r.GetFunc("/version", mainflux.Version("http"))
+	r.GetFunc("/health", mainflux.Health("http"))
 	r.Handle("/metrics", promhttp.Handler())
 
 	return r

lora/api/api.go

@@ -14,7 +14,7 @@ import (
 // MakeHandler returns a HTTP handler for API endpoints.
 func MakeHandler() http.Handler {
 	r := bone.New()
-	r.GetFunc("/version", mainflux.Version("lora-adapter"))
+	r.GetFunc("/health", mainflux.Health("lora-adapter"))
 	r.Handle("/metrics", promhttp.Handler())
 
 	return r

opcua/api/transport.go

@@ -43,7 +43,7 @@ func MakeHandler(svc opcua.Service) http.Handler {
 		opts...,
 	))
 
-	r.GetFunc("/version", mainflux.Version("opcua-adapter"))
+	r.GetFunc("/health", mainflux.Health("opcua-adapter"))
 	r.Handle("/metrics", promhttp.Handler())
 
 	return r

pkg/sdk/go/version.go

@@ -12,12 +12,12 @@ import (
 	"github.com/mainflux/mainflux/pkg/errors"
 )
 
-type version struct {
-	Value string `json:"version"`
+type health struct {
+	Version string `json:"version"`
 }
 
 func (sdk mfSDK) Version() (string, error) {
-	url := fmt.Sprintf("%s/version", sdk.thingsURL)
+	url := fmt.Sprintf("%s/health", sdk.thingsURL)
 
 	resp, err := sdk.client.Get(url)
 	if err != nil {
@@ -34,10 +34,10 @@ func (sdk mfSDK) Version() (string, error) {
 		return "", errors.Wrap(ErrFetchVersion, errors.New(resp.Status))
 	}
 
-	var ver version
-	if err := json.Unmarshal(body, &ver); err != nil {
+	var h health
+	if err := json.Unmarshal(body, &h); err != nil {
 		return "", err
 	}
 
-	return ver.Value, nil
+	return h.Version, nil
 }

provision/api/transport.go

@@ -47,7 +47,7 @@ func MakeHandler(svc provision.Service) http.Handler {
 	))
 
 	r.Handle("/metrics", promhttp.Handler())
-	r.GetFunc("/version", mainflux.Version("provision"))
+	r.GetFunc("/health", mainflux.Health("provision"))
 
 	return r
 }

readers/api/transport.go

@@ -62,7 +62,7 @@ func MakeHandler(svc readers.MessageRepository, tc mainflux.ThingsServiceClient,
 		opts...,
 	))
 
-	mux.GetFunc("/version", mainflux.Version(svcName))
+	mux.GetFunc("/health", mainflux.Health(svcName))
 	mux.Handle("/metrics", promhttp.Handler())
 
 	return mux

things/api/things/http/transport.go

@@ -198,7 +198,7 @@ func MakeHandler(tracer opentracing.Tracer, svc things.Service) http.Handler {
 		opts...,
 	))
 
-	r.GetFunc("/version", mainflux.Version("things"))
+	r.GetFunc("/health", mainflux.Health("things"))
 	r.Handle("/metrics", promhttp.Handler())
 
 	return r

twins/api/http/transport.go

@@ -81,7 +81,7 @@ func MakeHandler(tracer opentracing.Tracer, svc twins.Service) http.Handler {
 		opts...,
 	))
 
-	r.GetFunc("/version", mainflux.Version("twins"))
+	r.GetFunc("/health", mainflux.Health("twins"))
 	r.Handle("/metrics", promhttp.Handler())
 
 	return r

users/api/transport.go

@@ -109,7 +109,7 @@ func MakeHandler(svc users.Service, tracer opentracing.Tracer) http.Handler {
 		opts...,
 	))
 
-	mux.GetFunc("/version", mainflux.Version("users"))
+	mux.GetFunc("/health", mainflux.Health("users"))
 	mux.Handle("/metrics", promhttp.Handler())
 
 	return mux