forked from mirror/client_golang
Merge pull request #753 from prometheus/beorn7/test
Improve CollectAndCount
This commit is contained in:
commit
d8b51d4981
|
@ -112,31 +112,43 @@ func ToFloat64(c prometheus.Collector) float64 {
|
||||||
panic(fmt.Errorf("collected a non-gauge/counter/untyped metric: %s", pb))
|
panic(fmt.Errorf("collected a non-gauge/counter/untyped metric: %s", pb))
|
||||||
}
|
}
|
||||||
|
|
||||||
// CollectAndCount collects all Metrics from the provided Collector and returns their number.
|
// CollectAndCount registers the provided Collector with a newly created
|
||||||
//
|
// pedantic Registry. It then calls GatherAndCount with that Registry and with
|
||||||
// This can be used to assert the number of metrics collected by a given collector after certain operations.
|
// the provided metricNames. In the unlikely case that the registration or the
|
||||||
//
|
// gathering fails, this function panics. (This is inconsistent with the other
|
||||||
// This function is only for testing purposes, and even for testing, other approaches
|
// CollectAnd… functions in this package and has historical reasons. Changing
|
||||||
// are often more appropriate (see this package's documentation).
|
// the function signature would be a breaking change and will therefore only
|
||||||
func CollectAndCount(c prometheus.Collector) int {
|
// happen with the next major version bump.)
|
||||||
var (
|
func CollectAndCount(c prometheus.Collector, metricNames ...string) int {
|
||||||
mCount int
|
reg := prometheus.NewPedanticRegistry()
|
||||||
mChan = make(chan prometheus.Metric)
|
if err := reg.Register(c); err != nil {
|
||||||
done = make(chan struct{})
|
panic(fmt.Errorf("registering collector failed: %s", err))
|
||||||
)
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
for range mChan {
|
|
||||||
mCount++
|
|
||||||
}
|
}
|
||||||
close(done)
|
result, err := GatherAndCount(reg, metricNames...)
|
||||||
}()
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
c.Collect(mChan)
|
// GatherAndCount gathers all metrics from the provided Gatherer and counts
|
||||||
close(mChan)
|
// them. It returns the number of metric children in all gathered metric
|
||||||
<-done
|
// families together. If any metricNames are provided, only metrics with those
|
||||||
|
// names are counted.
|
||||||
|
func GatherAndCount(g prometheus.Gatherer, metricNames ...string) (int, error) {
|
||||||
|
got, err := g.Gather()
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("gathering metrics failed: %s", err)
|
||||||
|
}
|
||||||
|
if metricNames != nil {
|
||||||
|
got = filterMetrics(got, metricNames)
|
||||||
|
}
|
||||||
|
|
||||||
return mCount
|
result := 0
|
||||||
|
for _, mf := range got {
|
||||||
|
result += len(mf.GetMetric())
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// CollectAndCompare registers the provided Collector with a newly created
|
// CollectAndCompare registers the provided Collector with a newly created
|
||||||
|
|
|
@ -306,3 +306,30 @@ some_total{label1="value1"} 1
|
||||||
t.Errorf("Expected\n%#+v\nGot:\n%#+v", expectedError, err.Error())
|
t.Errorf("Expected\n%#+v\nGot:\n%#+v", expectedError, err.Error())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCollectAndCount(t *testing.T) {
|
||||||
|
c := prometheus.NewCounterVec(
|
||||||
|
prometheus.CounterOpts{
|
||||||
|
Name: "some_total",
|
||||||
|
Help: "A value that represents a counter.",
|
||||||
|
},
|
||||||
|
[]string{"foo"},
|
||||||
|
)
|
||||||
|
if got, want := CollectAndCount(c), 0; got != want {
|
||||||
|
t.Errorf("unexpected metric count, got %d, want %d", got, want)
|
||||||
|
}
|
||||||
|
c.WithLabelValues("bar")
|
||||||
|
if got, want := CollectAndCount(c), 1; got != want {
|
||||||
|
t.Errorf("unexpected metric count, got %d, want %d", got, want)
|
||||||
|
}
|
||||||
|
c.WithLabelValues("baz")
|
||||||
|
if got, want := CollectAndCount(c), 2; got != want {
|
||||||
|
t.Errorf("unexpected metric count, got %d, want %d", got, want)
|
||||||
|
}
|
||||||
|
if got, want := CollectAndCount(c, "some_total"), 2; got != want {
|
||||||
|
t.Errorf("unexpected metric count, got %d, want %d", got, want)
|
||||||
|
}
|
||||||
|
if got, want := CollectAndCount(c, "some_other_total"), 0; got != want {
|
||||||
|
t.Errorf("unexpected metric count, got %d, want %d", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
Loading…
Reference in New Issue