metrics

Documentation

Index

• type ContainerMetricsSnapshot
• type ExternalClientOptions
• type MetricsClient
  • func NewMetricsClient(source PodMetricsLister, namespace, clientName string) MetricsClient
• type PodMetricsLister
  • func NewExternalClient(c *rest.Config, clusterState *model.ClusterState, ...) PodMetricsLister
  • func NewPodMetricsesSource(source resourceclient.PodMetricsesGetter) PodMetricsLister

Types

type ContainerMetricsSnapshot

type ContainerMetricsSnapshot struct {
	// ID identifies a specific container those metrics are coming from.
	ID model.ContainerID
	// End time of the measurement interval.
	SnapshotTime time.Time
	// Duration of the measurement interval, which is [SnapshotTime - SnapshotWindow, SnapshotTime].
	SnapshotWindow time.Duration
	// Actual usage of the resources over the measurement interval.
	Usage model.Resources
}

ContainerMetricsSnapshot contains information about usage of certain container within defined time window.

type ExternalClientOptions

type ExternalClientOptions struct {
	ResourceMetrics map[k8sapiv1.ResourceName]string
	// Label to use for the container name.
	ContainerNameLabel string
}

ExternalClientOptions specifies parameters for using an External Metrics Client.

type MetricsClient

type MetricsClient interface {
	// GetContainersMetrics returns an array of ContainerMetricsSnapshots,
	// representing resource usage for every running container in the cluster
	GetContainersMetrics() ([]*ContainerMetricsSnapshot, error)
}

MetricsClient provides simple metrics on resources usage on container level.

func NewMetricsClient

func NewMetricsClient(source PodMetricsLister, namespace, clientName string) MetricsClient

NewMetricsClient creates new instance of MetricsClient, which is used by recommender. namespace limits queries to particular namespace, use k8sapiv1.NamespaceAll to select all namespaces.

type PodMetricsLister

type PodMetricsLister interface {
	List(ctx context.Context, namespace string, opts v1.ListOptions) (*v1beta1.PodMetricsList, error)
}

PodMetricsLister wraps both metrics-client and External Metrics

func NewExternalClient

func NewExternalClient(c *rest.Config, clusterState *model.ClusterState, options ExternalClientOptions) PodMetricsLister

NewExternalClient returns a Source for an External Metrics Client.

func NewPodMetricsesSource

func NewPodMetricsesSource(source resourceclient.PodMetricsesGetter) PodMetricsLister

NewPodMetricsesSource Returns a Source-wrapper around PodMetricsesGetter.