optimize

Documentation

Index

• func NewCmdConfigure() *cobra.Command
• func NewCmdDelete() *cobra.Command
• func NewCmdEvents() *cobra.Command
• func NewCmdRecommendations() *cobra.Command
• func NewCmdServoLogs() *cobra.Command
• func NewCmdStart() *cobra.Command
• func NewCmdStatus() *cobra.Command
• func NewCmdStop() *cobra.Command
• func NewCmdSuspend() *cobra.Command
• func NewCmdUnsuspend() *cobra.Command
• func NewSubCmd() *cobra.Command
• type Blocker
• type Blockers
• type CPU
• type Config
• type ErrorPercent
• type EventsRow
• type Guardrails
• type IgnoredBlockers
• type JsonStoreItem
• type K8SDeployment
• type MedianResponseTime
• type Mem
• type OptimizerConfiguration
• type OptimizerStatus
• type Principal
• type Slo
• type Suspension
• type Target

Functions

func NewCmdConfigure

func NewCmdConfigure() *cobra.Command

func NewCmdDelete

func NewCmdDelete() *cobra.Command

func NewCmdEvents

func NewCmdEvents() *cobra.Command

func NewCmdRecommendations

func NewCmdRecommendations() *cobra.Command

func NewCmdServoLogs

func NewCmdServoLogs() *cobra.Command

func NewCmdStart

func NewCmdStart() *cobra.Command

func NewCmdStatus

func NewCmdStatus() *cobra.Command

func NewCmdStop

func NewCmdStop() *cobra.Command

func NewCmdSuspend

func NewCmdSuspend() *cobra.Command

func NewCmdUnsuspend

func NewCmdUnsuspend() *cobra.Command

func NewSubCmd

func NewSubCmd() *cobra.Command

Types

type Blocker

type Blocker struct {
	Description string `json:"description"`
	Impact      string `json:"impact"`
	Overridable bool   `json:"-"` // do not write to json for orion
}

type Blockers

type Blockers struct {
	Stateful                    *Blocker `json:"stateful,omitempty"`
	NoTraffic                   *Blocker `json:"no_traffic,omitempty"`
	ResourcesNotSpecified       *Blocker `json:"resources_not_specified,omitempty"`
	CPUNotSpecified             *Blocker `json:"cpu_not_specified,omitempty"`
	MemNotSpecified             *Blocker `json:"mem_not_specified,omitempty"`
	CPUResourcesChange          *Blocker `json:"cpu_resources_change,omitempty"`
	MemoryResourcesChange       *Blocker `json:"mem_resources_change,omitempty"`
	K8sMetricsDeficient         *Blocker `json:"k8s_metrics_deficient,omitempty"`
	APMMetricsMissing           *Blocker `json:"apm_metrics_missing,omitempty"`
	APMMetricsDeficient         *Blocker `json:"apm_metrics_deficient,omitempty"`
	MultipleAPM                 *Blocker `json:"multiple_apm,omitempty"`
	UnequalLoadDistribution     *Blocker `json:"unequal_load_distribution,omitempty"`
	NoScaling                   *Blocker `json:"no_scaling,omitempty"`
	InsufficientRelativeScaling *Blocker `json:"insufficient_relative_scaling,omitempty"`
	InsufficientFixedScaling    *Blocker `json:"insufficient_fixed_scaling,omitempty"`
	MTBFHigh                    *Blocker `json:"mtbf_high,omitempty"`
	ErrorRateHigh               *Blocker `json:"error_rate_high,omitempty"`
	NoOrchestrationAgent        *Blocker `json:"no_orchestration_agent,omitempty"`
}

type CPU

type CPU struct {
	Max    float64 `json:"max"`
	Min    float64 `json:"min"`
	Pinned bool    `json:"pinned"`
}

type Config

type Config struct {
	Guardrails Guardrails `json:"guardrails"`
	Slo        Slo        `json:"slo"`
}

type ErrorPercent

type ErrorPercent struct {
	Target float64 `json:"target"`
}

type EventsRow

type EventsRow struct {
	Timestamp       time.Time
	EventAttributes map[string]any
	EntityInfo      string
	Summary         string
}

type Guardrails

type Guardrails struct {
	CPU CPU `json:"cpu"`
	Mem Mem `json:"mem"`
}

type IgnoredBlockers

type IgnoredBlockers struct {
	Principal Principal `json:"principal,omitempty"`
	Timestamp string    `json:"timestamp,omitempty"`
	Blockers  Blockers  `json:"blockers,omitempty"`
}

type JsonStoreItem

type JsonStoreItem struct {
	CreatedAt time.Time `json:"createdAt"`
	// Data           Data      `json:"data"`  NOTE: leave out data so that its type can be specified by embedding this type into another
	ID             string    `json:"id"`
	LayerID        string    `json:"layerId"`
	LayerType      string    `json:"layerType"`
	ObjectMimeType string    `json:"objectMimeType"`
	ObjectType     string    `json:"objectType"`
	ObjectVersion  int       `json:"objectVersion"`
	Patch          any       `json:"patch"`
	TargetObjectID any       `json:"targetObjectId"`
	UpdatedAt      time.Time `json:"updatedAt"`
}

TODO move to Orion package?

type K8SDeployment

type K8SDeployment struct {
	ClusterID     string `json:"clusterId"`
	DeploymentUID string `json:"deploymentUid"`
	ClusterName   string `json:"clusterName"`
	ContainerName string `json:"containerName"`
	NamespaceName string `json:"namespaceName"`
	WorkloadID    string `json:"workloadId"`
	WorkloadName  string `json:"workloadName"`
}

type MedianResponseTime

type MedianResponseTime struct {
	Target float64 `json:"target"`
}

type Mem

type Mem struct {
	Max    float64 `json:"max"`
	Min    float64 `json:"min"`
	Pinned bool    `json:"pinned"`
}

type OptimizerConfiguration

type OptimizerConfiguration struct {
	Config           Config                `json:"config"`
	IgnoredBlockers  IgnoredBlockers       `json:"ignoredBlockers"`
	DesiredState     string                `json:"desiredState"`
	OptimizerID      string                `json:"optimizerId"`
	RestartTimestamp string                `json:"restartTimestamp"`
	Suspensions      map[string]Suspension `json:"suspensions"`
	Target           Target                `json:"target"`
}

type OptimizerStatus

type OptimizerStatus struct {
	AgentState        string                 `json:"agentState"`
	OptimizationState string                 `json:"optimizationState"`
	Optimizer         OptimizerConfiguration `json:"optimizer"`
	OptimizerID       string                 `json:"optimizerId"`
	OptimizerState    string                 `json:"optimizerState"`
	ServoUID          string                 `json:"servoUid"`
	Suspended         bool                   `json:"suspended"`
	TuningState       string                 `json:"tuningState"`
}

type Principal

type Principal struct {
	Id   string `json:"id"`
	Type string `json:"type"`
}

type Slo

type Slo struct {
	ErrorPercent       ErrorPercent       `json:"errorPercent"`
	MedianResponseTime MedianResponseTime `json:"medianResponseTime"`
}

type Suspension

type Suspension struct {
	Reason    string `json:"reason"`
	Timestamp string `json:"timestamp"`
	User      string `json:"user"`
}

type Target

type Target struct {
	K8SDeployment K8SDeployment `json:"k8sDeployment"`
}