mirror of https://github.com/k3s-io/k3s
149 lines
5.1 KiB
Go
149 lines
5.1 KiB
Go
|
/*
|
||
|
Copyright 2019 The Kubernetes Authors.
|
||
|
|
||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
you may not use this file except in compliance with the License.
|
||
|
You may obtain a copy of the License at
|
||
|
|
||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
||
|
Unless required by applicable law or agreed to in writing, software
|
||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
See the License for the specific language governing permissions and
|
||
|
limitations under the License.
|
||
|
*/
|
||
|
|
||
|
package metrics
|
||
|
|
||
|
import (
|
||
|
"github.com/blang/semver"
|
||
|
"github.com/prometheus/client_golang/prometheus"
|
||
|
"k8s.io/klog"
|
||
|
)
|
||
|
|
||
|
// Histogram is our internal representation for our wrapping struct around prometheus
|
||
|
// histograms. Summary implements both KubeCollector and ObserverMetric
|
||
|
type Histogram struct {
|
||
|
ObserverMetric
|
||
|
*HistogramOpts
|
||
|
lazyMetric
|
||
|
selfCollector
|
||
|
}
|
||
|
|
||
|
// NewHistogram returns an object which is Histogram-like. However, nothing
|
||
|
// will be measured until the histogram is registered somewhere.
|
||
|
func NewHistogram(opts *HistogramOpts) *Histogram {
|
||
|
// todo: handle defaulting better
|
||
|
if opts.StabilityLevel == "" {
|
||
|
opts.StabilityLevel = ALPHA
|
||
|
}
|
||
|
h := &Histogram{
|
||
|
HistogramOpts: opts,
|
||
|
lazyMetric: lazyMetric{},
|
||
|
}
|
||
|
h.setPrometheusHistogram(noopMetric{})
|
||
|
h.lazyInit(h)
|
||
|
return h
|
||
|
}
|
||
|
|
||
|
// setPrometheusHistogram sets the underlying KubeGauge object, i.e. the thing that does the measurement.
|
||
|
func (h *Histogram) setPrometheusHistogram(histogram prometheus.Histogram) {
|
||
|
h.ObserverMetric = histogram
|
||
|
h.initSelfCollection(histogram)
|
||
|
}
|
||
|
|
||
|
// DeprecatedVersion returns a pointer to the Version or nil
|
||
|
func (h *Histogram) DeprecatedVersion() *semver.Version {
|
||
|
return h.HistogramOpts.DeprecatedVersion
|
||
|
}
|
||
|
|
||
|
// initializeMetric invokes the actual prometheus.Histogram object instantiation
|
||
|
// and stores a reference to it
|
||
|
func (h *Histogram) initializeMetric() {
|
||
|
h.HistogramOpts.annotateStabilityLevel()
|
||
|
// this actually creates the underlying prometheus gauge.
|
||
|
h.setPrometheusHistogram(prometheus.NewHistogram(h.HistogramOpts.toPromHistogramOpts()))
|
||
|
}
|
||
|
|
||
|
// initializeDeprecatedMetric invokes the actual prometheus.Histogram object instantiation
|
||
|
// but modifies the Help description prior to object instantiation.
|
||
|
func (h *Histogram) initializeDeprecatedMetric() {
|
||
|
h.HistogramOpts.markDeprecated()
|
||
|
h.initializeMetric()
|
||
|
}
|
||
|
|
||
|
// HistogramVec is the internal representation of our wrapping struct around prometheus
|
||
|
// histogramVecs.
|
||
|
type HistogramVec struct {
|
||
|
*prometheus.HistogramVec
|
||
|
*HistogramOpts
|
||
|
lazyMetric
|
||
|
originalLabels []string
|
||
|
}
|
||
|
|
||
|
// NewHistogramVec returns an object which satisfies KubeCollector and wraps the
|
||
|
// prometheus.HistogramVec object. However, the object returned will not measure
|
||
|
// anything unless the collector is first registered, since the metric is lazily instantiated.
|
||
|
func NewHistogramVec(opts *HistogramOpts, labels []string) *HistogramVec {
|
||
|
// todo: handle defaulting better
|
||
|
klog.Errorf("---%v---\n", opts)
|
||
|
if opts.StabilityLevel == "" {
|
||
|
opts.StabilityLevel = ALPHA
|
||
|
}
|
||
|
klog.Errorf("---%v---\n", opts)
|
||
|
v := &HistogramVec{
|
||
|
HistogramVec: noopHistogramVec,
|
||
|
HistogramOpts: opts,
|
||
|
originalLabels: labels,
|
||
|
lazyMetric: lazyMetric{},
|
||
|
}
|
||
|
v.lazyInit(v)
|
||
|
return v
|
||
|
}
|
||
|
|
||
|
// DeprecatedVersion returns a pointer to the Version or nil
|
||
|
func (v *HistogramVec) DeprecatedVersion() *semver.Version {
|
||
|
return v.HistogramOpts.DeprecatedVersion
|
||
|
}
|
||
|
|
||
|
func (v *HistogramVec) initializeMetric() {
|
||
|
v.HistogramOpts.annotateStabilityLevel()
|
||
|
v.HistogramVec = prometheus.NewHistogramVec(v.HistogramOpts.toPromHistogramOpts(), v.originalLabels)
|
||
|
}
|
||
|
|
||
|
func (v *HistogramVec) initializeDeprecatedMetric() {
|
||
|
v.HistogramOpts.markDeprecated()
|
||
|
v.initializeMetric()
|
||
|
}
|
||
|
|
||
|
// Default Prometheus behavior actually results in the creation of a new metric
|
||
|
// if a metric with the unique label values is not found in the underlying stored metricMap.
|
||
|
// This means that if this function is called but the underlying metric is not registered
|
||
|
// (which means it will never be exposed externally nor consumed), the metric will exist in memory
|
||
|
// for perpetuity (i.e. throughout application lifecycle).
|
||
|
//
|
||
|
// For reference: https://github.com/prometheus/client_golang/blob/v0.9.2/prometheus/histogram.go#L460-L470
|
||
|
|
||
|
// WithLabelValues returns the ObserverMetric for the given slice of label
|
||
|
// values (same order as the VariableLabels in Desc). If that combination of
|
||
|
// label values is accessed for the first time, a new ObserverMetric is created IFF the HistogramVec
|
||
|
// has been registered to a metrics registry.
|
||
|
func (v *HistogramVec) WithLabelValues(lvs ...string) ObserverMetric {
|
||
|
if !v.IsCreated() {
|
||
|
return noop
|
||
|
}
|
||
|
return v.HistogramVec.WithLabelValues(lvs...)
|
||
|
}
|
||
|
|
||
|
// With returns the ObserverMetric for the given Labels map (the label names
|
||
|
// must match those of the VariableLabels in Desc). If that label map is
|
||
|
// accessed for the first time, a new ObserverMetric is created IFF the HistogramVec has
|
||
|
// been registered to a metrics registry.
|
||
|
func (v *HistogramVec) With(labels prometheus.Labels) ObserverMetric {
|
||
|
if !v.IsCreated() {
|
||
|
return noop
|
||
|
}
|
||
|
return v.HistogramVec.With(labels)
|
||
|
}
|