collector

Documentation

Index

• func IsAlreadyRegisteredError(err error) bool
• func IsInvalidConfig(err error) bool
• type Interface
• type Set
  • func NewSet(config SetConfig) (*Set, error)
  • func (s *Set) Boot(ctx context.Context) error
  • func (s *Set) Collect(ch chan<- prometheus.Metric)
  • func (s *Set) Describe(ch chan<- *prometheus.Desc)
  • func (s *Set) Stop(ctx context.Context)
• type SetConfig

Functions

func IsAlreadyRegisteredError

func IsAlreadyRegisteredError(err error) bool

IsAlreadyRegisteredError asserts alreadyRegisteredError.

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Interface

type Interface interface {
	// Collect should align with the monitoring system's implementation
	// requirements. In this case Prometheus. See also
	// https://godoc.org/github.com/prometheus/client_golang/prometheus#Collector.
	// The difference here is that this specific interface provides additional
	// error handling capabilities.
	Collect(ch chan<- prometheus.Metric) error
	// Describe should align with the monitoring system's implementation
	// requirements. In this case Prometheus. See also
	// https://godoc.org/github.com/prometheus/client_golang/prometheus#Collector.
	// The difference here is that this specific interface provides additional
	// error handling capabilities.
	Describe(ch chan<- *prometheus.Desc) error
}

Interface defines how a collector implementation should look like.

type Set

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

func NewSet

func NewSet(config SetConfig) (*Set, error)

func (*Set) Boot

func (s *Set) Boot(ctx context.Context) error

func (*Set) Collect

func (s *Set) Collect(ch chan<- prometheus.Metric)

func (*Set) Describe

func (s *Set) Describe(ch chan<- *prometheus.Desc)

func (*Set) Stop

func (s *Set) Stop(ctx context.Context)

type SetConfig

type SetConfig struct {
	Collectors []Interface
	Logger     micrologger.Logger
}