Merge pull request #695 from Iceber/legacyregistry_metrics

metrics: register clusterpedia and kubernetes build info

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"
 )

cmd/clustersynchro-manager/app/config/config.go

@@ -7,7 +7,7 @@ import (
 
 	crdclientset "github.com/clusterpedia-io/clusterpedia/pkg/generated/clientset/versioned"
 	kubestatemetrics "github.com/clusterpedia-io/clusterpedia/pkg/kube_state_metrics"
-	metrics "github.com/clusterpedia-io/clusterpedia/pkg/metrics"
+	metricsserver "github.com/clusterpedia-io/clusterpedia/pkg/metrics/server"
 	"github.com/clusterpedia-io/clusterpedia/pkg/storage"
 	"github.com/clusterpedia-io/clusterpedia/pkg/synchromanager/clustersynchro"
 )
@@ -19,7 +19,7 @@ type Config struct {
 
 	WorkerNumber            int
 	ShardingName            string
-	MetricsServerConfig     metrics.Config
+	MetricsServerConfig     metricsserver.Config
 	KubeMetricsServerConfig *kubestatemetrics.ServerConfig
 	StorageFactory          storage.StorageFactory
 	ClusterSyncConfig       clustersynchro.ClusterSyncConfig

cmd/clustersynchro-manager/app/options/options.go

@@ -23,7 +23,7 @@ import (
 	"github.com/clusterpedia-io/clusterpedia/cmd/clustersynchro-manager/app/config"
 	crdclientset "github.com/clusterpedia-io/clusterpedia/pkg/generated/clientset/versioned"
 	kubestatemetrics "github.com/clusterpedia-io/clusterpedia/pkg/kube_state_metrics"
-	"github.com/clusterpedia-io/clusterpedia/pkg/metrics"
+	metricsserver "github.com/clusterpedia-io/clusterpedia/pkg/metrics/server"
 	"github.com/clusterpedia-io/clusterpedia/pkg/storage"
 	storageoptions "github.com/clusterpedia-io/clusterpedia/pkg/storage/options"
 	"github.com/clusterpedia-io/clusterpedia/pkg/synchromanager/clustersynchro"
@@ -42,7 +42,7 @@ type Options struct {
 
 	Logs             *logs.Options
 	Storage          *storageoptions.StorageOptions
-	Metrics          *metrics.Options
+	Metrics          *metricsserver.Options
 	KubeStateMetrics *kubestatemetrics.Options
 
 	WorkerNumber            int // WorkerNumber is the number of worker goroutines
@@ -76,7 +76,7 @@ func NewClusterSynchroManagerOptions() (*Options, error) {
 
 	options.Logs = logs.NewOptions()
 	options.Storage = storageoptions.NewStorageOptions()
-	options.Metrics = metrics.NewMetricsServerOptions()
+	options.Metrics = metricsserver.NewOptions()
 	options.KubeStateMetrics = kubestatemetrics.NewOptions()
 
 	options.WorkerNumber = 5

cmd/clustersynchro-manager/app/synchro.go

@@ -21,7 +21,7 @@ import (
 	"github.com/clusterpedia-io/clusterpedia/cmd/clustersynchro-manager/app/config"
 	"github.com/clusterpedia-io/clusterpedia/cmd/clustersynchro-manager/app/options"
 	kubestatemetrics "github.com/clusterpedia-io/clusterpedia/pkg/kube_state_metrics"
-	"github.com/clusterpedia-io/clusterpedia/pkg/metrics"
+	metricsserver "github.com/clusterpedia-io/clusterpedia/pkg/metrics/server"
 	"github.com/clusterpedia-io/clusterpedia/pkg/storage"
 	"github.com/clusterpedia-io/clusterpedia/pkg/synchromanager"
 	clusterpediafeature "github.com/clusterpedia-io/clusterpedia/pkg/utils/feature"
@@ -88,7 +88,7 @@ func Run(ctx context.Context, c *config.Config) error {
 	synchromanager := synchromanager.NewManager(c.CRDClient, c.StorageFactory, c.ClusterSyncConfig, c.ShardingName)
 
 	go func() {
-		metrics.RunServer(c.MetricsServerConfig)
+		metricsserver.Run(c.MetricsServerConfig)
 	}()
 
 	if c.KubeMetricsServerConfig != nil {

pkg/kube_state_metrics/options.go

@@ -10,7 +10,7 @@ import (
 	"github.com/spf13/pflag"
 	"k8s.io/kube-state-metrics/v2/pkg/options"
 
-	"github.com/clusterpedia-io/clusterpedia/pkg/metrics"
+	metricsserver "github.com/clusterpedia-io/clusterpedia/pkg/metrics/server"
 )
 
 var defaultResources = options.ResourceSet{
@@ -87,7 +87,7 @@ func (o *Options) MetricsStoreBuilderConfig() *MetricsStoreBuilderConfig {
 	}
 }
 
-func (o *Options) ServerConfig(config metrics.Config) *ServerConfig {
+func (o *Options) ServerConfig(config metricsserver.Config) *ServerConfig {
 	if !o.EnableKubeStateMetrics {
 		return nil
 	}

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"
+	metricsserver "github.com/clusterpedia-io/clusterpedia/pkg/metrics/server"
 	"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, metricsserver.Logger)
 }
 
 func buildMetricsServer(config ServerConfig, getter ClusterMetricsWriterListGetter, durationObserver prometheus.ObserverVec) *mux.Router {

pkg/metrics/logger.go → pkg/metrics/server/logger.go

@@ -1,4 +1,4 @@
-package metrics
+package server
 
 import "k8s.io/klog/v2"
 

pkg/metrics/options.go → pkg/metrics/server/options.go

@@ -1,4 +1,4 @@
-package metrics
+package server
 
 import (
 	"net"
@@ -15,7 +15,7 @@ type Options struct {
 	DisableGZIPEncoding bool
 }
 
-func NewMetricsServerOptions() *Options {
+func NewOptions() *Options {
 	return &Options{
 		Host:                "::",
 		Port:                8081,

pkg/metrics/server.go → pkg/metrics/server/server.go

@@ -1,4 +1,4 @@
-package metrics
+package server
 
 import (
 	"net/http"
@@ -9,6 +9,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/pprof"
 	"github.com/clusterpedia-io/clusterpedia/pkg/version"
 )
@@ -20,7 +21,7 @@ type Config struct {
 	DisableGZIPEncoding bool
 }
 
-func RunServer(config Config) {
+func Run(config Config) {
 	server := &http.Server{
 		Handler:           buildMetricsServer(config),
 		ReadHeaderTimeout: 6 * time.Second,

pkg/metrics/version.go

@@ -0,0 +1,23 @@
+package metrics
+
+import (
+	"k8s.io/component-base/metrics"
+	"k8s.io/component-base/metrics/legacyregistry"
+	_ "k8s.io/component-base/metrics/prometheus/version"
+
+	"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 Clusterpedia was built, and platform on which it is running.",
+	},
+	[]string{"git_version", "git_commit", "git_tree_state", "build_date", "go_version", "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)
+}

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