collectors

Documentation

Overview

TODO: rename collector

Index

• Variables
• type Builder
  • func NewBuilder(ctx context.Context) *Builder
  • func (b *Builder) Build() []*Collector
  • func (b *Builder) WithEnabledCollectors(c []string)
  • func (b *Builder) WithKubeClient(c clientset.Interface)
  • func (b *Builder) WithNamespaces(n options.NamespaceList)
  • func (b *Builder) WithWhiteBlackList(l whiteBlackLister)
• type Collector
  • func NewCollector(s Store) *Collector
  • func (c *Collector) Collect(w io.Writer)
• type Store

Variables

var (
	ScrapeErrorTotalMetric = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "ksm_scrape_error_total",
			Help: "Total scrape errors encountered when scraping a resource",
		},
		[]string{"resource"},
	)

	ResourcesPerScrapeMetric = prometheus.NewSummaryVec(
		prometheus.SummaryOpts{
			Name: "ksm_resources_per_scrape",
			Help: "Number of resources returned per scrape",
		},
		[]string{"resource"},
	)
)

Types

type Builder

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

Builder helps to build collectors. It follows the builder pattern (https://en.wikipedia.org/wiki/Builder_pattern).

func NewBuilder

func NewBuilder(
	ctx context.Context,
) *Builder

NewBuilder returns a new builder.

func (*Builder) Build

func (b *Builder) Build() []*Collector

Build initializes and registers all enabled collectors.

func (*Builder) WithEnabledCollectors

func (b *Builder) WithEnabledCollectors(c []string)

WithEnabledCollectors sets the enabledCollectors property of a Builder.

func (*Builder) WithKubeClient

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

WithKubeClient sets the kubeClient property of a Builder.

func (*Builder) WithNamespaces

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

WithNamespaces sets the namespaces property of a Builder.

func (*Builder) WithWhiteBlackList

func (b *Builder) WithWhiteBlackList(l whiteBlackLister)

WithWhiteBlackList configures the white or blacklisted metrics to be exposed by the collectors build by the Builder

type Collector

type Collector struct {
	Store Store
}

Collector represents a kube-state-metrics metric collector. It is a stripped down version of the Prometheus client_golang collector.

func NewCollector

func NewCollector(s Store) *Collector

NewCollector constructs a collector with the given Store.

func (*Collector) Collect

func (c *Collector) Collect(w io.Writer)

Collect returns all metrics of the underlying store of the collector.

type Store

type Store interface {
	WriteAll(io.Writer)
}

Store represents a metrics store e.g. k8s.io/kube-state-metrics/pkg/metrics_store.