ui

Documentation

Index

• func BrowseHandler(w http.ResponseWriter, r *http.Request)
• func DataList() (dataList []string)
• func Error(w http.ResponseWriter, msg ErrorReply)
• func FormValue(r *http.Request, json map[string]interface{}, key string) string
• func GetConfigAtPath(path string, data []byte) (map[string]interface{}, error)
• func Handler(w http.ResponseWriter, r *http.Request)
• func LogAndAddCacheControl(h http.Handler) http.Handler
• func LogAndFilterDataRequest(h http.Handler) http.Handler
• func RESTRunHandler(w http.ResponseWriter, r *http.Request)
• func RESTStatusHandler(w http.ResponseWriter, r *http.Request)
• func RESTStopHandler(w http.ResponseWriter, r *http.Request)
• func Report(baseurl, port, datadir string) bool
• func ResultToJsData(w io.Writer, json []byte)
• func Run(w http.ResponseWriter, r *http.Request, jd map[string]interface{}, ...)
• func SaveJSON(name string, json []byte) string
• func Serve(baseurl, port, debugpath, uipath, datadir string, percentileList []float64) bool
• func StopByRunID(runid int64) int
• func Sync(out io.Writer, u string, datadir string) bool
• func SyncHandler(w http.ResponseWriter, r *http.Request)
• type ChartOptions
• type ErrorReply
• type ListBucketResult
• type SelectableValue
  • func SelectValues(values []string, selectedValues []string) (selectableValues []SelectableValue, numSelected int)

Functions

func BrowseHandler

func BrowseHandler(w http.ResponseWriter, r *http.Request)

BrowseHandler handles listing and rendering the JSON results.

func DataList

func DataList() (dataList []string)

DataList returns the .json files/entries in data dir.

func Error

func Error(w http.ResponseWriter, msg ErrorReply)

Error writes serialized ErrorReply to the writer.

func FormValue

func FormValue(r *http.Request, json map[string]interface{}, key string) string

FormValue gets the value from the query arguments/url parameter or from the provided map (json data).

func GetConfigAtPath

func GetConfigAtPath(path string, data []byte) (map[string]interface{}, error)

GetConfigAtPath deserializes the bytes as JSON and extracts the map at the given path (only supports simple expression: . is all the json .foo.bar.blah will extract that part of the tree.

func Handler

func Handler(w http.ResponseWriter, r *http.Request)

Handler is the main UI handler creating the web forms and processing them. nolint: funlen, gocognit, gocyclo, nestif, maintidx // should be refactored indeed (TODO)

func LogAndAddCacheControl

func LogAndAddCacheControl(h http.Handler) http.Handler

LogAndAddCacheControl logs the request and wrapps an HTTP handler to add a Cache-Control header for static files.

func LogAndFilterDataRequest

func LogAndFilterDataRequest(h http.Handler) http.Handler

LogAndFilterDataRequest logs the data request.

func RESTRunHandler

func RESTRunHandler(w http.ResponseWriter, r *http.Request)

RESTRunHandler is api version of UI submit handler.

func RESTStatusHandler

func RESTStatusHandler(w http.ResponseWriter, r *http.Request)

RESTStatusHandler will print the state of the runs.

func RESTStopHandler

func RESTStopHandler(w http.ResponseWriter, r *http.Request)

RESTStopHandler is the api to stop a given run by runid or all the runs if unspecified/0.

func Report

func Report(baseurl, port, datadir string) bool

Report starts the browsing only UI server on the given port. Similar to Serve with only the read only part.

func ResultToJsData

func ResultToJsData(w io.Writer, json []byte)

ResultToJsData converts a result object to chart data arrays and title and creates a chart from the result object.

func Run

func Run(w http.ResponseWriter, r *http.Request, jd map[string]interface{},
	runner, url string, ro periodic.RunnerOptions, httpopts *fhttp.HTTPOptions,
)

Run executes the run (can be called async or not, writer is nil for async mode).

func SaveJSON

func SaveJSON(name string, json []byte) string

SaveJSON save Json bytes to give file name (.json) in data-path dir.

func Serve

func Serve(baseurl, port, debugpath, uipath, datadir string, percentileList []float64) bool

Serve starts the fhttp.Serve() plus the UI server on the given port and paths (empty disables the feature). uiPath should end with / (be a 'directory' path). Returns true if server is started successfully.

func StopByRunID

func StopByRunID(runid int64) int

StopByRunID stops all the runs if passed 0 or the runid provided.

func Sync

func Sync(out io.Writer, u string, datadir string) bool

Sync is the non http equivalent of fortio/sync?url=u.

func SyncHandler

func SyncHandler(w http.ResponseWriter, r *http.Request)

SyncHandler handles syncing/downloading from tsv url.

Types

type ChartOptions

type ChartOptions struct {
	XMin   string
	XMax   string
	YMin   string
	YMax   string
	XIsLog bool
	YIsLog bool
}

ChartOptions describes the user-configurable options for a chart.

type ErrorReply

type ErrorReply struct {
	Error     string
	Exception error
}

ErrorReply is returned on errors.

type ListBucketResult

type ListBucketResult struct {
	NextMarker string   `xml:"NextMarker"`
	Names      []string `xml:"Contents>Key"`
}

ListBucketResult is the minimum we need out of s3 xml results. https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGET.html e.g. https://storage.googleapis.com/fortio-data?max-keys=2&prefix=fortio.istio.io/

type SelectableValue

type SelectableValue struct {
	Value    string
	Selected bool
}

SelectableValue represets an entry in the <select> of results.

func SelectValues

func SelectValues(values []string, selectedValues []string) (selectableValues []SelectableValue, numSelected int)

SelectValues maps the list of values (from DataList) to a list of SelectableValues. Each returned SelectableValue is selected if its value is contained in selectedValues. It is assumed that values does not contain duplicates.