metric

Documentation

Overview

Package metric provides functionality for managing gathering metrics, calling external metric gathering logic through shell commands with relevant data piped to them.

Index

• type Gatherer
  • func (m *Gatherer) GetMetrics(resource metav1.Object) (*ResourceMetrics, error)
• type GetMetricer
• type Metric
• type ResourceMetrics

Types

type Gatherer

type Gatherer struct {
	Clientset kubernetes.Interface
	Config    *config.Config
	Execute   execute.Executer
}

Gatherer handles triggering the metric gathering logic to gather metrics for a resource

func (*Gatherer) GetMetrics

func (m *Gatherer) GetMetrics(resource metav1.Object) (*ResourceMetrics, error)

GetMetrics gathers metrics for the resource supplied

type GetMetricer

type GetMetricer interface {
	GetMetrics(resource metav1.Object) (*ResourceMetrics, error)
}

GetMetricer provides methods for retrieving metrics

type Metric

type Metric struct {
	Resource string `json:"resource,omitempty"`
	Value    string `json:"value,omitempty"`
}

Metric is the result of the custom metric calculation, containing information on the relevant resource and the metric value

type ResourceMetrics

type ResourceMetrics struct {
	ResourceName string        `json:"resource"`
	RunType      string        `json:"run_type"`
	Metrics      []*Metric     `json:"metrics"`
	Resource     metav1.Object `json:"-"` // hide
}

ResourceMetrics represents a resource's metrics, including each resource's metrics