builder

Documentation

Index

• type Builder
  • func New(client *statsd.Client) *Builder
  • func (b *Builder) Build() []cache.Store
  • func (b *Builder) GenerateStore(metricFamilies []generator.FamilyGenerator, expectedType interface{}, ...) cache.Store
  • func (b *Builder) WithAllowDenyList(l ksmtypes.AllowDenyLister)
  • func (b *Builder) WithContext(ctx context.Context)
  • func (b *Builder) WithEnabledResources(c []string) error
  • func (b *Builder) WithGenerateStoreFunc(f ksmtypes.BuildStoreFunc)
  • func (b *Builder) WithKubeClient(c clientset.Interface)
  • func (b *Builder) WithMetrics(r *prometheus.Registry)
  • func (b *Builder) WithNamespaces(nss options.NamespaceList)
  • func (b *Builder) WithSharding(shard int32, totalShards int)
  • func (b *Builder) WithVPAClient(c vpaclientset.Interface)

Types

type Builder

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

Builder struct represented the metric store generator

func New

func New(client *statsd.Client) *Builder

New returns new Builder instance

func (*Builder) Build

func (b *Builder) Build() []cache.Store

Build initializes and registers all enabled stores.

func (*Builder) GenerateStore

func (b *Builder) GenerateStore(metricFamilies []generator.FamilyGenerator,
	expectedType interface{},
	listWatchFunc func(kubeClient clientset.Interface, ns string) cache.ListerWatcher,
) cache.Store

GenerateStore use to generate new Metrics Store for Metrics Families

func (*Builder) WithAllowDenyList

func (b *Builder) WithAllowDenyList(l ksmtypes.AllowDenyLister)

WithAllowDenyList configures the Allow or Deny metric to be exposed by the store build by the Builder.

func (*Builder) WithContext

func (b *Builder) WithContext(ctx context.Context)

WithContext sets the ctx property of a Builder.

func (*Builder) WithEnabledResources

func (b *Builder) WithEnabledResources(c []string) error

WithEnabledResources sets the enabledResources property of a Builder.

func (*Builder) WithGenerateStoreFunc

func (b *Builder) WithGenerateStoreFunc(f ksmtypes.BuildStoreFunc)

WithGenerateStoreFunc configures a constom generate store function

func (*Builder) WithKubeClient

func (b *Builder) WithKubeClient(c clientset.Interface)

WithKubeClient sets the kubeClient property of a Builder.

func (*Builder) WithMetrics

func (b *Builder) WithMetrics(r *prometheus.Registry)

WithMetrics sets the metrics property of a Builder.

func (*Builder) WithNamespaces

func (b *Builder) WithNamespaces(nss options.NamespaceList)

WithNamespaces sets the namespaces property of a Builder.

func (*Builder) WithSharding

func (b *Builder) WithSharding(shard int32, totalShards int)

WithSharding sets the shard and totalShards property of a Builder.

func (*Builder) WithVPAClient

func (b *Builder) WithVPAClient(c vpaclientset.Interface)

WithVPAClient sets the vpaClient property of a Builder so that the verticalpodautoscaler collector can query VPA objects.