Merge pull request #189 from AndrewSirenko/legacy-metrics

Let CSIMetricsManager serve additional registries

Author: k8s-ci-robot

go.mod

@@ -4,6 +4,7 @@ go 1.23.1
 
 require (
 	github.com/container-storage-interface/spec v1.11.0
+	github.com/prometheus/client_golang v1.20.5
 	github.com/stretchr/testify v1.10.0
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.58.0
 	go.opentelemetry.io/otel/trace v1.33.0
@@ -43,7 +44,6 @@ require (
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
-	github.com/prometheus/client_golang v1.20.5 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/common v0.61.0 // indirect
 	github.com/prometheus/procfs v0.15.1 // indirect

metrics/metrics.go

@@ -25,6 +25,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/prometheus/client_golang/prometheus"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 	"k8s.io/component-base/metrics"
@@ -91,6 +92,11 @@ type CSIMetricsManager interface {
 	// value is defined in the metrics manager
 	HaveAdditionalLabel(name string) bool
 
+	// WithAdditionalRegistry can be used to ensure additional non-CSI registries are served through RegisterToServer
+	//
+	// registry - Any registry which implements Gather() (e.g. metrics.KubeRegistry, prometheus.Registry, etc.)
+	WithAdditionalRegistry(registry prometheus.Gatherer) CSIMetricsManager
+
 	// SetDriverName is called to update the CSI driver name. This should be done
 	// as soon as possible, otherwise metrics recorded by this manager will be
 	// recorded with an "unknown-driver" driver_name.
@@ -242,11 +248,6 @@ func NewCSIMetricsManagerWithOptions(driverName string, options ...MetricsManage
 		// https://github.com/open-telemetry/opentelemetry-collector/issues/969
 		// Add process_start_time_seconds into the metric to let the start time be parsed correctly
 		metrics.RegisterProcessStartTime(cmm.registry.Register)
-		// TODO: This is a bug in component-base library. We need to remove this after upgrade component-base dependency
-		// BugFix: https://github.com/kubernetes/kubernetes/pull/96435
-		// The first call to RegisterProcessStartTime can only create the metric, so we need a second call to actually
-		// register the metric.
-		metrics.RegisterProcessStartTime(cmm.registry.Register)
 	}
 
 	labels := []string{labelCSIDriverName, labelCSIOperationName, labelGrpcStatusCode}
@@ -266,6 +267,9 @@ func NewCSIMetricsManagerWithOptions(driverName string, options ...MetricsManage
 	)
 	cmm.SetDriverName(driverName)
 	cmm.registerMetrics()
+	cmm.gatherers = prometheus.Gatherers{
+		cmm.GetRegistry(),
+	}
 	return &cmm
 }
 
@@ -278,6 +282,7 @@ type csiMetricsManager struct {
 	driverName                 string
 	additionalLabelNames       []string
 	additionalLabels           []label
+	gatherers                  prometheus.Gatherers
 	csiOperationsLatencyMetric *metrics.HistogramVec
 	registerProcessStartTime   bool
 }
@@ -367,6 +372,14 @@ func (cmm *csiMetricsManager) HaveAdditionalLabel(name string) bool {
 	return false
 }
 
+// WithAdditionalRegistry can be used to ensure additional non-CSI registries are served through RegisterToServer
+//
+// registry - Any registry which implements Gather() (e.g. metrics.KubeRegistry, prometheus.Registry, etc.)
+func (cmm *csiMetricsManager) WithAdditionalRegistry(registry prometheus.Gatherer) CSIMetricsManager {
+	cmm.gatherers = append(cmm.gatherers, registry)
+	return cmm
+}
+
 // RecordMetrics passes the stored values as to the implementation.
 func (cmmv *csiMetricsManagerWithValues) RecordMetrics(
 	operationName string,
@@ -390,7 +403,7 @@ func (cmm *csiMetricsManager) SetDriverName(driverName string) {
 // given server at the specified address/path.
 func (cmm *csiMetricsManager) RegisterToServer(s Server, metricsPath string) {
 	s.Handle(metricsPath, metrics.HandlerFor(
-		cmm.GetRegistry(),
+		cmm.gatherers,
 		metrics.HandlerOpts{
 			ErrorHandling: metrics.ContinueOnError}))
 }