types

Documentation

Index

• type AllowDenyLister
• type BuildCustomResourceStoresFunc
• type BuildStoresFunc
• type BuilderInterface

Types

type AllowDenyLister

type AllowDenyLister interface {
	IsIncluded(string) bool
	IsExcluded(string) bool
}

AllowDenyLister interface for AllowDeny lister that can allow or exclude metrics by there names

type BuildCustomResourceStoresFunc

type BuildCustomResourceStoresFunc func(resourceName string,
	metricFamilies []generator.FamilyGenerator,
	expectedType interface{},
	listWatchFunc func(customResourceClient interface{}, ns string, fieldSelector string) cache.ListerWatcher,
	useAPIServerCache bool,
) []cache.Store

BuildCustomResourceStoresFunc function signature that is used to return a list of custom resource cache.Store

type BuildStoresFunc

type BuildStoresFunc func(metricFamilies []generator.FamilyGenerator,
	expectedType interface{},
	listWatchFunc func(kubeClient clientset.Interface, ns string, fieldSelector string) cache.ListerWatcher,
	useAPIServerCache bool,
) []cache.Store

BuildStoresFunc function signature that is used to return a list of cache.Store

type BuilderInterface

type BuilderInterface interface {
	WithMetrics(r prometheus.Registerer)
	WithEnabledResources(c []string) error
	WithNamespaces(n options.NamespaceList, nsFilter string)
	WithSharding(shard int32, totalShards int)
	WithContext(ctx context.Context)
	WithKubeClient(c clientset.Interface)
	WithVPAClient(c vpaclientset.Interface)
	WithCustomResourceClients(cs map[string]interface{})
	WithUsingAPIServerCache(u bool)
	WithFamilyGeneratorFilter(l generator.FamilyGeneratorFilter)
	WithAllowAnnotations(a map[string][]string)
	WithAllowLabels(l map[string][]string)
	WithGenerateStoresFunc(f BuildStoresFunc)
	WithGenerateCustomResourceStoresFunc(f BuildCustomResourceStoresFunc)
	DefaultGenerateStoresFunc() BuildStoresFunc
	DefaultGenerateCustomResourceStoresFunc() BuildCustomResourceStoresFunc
	WithCustomResourceStoreFactories(fs ...customresource.RegistryFactory)
	Build() []metricsstore.MetricsWriter
	BuildStores() [][]cache.Store
}

BuilderInterface represent all methods that a Builder should implements