promlint

package

v1.6.0 Latest Latest Go to latest Published: Apr 14, 2017 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/saswatamcode/prometheus

Links

Open Source Insights

Documentation ¶

Overview ¶

Package promlint provides a linter for Prometheus metrics.

Index ¶

type Linter
- func New(r io.Reader) *Linter
- func (l *Linter) Lint() ([]Problem, error)
type Problem

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Linter ¶

type Linter struct {
	// contains filtered or unexported fields
}

A Linter is a Prometheus metrics linter. It identifies issues with metric names, types, and metadata, and reports them to the caller.

func New ¶

func New(r io.Reader) *Linter

New creates a new Linter that reads an input stream of Prometheus metrics. Only the text exposition format is supported.

func (*Linter) Lint ¶

func (l *Linter) Lint() ([]Problem, error)

Lint performs a linting pass, returning a slice of Problems indicating any issues found in the metrics stream. The slice is sorted by metric name and issue description.

type Problem ¶

type Problem struct {
	// The name of the metric indicated by this Problem.
	Metric string

	// A description of the issue for this Problem.
	Text string
}

A Problem is an issue detected by a Linter.

Source Files ¶

View all Source files

promlint.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL