metrics: register clusterpedia and kubernetes build info

Signed-off-by: Iceber Gu <[email protected]>
Iceber · Aug 29, 2024 · 764d1a5 · 764d1a5
1 parent b570837
commit 764d1a5
Show file tree

Hide file tree

Showing 10 changed files with 74 additions and 67 deletions.
diff --git a/cmd/apiserver/app/apiserver.go b/cmd/apiserver/app/apiserver.go
@@ -16,6 +16,7 @@ import (
 	"k8s.io/component-base/term"
 
 	"github.com/clusterpedia-io/clusterpedia/cmd/apiserver/app/options"
+	_ "github.com/clusterpedia-io/clusterpedia/pkg/metrics"
 	"github.com/clusterpedia-io/clusterpedia/pkg/storage"
 	"github.com/clusterpedia-io/clusterpedia/pkg/version/verflag"
 )

diff --git a/pkg/kube_state_metrics/server.go b/pkg/kube_state_metrics/server.go
@@ -16,7 +16,7 @@ import (
 	"k8s.io/component-base/metrics/legacyregistry"
 	"k8s.io/klog/v2"
 
-	"github.com/clusterpedia-io/clusterpedia/pkg/metrics"
+	"github.com/clusterpedia-io/clusterpedia/pkg/metrics/logger"
 	"github.com/clusterpedia-io/clusterpedia/pkg/version"
 )
 
@@ -49,7 +49,7 @@ func RunServer(config ServerConfig, getter ClusterMetricsWriterListGetter) {
 
 	klog.Info("Kube State Metrics Server is running...")
 	// TODO(iceber): handle error
-	_ = web.ListenAndServe(server, flags, metrics.Logger)
+	_ = web.ListenAndServe(server, flags, logger.Logger)
 }
 
 func buildMetricsServer(config ServerConfig, getter ClusterMetricsWriterListGetter, durationObserver prometheus.ObserverVec) *mux.Router {

diff --git a/pkg/metrics/logger.go → pkg/metrics/logger/logger.go b/pkg/metrics/logger.go → pkg/metrics/logger/logger.go
@@ -1,4 +1,4 @@
-package metrics
+package logger
 
 import "k8s.io/klog/v2"
 

diff --git a/pkg/metrics/metrics.go b/pkg/metrics/metrics.go
diff --git a/pkg/metrics/options.go → pkg/metrics/server/options.go b/pkg/metrics/options.go → pkg/metrics/server/options.go
@@ -1,4 +1,4 @@
-package metrics
+package server
 
 import (
 	"net"

diff --git a/pkg/metrics/server.go → pkg/metrics/server/server.go b/pkg/metrics/server.go → pkg/metrics/server/server.go
@@ -1,4 +1,4 @@
-package metrics
+package server
 
 import (
 	"net/http"
@@ -9,6 +9,8 @@ import (
 	"k8s.io/component-base/metrics/legacyregistry"
 	"k8s.io/klog/v2"
 
+	_ "github.com/clusterpedia-io/clusterpedia/pkg/metrics"
+	"github.com/clusterpedia-io/clusterpedia/pkg/metrics/logger"
 	"github.com/clusterpedia-io/clusterpedia/pkg/pprof"
 	"github.com/clusterpedia-io/clusterpedia/pkg/version"
 )
@@ -33,15 +35,15 @@ func RunServer(config Config) {
 	}
 
 	klog.Info("Metrics Server is running...")
-	_ = web.ListenAndServe(server, flags, Logger)
+	_ = web.ListenAndServe(server, flags, logger.Logger)
 }
 
 func buildMetricsServer(config Config) *http.ServeMux {
 	mux := http.NewServeMux()
 	mux.Handle("/metrics", metrics.HandlerWithReset(
 		legacyregistry.DefaultGatherer.(metrics.KubeRegistry),
 		metrics.HandlerOpts{
-			ErrorLog:           Logger,
+			ErrorLog:           logger.Logger,
 			DisableCompression: config.DisableGZIPEncoding,
 		}),
 	)

diff --git a/pkg/metrics/version.go b/pkg/metrics/version.go
@@ -0,0 +1,22 @@
+package metrics
+
+import (
+	"k8s.io/component-base/metrics"
+	"k8s.io/component-base/metrics/legacyregistry"
+
+	"github.com/clusterpedia-io/clusterpedia/pkg/version"
+)
+
+var buildInfo = metrics.NewGaugeVec(
+	&metrics.GaugeOpts{
+		Name: "clusterpedia_build_info",
+		Help: "A metric with a constant '1' value labeled by git version, git commit, git tree state, build date, Go version, and compiler from which Kubernetes was built, and platform on which it is running.",
+	},
+	[]string{"git_version", "git_commit", "git_tree_state", "build_date", "go_ve    rsion", "compiler", "platform"},
+)
+
+func init() {
+	info := version.Get()
+	legacyregistry.MustRegister(buildInfo)
+	buildInfo.WithLabelValues(info.GitVersion, info.GitCommit, info.GitTreeState, info.BuildDate, info.GoVersion, info.Compiler, info.Platform).Set(1)
+}
diff --git a/vendor/github.com/prometheus/client_golang/prometheus/collectors/version/version.go b/vendor/github.com/prometheus/client_golang/prometheus/collectors/version/version.go
diff --git a/vendor/k8s.io/component-base/metrics/prometheus/version/metrics.go b/vendor/k8s.io/component-base/metrics/prometheus/version/metrics.go
diff --git a/vendor/modules.txt b/vendor/modules.txt
@@ -297,7 +297,6 @@ github.com/pmezard/go-difflib/difflib
 ## explicit; go 1.20
 github.com/prometheus/client_golang/prometheus
 github.com/prometheus/client_golang/prometheus/collectors
-github.com/prometheus/client_golang/prometheus/collectors/version
 github.com/prometheus/client_golang/prometheus/internal
 github.com/prometheus/client_golang/prometheus/promauto
 github.com/prometheus/client_golang/prometheus/promhttp
@@ -1372,6 +1371,7 @@ k8s.io/component-base/metrics/features
 k8s.io/component-base/metrics/legacyregistry
 k8s.io/component-base/metrics/prometheus/feature
 k8s.io/component-base/metrics/prometheus/slis
+k8s.io/component-base/metrics/prometheus/version
 k8s.io/component-base/metrics/prometheus/workqueue
 k8s.io/component-base/metrics/prometheusextension
 k8s.io/component-base/metrics/testutil