resource

Documentation

Overview

Package resource provides utilities for gathering and evaluating resource metrics

Index

• type Evaluate
  • func (e *Evaluate) Evaluate(currentReplicas int32, gatheredMetric *metrics.Metric, tolerance float64) (int32, error)
• type Gather
  • func (c *Gather) Gather(resourceName corev1.ResourceName, namespace string, ...) (*resource.Metric, error)
  • func (c *Gather) GatherRaw(resourceName corev1.ResourceName, namespace string, ...) (*resource.Metric, error)

Types

type Evaluate

type Evaluate struct {
	Calculater replicas.Calculator
}

Evaluate (resource) calculates a replica count evaluation, using the tolerance and calculater provided

func (*Evaluate) Evaluate

func (e *Evaluate) Evaluate(currentReplicas int32, gatheredMetric *metrics.Metric, tolerance float64) (int32, error)

Evaluate calculates an evaluation based on the metric provided and the current number of replicas

type Gather

type Gather struct {
	MetricsClient metricsclient.Client
	PodLister     corelisters.PodLister
}

Gather (Resource) provides functionality for retrieving metrics for resource metric specs.

func (*Gather) Gather

func (c *Gather) Gather(resourceName corev1.ResourceName, namespace string, podSelector labels.Selector,
	cpuInitializationPeriod time.Duration, delayOfInitialReadinessStatus time.Duration) (*resource.Metric, error)

Gather retrieves a resource metric

func (*Gather) GatherRaw

func (c *Gather) GatherRaw(resourceName corev1.ResourceName, namespace string, podSelector labels.Selector,
	cpuInitializationPeriod time.Duration, delayOfInitialReadinessStatus time.Duration) (*resource.Metric, error)

GatherRaw retrieves a a raw resource metric