base

type AggregationType string

type CollectDatabaseTemplate struct {
	Url      string            `json:"url" yaml:"url"`
	Headers  map[string]string `json:"headers" yaml:"headers"`
	Provider string            `json:"provider" yaml:"provider"`
	Method   string            `json:"method" yaml:"method"`
	Metrics  []Metric          `json:"metrics" yaml:"metrics"`
}

type Driver interface {
	// ReadSpec reads the experiment spec
	ReadSpec() (ExperimentSpec, error)
	// ReadResult reads the experiment result
	ReadResult() (*ExperimentResult, error)
	// WriteResult writes the experiment result
	WriteResult(r *ExperimentResult) error
}

type Experiment struct {
	// Tasks is the sequence of tasks that constitute this experiment
	Tasks ExperimentSpec
	// Result is the current results from this experiment.
	// The experiment may not have completed in which case results may be partial.
	Result *ExperimentResult
}

type ExperimentResult struct {
	// StartTime is the time when the experiment run started
	StartTime time.Time `json:"startTime" yaml:"startTime"`

	// NumCompletedTasks is the number of completed tasks
	NumCompletedTasks int `json:"numCompletedTasks" yaml:"numCompletedTasks"`

	// Failure is true if any of its tasks failed
	Failure bool `json:"failure" yaml:"failure"`

	// Insights produced in this experiment
	Insights *Insights `json:"insights,omitempty" yaml:"insights,omitempty"`

	// Iter8Version is the version of Iter8 CLI that created this result object
	Iter8Version string `json:"iter8Version" yaml:"iter8Version"`
}

type ExperimentSpec []Task

type HistBucket struct {
	// Lower endpoint of a histogram bucket
	Lower float64 `json:"lower" yaml:"lower"`
	// Upper endpoint of a histogram bucket
	Upper float64 `json:"upper" yaml:"upper"`
	// Count is the frequency count of the bucket
	Count uint64 `json:"count" yaml:"count"`
}

type Insights struct {
	// NumVersions is the number of app versions detected by Iter8
	NumVersions int `json:"numVersions" yaml:"numVersions"`

	// MetricsInfo identifies the metrics involved in this experiment
	MetricsInfo map[string]MetricMeta `json:"metricsInfo,omitempty" yaml:"metricsInfo,omitempty"`

	// NonHistMetricValues:
	// the outer slice must be the same length as the number of app versions
	// the map key must match name of a metric in MetricsInfo
	// the inner slice contains the list of all observed metric values for given version and given metric; float value [i]["foo/bar"][k] is the [k]th observation for version [i] for the metric bar under backend foo.
	// this struct is meant exclusively for metrics of type other than histogram
	NonHistMetricValues []map[string][]float64 `json:"nonHistMetricValues,omitempty" yaml:"nonHistMetricValues,omitempty"`

	// HistMetricValues:
	// the outer slice must be the same length as the number of app versions
	// the map key must match name of a histogram metric in MetricsInfo
	// the inner slice contains the list of all observed histogram buckets for a given version and given metric; value [i]["foo/bar"][k] is the [k]th observed bucket for version [i] for the hist metric `bar` under backend `foo`.
	HistMetricValues []map[string][]HistBucket `json:"histMetricValues,omitempty" yaml:"histMetricValues,omitempty"`

	// SLOs involved in this experiment
	SLOs []SLO `json:"SLOs,omitempty" yaml:"SLOs,omitempty"`

	// SLOsSatisfied:
	// the outer slice must be of the same length as SLOs
	// the length of the inner slice must be the number of app versions
	// the boolean value at [i][j] indicate if SLO [i] is satisfied by version [j]
	SLOsSatisfied [][]bool `json:"SLOsSatisfied,omitempty" yaml:"SLOsSatisfied,omitempty"`
}

type Metric struct {
	Name         string    `json:"name" yaml:"name"`
	Description  *string   `json:"description,omitempty" yaml:"description,omitempty"`
	Type         string    `json:"type" yaml:"type"`
	Units        *string   `json:"units,omitempty" yaml:"units,omitempty"`
	Params       *[]Params `json:"params,omitempty" yaml:"params,omitempty"`
	Body         *string   `json:"body,omitempty" yaml:"body,omitempty"`
	JqExpression string    `json:"jqExpression" yaml:"jqExpression"`
}

type MetricMeta struct {
	// Description is a human readable description of the metric
	Description string `json:"description" yaml:"description"`
	// Units for this metric (if any)
	Units *string `json:"units,omitempty" yaml:"units,omitempty"`
	// Type of the metric. Example: counter
	Type MetricType `json:"type" yaml:"type"`
}

type MetricType string

type Params struct {
	Name  string `json:"name" yaml:"name"`
	Value string `json:"value" yaml:"value"`
}

type SLO struct {
	// Metric is the fully qualified metric name in the backendName/metricName format
	Metric string `json:"metric" yaml:"metric"`

	// UpperLimit is the maximum acceptable value of the metric
	UpperLimit *float64 `json:"upperLimit,omitempty" yaml:"upperLimit,omitempty"`

	// LowerLimit is the minimum acceptable value of the metric
	LowerLimit *float64 `json:"lowerLimit,omitempty" yaml:"lowerLimit,omitempty"`
}

type Task interface {
	// contains filtered or unexported methods
}

type TaskMeta struct {
	// Task is the name of the task
	Task *string `json:"task,omitempty" yaml:"task,omitempty"`
	// Run is the script used in a run task
	// Specify either Task or Run but not both
	Run *string `json:"run,omitempty" yaml:"run,omitempty"`
	// If is the condition used to determine if this task needs to run
	// If the condition is not satisfied, then it is skipped in an experiment
	// Example: SLOs()
	If *string `json:"if,omitempty" yaml:"if,omitempty"`
}