33 lines
975 B
Go
33 lines
975 B
Go
|
// Copyright 2020 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 (
|
||
|
|
"errors"
|
||
|
|
|
||
|
|
dto "github.com/prometheus/client_model/go"
|
||
|
|
)
|
||
|
|
|
||
|
|
// LintHelp detects issues related to the help text for a metric.
|
||
|
|
func LintHelp(mf *dto.MetricFamily) []error {
|
||
|
|
var problems []error
|
||
|
|
|
||
|
|
// Expect all metrics to have help text available.
|
||
|
|
if mf.Help == nil {
|
||
|
|
problems = append(problems, errors.New("no help text"))
|
||
|
|
}
|
||
|
|
|
||
|
|
return problems
|
||
|
|
}
|