498 lines
12 KiB
Go
498 lines
12 KiB
Go
// Copyright 2017 The Prometheus 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 promlint_test
|
|
|
|
import (
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/prometheus/prometheus/util/promlint"
|
|
)
|
|
|
|
func TestLintNoHelpText(t *testing.T) {
|
|
const msg = "no help text"
|
|
|
|
tests := []struct {
|
|
name string
|
|
in string
|
|
problems []promlint.Problem
|
|
}{
|
|
{
|
|
name: "no help",
|
|
in: `
|
|
# TYPE go_goroutines gauge
|
|
go_goroutines 24
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "go_goroutines",
|
|
Text: msg,
|
|
}},
|
|
},
|
|
{
|
|
name: "empty help",
|
|
in: `
|
|
# HELP go_goroutines
|
|
# TYPE go_goroutines gauge
|
|
go_goroutines 24
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "go_goroutines",
|
|
Text: msg,
|
|
}},
|
|
},
|
|
{
|
|
name: "no help and empty help",
|
|
in: `
|
|
# HELP go_goroutines
|
|
# TYPE go_goroutines gauge
|
|
go_goroutines 24
|
|
# TYPE go_threads gauge
|
|
go_threads 10
|
|
`,
|
|
problems: []promlint.Problem{
|
|
{
|
|
Metric: "go_goroutines",
|
|
Text: msg,
|
|
},
|
|
{
|
|
Metric: "go_threads",
|
|
Text: msg,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "OK",
|
|
in: `
|
|
# HELP go_goroutines Number of goroutines that currently exist.
|
|
# TYPE go_goroutines gauge
|
|
go_goroutines 24
|
|
`,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
l := promlint.New(strings.NewReader(tt.in))
|
|
|
|
problems, err := l.Lint()
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
if want, got := tt.problems, problems; !reflect.DeepEqual(want, got) {
|
|
t.Fatalf("unexpected problems:\n- want: %v\n- got: %v",
|
|
want, got)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestLintMetricUnits(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
in string
|
|
problems []promlint.Problem
|
|
}{
|
|
{
|
|
name: "amperes",
|
|
in: `
|
|
# HELP x_milliamperes Test metric.
|
|
# TYPE x_milliamperes untyped
|
|
x_milliamperes 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_milliamperes",
|
|
Text: `use base unit "amperes" instead of "milliamperes"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "bytes",
|
|
in: `
|
|
# HELP x_gigabytes Test metric.
|
|
# TYPE x_gigabytes untyped
|
|
x_gigabytes 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_gigabytes",
|
|
Text: `use base unit "bytes" instead of "gigabytes"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "candela",
|
|
in: `
|
|
# HELP x_kilocandela Test metric.
|
|
# TYPE x_kilocandela untyped
|
|
x_kilocandela 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_kilocandela",
|
|
Text: `use base unit "candela" instead of "kilocandela"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "grams",
|
|
in: `
|
|
# HELP x_kilograms Test metric.
|
|
# TYPE x_kilograms untyped
|
|
x_kilograms 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_kilograms",
|
|
Text: `use base unit "grams" instead of "kilograms"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "kelvin",
|
|
in: `
|
|
# HELP x_nanokelvin Test metric.
|
|
# TYPE x_nanokelvin untyped
|
|
x_nanokelvin 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_nanokelvin",
|
|
Text: `use base unit "kelvin" instead of "nanokelvin"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "kelvins",
|
|
in: `
|
|
# HELP x_nanokelvins Test metric.
|
|
# TYPE x_nanokelvins untyped
|
|
x_nanokelvins 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_nanokelvins",
|
|
Text: `use base unit "kelvins" instead of "nanokelvins"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "meters",
|
|
in: `
|
|
# HELP x_kilometers Test metric.
|
|
# TYPE x_kilometers untyped
|
|
x_kilometers 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_kilometers",
|
|
Text: `use base unit "meters" instead of "kilometers"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "metres",
|
|
in: `
|
|
# HELP x_kilometres Test metric.
|
|
# TYPE x_kilometres untyped
|
|
x_kilometres 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_kilometres",
|
|
Text: `use base unit "metres" instead of "kilometres"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "moles",
|
|
in: `
|
|
# HELP x_picomoles Test metric.
|
|
# TYPE x_picomoles untyped
|
|
x_picomoles 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_picomoles",
|
|
Text: `use base unit "moles" instead of "picomoles"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "seconds",
|
|
in: `
|
|
# HELP x_microseconds Test metric.
|
|
# TYPE x_microseconds untyped
|
|
x_microseconds 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_microseconds",
|
|
Text: `use base unit "seconds" instead of "microseconds"`,
|
|
}},
|
|
},
|
|
{
|
|
name: "OK",
|
|
in: `
|
|
# HELP thermometers_kelvin Test metric with name that looks like "meters".
|
|
# TYPE thermometers_kelvin untyped
|
|
thermometers_kelvin 0
|
|
`,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
l := promlint.New(strings.NewReader(tt.in))
|
|
|
|
problems, err := l.Lint()
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
if want, got := tt.problems, problems; !reflect.DeepEqual(want, got) {
|
|
t.Fatalf("unexpected problems:\n- want: %v\n- got: %v",
|
|
want, got)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestLintCounter(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
in string
|
|
problems []promlint.Problem
|
|
}{
|
|
{
|
|
name: "counter without _total suffix",
|
|
in: `
|
|
# HELP x_bytes Test metric.
|
|
# TYPE x_bytes counter
|
|
x_bytes 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_bytes",
|
|
Text: `counter metrics should have "_total" suffix`,
|
|
}},
|
|
},
|
|
{
|
|
name: "gauge with _total suffix",
|
|
in: `
|
|
# HELP x_bytes_total Test metric.
|
|
# TYPE x_bytes_total gauge
|
|
x_bytes_total 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_bytes_total",
|
|
Text: `non-counter metrics should not have "_total" suffix`,
|
|
}},
|
|
},
|
|
{
|
|
name: "counter with _total suffix",
|
|
in: `
|
|
# HELP x_bytes_total Test metric.
|
|
# TYPE x_bytes_total counter
|
|
x_bytes_total 10
|
|
`,
|
|
},
|
|
{
|
|
name: "gauge without _total suffix",
|
|
in: `
|
|
# HELP x_bytes Test metric.
|
|
# TYPE x_bytes gauge
|
|
x_bytes 10
|
|
`,
|
|
},
|
|
{
|
|
name: "untyped with _total suffix",
|
|
in: `
|
|
# HELP x_bytes_total Test metric.
|
|
# TYPE x_bytes_total untyped
|
|
x_bytes_total 10
|
|
`,
|
|
},
|
|
{
|
|
name: "untyped without _total suffix",
|
|
in: `
|
|
# HELP x_bytes Test metric.
|
|
# TYPE x_bytes untyped
|
|
x_bytes 10
|
|
`,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
l := promlint.New(strings.NewReader(tt.in))
|
|
|
|
problems, err := l.Lint()
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
if want, got := tt.problems, problems; !reflect.DeepEqual(want, got) {
|
|
t.Fatalf("unexpected problems:\n- want: %v\n- got: %v",
|
|
want, got)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestLintHistogramSummaryReserved(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
in string
|
|
problems []promlint.Problem
|
|
}{
|
|
{
|
|
name: "gauge with _bucket suffix",
|
|
in: `
|
|
# HELP x_bytes_bucket Test metric.
|
|
# TYPE x_bytes_bucket gauge
|
|
x_bytes_bucket 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_bytes_bucket",
|
|
Text: `non-histogram metrics should not have "_bucket" suffix`,
|
|
}},
|
|
},
|
|
{
|
|
name: "gauge with _count suffix",
|
|
in: `
|
|
# HELP x_bytes_count Test metric.
|
|
# TYPE x_bytes_count gauge
|
|
x_bytes_count 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_bytes_count",
|
|
Text: `non-histogram and non-summary metrics should not have "_count" suffix`,
|
|
}},
|
|
},
|
|
{
|
|
name: "gauge with _sum suffix",
|
|
in: `
|
|
# HELP x_bytes_sum Test metric.
|
|
# TYPE x_bytes_sum gauge
|
|
x_bytes_sum 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_bytes_sum",
|
|
Text: `non-histogram and non-summary metrics should not have "_sum" suffix`,
|
|
}},
|
|
},
|
|
{
|
|
name: "gauge with le label",
|
|
in: `
|
|
# HELP x_bytes Test metric.
|
|
# TYPE x_bytes gauge
|
|
x_bytes{le="1"} 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_bytes",
|
|
Text: `non-histogram metrics should not have "le" label`,
|
|
}},
|
|
},
|
|
{
|
|
name: "gauge with quantile label",
|
|
in: `
|
|
# HELP x_bytes Test metric.
|
|
# TYPE x_bytes gauge
|
|
x_bytes{quantile="1"} 10
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "x_bytes",
|
|
Text: `non-summary metrics should not have "quantile" label`,
|
|
}},
|
|
},
|
|
{
|
|
name: "histogram with quantile label",
|
|
in: `
|
|
# HELP tsdb_compaction_duration Duration of compaction runs.
|
|
# TYPE tsdb_compaction_duration histogram
|
|
tsdb_compaction_duration_bucket{le="0.005",quantile="0.01"} 0
|
|
tsdb_compaction_duration_bucket{le="0.01",quantile="0.01"} 0
|
|
tsdb_compaction_duration_bucket{le="0.025",quantile="0.01"} 0
|
|
tsdb_compaction_duration_bucket{le="0.05",quantile="0.01"} 0
|
|
tsdb_compaction_duration_bucket{le="0.1",quantile="0.01"} 0
|
|
tsdb_compaction_duration_bucket{le="0.25",quantile="0.01"} 0
|
|
tsdb_compaction_duration_bucket{le="0.5",quantile="0.01"} 57
|
|
tsdb_compaction_duration_bucket{le="1",quantile="0.01"} 68
|
|
tsdb_compaction_duration_bucket{le="2.5",quantile="0.01"} 69
|
|
tsdb_compaction_duration_bucket{le="5",quantile="0.01"} 69
|
|
tsdb_compaction_duration_bucket{le="10",quantile="0.01"} 69
|
|
tsdb_compaction_duration_bucket{le="+Inf",quantile="0.01"} 69
|
|
tsdb_compaction_duration_sum 28.740810936000006
|
|
tsdb_compaction_duration_count 69
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "tsdb_compaction_duration",
|
|
Text: `non-summary metrics should not have "quantile" label`,
|
|
}},
|
|
},
|
|
{
|
|
name: "summary with le label",
|
|
in: `
|
|
# HELP go_gc_duration_seconds A summary of the GC invocation durations.
|
|
# TYPE go_gc_duration_seconds summary
|
|
go_gc_duration_seconds{quantile="0",le="0.01"} 4.2365e-05
|
|
go_gc_duration_seconds{quantile="0.25",le="0.01"} 8.1492e-05
|
|
go_gc_duration_seconds{quantile="0.5",le="0.01"} 0.000100656
|
|
go_gc_duration_seconds{quantile="0.75",le="0.01"} 0.000113913
|
|
go_gc_duration_seconds{quantile="1",le="0.01"} 0.021754305
|
|
go_gc_duration_seconds_sum 1.769429004
|
|
go_gc_duration_seconds_count 5962
|
|
`,
|
|
problems: []promlint.Problem{{
|
|
Metric: "go_gc_duration_seconds",
|
|
Text: `non-histogram metrics should not have "le" label`,
|
|
}},
|
|
},
|
|
{
|
|
name: "histogram OK",
|
|
in: `
|
|
# HELP tsdb_compaction_duration Duration of compaction runs.
|
|
# TYPE tsdb_compaction_duration histogram
|
|
tsdb_compaction_duration_bucket{le="0.005"} 0
|
|
tsdb_compaction_duration_bucket{le="0.01"} 0
|
|
tsdb_compaction_duration_bucket{le="0.025"} 0
|
|
tsdb_compaction_duration_bucket{le="0.05"} 0
|
|
tsdb_compaction_duration_bucket{le="0.1"} 0
|
|
tsdb_compaction_duration_bucket{le="0.25"} 0
|
|
tsdb_compaction_duration_bucket{le="0.5"} 57
|
|
tsdb_compaction_duration_bucket{le="1"} 68
|
|
tsdb_compaction_duration_bucket{le="2.5"} 69
|
|
tsdb_compaction_duration_bucket{le="5"} 69
|
|
tsdb_compaction_duration_bucket{le="10"} 69
|
|
tsdb_compaction_duration_bucket{le="+Inf"} 69
|
|
tsdb_compaction_duration_sum 28.740810936000006
|
|
tsdb_compaction_duration_count 69
|
|
`,
|
|
},
|
|
{
|
|
name: "summary OK",
|
|
in: `
|
|
# HELP go_gc_duration_seconds A summary of the GC invocation durations.
|
|
# TYPE go_gc_duration_seconds summary
|
|
go_gc_duration_seconds{quantile="0"} 4.2365e-05
|
|
go_gc_duration_seconds{quantile="0.25"} 8.1492e-05
|
|
go_gc_duration_seconds{quantile="0.5"} 0.000100656
|
|
go_gc_duration_seconds{quantile="0.75"} 0.000113913
|
|
go_gc_duration_seconds{quantile="1"} 0.021754305
|
|
go_gc_duration_seconds_sum 1.769429004
|
|
go_gc_duration_seconds_count 5962
|
|
`,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
l := promlint.New(strings.NewReader(tt.in))
|
|
|
|
problems, err := l.Lint()
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
if want, got := tt.problems, problems; !reflect.DeepEqual(want, got) {
|
|
t.Fatalf("unexpected problems:\n- want: %v\n- got: %v",
|
|
want, got)
|
|
}
|
|
})
|
|
}
|
|
}
|