api

Documentation

Overview

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• type Assessment
• type MetricsTraffic
• type Request
• type Response
• type SuccessCriterion
• type TrafficControl
• type Window

Constants

const (
	TCKeyMaxTrafficPercent string = "max_traffic_percent"

	TCKeySuccessCriteria string = "success_criteria"

	TCKeyReward string = "reward"
)

const (
	// SCKeyMetricName specifies the name of the metric to which the criterion applies
	// example: iter8_latency
	SCKeyMetricName string = "metric_name"

	// SCKeyType stores the criterion type. Options:
	// "delta": compares the candidate against the baseline version with respect to the metric;
	// "threshold": checks the candidate with respect to the metric
	SCKeyType string = "type"

	// SCKeyIsCounter indicates whether this is a counter
	SCKeyIsCounter string = "is_counter"

	// SCKeyAbsentValue is default value when data source does not return one
	SCKeyAbsentValue string = "absent_value"

	// SCKeyTemplate specifies the query template for the metric
	SCKeyTemplate string = "metric_query_template"

	// SCKeySampleSizeTemplate specifies the query template for the sample size
	SCKeySampleSizeTemplate string = "metric_sample_size_query_template"

	// SCKeyValue is the value for the success criteria to check
	SCKeyValue string = "value"

	// SCKeyStopOnFailure indicates whether or not the experiment must finish if this criterion is not satisfied;
	// defaults to false
	SCKeyStopOnFailure string = "stop_on_failure"

	// SCKeyMinMax points to min_max metrics used for calculating reward
	SCKeyMinMax string = "min_max"
)

const (
	AnalyticsAPIPath string = "/api/v1/experiment/"
)

Types

type Assessment

type Assessment struct {
	// Summary of the candidate assessment based on success criteria
	Summary iter8v1alpha1.Summary `json:"summary"`

	// Summary of results for each success criterion
	SuccessCriteria []iter8v1alpha1.SuccessCriterionStatus `json:"success_criteria"`
}

Assessment includes the assessment content

type MetricsTraffic

type MetricsTraffic struct {
	// Traffic recommendation for the version
	TrafficPercentage float64 `json:"traffic_percentage"`

	// Sate returned by the server, to be passed on the next call
	LastState interface{} `json:"_last_state"`
}

MetricsTraffic specifies traffic recommendations and stores states information

type Request

type Request struct {
	// Specifies the name of the experiment
	Name string `json:"name"`

	// Specifies a time interval and key-value pairs for retrieving and processing data pertaining to the baseline version
	Baseline Window `json:"baseline"`

	// Specifies a time interval and key-value pairs for retrieving and processing data pertaining to the candidate version
	Candidate Window `json:"candidate"`

	// State returned by the server on the previous call
	LastState interface{} `json:"_last_state"`

	// Parameters controlling the behavior of the analytics
	TrafficControl TrafficControl `json:"traffic_control"`
}

Request defines payload to analytics service

type Response

type Response struct {
	// Traffic recommendation for the baseline version
	Baseline MetricsTraffic `json:"baseline"`

	// Traffic recommendation for the candidate version
	Candidate MetricsTraffic `json:"candidate"`

	// Summary of the candidate assessment based on success criteria
	Assessment Assessment `json:"assessment"`

	// State returned by the server, to be passed on the next call
	LastState interface{} `json:"_last_state"`
}

Response defines the response from analytics server

type SuccessCriterion

type SuccessCriterion map[string]interface{}

SuccessCriterion stores the fields as key-value pairs

type TrafficControl

type TrafficControl map[string]interface{}

type Window

type Window struct {
	// ISO8601 timestamp for the beginning of the time range of interest
	StartTime string `json:"start_time"`

	// ISO8601 timestamp for the end of the time range of interest; if omitted, current time is assumed
	EndTime string `json:"end_time"`

	// Key-value pairs identifying the data pertaining to a version
	Tags map[string]string `json:"tags"`
}

Window specifies the time range and tags