common

Documentation

Overview

Package common is for some common functions for tooling

Index

• func CalculateAverageAndPeak(data []Data) (float64, float64)
• func ConstructPrometheusClient(address string) (v1.API, error)
• func ConstructTimeRange(startTime, endTime time.Time, stepDuration time.Duration) v1.Range
• type Data
• type Result
  • func ConstructResult(value model.Value, metric, unit string, podName string) (*Result, error)
  • func (r Result) Print()

Functions

func CalculateAverageAndPeak

func CalculateAverageAndPeak(data []Data) (float64, float64)

CalculateAverageAndPeak calculates the average and peak values of related metric

func ConstructPrometheusClient

func ConstructPrometheusClient(address string) (v1.API, error)

ConstructPrometheusClient creates a Prometheus API Client

func ConstructTimeRange

func ConstructTimeRange(startTime, endTime time.Time, stepDuration time.Duration) v1.Range

ConstructTimeRange creates a Range object that consists the start time, end time and step duration

Types

type Data

type Data struct {
	Timestamp time.Time
	Value     float64
}

Data represents a collected data

type Result

type Result struct {
	Data          []Data
	Metric        string
	MetricUnit    string
	Peak, Average float64
	PodName       string
}

Result represents all collected data for a metric

func ConstructResult

func ConstructResult(value model.Value, metric, unit string, podName string) (*Result, error)

ConstructResult creates a Result object from collected data

func (Result) Print

func (r Result) Print()

Print reports the results