metricsstore

Documentation

Index

• type FamilyByteSlicer
• type MetricsStore
  • func NewMetricsStore(headers []string, generateFunc func(interface{}) []FamilyByteSlicer) *MetricsStore
  • func (s *MetricsStore) Add(obj interface{}) error
  • func (s *MetricsStore) Delete(obj interface{}) error
  • func (s *MetricsStore) Get(obj interface{}) (item interface{}, exists bool, err error)
  • func (s *MetricsStore) GetByKey(key string) (item interface{}, exists bool, err error)
  • func (s *MetricsStore) List() []interface{}
  • func (s *MetricsStore) ListKeys() []string
  • func (s *MetricsStore) Replace(list []interface{}, _ string) error
  • func (s *MetricsStore) Resync() error
  • func (s *MetricsStore) Update(obj interface{}) error
  • func (s *MetricsStore) WriteAll(w io.Writer)

Types

type FamilyByteSlicer

type FamilyByteSlicer interface {
	ByteSlice() []byte
}

FamilyByteSlicer represents a metric family that can be converted to its string representation.

type MetricsStore

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

MetricsStore implements the k8s.io/client-go/tools/cache.Store interface. Instead of storing entire Kubernetes objects, it stores metrics generated based on those objects.

func NewMetricsStore

func NewMetricsStore(headers []string, generateFunc func(interface{}) []FamilyByteSlicer) *MetricsStore

NewMetricsStore returns a new MetricsStore

func (*MetricsStore) Add

func (s *MetricsStore) Add(obj interface{}) error

Add inserts adds to the MetricsStore by calling the metrics generator functions and adding the generated metrics to the metrics map that underlies the MetricStore.

func (*MetricsStore) Delete

func (s *MetricsStore) Delete(obj interface{}) error

Delete deletes an existing entry in the MetricsStore.

func (*MetricsStore) Get

func (s *MetricsStore) Get(obj interface{}) (item interface{}, exists bool, err error)

Get implements the Get method of the store interface.

func (*MetricsStore) GetByKey

func (s *MetricsStore) GetByKey(key string) (item interface{}, exists bool, err error)

GetByKey implements the GetByKey method of the store interface.

func (*MetricsStore) List

func (s *MetricsStore) List() []interface{}

List implements the List method of the store interface.

func (*MetricsStore) ListKeys

func (s *MetricsStore) ListKeys() []string

ListKeys implements the ListKeys method of the store interface.

func (*MetricsStore) Replace

func (s *MetricsStore) Replace(list []interface{}, _ string) error

Replace will delete the contents of the store, using instead the given list.

func (*MetricsStore) Resync

func (s *MetricsStore) Resync() error

Resync implements the Resync method of the store interface.

func (*MetricsStore) Update

func (s *MetricsStore) Update(obj interface{}) error

Update updates the existing entry in the MetricsStore.

func (*MetricsStore) WriteAll

func (s *MetricsStore) WriteAll(w io.Writer)

WriteAll writes all metrics of the store into the given writer, zipped with the help text of each metric family.