collector

Documentation

Index

• func IsInvalidConfig(err error) bool
• func IsInvalidExecution(err error) bool
• type App
  • func NewApp(config AppConfig) (*App, error)
  • func (a *App) Collect(ch chan<- prometheus.Metric) error
  • func (a *App) Describe(ch chan<- *prometheus.Desc) error
• type AppConfig
• type AppOperator
  • func NewAppOperator(config AppOperatorConfig) (*AppOperator, error)
  • func (a *AppOperator) Collect(ch chan<- prometheus.Metric) error
  • func (a *AppOperator) Describe(ch chan<- *prometheus.Desc) error
• type AppOperatorConfig
• type Set
  • func NewSet(config SetConfig) (*Set, error)
• type SetConfig

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func IsInvalidExecution

func IsInvalidExecution(err error) bool

IsInvalidExecution asserts invalidExecutionError.

Types

type App

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

App is the main struct for this collector.

func NewApp

func NewApp(config AppConfig) (*App, error)

NewApp creates a new App metrics collector

func (*App) Collect

func (a *App) Collect(ch chan<- prometheus.Metric) error

Collect is the main metrics collection function.

func (*App) Describe

func (a *App) Describe(ch chan<- *prometheus.Desc) error

Describe emits the description for the metrics collected here.

type AppConfig

type AppConfig struct {
	K8sClient k8sclient.Interface
	Logger    micrologger.Logger

	AppTeamMappings     map[string]string
	DefaultTeam         string
	Provider            string
	RetiredTeamsMapping map[string]string
}

AppConfig is this collector's configuration struct.

type AppOperator

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

AppOperator is the main struct for this collector.

func NewAppOperator

func NewAppOperator(config AppOperatorConfig) (*AppOperator, error)

NewAppOperator creates a new AppOperator metrics collector

func (*AppOperator) Collect

func (a *AppOperator) Collect(ch chan<- prometheus.Metric) error

Collect is the main metrics collection function.

func (*AppOperator) Describe

func (a *AppOperator) Describe(ch chan<- *prometheus.Desc) error

Describe emits the description for the metrics collected here.

type AppOperatorConfig

type AppOperatorConfig struct {
	K8sClient k8sclient.Interface
	Logger    micrologger.Logger
}

AppOperatorConfig is this collector's configuration struct.

type Set

type Set struct {
	*collector.Set
}

Set is basically only a wrapper for the operator's collector implementations. It eases the iniitialization and prevents some weird import mess so we do not have to alias packages.

func NewSet

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

type SetConfig

type SetConfig struct {
	K8sClient k8sclient.Interface
	Logger    micrologger.Logger

	AppTeamMappings     map[string]string
	DefaultTeam         string
	Provider            string
	RetiredTeamsMapping map[string]string
}