metrics

Documentation

Index

• type ContainerMetricsSnapshot
• type MetricsClient
  • func NewMetricsClient(config *rest.Config, namespace, clientName string) MetricsClient

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 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(config *rest.Config, 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.