72 lines
2.1 KiB
Go
72 lines
2.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 (
|
|
"time"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
)
|
|
|
|
// ValueType is an enumeration of metric types that represent a simple value.
|
|
type ValueType int
|
|
|
|
// Possible values for the ValueType enum.
|
|
const (
|
|
_ ValueType = iota
|
|
CounterValue
|
|
GaugeValue
|
|
UntypedValue
|
|
)
|
|
|
|
func (vt *ValueType) toPromValueType() prometheus.ValueType {
|
|
return prometheus.ValueType(*vt)
|
|
}
|
|
|
|
// NewLazyConstMetric is a helper of MustNewConstMetric.
|
|
//
|
|
// Note: If the metrics described by the desc is hidden, the metrics will not be created.
|
|
func NewLazyConstMetric(desc *Desc, valueType ValueType, value float64, labelValues ...string) Metric {
|
|
if desc.IsHidden() {
|
|
return nil
|
|
}
|
|
return prometheus.MustNewConstMetric(desc.toPrometheusDesc(), valueType.toPromValueType(), value, labelValues...)
|
|
}
|
|
|
|
// NewConstMetric is a helper of NewConstMetric.
|
|
//
|
|
// Note: If the metrics described by the desc is hidden, the metrics will not be created.
|
|
func NewConstMetric(desc *Desc, valueType ValueType, value float64, labelValues ...string) (Metric, error) {
|
|
if desc.IsHidden() {
|
|
return nil, nil
|
|
}
|
|
return prometheus.NewConstMetric(desc.toPrometheusDesc(), valueType.toPromValueType(), value, labelValues...)
|
|
}
|
|
|
|
// NewLazyMetricWithTimestamp is a helper of NewMetricWithTimestamp.
|
|
//
|
|
// Warning: the Metric 'm' must be the one created by NewLazyConstMetric(),
|
|
//
|
|
// otherwise, no stability guarantees would be offered.
|
|
func NewLazyMetricWithTimestamp(t time.Time, m Metric) Metric {
|
|
if m == nil {
|
|
return nil
|
|
}
|
|
|
|
return prometheus.NewMetricWithTimestamp(t, m)
|
|
}
|