Improve various comments

Signed-off-by: beorn7 <beorn@grafana.com>
This commit is contained in:
beorn7 2020-04-25 15:59:53 +02:00
parent 39dbb24d13
commit dc79bd6093
4 changed files with 13 additions and 7 deletions

View File

@ -20,9 +20,9 @@ import (
"github.com/prometheus/client_golang/prometheus/testutil/promlint" "github.com/prometheus/client_golang/prometheus/testutil/promlint"
) )
// CollectAndLint registers the provided Collector with a newly created // CollectAndLint registers the provided Collector with a newly created pedantic
// pedantic Registry. It then does the same as GatherAndLint, gathering the // Registry. It then calls GatherAndLint with that Registry and with the
// metrics from the pedantic Registry. // provided metricNames.
func CollectAndLint(c prometheus.Collector, metricNames ...string) ([]promlint.Problem, error) { func CollectAndLint(c prometheus.Collector, metricNames ...string) ([]promlint.Problem, error) {
reg := prometheus.NewPedanticRegistry() reg := prometheus.NewPedanticRegistry()
if err := reg.Register(c); err != nil { if err := reg.Register(c); err != nil {

View File

@ -63,8 +63,9 @@ func TestCollectAndLintBad(t *testing.T) {
if len(problems) < 5 { if len(problems) < 5 {
// The exact nature of the lint problems found is tested within // The exact nature of the lint problems found is tested within
// the promlint package itself. Here we only want to make sure // the promlint package itself. Here we only want to make sure
// that the collector successfully hit the linter and got enough // that the collector successfully hits the linter and that at
// problems flagged. // least the five problems that the linter could recognize at
// the time of writing this test are flagged.
t.Error("Not enough lint problems found.") t.Error("Not enough lint problems found.")
} }
} }

View File

@ -29,6 +29,11 @@ import (
// A Linter is a Prometheus metrics linter. It identifies issues with metric // A Linter is a Prometheus metrics linter. It identifies issues with metric
// names, types, and metadata, and reports them to the caller. // names, types, and metadata, and reports them to the caller.
type Linter struct { type Linter struct {
// The linter will read metrics in the Prometheus text format from r and
// then lint it, _and_ it will lint the metrics provided directly as
// MetricFamily proto messages in mfs. Note, however, that the current
// constructor functions New and NewWithMetricFamilies only ever set one
// of them.
r io.Reader r io.Reader
mfs []*dto.MetricFamily mfs []*dto.MetricFamily
} }

View File

@ -140,8 +140,8 @@ func CollectAndCount(c prometheus.Collector) int {
} }
// CollectAndCompare registers the provided Collector with a newly created // CollectAndCompare registers the provided Collector with a newly created
// pedantic Registry. It then does the same as GatherAndCompare, gathering the // pedantic Registry. It then calls GatherAndCompare with that Registry and with
// metrics from the pedantic Registry. // the provided metricNames.
func CollectAndCompare(c prometheus.Collector, expected io.Reader, metricNames ...string) error { func CollectAndCompare(c prometheus.Collector, expected io.Reader, metricNames ...string) error {
reg := prometheus.NewPedanticRegistry() reg := prometheus.NewPedanticRegistry()
if err := reg.Register(c); err != nil { if err := reg.Register(c); err != nil {