metrics

Documentation

Index

• Constants
• func CollectCronJobs(cronjobs []batchv1.CronJob) (*MetricSet, StateSet)
• func CollectDaemonSets(daemonsets []appsv1.DaemonSet) (*MetricSet, StateSet)
• func CollectDeployments(deployments []appsv1.Deployment) (*MetricSet, StateSet)
• func CollectJobs(jobs []batchv1.Job) (*MetricSet, StateSet)
• func CollectPods(pods []corev1.Pod) (*MetricSet, StateSet)
• func CollectReplicaSets(replicasets []appsv1.ReplicaSet) (*MetricSet, StateSet)
• func CollectStatefulSets(statefulsets []appsv1.StatefulSet) (*MetricSet, StateSet)
• func ConvertToMetricData(timestamp time.Time, cluster string, states StateSet) []awstypes.MetricDatum
• func Log(writer io.Writer, metrics *MetricSet) error
• type Metric
• type MetricSet
  • func CombineRecords(recordsInput *MetricSet, recordsAppend *MetricSet) *MetricSet
  • func NewMetricSet() *MetricSet
  • func (s *MetricSet) Increment(kind, namespace string, phase string)
• type Pusher
  • func NewPusher(cloudwatchClient types.CloudwatchInterface) *Pusher
  • func (p *Pusher) Push(ctx context.Context, namespace string, metricData []awstypes.MetricDatum) error
• type StateSet
  • func CombineStates(input *StateSet, og *StateSet) StateSet

Constants

const (
	// KindPod is the cost reference to the Kubernetes Pod object.
	KindPod = "Pod"
	// KindDaemonSet is a daemonset.
	KindDaemonSet = "DaemonSet"
	// KindDeployment is the cost reference to the Kubernetes Deployment object.
	KindDeployment = "Deployment"
	// KindReplicaSet is the cost reference to the Kubernetes ReplicaSet object.
	KindReplicaSet = "ReplicaSet"
	// KindStatefulSet is the cost reference to the Kubernetes StatefulSet object.
	KindStatefulSet = "StatefulSet"
	// KindCronJob is the cost reference to the Kubernetes CronJob object.
	KindCronJob = "CronJob"
	// KindJob is the cost reference to the Kubernetes Job object.
	KindJob = "Job"

	// StateScaledDown indicates the desired replicas for the object is 0.
	StateScaledDown = "ScaledDown"
	// StateReady is the const representing the state for an object being Ready
	StateReady = string(corev1.PodReady)
	// StateNotReady is the const representing the state for an object not being Ready
	StateNotReady = string(corev1.PodPending)
	// StateSuspended is the const representing the state for a CronJob being Suspended
	StateSuspended = string(batchv1.JobSuspended)
	// StateActive is the const representing the state for a CronJob being not Suspended
	StateActive = "Active"
	// StateRunning is the const representing the state for a Job currently running
	StateRunning = string(corev1.PodRunning)
	// StateFailed is the const representing the state for an object having been Failed
	StateFailed = string(batchv1.JobFailed)
	// StateSucceeded is the const representing the state for an object having been completed successfully
	StateSucceeded = string(batchv1.JobComplete)
	// StateAvailable is the state of which a DaemonSet is available for scheduling.
	StateAvailable = "Available"
	// StateUnavailable is the state of which a DaemonSet is not available for scheduling.
	StateUnavailable = "Unavailable"
	// StateMisscheduled is the state of which a DaemonSet was not able to schedule.
	StateMisscheduled = "Misscheduled"
	// StateScheduled is the state of which a DaemonSet was able to schedule.
	StateScheduled = "Scheduled"
)

Functions

func CollectCronJobs

func CollectCronJobs(cronjobs []batchv1.CronJob) (*MetricSet, StateSet)

CollectCronJobs will collect ze metrics for cronjobs.

func CollectDaemonSets

func CollectDaemonSets(daemonsets []appsv1.DaemonSet) (*MetricSet, StateSet)

CollectDaemonSets will collect ze metrics for statefulsets.

func CollectDeployments

func CollectDeployments(deployments []appsv1.Deployment) (*MetricSet, StateSet)

CollectDeployments will collect ze metrics for deployments.

func CollectJobs

func CollectJobs(jobs []batchv1.Job) (*MetricSet, StateSet)

CollectJobs will collect ze metrics for jobs.

func CollectPods

func CollectPods(pods []corev1.Pod) (*MetricSet, StateSet)

CollectPods will collect ze metrics for pods.

func CollectReplicaSets

func CollectReplicaSets(replicasets []appsv1.ReplicaSet) (*MetricSet, StateSet)

CollectReplicaSets will collect ze metrics for replicasets.

func CollectStatefulSets

func CollectStatefulSets(statefulsets []appsv1.StatefulSet) (*MetricSet, StateSet)

CollectStatefulSets will collect ze metrics for statefulsets.

func ConvertToMetricData

func ConvertToMetricData(timestamp time.Time, cluster string, states StateSet) []awstypes.MetricDatum

ConvertToMetricData converts our metrics to aws metric data.

func Log

func Log(writer io.Writer, metrics *MetricSet) error

Log logs the metrics to the writer.

Types

type Metric

type Metric struct {
	Name   string            `json:"name"`
	Value  int               `json:"value"`
	Type   string            `json:"type"`
	Labels map[string]string `json:"labels"`
}

Metric represents an individual metric.

type MetricSet

type MetricSet struct {
	Items map[string]*Metric
}

MetricSet is the metric set.

func CombineRecords

func CombineRecords(recordsInput *MetricSet, recordsAppend *MetricSet) *MetricSet

CombineRecords will combine two metric sets.

func NewMetricSet

func NewMetricSet() *MetricSet

NewMetricSet creates a new metric set.

func (*MetricSet) Increment

func (s *MetricSet) Increment(kind, namespace string, phase string)

Increment the metric.

type Pusher

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

Pusher the metrics pusher.

func NewPusher

func NewPusher(cloudwatchClient types.CloudwatchInterface) *Pusher

NewPusher creates a new metrics pusher.

func (*Pusher) Push

func (p *Pusher) Push(ctx context.Context, namespace string, metricData []awstypes.MetricDatum) error

Push the metrics.

type StateSet

type StateSet map[string]map[string]int

StateSet is the state of the metrics. ie Pod Phase, Deployment Status or CronJob Suspended state.

func CombineStates

func CombineStates(input *StateSet, og *StateSet) StateSet

CombineStates will combine two state sets.