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
 }

auth/api/metrics.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

bootstrap/api/logging.go

@@ -1,7 +1,7 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
-// +build !test
+//go:build !test
 
 package api
 

bootstrap/api/metrics.go

@@ -1,7 +1,7 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
-// +build !test
+//go:build !test
 
 package api
 

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/logging.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

certs/api/metrics.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

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
 }

cli/README.md

@@ -7,9 +7,9 @@ make cli
 
 ## Usage
 ### Service
-#### Get the version of Mainflux services
+#### Get Mainflux Things services Health Check
 ```bash
-mainflux-cli version
+mainflux-cli health
 ```
 
 ### Users management
@@ -239,4 +239,4 @@ mainflux-cli groups members <group_id> <user_auth_token>
 #### List groups that user belongs to
 ```bash
 mainflux-cli groups membership <user_id> <user_auth_token>
-```
+```

cli/version.go → cli/health.go

@@ -5,14 +5,14 @@ package cli
 
 import "github.com/spf13/cobra"
 
-// NewVersionCmd returns version command.
-func NewVersionCmd() *cobra.Command {
+// NewHealthCmd returns health check command.
+func NewHealthCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:   "version",
-		Short: "Mainflux services version",
-		Long:  `Mainflux services version: get version of Mainflux Things Service`,
+		Use:   "health",
+		Short: "Health Check",
+		Long:  `Mainflux Things service Health Check`,
 		Run: func(cmd *cobra.Command, args []string) {
-			v, err := sdk.Version()
+			v, err := sdk.Health()
 			if err != nil {
 				logError(err)
 				return

cmd/cli/main.go

@@ -41,7 +41,7 @@ func main() {
 	}
 
 	// API commands
-	versionCmd := cli.NewVersionCmd()
+	healthCmd := cli.NewHealthCmd()
 	usersCmd := cli.NewUsersCmd()
 	thingsCmd := cli.NewThingsCmd()
 	groupsCmd := cli.NewGroupsCmd()
@@ -52,7 +52,7 @@ func main() {
 	certsCmd := cli.NewCertsCmd()
 
 	// Root Commands
-	rootCmd.AddCommand(versionCmd)
+	rootCmd.AddCommand(healthCmd)
 	rootCmd.AddCommand(usersCmd)
 	rootCmd.AddCommand(groupsCmd)
 	rootCmd.AddCommand(thingsCmd)

coap/api/logging.go

@@ -1,7 +1,7 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
-// +build !test
+//go:build !test
 
 package api
 

coap/api/metrics.go

@@ -1,7 +1,7 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
-// +build !test
+//go:build !test
 
 package api
 

coap/api/transport.go

@@ -40,10 +40,10 @@ var (
 	service coap.Service
 )
 
-//MakeHTTPHandler creates handler for version endpoint.
+// MakeHandler returns a HTTP handler for API endpoints.
 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/logging.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

consumers/notifiers/api/metrics.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

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/logging.go

@@ -1,7 +1,7 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
-// +build !test
+//go:build !test
 
 package api
 

consumers/writers/api/metrics.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

consumers/writers/api/transport.go

@@ -1,8 +1,6 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
-// +build !test
-
 package api
 
 import (
@@ -13,10 +11,10 @@ import (
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 )
 
-// MakeHandler returns a HTTP API handler with version and metrics.
+// MakeHandler returns a HTTP API handler with health check 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,51 @@
+// Copyright (c) Mainflux
+// SPDX-License-Identifier: Apache-2.0
+
+package mainflux
+
+import (
+	"encoding/json"
+	"net/http"
+)
+
+const (
+	version         string = "0.12.1"
+	contentType            = "Content-Type"
+	contentTypeJSON string = "application/json"
+	svcStatus       string = "pass"
+)
+
+// HealthInfo contains version endpoint response.
+type HealthInfo struct {
+	// Status contains service status.
+	Status string `json:"status"`
+
+	// Version contains current service 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(contentType, contentTypeJSON)
+		if r.Method != http.MethodGet && r.Method != http.MethodHead {
+			w.WriteHeader(http.StatusMethodNotAllowed)
+			return
+		}
+
+		res := HealthInfo{
+			Status:      svcStatus,
+			Description: service + " service",
+			Version:     version,
+		}
+
+		w.WriteHeader(http.StatusOK)
+
+		if err := json.NewEncoder(w).Encode(res); err != nil {
+			w.WriteHeader(http.StatusInternalServerError)
+		}
+	})
+}

http/api/logging.go

@@ -1,7 +1,7 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
-// +build !test
+//go:build !test
 
 package api
 

http/api/metrics.go

@@ -1,7 +1,7 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
-// +build !test
+//go:build !test
 
 package api
 

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

lora/api/logging.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

lora/api/metrics.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

opcua/api/logging.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

opcua/api/metrics.go

@@ -1,6 +1,8 @@
 // Copyright (c) Mainflux
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build !test
+
 package api
 
 import (

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/README.md

@@ -77,6 +77,6 @@ func (sdk mfSDK) UpdateChannel(channel Channel, token string) error
 func (sdk mfSDK) UpdateThing(thing Thing, token string) error
     UpdateThing - updates thing by ID
 
-func (sdk mfSDK) Version() (string, error)
-    Version - server health check
+func (sdk mfSDK) Health() (mainflux.Health, error)
+    Health - things service health check
 ```