report

Documentation

Index

• Variables
• func FormatFloat3(f func() (float64, error)) string
• func FormatFloatAsRate(f func() float64) string
• func FormatNanosAsSec3(f func() (float64, error)) string
• func GetSortedScenarioIds(summary api.Summary) []api.ID
• func NewCsvReportWriter(writer *bufio.Writer) api.WriteSummaryReportFn
• func NewMarkdownSummaryReportWriter(writer *bufio.Writer) api.WriteSummaryReportFn
• func NewTextReportWriter(writer *bufio.Writer, colorsOn bool) api.WriteSummaryReportFn
• type CsvStreamReportWriter
  • func NewCsvStreamReportWriter(writer *bufio.Writer, ctx *api.ReportContext) *CsvStreamReportWriter
  • func (rw *CsvStreamReportWriter) Handle(trace api.Trace) (err error)
• type MarkdownStreamReportWriter
  • func NewMarkdownStreamReportWriter(writer *bufio.Writer, ctx *api.ReportContext) *MarkdownStreamReportWriter
  • func (rw *MarkdownStreamReportWriter) Handle(trace api.Trace) (err error)
• type MarkdownTable
  • func NewMarkdownTable(rows, cols int) *MarkdownTable
  • func (t *MarkdownTable) SetData(row, col int, data interface{}) *MarkdownTable
  • func (t *MarkdownTable) SetFloat64(row, col int, data float64) *MarkdownTable
  • func (t *MarkdownTable) SetHeader(col int, header string) *MarkdownTable
  • func (t *MarkdownTable) SetInt(row, col int, data int) *MarkdownTable
  • func (t *MarkdownTable) Write(writer *bufio.Writer)
• type MarkdownTableWriter
  • func NewMarkdownTableWriter(writer *bufio.Writer) *MarkdownTableWriter
  • func (tw *MarkdownTableWriter) WriteHeaders(headers []string) (err error)
  • func (tw *MarkdownTableWriter) WriteRow(row []string) (err error)

Variables

var RawDataReportHeaders = []string{"Timestamp", "Scenario", "Labels", "Duration", "Error"}

var SummaryReportHeaders = []string{
	"Timestamp",
	"Scenario",
	"Samples",
	"Labels",
	"Min",
	"Max",
	"Mean",
	"Median",
	"Percentile 90",
	"StdDev",
	"Errors",
}

Functions

func FormatFloat3

func FormatFloat3(f func() (float64, error)) string

func FormatFloatAsRate

func FormatFloatAsRate(f func() float64) string

func FormatNanosAsSec3

func FormatNanosAsSec3(f func() (float64, error)) string

func GetSortedScenarioIds

func GetSortedScenarioIds(summary api.Summary) []api.ID

GetSortedScenarioIds returns a sorted array of scenario IDs for the specified api.Summary

func NewCsvReportWriter

func NewCsvReportWriter(writer *bufio.Writer) api.WriteSummaryReportFn

NewCsvReportWriter returns a CSV report write handler.

func NewMarkdownSummaryReportWriter

func NewMarkdownSummaryReportWriter(writer *bufio.Writer) api.WriteSummaryReportFn

NewMarkdownSummaryReportWriter returns a Markdown report write handler.

func NewTextReportWriter

func NewTextReportWriter(writer *bufio.Writer, colorsOn bool) api.WriteSummaryReportFn

NewTextReportWriter returns a text report write handler.

Types

type CsvStreamReportWriter

type CsvStreamReportWriter struct {
	// contains filtered or unexported fields
}

CsvStreamReportWriter a simple human readable test report writer

func NewCsvStreamReportWriter

func NewCsvStreamReportWriter(writer *bufio.Writer, ctx *api.ReportContext) *CsvStreamReportWriter

NewCsvStreamReportWriter returns a streaming CSV report writer.

func (*CsvStreamReportWriter) Handle

func (rw *CsvStreamReportWriter) Handle(trace api.Trace) (err error)

Handle handles a real time trace event

type MarkdownStreamReportWriter

type MarkdownStreamReportWriter struct {
	// contains filtered or unexported fields
}

MarkdownStreamReportWriter a simple human readable test report writer

func NewMarkdownStreamReportWriter

func NewMarkdownStreamReportWriter(writer *bufio.Writer, ctx *api.ReportContext) *MarkdownStreamReportWriter

NewMarkdownStreamReportWriter returns a streaming CSV report writer.

func (*MarkdownStreamReportWriter) Handle

func (rw *MarkdownStreamReportWriter) Handle(trace api.Trace) (err error)

Handle handles a real time trace event

type MarkdownTable

type MarkdownTable struct {
	// contains filtered or unexported fields
}

func NewMarkdownTable

func NewMarkdownTable(rows, cols int) *MarkdownTable

func (*MarkdownTable) SetData

func (t *MarkdownTable) SetData(row, col int, data interface{}) *MarkdownTable

func (*MarkdownTable) SetFloat64

func (t *MarkdownTable) SetFloat64(row, col int, data float64) *MarkdownTable

func (*MarkdownTable) SetHeader

func (t *MarkdownTable) SetHeader(col int, header string) *MarkdownTable

func (*MarkdownTable) SetInt

func (t *MarkdownTable) SetInt(row, col int, data int) *MarkdownTable

func (*MarkdownTable) Write

func (t *MarkdownTable) Write(writer *bufio.Writer)

type MarkdownTableWriter

type MarkdownTableWriter struct {
	// contains filtered or unexported fields
}

func NewMarkdownTableWriter

func NewMarkdownTableWriter(writer *bufio.Writer) *MarkdownTableWriter

func (*MarkdownTableWriter) WriteHeaders

func (tw *MarkdownTableWriter) WriteHeaders(headers []string) (err error)

func (*MarkdownTableWriter) WriteRow

func (tw *MarkdownTableWriter) WriteRow(row []string) (err error)