collector

Documentation

Index

• Constants
• func RegisterAPI(clientAPI ClientAPI)
• func RegisterCollector(collector string, flag *bool, ...)
• type ClientAPI
• type Collector
• type CollectorSet
  • func NewCollectorSet(namespace, target string, params map[string]string, logger *slog.Logger) (CollectorSet, error)
  • func (cs *CollectorSet) Collect(ch chan<- prometheus.Metric)
  • func (cs *CollectorSet) Describe(ch chan<- *prometheus.Desc)
• type ScrapeMetrics

Constants

const (
	DefaultEnabled  = true
	DefaultDisabled = false
)

Functions

func RegisterAPI

func RegisterAPI(clientAPI ClientAPI)

func RegisterCollector

func RegisterCollector(collector string, flag *bool, factory func(logger *slog.Logger) (Collector, error))

Types

type ClientAPI

type ClientAPI interface {
	Login(target string, logger *slog.Logger) (map[string]interface{}, error)
	Logout(loginData map[string]interface{}, logger *slog.Logger) error
	Get(loginData, extraConfig map[string]interface{}, logger *slog.Logger) (interface{}, error)
}

type Collector

type Collector interface {
	Update(ch chan<- prometheus.Metric, namespace string, clientAPI ClientAPI, clientData map[string]interface{}, extraParams map[string]string) error
}

Collector is the interface a collector has to implement.

type CollectorSet

type CollectorSet struct {
	Collectors map[string]Collector

	ScrapeMetrics ScrapeMetrics
	// contains filtered or unexported fields
}

func NewCollectorSet

func NewCollectorSet(namespace, target string, params map[string]string, logger *slog.Logger) (CollectorSet, error)

func (*CollectorSet) Collect

func (cs *CollectorSet) Collect(ch chan<- prometheus.Metric)

func (*CollectorSet) Describe

func (cs *CollectorSet) Describe(ch chan<- *prometheus.Desc)

type ScrapeMetrics

type ScrapeMetrics struct {
	Success  *prometheus.Desc
	Duration *prometheus.Desc
}