diff --git a/pkg/admission/metrics/metrics.go b/pkg/admission/metrics/metrics.go index dbdc5db78..a1ada6258 100644 --- a/pkg/admission/metrics/metrics.go +++ b/pkg/admission/metrics/metrics.go @@ -22,9 +22,9 @@ import ( "strconv" "time" - "github.com/prometheus/client_golang/prometheus" - "k8s.io/apiserver/pkg/admission" + "k8s.io/component-base/metrics" + "k8s.io/component-base/metrics/legacyregistry" ) const ( @@ -154,33 +154,35 @@ func (m *AdmissionMetrics) ObserveWebhook(elapsed time.Duration, rejected bool, } type metricSet struct { - latencies *prometheus.HistogramVec - latenciesSummary *prometheus.SummaryVec + latencies *metrics.HistogramVec + latenciesSummary *metrics.SummaryVec } func newMetricSet(name string, labels []string, helpTemplate string, hasSummary bool) *metricSet { - var summary *prometheus.SummaryVec + var summary *metrics.SummaryVec if hasSummary { - summary = prometheus.NewSummaryVec( - prometheus.SummaryOpts{ - Namespace: namespace, - Subsystem: subsystem, - Name: fmt.Sprintf("%s_admission_duration_seconds_summary", name), - Help: fmt.Sprintf(helpTemplate, "latency summary in seconds"), - MaxAge: latencySummaryMaxAge, + summary = metrics.NewSummaryVec( + &metrics.SummaryOpts{ + Namespace: namespace, + Subsystem: subsystem, + Name: fmt.Sprintf("%s_admission_duration_seconds_summary", name), + Help: fmt.Sprintf(helpTemplate, "latency summary in seconds"), + MaxAge: latencySummaryMaxAge, + StabilityLevel: metrics.ALPHA, }, labels, ) } return &metricSet{ - latencies: prometheus.NewHistogramVec( - prometheus.HistogramOpts{ - Namespace: namespace, - Subsystem: subsystem, - Name: fmt.Sprintf("%s_admission_duration_seconds", name), - Help: fmt.Sprintf(helpTemplate, "latency histogram in seconds"), - Buckets: latencyBuckets, + latencies: metrics.NewHistogramVec( + &metrics.HistogramOpts{ + Namespace: namespace, + Subsystem: subsystem, + Name: fmt.Sprintf("%s_admission_duration_seconds", name), + Help: fmt.Sprintf(helpTemplate, "latency histogram in seconds"), + Buckets: latencyBuckets, + StabilityLevel: metrics.ALPHA, }, labels, ), @@ -191,9 +193,9 @@ func newMetricSet(name string, labels []string, helpTemplate string, hasSummary // MustRegister registers all the prometheus metrics in the metricSet. func (m *metricSet) mustRegister() { - prometheus.MustRegister(m.latencies) + legacyregistry.MustRegister(m.latencies) if m.latenciesSummary != nil { - prometheus.MustRegister(m.latenciesSummary) + legacyregistry.MustRegister(m.latenciesSummary) } } diff --git a/pkg/audit/metrics.go b/pkg/audit/metrics.go index 9b81b30cc..6c51d1385 100644 --- a/pkg/audit/metrics.go +++ b/pkg/audit/metrics.go @@ -19,8 +19,9 @@ package audit import ( "fmt" - "github.com/prometheus/client_golang/prometheus" auditinternal "k8s.io/apiserver/pkg/apis/audit" + "k8s.io/component-base/metrics" + "k8s.io/component-base/metrics/legacyregistry" "k8s.io/klog" ) @@ -29,45 +30,49 @@ const ( ) var ( - eventCounter = prometheus.NewCounter( - prometheus.CounterOpts{ - Subsystem: subsystem, - Name: "event_total", - Help: "Counter of audit events generated and sent to the audit backend.", + eventCounter = metrics.NewCounter( + &metrics.CounterOpts{ + Subsystem: subsystem, + Name: "event_total", + Help: "Counter of audit events generated and sent to the audit backend.", + StabilityLevel: metrics.ALPHA, }) - errorCounter = prometheus.NewCounterVec( - prometheus.CounterOpts{ + errorCounter = metrics.NewCounterVec( + &metrics.CounterOpts{ Subsystem: subsystem, Name: "error_total", Help: "Counter of audit events that failed to be audited properly. " + "Plugin identifies the plugin affected by the error.", + StabilityLevel: metrics.ALPHA, }, []string{"plugin"}, ) - levelCounter = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Subsystem: subsystem, - Name: "level_total", - Help: "Counter of policy levels for audit events (1 per request).", + levelCounter = metrics.NewCounterVec( + &metrics.CounterOpts{ + Subsystem: subsystem, + Name: "level_total", + Help: "Counter of policy levels for audit events (1 per request).", + StabilityLevel: metrics.ALPHA, }, []string{"level"}, ) - ApiserverAuditDroppedCounter = prometheus.NewCounter( - prometheus.CounterOpts{ + ApiserverAuditDroppedCounter = metrics.NewCounter( + &metrics.CounterOpts{ Subsystem: subsystem, Name: "requests_rejected_total", Help: "Counter of apiserver requests rejected due to an error " + "in audit logging backend.", + StabilityLevel: metrics.ALPHA, }, ) ) func init() { - prometheus.MustRegister(eventCounter) - prometheus.MustRegister(errorCounter) - prometheus.MustRegister(levelCounter) - prometheus.MustRegister(ApiserverAuditDroppedCounter) + legacyregistry.MustRegister(eventCounter) + legacyregistry.MustRegister(errorCounter) + legacyregistry.MustRegister(levelCounter) + legacyregistry.MustRegister(ApiserverAuditDroppedCounter) } // ObserveEvent updates the relevant prometheus metrics for the generated audit event. diff --git a/pkg/authentication/request/x509/x509.go b/pkg/authentication/request/x509/x509.go index 5e91034aa..364ac2d94 100644 --- a/pkg/authentication/request/x509/x509.go +++ b/pkg/authentication/request/x509/x509.go @@ -23,16 +23,16 @@ import ( "net/http" "time" - "github.com/prometheus/client_golang/prometheus" - utilerrors "k8s.io/apimachinery/pkg/util/errors" "k8s.io/apimachinery/pkg/util/sets" "k8s.io/apiserver/pkg/authentication/authenticator" "k8s.io/apiserver/pkg/authentication/user" + "k8s.io/component-base/metrics" + "k8s.io/component-base/metrics/legacyregistry" ) -var clientCertificateExpirationHistogram = prometheus.NewHistogram( - prometheus.HistogramOpts{ +var clientCertificateExpirationHistogram = metrics.NewHistogram( + &metrics.HistogramOpts{ Namespace: "apiserver", Subsystem: "client", Name: "certificate_expiration_seconds", @@ -53,11 +53,12 @@ var clientCertificateExpirationHistogram = prometheus.NewHistogram( (6 * 30 * 24 * time.Hour).Seconds(), (12 * 30 * 24 * time.Hour).Seconds(), }, + StabilityLevel: metrics.ALPHA, }, ) func init() { - prometheus.MustRegister(clientCertificateExpirationHistogram) + legacyregistry.MustRegister(clientCertificateExpirationHistogram) } // UserConversion defines an interface for extracting user info from a client certificate chain diff --git a/pkg/endpoints/filters/authentication.go b/pkg/endpoints/filters/authentication.go index d9f70efac..17b456a03 100644 --- a/pkg/endpoints/filters/authentication.go +++ b/pkg/endpoints/filters/authentication.go @@ -21,29 +21,30 @@ import ( "net/http" "strings" - "github.com/prometheus/client_golang/prometheus" - "k8s.io/klog" - apierrors "k8s.io/apimachinery/pkg/api/errors" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime/schema" "k8s.io/apiserver/pkg/authentication/authenticator" "k8s.io/apiserver/pkg/endpoints/handlers/responsewriters" genericapirequest "k8s.io/apiserver/pkg/endpoints/request" + "k8s.io/component-base/metrics" + "k8s.io/component-base/metrics/legacyregistry" + "k8s.io/klog" ) var ( - authenticatedUserCounter = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Name: "authenticated_user_requests", - Help: "Counter of authenticated requests broken out by username.", + authenticatedUserCounter = metrics.NewCounterVec( + &metrics.CounterOpts{ + Name: "authenticated_user_requests", + Help: "Counter of authenticated requests broken out by username.", + StabilityLevel: metrics.ALPHA, }, []string{"username"}, ) ) func init() { - prometheus.MustRegister(authenticatedUserCounter) + legacyregistry.MustRegister(authenticatedUserCounter) } // WithAuthentication creates an http handler that tries to authenticate the given request as a user, and then diff --git a/pkg/endpoints/metrics/metrics.go b/pkg/endpoints/metrics/metrics.go index ea0146d5c..429496456 100644 --- a/pkg/endpoints/metrics/metrics.go +++ b/pkg/endpoints/metrics/metrics.go @@ -27,6 +27,9 @@ import ( "sync" "time" + restful "github.com/emicklei/go-restful" + "github.com/prometheus/client_golang/prometheus" + "k8s.io/apimachinery/pkg/apis/meta/v1/validation" "k8s.io/apimachinery/pkg/types" utilnet "k8s.io/apimachinery/pkg/util/net" @@ -34,15 +37,14 @@ import ( "k8s.io/apiserver/pkg/endpoints/request" "k8s.io/apiserver/pkg/features" utilfeature "k8s.io/apiserver/pkg/util/feature" - - restful "github.com/emicklei/go-restful" - "github.com/prometheus/client_golang/prometheus" + compbasemetrics "k8s.io/component-base/metrics" + "k8s.io/component-base/metrics/legacyregistry" ) // resettableCollector is the interface implemented by prometheus.MetricVec // that can be used by Prometheus to collect metrics and reset their values. type resettableCollector interface { - prometheus.Collector + compbasemetrics.Registerable Reset() } @@ -53,10 +55,11 @@ const ( var ( // TODO(a-robinson): Add unit tests for the handling of these metrics once // the upstream library supports it. - requestCounter = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Name: "apiserver_request_total", - Help: "Counter of apiserver requests broken out for each verb, dry run value, group, version, resource, scope, component, client, and HTTP response contentType and code.", + requestCounter = compbasemetrics.NewCounterVec( + &compbasemetrics.CounterOpts{ + Name: "apiserver_request_total", + Help: "Counter of apiserver requests broken out for each verb, dry run value, group, version, resource, scope, component, client, and HTTP response contentType and code.", + StabilityLevel: compbasemetrics.ALPHA, }, // The label_name contentType doesn't follow the label_name convention defined here: // https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/instrumentation.md @@ -64,22 +67,24 @@ var ( // should be all lowercase and separated by underscores. []string{"verb", "dry_run", "group", "version", "resource", "subresource", "scope", "component", "client", "contentType", "code"}, ) - deprecatedRequestCounter = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Name: "apiserver_request_count", - Help: "(Deprecated) Counter of apiserver requests broken out for each verb, group, version, resource, scope, component, client, and HTTP response contentType and code.", + deprecatedRequestCounter = compbasemetrics.NewCounterVec( + &compbasemetrics.CounterOpts{ + Name: "apiserver_request_count", + Help: "(Deprecated) Counter of apiserver requests broken out for each verb, group, version, resource, scope, component, client, and HTTP response contentType and code.", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"verb", "group", "version", "resource", "subresource", "scope", "component", "client", "contentType", "code"}, ) - longRunningRequestGauge = prometheus.NewGaugeVec( - prometheus.GaugeOpts{ - Name: "apiserver_longrunning_gauge", - Help: "Gauge of all active long-running apiserver requests broken out by verb, group, version, resource, scope and component. Not all requests are tracked this way.", + longRunningRequestGauge = compbasemetrics.NewGaugeVec( + &compbasemetrics.GaugeOpts{ + Name: "apiserver_longrunning_gauge", + Help: "Gauge of all active long-running apiserver requests broken out by verb, group, version, resource, scope and component. Not all requests are tracked this way.", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"verb", "group", "version", "resource", "subresource", "scope", "component"}, ) - requestLatencies = prometheus.NewHistogramVec( - prometheus.HistogramOpts{ + requestLatencies = compbasemetrics.NewHistogramVec( + &compbasemetrics.HistogramOpts{ Name: "apiserver_request_duration_seconds", Help: "Response latency distribution in seconds for each verb, dry run value, group, version, resource, subresource, scope and component.", // This metric is used for verifying api call latencies SLO, @@ -87,81 +92,91 @@ var ( // Thus we customize buckets significantly, to empower both usecases. Buckets: []float64{0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.25, 1.5, 1.75, 2.0, 2.5, 3.0, 3.5, 4.0, 4.5, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 40, 50, 60}, + StabilityLevel: compbasemetrics.ALPHA, }, []string{"verb", "dry_run", "group", "version", "resource", "subresource", "scope", "component"}, ) - deprecatedRequestLatencies = prometheus.NewHistogramVec( - prometheus.HistogramOpts{ + deprecatedRequestLatencies = compbasemetrics.NewHistogramVec( + &compbasemetrics.HistogramOpts{ Name: "apiserver_request_latencies", Help: "(Deprecated) Response latency distribution in microseconds for each verb, group, version, resource, subresource, scope and component.", // Use buckets ranging from 125 ms to 8 seconds. - Buckets: prometheus.ExponentialBuckets(125000, 2.0, 7), + Buckets: prometheus.ExponentialBuckets(125000, 2.0, 7), + StabilityLevel: compbasemetrics.ALPHA, }, []string{"verb", "group", "version", "resource", "subresource", "scope", "component"}, ) - deprecatedRequestLatenciesSummary = prometheus.NewSummaryVec( - prometheus.SummaryOpts{ + deprecatedRequestLatenciesSummary = compbasemetrics.NewSummaryVec( + &compbasemetrics.SummaryOpts{ Name: "apiserver_request_latencies_summary", Help: "(Deprecated) Response latency summary in microseconds for each verb, group, version, resource, subresource, scope and component.", // Make the sliding window of 5h. // TODO: The value for this should be based on our SLI definition (medium term). - MaxAge: 5 * time.Hour, + MaxAge: 5 * time.Hour, + StabilityLevel: compbasemetrics.ALPHA, }, []string{"verb", "group", "version", "resource", "subresource", "scope", "component"}, ) - responseSizes = prometheus.NewHistogramVec( - prometheus.HistogramOpts{ + responseSizes = compbasemetrics.NewHistogramVec( + &compbasemetrics.HistogramOpts{ Name: "apiserver_response_sizes", Help: "Response size distribution in bytes for each group, version, verb, resource, subresource, scope and component.", // Use buckets ranging from 1000 bytes (1KB) to 10^9 bytes (1GB). - Buckets: prometheus.ExponentialBuckets(1000, 10.0, 7), + Buckets: prometheus.ExponentialBuckets(1000, 10.0, 7), + StabilityLevel: compbasemetrics.ALPHA, }, []string{"verb", "group", "version", "resource", "subresource", "scope", "component"}, ) // DroppedRequests is a number of requests dropped with 'Try again later' response" - DroppedRequests = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Name: "apiserver_dropped_requests_total", - Help: "Number of requests dropped with 'Try again later' response", + DroppedRequests = compbasemetrics.NewCounterVec( + &compbasemetrics.CounterOpts{ + Name: "apiserver_dropped_requests_total", + Help: "Number of requests dropped with 'Try again later' response", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"requestKind"}, ) - DeprecatedDroppedRequests = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Name: "apiserver_dropped_requests", - Help: "(Deprecated) Number of requests dropped with 'Try again later' response", + DeprecatedDroppedRequests = compbasemetrics.NewCounterVec( + &compbasemetrics.CounterOpts{ + Name: "apiserver_dropped_requests", + Help: "(Deprecated) Number of requests dropped with 'Try again later' response", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"requestKind"}, ) // RegisteredWatchers is a number of currently registered watchers splitted by resource. - RegisteredWatchers = prometheus.NewGaugeVec( - prometheus.GaugeOpts{ - Name: "apiserver_registered_watchers", - Help: "Number of currently registered watchers for a given resources", + RegisteredWatchers = compbasemetrics.NewGaugeVec( + &compbasemetrics.GaugeOpts{ + Name: "apiserver_registered_watchers", + Help: "Number of currently registered watchers for a given resources", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"group", "version", "kind"}, ) - WatchEvents = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Name: "apiserver_watch_events_total", - Help: "Number of events sent in watch clients", + WatchEvents = compbasemetrics.NewCounterVec( + &compbasemetrics.CounterOpts{ + Name: "apiserver_watch_events_total", + Help: "Number of events sent in watch clients", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"group", "version", "kind"}, ) - WatchEventsSizes = prometheus.NewHistogramVec( - prometheus.HistogramOpts{ - Name: "apiserver_watch_events_sizes", - Help: "Watch event size distribution in bytes", - Buckets: prometheus.ExponentialBuckets(1024, 2.0, 8), // 1K, 2K, 4K, 8K, ..., 128K. + WatchEventsSizes = compbasemetrics.NewHistogramVec( + &compbasemetrics.HistogramOpts{ + Name: "apiserver_watch_events_sizes", + Help: "Watch event size distribution in bytes", + Buckets: prometheus.ExponentialBuckets(1024, 2.0, 8), // 1K, 2K, 4K, 8K, ..., 128K. + StabilityLevel: compbasemetrics.ALPHA, }, []string{"group", "version", "kind"}, ) // Because of volatality of the base metric this is pre-aggregated one. Instead of reporing current usage all the time // it reports maximal usage during the last second. - currentInflightRequests = prometheus.NewGaugeVec( - prometheus.GaugeOpts{ - Name: "apiserver_current_inflight_requests", - Help: "Maximal number of currently used inflight request limit of this apiserver per request kind in last second.", + currentInflightRequests = compbasemetrics.NewGaugeVec( + &compbasemetrics.GaugeOpts{ + Name: "apiserver_current_inflight_requests", + Help: "Maximal number of currently used inflight request limit of this apiserver per request kind in last second.", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"requestKind"}, ) @@ -197,7 +212,7 @@ var registerMetrics sync.Once func Register() { registerMetrics.Do(func() { for _, metric := range metrics { - prometheus.MustRegister(metric) + legacyregistry.MustRegister(metric) } }) } @@ -241,7 +256,7 @@ func RecordLongRunning(req *http.Request, requestInfo *request.RequestInfo, comp if requestInfo == nil { requestInfo = &request.RequestInfo{Verb: req.Method, Path: req.URL.Path} } - var g prometheus.Gauge + var g compbasemetrics.GaugeMetric scope := CleanScope(requestInfo) // We don't use verb from , as for the healthy path // MonitorRequest is called from InstrumentRouteFunc which is registered diff --git a/pkg/server/routes/metrics.go b/pkg/server/routes/metrics.go index f9ae46f64..7b4591c87 100644 --- a/pkg/server/routes/metrics.go +++ b/pkg/server/routes/metrics.go @@ -23,8 +23,7 @@ import ( apimetrics "k8s.io/apiserver/pkg/endpoints/metrics" "k8s.io/apiserver/pkg/server/mux" etcd3metrics "k8s.io/apiserver/pkg/storage/etcd3/metrics" - - "github.com/prometheus/client_golang/prometheus" + "k8s.io/component-base/metrics/legacyregistry" ) // DefaultMetrics installs the default prometheus metrics handler @@ -33,7 +32,7 @@ type DefaultMetrics struct{} // Install adds the DefaultMetrics handler func (m DefaultMetrics) Install(c *mux.PathRecorderMux) { register() - c.Handle("/metrics", prometheus.Handler()) + c.Handle("/metrics", legacyregistry.Handler()) } // MetricsWithReset install the prometheus metrics handler extended with support for the DELETE method @@ -43,7 +42,7 @@ type MetricsWithReset struct{} // Install adds the MetricsWithReset handler func (m MetricsWithReset) Install(c *mux.PathRecorderMux) { register() - defaultMetricsHandler := prometheus.Handler().ServeHTTP + defaultMetricsHandler := legacyregistry.Handler().ServeHTTP c.HandleFunc("/metrics", func(w http.ResponseWriter, req *http.Request) { if req.Method == "DELETE" { apimetrics.Reset() diff --git a/pkg/storage/cacher/cacher.go b/pkg/storage/cacher/cacher.go index 65ef690f4..f27db4e9d 100644 --- a/pkg/storage/cacher/cacher.go +++ b/pkg/storage/cacher/cacher.go @@ -24,8 +24,6 @@ import ( "sync" "time" - "k8s.io/klog" - "k8s.io/apimachinery/pkg/api/errors" "k8s.io/apimachinery/pkg/api/meta" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" @@ -41,16 +39,18 @@ import ( "k8s.io/apiserver/pkg/storage" utilfeature "k8s.io/apiserver/pkg/util/feature" "k8s.io/client-go/tools/cache" + "k8s.io/component-base/metrics" + "k8s.io/component-base/metrics/legacyregistry" + "k8s.io/klog" utiltrace "k8s.io/utils/trace" - - "github.com/prometheus/client_golang/prometheus" ) var ( - initCounter = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Name: "apiserver_init_events_total", - Help: "Counter of init events processed in watchcache broken by resource type", + initCounter = metrics.NewCounterVec( + &metrics.CounterOpts{ + Name: "apiserver_init_events_total", + Help: "Counter of init events processed in watchcache broken by resource type", + StabilityLevel: metrics.ALPHA, }, []string{"resource"}, ) @@ -64,7 +64,7 @@ const ( ) func init() { - prometheus.MustRegister(initCounter) + legacyregistry.MustRegister(initCounter) } // Config contains the configuration for a given Cache. diff --git a/pkg/storage/etcd3/metrics/metrics.go b/pkg/storage/etcd3/metrics/metrics.go index 68f8b3158..c32326c04 100644 --- a/pkg/storage/etcd3/metrics/metrics.go +++ b/pkg/storage/etcd3/metrics/metrics.go @@ -20,29 +20,33 @@ import ( "sync" "time" - "github.com/prometheus/client_golang/prometheus" + compbasemetrics "k8s.io/component-base/metrics" + "k8s.io/component-base/metrics/legacyregistry" ) var ( - etcdRequestLatency = prometheus.NewHistogramVec( - prometheus.HistogramOpts{ - Name: "etcd_request_duration_seconds", - Help: "Etcd request latency in seconds for each operation and object type.", + etcdRequestLatency = compbasemetrics.NewHistogramVec( + &compbasemetrics.HistogramOpts{ + Name: "etcd_request_duration_seconds", + Help: "Etcd request latency in seconds for each operation and object type.", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"operation", "type"}, ) - objectCounts = prometheus.NewGaugeVec( - prometheus.GaugeOpts{ - Name: "etcd_object_counts", - Help: "Number of stored objects at the time of last check split by kind.", + objectCounts = compbasemetrics.NewGaugeVec( + &compbasemetrics.GaugeOpts{ + Name: "etcd_object_counts", + Help: "Number of stored objects at the time of last check split by kind.", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"resource"}, ) - deprecatedEtcdRequestLatenciesSummary = prometheus.NewSummaryVec( - prometheus.SummaryOpts{ - Name: "etcd_request_latencies_summary", - Help: "(Deprecated) Etcd request latency summary in microseconds for each operation and object type.", + deprecatedEtcdRequestLatenciesSummary = compbasemetrics.NewSummaryVec( + &compbasemetrics.SummaryOpts{ + Name: "etcd_request_latencies_summary", + Help: "(Deprecated) Etcd request latency summary in microseconds for each operation and object type.", + StabilityLevel: compbasemetrics.ALPHA, }, []string{"operation", "type"}, ) @@ -54,11 +58,11 @@ var registerMetrics sync.Once func Register() { // Register the metrics. registerMetrics.Do(func() { - prometheus.MustRegister(etcdRequestLatency) - prometheus.MustRegister(objectCounts) + legacyregistry.MustRegister(etcdRequestLatency) + legacyregistry.MustRegister(objectCounts) // TODO(danielqsj): Remove the following metrics, they are deprecated - prometheus.MustRegister(deprecatedEtcdRequestLatenciesSummary) + legacyregistry.MustRegister(deprecatedEtcdRequestLatenciesSummary) }) } diff --git a/pkg/storage/storagebackend/factory/etcd3.go b/pkg/storage/storagebackend/factory/etcd3.go index 801f8d6c9..eadb684f5 100644 --- a/pkg/storage/storagebackend/factory/etcd3.go +++ b/pkg/storage/storagebackend/factory/etcd3.go @@ -34,6 +34,7 @@ import ( "k8s.io/apiserver/pkg/storage/etcd3" "k8s.io/apiserver/pkg/storage/storagebackend" "k8s.io/apiserver/pkg/storage/value" + "k8s.io/component-base/metrics/legacyregistry" ) // The short keepalive timeout and interval have been chosen to aggressively @@ -46,6 +47,10 @@ const keepaliveTimeout = 10 * time.Second // on heavily loaded arm64 CPUs (issue #64649) const dialTimeout = 20 * time.Second +func init() { + legacyregistry.RawMustRegister(grpcprom.DefaultClientMetrics) +} + func newETCD3HealthCheck(c storagebackend.Config) (func() error, error) { // constructing the etcd v3 client blocks and times out if etcd is not available. // retry in a loop in the background until we successfully create the client, storing the client or error encountered diff --git a/pkg/storage/value/metrics.go b/pkg/storage/value/metrics.go index 9da584bcd..179d2b98e 100644 --- a/pkg/storage/value/metrics.go +++ b/pkg/storage/value/metrics.go @@ -20,9 +20,11 @@ import ( "sync" "time" + "github.com/prometheus/client_golang/prometheus" "google.golang.org/grpc/status" - "github.com/prometheus/client_golang/prometheus" + "k8s.io/component-base/metrics" + "k8s.io/component-base/metrics/legacyregistry" ) const ( @@ -31,84 +33,92 @@ const ( ) var ( - transformerLatencies = prometheus.NewHistogramVec( - prometheus.HistogramOpts{ + transformerLatencies = metrics.NewHistogramVec( + &metrics.HistogramOpts{ Namespace: namespace, Subsystem: subsystem, Name: "transformation_duration_seconds", Help: "Latencies in seconds of value transformation operations.", // In-process transformations (ex. AES CBC) complete on the order of 20 microseconds. However, when // external KMS is involved latencies may climb into milliseconds. - Buckets: prometheus.ExponentialBuckets(5e-6, 2, 14), + Buckets: prometheus.ExponentialBuckets(5e-6, 2, 14), + StabilityLevel: metrics.ALPHA, }, []string{"transformation_type"}, ) - deprecatedTransformerLatencies = prometheus.NewHistogramVec( - prometheus.HistogramOpts{ + deprecatedTransformerLatencies = metrics.NewHistogramVec( + &metrics.HistogramOpts{ Namespace: namespace, Subsystem: subsystem, Name: "transformation_latencies_microseconds", Help: "(Deprecated) Latencies in microseconds of value transformation operations.", // In-process transformations (ex. AES CBC) complete on the order of 20 microseconds. However, when // external KMS is involved latencies may climb into milliseconds. - Buckets: prometheus.ExponentialBuckets(5, 2, 14), + Buckets: prometheus.ExponentialBuckets(5, 2, 14), + StabilityLevel: metrics.ALPHA, }, []string{"transformation_type"}, ) - transformerOperationsTotal = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Namespace: namespace, - Subsystem: subsystem, - Name: "transformation_operations_total", - Help: "Total number of transformations.", + transformerOperationsTotal = metrics.NewCounterVec( + &metrics.CounterOpts{ + Namespace: namespace, + Subsystem: subsystem, + Name: "transformation_operations_total", + Help: "Total number of transformations.", + StabilityLevel: metrics.ALPHA, }, []string{"transformation_type", "transformer_prefix", "status"}, ) - deprecatedTransformerFailuresTotal = prometheus.NewCounterVec( - prometheus.CounterOpts{ - Namespace: namespace, - Subsystem: subsystem, - Name: "transformation_failures_total", - Help: "(Deprecated) Total number of failed transformation operations.", + deprecatedTransformerFailuresTotal = metrics.NewCounterVec( + &metrics.CounterOpts{ + Namespace: namespace, + Subsystem: subsystem, + Name: "transformation_failures_total", + Help: "(Deprecated) Total number of failed transformation operations.", + StabilityLevel: metrics.ALPHA, }, []string{"transformation_type"}, ) - envelopeTransformationCacheMissTotal = prometheus.NewCounter( - prometheus.CounterOpts{ - Namespace: namespace, - Subsystem: subsystem, - Name: "envelope_transformation_cache_misses_total", - Help: "Total number of cache misses while accessing key decryption key(KEK).", + envelopeTransformationCacheMissTotal = metrics.NewCounter( + &metrics.CounterOpts{ + Namespace: namespace, + Subsystem: subsystem, + Name: "envelope_transformation_cache_misses_total", + Help: "Total number of cache misses while accessing key decryption key(KEK).", + StabilityLevel: metrics.ALPHA, }, ) - dataKeyGenerationLatencies = prometheus.NewHistogram( - prometheus.HistogramOpts{ - Namespace: namespace, - Subsystem: subsystem, - Name: "data_key_generation_duration_seconds", - Help: "Latencies in seconds of data encryption key(DEK) generation operations.", - Buckets: prometheus.ExponentialBuckets(5e-6, 2, 14), + dataKeyGenerationLatencies = metrics.NewHistogram( + &metrics.HistogramOpts{ + Namespace: namespace, + Subsystem: subsystem, + Name: "data_key_generation_duration_seconds", + Help: "Latencies in seconds of data encryption key(DEK) generation operations.", + Buckets: prometheus.ExponentialBuckets(5e-6, 2, 14), + StabilityLevel: metrics.ALPHA, }, ) - deprecatedDataKeyGenerationLatencies = prometheus.NewHistogram( - prometheus.HistogramOpts{ - Namespace: namespace, - Subsystem: subsystem, - Name: "data_key_generation_latencies_microseconds", - Help: "(Deprecated) Latencies in microseconds of data encryption key(DEK) generation operations.", - Buckets: prometheus.ExponentialBuckets(5, 2, 14), + deprecatedDataKeyGenerationLatencies = metrics.NewHistogram( + &metrics.HistogramOpts{ + Namespace: namespace, + Subsystem: subsystem, + Name: "data_key_generation_latencies_microseconds", + Help: "(Deprecated) Latencies in microseconds of data encryption key(DEK) generation operations.", + Buckets: prometheus.ExponentialBuckets(5, 2, 14), + StabilityLevel: metrics.ALPHA, }, ) - dataKeyGenerationFailuresTotal = prometheus.NewCounter( - prometheus.CounterOpts{ - Namespace: namespace, - Subsystem: subsystem, - Name: "data_key_generation_failures_total", - Help: "Total number of failed data encryption key(DEK) generation operations.", + dataKeyGenerationFailuresTotal = metrics.NewCounter( + &metrics.CounterOpts{ + Namespace: namespace, + Subsystem: subsystem, + Name: "data_key_generation_failures_total", + Help: "Total number of failed data encryption key(DEK) generation operations.", + StabilityLevel: metrics.ALPHA, }, ) ) @@ -117,14 +127,14 @@ var registerMetrics sync.Once func RegisterMetrics() { registerMetrics.Do(func() { - prometheus.MustRegister(transformerLatencies) - prometheus.MustRegister(deprecatedTransformerLatencies) - prometheus.MustRegister(transformerOperationsTotal) - prometheus.MustRegister(deprecatedTransformerFailuresTotal) - prometheus.MustRegister(envelopeTransformationCacheMissTotal) - prometheus.MustRegister(dataKeyGenerationLatencies) - prometheus.MustRegister(deprecatedDataKeyGenerationLatencies) - prometheus.MustRegister(dataKeyGenerationFailuresTotal) + legacyregistry.MustRegister(transformerLatencies) + legacyregistry.MustRegister(deprecatedTransformerLatencies) + legacyregistry.MustRegister(transformerOperationsTotal) + legacyregistry.MustRegister(deprecatedTransformerFailuresTotal) + legacyregistry.MustRegister(envelopeTransformationCacheMissTotal) + legacyregistry.MustRegister(dataKeyGenerationLatencies) + legacyregistry.MustRegister(deprecatedDataKeyGenerationLatencies) + legacyregistry.MustRegister(dataKeyGenerationFailuresTotal) }) } diff --git a/pkg/storage/value/metrics_test.go b/pkg/storage/value/metrics_test.go index bfdbb4049..d67edc3d7 100644 --- a/pkg/storage/value/metrics_test.go +++ b/pkg/storage/value/metrics_test.go @@ -44,10 +44,10 @@ func TestTotals(t *testing.T) { }, error: errors.New("foo"), want: ` - # HELP apiserver_storage_transformation_failures_total (Deprecated) Total number of failed transformation operations. + # HELP apiserver_storage_transformation_failures_total [ALPHA] (Deprecated) Total number of failed transformation operations. # TYPE apiserver_storage_transformation_failures_total counter apiserver_storage_transformation_failures_total{transformation_type="encrypt"} 1 - # HELP apiserver_storage_transformation_operations_total Total number of transformations. + # HELP apiserver_storage_transformation_operations_total [ALPHA] Total number of transformations. # TYPE apiserver_storage_transformation_operations_total counter apiserver_storage_transformation_operations_total{status="Unknown",transformation_type="encrypt",transformer_prefix="k8s:enc:kms:v1:"} 1 `, @@ -59,7 +59,7 @@ func TestTotals(t *testing.T) { "apiserver_storage_transformation_failures_total", }, want: ` - # HELP apiserver_storage_transformation_operations_total Total number of transformations. + # HELP apiserver_storage_transformation_operations_total [ALPHA] Total number of transformations. # TYPE apiserver_storage_transformation_operations_total counter apiserver_storage_transformation_operations_total{status="OK",transformation_type="encrypt",transformer_prefix="k8s:enc:kms:v1:"} 1 `, @@ -72,10 +72,10 @@ func TestTotals(t *testing.T) { }, error: status.Error(codes.FailedPrecondition, "foo"), want: ` - # HELP apiserver_storage_transformation_failures_total (Deprecated) Total number of failed transformation operations. + # HELP apiserver_storage_transformation_failures_total [ALPHA] (Deprecated) Total number of failed transformation operations. # TYPE apiserver_storage_transformation_failures_total counter apiserver_storage_transformation_failures_total{transformation_type="encrypt"} 1 - # HELP apiserver_storage_transformation_operations_total Total number of transformations. + # HELP apiserver_storage_transformation_operations_total [ALPHA] Total number of transformations. # TYPE apiserver_storage_transformation_operations_total counter apiserver_storage_transformation_operations_total{status="FailedPrecondition",transformation_type="encrypt",transformer_prefix="k8s:enc:kms:v1:"} 1 `, diff --git a/pkg/storage/value/transformer_test.go b/pkg/storage/value/transformer_test.go index 3ae9e3e35..954275867 100644 --- a/pkg/storage/value/transformer_test.go +++ b/pkg/storage/value/transformer_test.go @@ -128,7 +128,7 @@ func TestPrefixFromMetrics(t *testing.T) { "apiserver_storage_transformation_operations_total", }, want: ` - # HELP apiserver_storage_transformation_operations_total Total number of transformations. + # HELP apiserver_storage_transformation_operations_total [ALPHA] Total number of transformations. # TYPE apiserver_storage_transformation_operations_total counter apiserver_storage_transformation_operations_total{status="OK",transformation_type="from_storage",transformer_prefix="identity"} 1 `, @@ -142,7 +142,7 @@ func TestPrefixFromMetrics(t *testing.T) { "apiserver_storage_transformation_operations_total", }, want: ` - # HELP apiserver_storage_transformation_operations_total Total number of transformations. + # HELP apiserver_storage_transformation_operations_total [ALPHA] Total number of transformations. # TYPE apiserver_storage_transformation_operations_total counter apiserver_storage_transformation_operations_total{status="OK",transformation_type="from_storage",transformer_prefix="other:"} 1 `, @@ -156,7 +156,7 @@ func TestPrefixFromMetrics(t *testing.T) { "apiserver_storage_transformation_operations_total", }, want: ` - # HELP apiserver_storage_transformation_operations_total Total number of transformations. + # HELP apiserver_storage_transformation_operations_total [ALPHA] Total number of transformations. # TYPE apiserver_storage_transformation_operations_total counter apiserver_storage_transformation_operations_total{status="Unknown",transformation_type="from_storage",transformer_prefix="other:"} 1 `, @@ -170,7 +170,7 @@ func TestPrefixFromMetrics(t *testing.T) { "apiserver_storage_transformation_operations_total", }, want: ` - # HELP apiserver_storage_transformation_operations_total Total number of transformations. + # HELP apiserver_storage_transformation_operations_total [ALPHA] Total number of transformations. # TYPE apiserver_storage_transformation_operations_total counter apiserver_storage_transformation_operations_total{status="Unknown",transformation_type="from_storage",transformer_prefix="unknown"} 1 `, @@ -214,7 +214,7 @@ func TestPrefixToMetrics(t *testing.T) { "apiserver_storage_transformation_operations_total", }, want: ` - # HELP apiserver_storage_transformation_operations_total Total number of transformations. + # HELP apiserver_storage_transformation_operations_total [ALPHA] Total number of transformations. # TYPE apiserver_storage_transformation_operations_total counter apiserver_storage_transformation_operations_total{status="OK",transformation_type="to_storage",transformer_prefix="other:"} 1 `, @@ -228,7 +228,7 @@ func TestPrefixToMetrics(t *testing.T) { "apiserver_storage_transformation_operations_total", }, want: ` - # HELP apiserver_storage_transformation_operations_total Total number of transformations. + # HELP apiserver_storage_transformation_operations_total [ALPHA] Total number of transformations. # TYPE apiserver_storage_transformation_operations_total counter apiserver_storage_transformation_operations_total{status="Unknown",transformation_type="to_storage",transformer_prefix="other:"} 1 `,