feat: expose version info

.gitignore

@@ -31,3 +31,4 @@ settings.yaml
 
 # Build
 /.build/
+/dist/

cmd/data-aggregation-api/main.go

@@ -11,6 +11,7 @@ import (
 	"github.com/rs/zerolog/log"
 
 	"github.com/criteo/data-aggregation-api/internal/api/router"
+	"github.com/criteo/data-aggregation-api/internal/app"
 	"github.com/criteo/data-aggregation-api/internal/config"
 	"github.com/criteo/data-aggregation-api/internal/convertor/device"
 	"github.com/criteo/data-aggregation-api/internal/job"
@@ -32,9 +33,10 @@ func configureLogging(logLevel string, pretty bool) error {
 }
 
 var (
-	version   = ""
-	buildTime = "unknown"
-	buildUser = "unknown"
+	version = ""
+	date    = "unknown"
+	commit  = "unknown"
+	builtBy = "unknown"
 )
 
 func run() error {
@@ -49,8 +51,9 @@ func run() error {
 	}
 
 	log.Info().Str("version", version).Send()
-	log.Info().Str("build-time", buildTime).Send()
-	log.Info().Str("build-user", buildUser).Send()
+	log.Info().Str("commit", commit).Send()
+	log.Info().Str("build-time", date).Send()
+	log.Info().Str("build-user", builtBy).Send()
 
 	deviceRepo := device.NewSafeRepository()
 	reports := report.NewRepository()
@@ -66,6 +69,11 @@ func run() error {
 }
 
 func main() {
+	app.Info.Version = version
+	app.Info.BuildTime = date
+	app.Info.BuildUser = builtBy
+	app.Info.Commit = commit
+
 	if err := run(); err != nil {
 		log.Fatal().Err(err).Send()
 	}

internal/api/router/endpoints.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/rs/zerolog/log"
 
+	"github.com/criteo/data-aggregation-api/internal/app"
 	"github.com/criteo/data-aggregation-api/internal/convertor/device"
 	"github.com/julienschmidt/httprouter"
 )
@@ -21,6 +22,11 @@ func healthCheck(w http.ResponseWriter, _ *http.Request, _ httprouter.Params) {
 	fmt.Fprintf(w, `{"status": "ok"}`)
 }
 
+func getVersion(w http.ResponseWriter, _ *http.Request, _ httprouter.Params) {
+	w.Header().Set(contentType, applicationJSON)
+	fmt.Fprintf(w, `{"version": "%s", "build_time": "%s", "build_user": "%s"}`, app.Info.Version, app.Info.BuildTime, app.Info.BuildUser)
+}
+
 func prometheusMetrics(h http.Handler) httprouter.Handle {
 	return func(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
 		h.ServeHTTP(w, r)

internal/api/router/manager.go

@@ -47,6 +47,7 @@ func (m *Manager) ListenAndServe(ctx context.Context, address string, port int)
 	router := httprouter.New()
 
 	router.GET("/metrics", prometheusMetrics(promhttp.Handler()))
+	router.GET("/api/version", getVersion)
 	router.GET("/api/health", healthCheck)
 	router.GET("/v1/devices/:hostname/afk_enabled", withAuth.Wrap(m.getAFKEnabled))
 	router.GET("/v1/devices/:hostname/openconfig", withAuth.Wrap(m.getDeviceOpenConfig))

internal/app/version.go

@@ -0,0 +1,10 @@
+package app
+
+type info struct {
+	Version   string
+	BuildTime string
+	BuildUser string
+	Commit    string
+}
+
+var Info = info{}

internal/metrics/registry.go

@@ -1,18 +1,30 @@
 package metrics
 
 import (
+	"github.com/criteo/data-aggregation-api/internal/app"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promauto"
 )
 
 type Registry struct {
+	AppInfo            *prometheus.GaugeVec
 	BuiltDevicesNumber *prometheus.GaugeVec
 	lastBuildStatus    *prometheus.GaugeVec
 	buildTotal         *prometheus.CounterVec
 }
 
 func NewRegistry() Registry {
+	appInfo := promauto.NewGaugeVec(
+		prometheus.GaugeOpts{
+			Name: "data_aggregation_api_info",
+			Help: "Version of the application",
+		},
+		[]string{"version", "commit", "build_time", "built_by"},
+	)
+	appInfo.WithLabelValues(app.Info.Version, app.Info.Commit, app.Info.BuildTime, app.Info.BuildUser).Set(1)
+
 	return Registry{
+		AppInfo: appInfo,
 		BuiltDevicesNumber: promauto.NewGaugeVec(
 			prometheus.GaugeOpts{
 				Name: "built_devices_number",