move files to component-base

Author: Han Kang

pkg/util/metrics/BUILD

@@ -34,9 +34,6 @@ filegroup(
 
 filegroup(
     name = "all-srcs",
-    srcs = [
-        ":package-srcs",
-        "//pkg/util/metrics/framework:all-srcs",
-    ],
+    srcs = [":package-srcs"],
     tags = ["automanaged"],
 )

staging/src/k8s.io/component-base/BUILD

@@ -13,6 +13,7 @@ filegroup(
         "//staging/src/k8s.io/component-base/cli/globalflag:all-srcs",
         "//staging/src/k8s.io/component-base/config:all-srcs",
         "//staging/src/k8s.io/component-base/logs:all-srcs",
+        "//staging/src/k8s.io/component-base/metrics:all-srcs",
     ],
     tags = ["automanaged"],
     visibility = ["//visibility:public"],

pkg/util/metrics/framework/BUILD renamed to staging/src/k8s.io/component-base/metrics/BUILD

@@ -16,9 +16,9 @@ go_library(
         "version_parser.go",
         "wrappers.go",
     ],
-    importpath = "k8s.io/kubernetes/pkg/util/metrics/framework",
+    importmap = "k8s.io/kubernetes/vendor/k8s.io/component-base/metrics",
+    importpath = "k8s.io/component-base/metrics",
     deps = [
-        "//pkg/version:go_default_library",
         "//staging/src/k8s.io/apimachinery/pkg/version:go_default_library",
         "//vendor/github.com/blang/semver:go_default_library",
         "//vendor/github.com/prometheus/client_golang/prometheus:go_default_library",

pkg/util/metrics/framework/counter.go renamed to staging/src/k8s.io/component-base/metrics/counter.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package framework
+package metrics
 
 import (
 	"github.com/blang/semver"

pkg/util/metrics/framework/counter_test.go renamed to staging/src/k8s.io/component-base/metrics/counter_test.go

@@ -14,22 +14,22 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package framework
+package metrics
 
 import (
 	"bytes"
 	"github.com/blang/semver"
 	"github.com/prometheus/common/expfmt"
+	apimachineryversion "k8s.io/apimachinery/pkg/version"
 	"testing"
 )
 
 func TestCounter(t *testing.T) {
-	v115 := semver.MustParse("1.15.0")
 	v114 := semver.MustParse("1.14.0")
+	v115 := semver.MustParse("1.15.0")
 	var tests = []struct {
 		desc string
 		*CounterOpts
-		registryVersion     *semver.Version
 		expectedMetricCount int
 		expectedHelp        string
 	}{
@@ -42,7 +42,6 @@ func TestCounter(t *testing.T) {
 				StabilityLevel: ALPHA,
 				Help:           "counter help",
 			},
-			registryVersion:     &v115,
 			expectedMetricCount: 1,
 			expectedHelp:        "[ALPHA] counter help",
 		},
@@ -56,7 +55,6 @@ func TestCounter(t *testing.T) {
 				StabilityLevel:    ALPHA,
 				DeprecatedVersion: &v115,
 			},
-			registryVersion:     &v115,
 			expectedMetricCount: 1,
 			expectedHelp:        "[ALPHA] (Deprecated since 1.15.0) counter help",
 		},
@@ -70,14 +68,17 @@ func TestCounter(t *testing.T) {
 				StabilityLevel:    ALPHA,
 				DeprecatedVersion: &v114,
 			},
-			registryVersion:     &v115,
 			expectedMetricCount: 0,
 		},
 	}
 
 	for _, test := range tests {
 		t.Run(test.desc, func(t *testing.T) {
-			registry := newKubeRegistry(*test.registryVersion)
+			registry := newKubeRegistry(&apimachineryversion.Info{
+				Major:      "1",
+				Minor:      "15",
+				GitVersion: "v1.15.0-alpha-1.12345",
+			})
 			c := NewCounter(test.CounterOpts)
 			registry.MustRegister(c)
 
@@ -141,7 +142,6 @@ func TestCounterVec(t *testing.T) {
 				Help:      "counter help",
 			},
 			labels:                    []string{"label_a", "label_b"},
-			registryVersion:           &v115,
 			expectedMetricFamilyCount: 1,
 			expectedHelp:              "counter help",
 		},
@@ -155,7 +155,6 @@ func TestCounterVec(t *testing.T) {
 				DeprecatedVersion: &v115,
 			},
 			labels:                    []string{"label_a", "label_b"},
-			registryVersion:           &v115,
 			expectedMetricFamilyCount: 1,
 			expectedHelp:              "(Deprecated since 1.15.0) counter help",
 		},
@@ -169,15 +168,18 @@ func TestCounterVec(t *testing.T) {
 				DeprecatedVersion: &v114,
 			},
 			labels:                    []string{"label_a", "label_b"},
-			registryVersion:           &v115,
 			expectedMetricFamilyCount: 0,
 			expectedHelp:              "counter help",
 		},
 	}
 
 	for _, test := range tests {
 		t.Run(test.desc, func(t *testing.T) {
-			registry := newKubeRegistry(*test.registryVersion)
+			registry := newKubeRegistry(&apimachineryversion.Info{
+				Major:      "1",
+				Minor:      "15",
+				GitVersion: "v1.15.0-alpha-1.12345",
+			})
 			c := NewCounterVec(test.CounterOpts, test.labels)
 			registry.MustRegister(c)
 			c.WithLabelValues("1", "2").Inc()

pkg/util/metrics/framework/metric.go renamed to staging/src/k8s.io/component-base/metrics/metric.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package framework
+package metrics
 
 import (
 	"github.com/blang/semver"

pkg/util/metrics/framework/opts.go renamed to staging/src/k8s.io/component-base/metrics/opts.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package framework
+package metrics
 
 import (
 	"fmt"

pkg/util/metrics/framework/registry.go renamed to staging/src/k8s.io/component-base/metrics/registry.go

@@ -14,46 +14,80 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package framework
+package metrics
 
 import (
 	"github.com/blang/semver"
 	"github.com/prometheus/client_golang/prometheus"
 	dto "github.com/prometheus/client_model/go"
-	"k8s.io/klog"
-	"k8s.io/kubernetes/pkg/version"
+	apimachineryversion "k8s.io/apimachinery/pkg/version"
+	"sync"
 )
 
-// DefaultGlobalRegistry is a stub for the global registry which prometheus client
-// currently uses.
-var DefaultGlobalRegistry = NewKubeRegistry()
+var globalRegistryFactory = metricsRegistryFactory{
+	globalRegistry: &noopKubeRegistry{},
+}
 
-// KubeRegistry is a wrapper around a prometheus registry-type object. Upon initialization
+// NewKubeRegistry creates a new kubernetes metric registry, loading in the kubernetes
+// version information available to the binary.
+func (r metricsRegistryFactory) newKubeRegistry() KubeRegistry {
+	if r.kubeVersion == nil {
+		return noopKubeRegistry{}
+	}
+	return newKubeRegistry(r.kubeVersion)
+}
+
+type metricsRegistryFactory struct {
+	globalRegistry KubeRegistry
+	kubeVersion    *apimachineryversion.Info
+	setVersionOnce sync.Once
+}
+
+// KubeRegistry is an interface which implements a subset of prometheus.Registerer and
+// prometheus.Gatherer interfaces
+type KubeRegistry interface {
+	Register(KubeCollector) error
+	MustRegister(...KubeCollector)
+	Unregister(KubeCollector) bool
+	Gather() ([]*dto.MetricFamily, error)
+}
+
+// kubeRegistry is a wrapper around a prometheus registry-type object. Upon initialization
 // the kubernetes binary version information is loaded into the registry object, so that
 // automatic behavior can be configured for metric versioning.
-type KubeRegistry struct {
+type kubeRegistry struct {
 	PromRegistry
 	version semver.Version
 }
 
+// SetRegistryFactoryVersion sets the kubernetes version information for all
+// subsequent metrics registry initializations. Only the first call has an effect.
+// If a version is not set, then metrics registry creation will no-opt
+func SetRegistryFactoryVersion(ver *apimachineryversion.Info) {
+	globalRegistryFactory.setVersionOnce.Do(func() {
+		globalRegistryFactory.globalRegistry = newKubeRegistry(ver)
+		globalRegistryFactory.kubeVersion = ver
+	})
+}
+
 // Register registers a collectable metric, but it uses a global registry.
 func Register(c KubeCollector) error {
-	return DefaultGlobalRegistry.Register(c)
+	return globalRegistryFactory.globalRegistry.Register(c)
 }
 
 // MustRegister works like Register but registers any number of
 // Collectors and panics upon the first registration that causes an
 // error.
 func MustRegister(cs ...KubeCollector) {
-	DefaultGlobalRegistry.MustRegister(cs...)
+	globalRegistryFactory.globalRegistry.MustRegister(cs...)
 }
 
 // Register registers a new Collector to be included in metrics
 // collection. It returns an error if the descriptors provided by the
 // Collector are invalid or if they — in combination with descriptors of
 // already registered Collectors — do not fulfill the consistency and
 // uniqueness criteria described in the documentation of metric.Desc.
-func (kr *KubeRegistry) Register(c KubeCollector) error {
+func (kr *kubeRegistry) Register(c KubeCollector) error {
 	if c.Create(&kr.version) {
 		return kr.PromRegistry.Register(c)
 	}
@@ -63,7 +97,7 @@ func (kr *KubeRegistry) Register(c KubeCollector) error {
 // MustRegister works like Register but registers any number of
 // Collectors and panics upon the first registration that causes an
 // error.
-func (kr *KubeRegistry) MustRegister(cs ...KubeCollector) {
+func (kr *kubeRegistry) MustRegister(cs ...KubeCollector) {
 	metrics := make([]prometheus.Collector, 0, len(cs))
 	for _, c := range cs {
 		if c.Create(&kr.version) {
@@ -79,7 +113,7 @@ func (kr *KubeRegistry) MustRegister(cs ...KubeCollector) {
 // returns whether a Collector was unregistered. Note that an unchecked
 // Collector cannot be unregistered (as its Describe method does not
 // yield any descriptor).
-func (kr *KubeRegistry) Unregister(collector KubeCollector) bool {
+func (kr *kubeRegistry) Unregister(collector KubeCollector) bool {
 	return kr.PromRegistry.Unregister(collector)
 }
 
@@ -90,28 +124,31 @@ func (kr *KubeRegistry) Unregister(collector KubeCollector) bool {
 // for valid exposition. As an exception to the strict consistency
 // requirements described for metric.Desc, Gather will tolerate
 // different sets of label names for metrics of the same metric family.
-func (kr *KubeRegistry) Gather() ([]*dto.MetricFamily, error) {
+func (kr *kubeRegistry) Gather() ([]*dto.MetricFamily, error) {
 	return kr.PromRegistry.Gather()
 }
 
 // NewKubeRegistry creates a new kubernetes metric registry, loading in the kubernetes
 // version information available to the binary.
-func NewKubeRegistry() *KubeRegistry {
-	v, err := parseVersion(version.Get())
-	if err != nil {
-		klog.Fatalf("Can't initialize a registry without a valid version %v", err)
-	}
-	if v == nil {
-		klog.Fatalf("No valid version loaded for metrics registry")
-	}
-	return newKubeRegistry(semver.MustParse(*v))
+func NewKubeRegistry() KubeRegistry {
+	return globalRegistryFactory.newKubeRegistry()
 }
 
 // newKubeRegistry creates a new vanilla Registry without any Collectors
 // pre-registered.
-func newKubeRegistry(version semver.Version) *KubeRegistry {
-	return &KubeRegistry{
+func newKubeRegistry(v *apimachineryversion.Info) KubeRegistry {
+	return &kubeRegistry{
 		PromRegistry: prometheus.NewRegistry(),
-		version:      version,
+		version:      parseVersion(*v),
 	}
 }
+
+// noop registry
+var noopRegistry = &noopKubeRegistry{}
+
+type noopKubeRegistry struct{}
+
+func (noopKubeRegistry) Register(KubeCollector) error         { return nil }
+func (noopKubeRegistry) MustRegister(...KubeCollector)        {}
+func (noopKubeRegistry) Unregister(KubeCollector) bool        { return false }
+func (noopKubeRegistry) Gather() ([]*dto.MetricFamily, error) { return nil, nil }

pkg/util/metrics/framework/registry_test.go renamed to staging/src/k8s.io/component-base/metrics/registry_test.go

@@ -14,12 +14,13 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package framework
+package metrics
 
 import (
 	"github.com/blang/semver"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/stretchr/testify/assert"
+	apimachineryversion "k8s.io/apimachinery/pkg/version"
 	"testing"
 )
 
@@ -116,7 +117,11 @@ func TestRegister(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.desc, func(t *testing.T) {
-			registry := newKubeRegistry(*test.registryVersion)
+			registry := newKubeRegistry(&apimachineryversion.Info{
+				Major:      "1",
+				Minor:      "15",
+				GitVersion: "v1.15.0-alpha-1.12345",
+			})
 			for i, m := range test.metrics {
 				err := registry.Register(m)
 				if err != test.expectedErrors[i] && err.Error() != test.expectedErrors[i].Error() {
@@ -183,7 +188,11 @@ func TestMustRegister(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.desc, func(t *testing.T) {
-			registry := newKubeRegistry(*test.registryVersion)
+			registry := newKubeRegistry(&apimachineryversion.Info{
+				Major:      "1",
+				Minor:      "15",
+				GitVersion: "v1.15.0-alpha-1.12345",
+			})
 			for i, m := range test.metrics {
 				if test.expectedPanics[i] {
 					assert.Panics(t,

pkg/util/metrics/framework/version_parser.go renamed to staging/src/k8s.io/component-base/metrics/version_parser.go

@@ -14,10 +14,11 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package framework
+package metrics
 
 import (
 	"fmt"
+	"github.com/blang/semver"
 	apimachineryversion "k8s.io/apimachinery/pkg/version"
 	"regexp"
 )
@@ -30,11 +31,11 @@ var (
 	versionRe = regexp.MustCompile(versionRegexpString)
 )
 
-func parseVersion(ver apimachineryversion.Info) (*string, error) {
+func parseVersion(ver apimachineryversion.Info) semver.Version {
 	matches := versionRe.FindAllStringSubmatch(ver.String(), -1)
 
 	if len(matches) != 1 {
-		return nil, fmt.Errorf("version string \"%v\" doesn't match expected regular expression: \"%v\"", ver.String(), versionRe.String())
+		panic(fmt.Sprintf("version string \"%v\" doesn't match expected regular expression: \"%v\"", ver.String(), versionRe.String()))
 	}
-	return &matches[0][1], nil
+	return semver.MustParse(matches[0][1])
 }