scout

Documentation

Index

• Constants
• func Contains(slice []string, value string) bool
• func GetPercentage(x, y float64) float64
• type Advice
• type Config
• type ContainerMetrics
• type Resources
• type UsageStats

Constants

const (
	ABillion              float64 = 1_000_000_000
	EmojiFingerPointRight         = "👉"
	FlashingLightEmoji            = "🚨"
	SuccessEmoji                  = "✅"
	WarningSign                   = "⚠️ " // why does this need an extra space to align?!?!
	HEALTHY                       = "HEALTHY"
	WARNING                       = "WARNING"
	DANGER                        = "DANGER"
)

Functions

func Contains

func Contains(slice []string, value string) bool

contains checks if a string slice contains a given value.

func GetPercentage

func GetPercentage(x, y float64) float64

getPercentage calculates the percentage of x in relation to y.

Types

type Advice

type Advice struct {
	Kind string
	Msg  string
}

type Config

type Config struct {
	Namespace     string
	Pod           string
	Output        string
	Warnings      bool
	RestConfig    *rest.Config
	K8sClient     *kubernetes.Clientset
	MetricsClient *metricsv.Clientset
}

type ContainerMetrics

type ContainerMetrics struct {
	PodName string
	Limits  map[string]Resources
}

type Resources

type Resources struct {
	Cpu     *resource.Quantity
	Memory  *resource.Quantity
	Storage *resource.Quantity
}

type UsageStats

type UsageStats struct {
	ContainerName string
	CpuCores      *resource.Quantity
	Memory        *resource.Quantity
	Storage       *resource.Quantity
	CpuUsage      float64
	MemoryUsage   float64
	StorageUsage  float64
}