prometheus

Documentation

Overview

Package prometheus defines shared elements for Prometheus.

Index

• Variables
• type Registry
• type Settings
  • func (s *Settings) SetDefaults()
  • func (s Settings) Validate() (err error)

Variables

var (
	ErrPrefixContainsSpace = errors.New("prefix contains one or more spaces")
)

Types

type Registry

type Registry interface {
	prometheus.Registerer
}

type Settings

type Settings struct {
	// Prefix, aka Subsystem, is the prefix string in front
	// of all metric names.
	Prefix string
	// Registry is the Prometheus registry to use for the metrics.
	// It defaults to prometheus.DefaultRegisterer if left unset.
	Registry Registry
}

func (*Settings) SetDefaults

func (s *Settings) SetDefaults()

func (Settings) Validate

func (s Settings) Validate() (err error)