metricsresource

Documentation

Index

• Constants
• func IsInvalidConfig(err error) bool
• func New(config Config) (framework.Resource, error)
• func Wrap(resources []framework.Resource, config WrapConfig) ([]framework.Resource, error)
• type Config
• type WrapConfig

Constants

const (
	PrometheusNamespace = "operatorkit"
	PrometheusSubsystem = "framework"
)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func New

func New(config Config) (framework.Resource, error)

func Wrap

func Wrap(resources []framework.Resource, config WrapConfig) ([]framework.Resource, error)

Wrap wraps each given resource with a metrics resource and returns the list of wrapped resources.

Types

type Config

type Config struct {
	Resource framework.Resource

	// Name is name of the service using the reconciler framework. This may be the
	// name of the executing operator or controller. The service name will be used
	// to label metrics.
	Name string
}

type WrapConfig

type WrapConfig struct {
	Name string
}