import "k8s.io/kubernetes/staging/src/k8s.io/component-base/metrics/testutil"
metrics.go promlint.go testutil.go
var ( // MetricNameLabel is label under which model.Sample stores metric name MetricNameLabel model.LabelName = model.MetricNameLabel // QuantileLabel is label under which model.Sample stores latency quantile value QuantileLabel model.LabelName = model.QuantileLabel )
CollectAndCompare registers the provided Collector with a newly created pedantic Registry. It then does the same as GatherAndCompare, gathering the metrics from the pedantic Registry.
ComputeHistogramDelta computes the change in histogram metric for a selected label. Results are stored in after samples
func CustomCollectAndCompare(c metrics.StableCollector, expected io.Reader, metricNames ...string) error
CustomCollectAndCompare registers the provided StableCollector with a newly created registry. It then does the same as GatherAndCompare, gathering the metrics from the pedantic Registry.
GatherAndCompare gathers all metrics from the provided Gatherer and compares it to an expected output read from the provided Reader in the Prometheus text exposition format. If any metricNames are provided, only metrics with those names are compared.
func GetCounterMetricValue(m metrics.CounterMetric) (float64, error)
GetCounterMetricValue extract metric value from CounterMetric
func GetGaugeMetricValue(m metrics.GaugeMetric) (float64, error)
GetGaugeMetricValue extract metric value from GaugeMetric
func GetHistogramMetricValue(m metrics.ObserverMetric) (float64, error)
GetHistogramMetricValue extract sum of all samples from ObserverMetric
GetMetricValuesForLabel returns value of metric for a given dimension
LabelsMatch returns true if metric has all expected labels otherwise false
func NewFakeKubeRegistry(ver string) metrics.KubeRegistry
NewFakeKubeRegistry creates a fake `KubeRegistry` that takes the input version as `build in version`. It should only be used in testing scenario especially for the deprecated metrics. The input version format should be `major.minor.patch`, e.g. '1.18.0'.
ParseMetrics parses Metrics from data returned from prometheus endpoint
PrintSample returns formatted representation of metric Sample
TextToMetricFamilies reads 'in' as the simple and flat text-based exchange format and creates MetricFamily proto messages. It returns the MetricFamily proto messages in a map where the metric names are the keys, along with any error encountered.
ValidateMetrics verifies if every sample of metric has all expected labels
Histogram wraps prometheus histogram DTO (data transfer object)
GetHistogramFromGatherer collects a metric from a gatherer implementing k8s.io/component-base/metrics.Gatherer interface. Used only for testing purposes where we need to gather metrics directly from a running binary (without metrics endpoint).
Average computes histogram's average value
Clear clears all fields of the wrapped histogram
Quantile computes q-th quantile of a cumulative histogram. It's expected the histogram is valid (by calling Validate)
Validate makes sure the wrapped histogram has all necessary fields set and with valid values.
type Linter struct {
// contains filtered or unexported fields
}
A Linter is a Prometheus metrics linter. It identifies issues with metric names, types, and metadata, and reports them to the caller.
NewPromLinter creates a new Linter that reads an input stream of Prometheus metrics. Only the text exposition format is supported.
Lint performs a linting pass, returning a slice of Problems indicating any issues found in the metrics stream. The slice is sorted by metric name and issue description.
Metrics is generic metrics for other specific metrics
NewMetrics returns new metrics which are initialized.
Equal returns true if all metrics are the same as the arguments.
A Problem is an issue detected by a Linter.
Package testutil imports 13 packages (graph). Updated 2020-12-10. Refresh now. Tools for package owners.