From 25074625b77eafe0c67d88e0f2b6e7e795339e86 Mon Sep 17 00:00:00 2001 From: Hrishikesh Barman Date: Sat, 16 Mar 2024 12:07:46 +0000 Subject: [PATCH] Add LintDuplicateMetric to promlint Signed-off-by: Hrishikesh Barman --- prometheus/testutil/promlint/promlint_test.go | 24 ++++++++++++ prometheus/testutil/promlint/validation.go | 1 + .../validations/duplicate_validations.go | 37 +++++++++++++++++++ 3 files changed, 62 insertions(+) create mode 100644 prometheus/testutil/promlint/validations/duplicate_validations.go diff --git a/prometheus/testutil/promlint/promlint_test.go b/prometheus/testutil/promlint/promlint_test.go index 7a0ba46..c60507c 100644 --- a/prometheus/testutil/promlint/promlint_test.go +++ b/prometheus/testutil/promlint/promlint_test.go @@ -839,3 +839,27 @@ mc_something_total 10 lintAndVerify(l2, cv) }) } + +func TestLintDuplicateMetric(t *testing.T) { + const msg = "metric not unique" + + tests := []test{ + { + name: "metric not unique", + in: ` +# HELP not_unique_total the helptext +# TYPE not_unique_total counter +not_unique_total{bar="abc", spam="xyz"} 1 +not_unique_total{bar="abc", spam="xyz"} 2 +`, + problems: []promlint.Problem{ + { + Metric: "not_unique_total", + Text: msg, + }, + }, + }, + } + + runTests(t, tests) +} diff --git a/prometheus/testutil/promlint/validation.go b/prometheus/testutil/promlint/validation.go index f52ad9e..e144159 100644 --- a/prometheus/testutil/promlint/validation.go +++ b/prometheus/testutil/promlint/validation.go @@ -30,4 +30,5 @@ var defaultValidations = []Validation{ validations.LintReservedChars, validations.LintCamelCase, validations.LintUnitAbbreviations, + validations.LintDuplicateMetric, } diff --git a/prometheus/testutil/promlint/validations/duplicate_validations.go b/prometheus/testutil/promlint/validations/duplicate_validations.go new file mode 100644 index 0000000..fdc1e62 --- /dev/null +++ b/prometheus/testutil/promlint/validations/duplicate_validations.go @@ -0,0 +1,37 @@ +// Copyright 2024 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 validations + +import ( + "fmt" + "reflect" + + dto "github.com/prometheus/client_model/go" +) + +// LintDuplicateMetric detects duplicate metric. +func LintDuplicateMetric(mf *dto.MetricFamily) []error { + var problems []error + + for i, m := range mf.Metric { + for _, k := range mf.Metric[i+1:] { + if reflect.DeepEqual(m.Label, k.Label) { + problems = append(problems, fmt.Errorf("metric not unique")) + break + } + } + } + + return problems +}