provider

Documentation

Index

• type Config
• type MetricMessage
• type MetricState
• type MetricWrapper
  • func (wrapper *MetricWrapper) PushFailure(description string, args ...any)
  • func (wrapper *MetricWrapper) PushMessage(description string, args ...any)
  • func (wrapper *MetricWrapper) PushOK()
• type Provider
  • func LoadProviderFromConfig(ctx context.Context, cfg Config) (Provider, error)
  • func NewProviderContainer() (Provider, error)
  • func NewProviderFileSystemUsage(params map[string]any) (Provider, error)
  • func NewProviderPing(params map[string]any) (Provider, error)
  • func NewProviderSystemd(ctx context.Context, params map[string]any) (Provider, error)
• type ProviderContainer
  • func (*ProviderContainer) Destroy()
  • func (containerProvider *ProviderContainer) GetUpdateTaskList(ctx context.Context, resultWrapper *ScrapeResultWrapper, ...) UpdateTaskList
  • func (containerProvider *ProviderContainer) MultipleInstanceAllowed() bool
• type ProviderFileSystemUsage
  • func (*ProviderFileSystemUsage) Destroy()
  • func (provider *ProviderFileSystemUsage) GetUpdateTaskList(ctx context.Context, resultWrapper *ScrapeResultWrapper, ...) UpdateTaskList
  • func (*ProviderFileSystemUsage) MultipleInstanceAllowed() bool
• type ProviderPing
  • func (*ProviderPing) Destroy()
  • func (pingProvider *ProviderPing) GetUpdateTaskList(ctx context.Context, resultWrapper *ScrapeResultWrapper, ...) UpdateTaskList
  • func (pingProvider *ProviderPing) MultipleInstanceAllowed() bool
• type ProviderSystemd
  • func (systemdProvider *ProviderSystemd) Destroy()
  • func (systemdProvider *ProviderSystemd) GetUpdateTaskList(ctx context.Context, resultWrapper *ScrapeResultWrapper, ...) UpdateTaskList
  • func (*ProviderSystemd) MultipleInstanceAllowed() bool
• type ScrapeResultWrapper
  • func MakeScrapeResultWrapper(prefix string, resultChan chan<- any) ScrapeResultWrapper
  • func (wrapper *ScrapeResultWrapper) Metric(metricId, name string) MetricWrapper
• type UpdateTaskList

Types

type Config

type Config struct {
	Type           string         `json:"type"`
	ScrapeInterval uint           `json:"scrape_interval" default:"120"` // scrape interval in seconds
	Params         map[string]any `json:"params" default:"{}"`           // extra parameters
}

type MetricMessage

type MetricMessage struct {
	MetricID    string
	Name        string
	Description string
}

type MetricState

type MetricState struct {
	MetricID    string
	Name        string
	IsHealthy   bool
	Description string
}

type MetricWrapper

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

func (*MetricWrapper) PushFailure

func (wrapper *MetricWrapper) PushFailure(description string, args ...any)

func (*MetricWrapper) PushMessage

func (wrapper *MetricWrapper) PushMessage(description string, args ...any)

func (*MetricWrapper) PushOK

func (wrapper *MetricWrapper) PushOK()

type Provider

type Provider interface {
	// return the list of tasks to be performed to update the provider metrics.
	// This function is called only once at startup.
	// Tasks may be executed in parallel.
	GetUpdateTaskList(ctx context.Context, resultWrapper *ScrapeResultWrapper, storage storage.Storager) UpdateTaskList
	MultipleInstanceAllowed() bool
	Destroy()
}

func LoadProviderFromConfig

func LoadProviderFromConfig(ctx context.Context, cfg Config) (Provider, error)

func NewProviderContainer

func NewProviderContainer() (Provider, error)

func NewProviderFileSystemUsage

func NewProviderFileSystemUsage(params map[string]any) (Provider, error)

func NewProviderPing

func NewProviderPing(params map[string]any) (Provider, error)

func NewProviderSystemd

func NewProviderSystemd(ctx context.Context, params map[string]any) (Provider, error)

type ProviderContainer

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

func (*ProviderContainer) Destroy

func (*ProviderContainer) Destroy()

func (*ProviderContainer) GetUpdateTaskList

func (containerProvider *ProviderContainer) GetUpdateTaskList(ctx context.Context, resultWrapper *ScrapeResultWrapper, storage storage.Storager) UpdateTaskList

func (*ProviderContainer) MultipleInstanceAllowed

func (containerProvider *ProviderContainer) MultipleInstanceAllowed() bool

type ProviderFileSystemUsage

type ProviderFileSystemUsage struct {
	MountPoints             []string `json:"mountpoints"`
	SpaceRemainingThreshold uint     `json:"threshold_percent" default:"20"`
}

func (*ProviderFileSystemUsage) Destroy

func (*ProviderFileSystemUsage) Destroy()

func (*ProviderFileSystemUsage) GetUpdateTaskList

func (provider *ProviderFileSystemUsage) GetUpdateTaskList(ctx context.Context, resultWrapper *ScrapeResultWrapper, storage storage.Storager) UpdateTaskList

func (*ProviderFileSystemUsage) MultipleInstanceAllowed

func (*ProviderFileSystemUsage) MultipleInstanceAllowed() bool

type ProviderPing

type ProviderPing struct {
	Targets    []string `json:"targets"`
	RetryCount uint     `json:"retry_count" default:"3"`
}

func (*ProviderPing) Destroy

func (*ProviderPing) Destroy()

func (*ProviderPing) GetUpdateTaskList

func (pingProvider *ProviderPing) GetUpdateTaskList(ctx context.Context, resultWrapper *ScrapeResultWrapper, storage storage.Storager) UpdateTaskList

func (*ProviderPing) MultipleInstanceAllowed

func (pingProvider *ProviderPing) MultipleInstanceAllowed() bool

type ProviderSystemd

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

func (*ProviderSystemd) Destroy

func (systemdProvider *ProviderSystemd) Destroy()

func (*ProviderSystemd) GetUpdateTaskList

func (systemdProvider *ProviderSystemd) GetUpdateTaskList(ctx context.Context, resultWrapper *ScrapeResultWrapper, storage storage.Storager) UpdateTaskList

func (*ProviderSystemd) MultipleInstanceAllowed

func (*ProviderSystemd) MultipleInstanceAllowed() bool

type ScrapeResultWrapper

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

func MakeScrapeResultWrapper

func MakeScrapeResultWrapper(prefix string, resultChan chan<- any) ScrapeResultWrapper

func (*ScrapeResultWrapper) Metric

func (wrapper *ScrapeResultWrapper) Metric(metricId, name string) MetricWrapper

type UpdateTaskList

type UpdateTaskList []func()