report

package
v0.0.0-...-1be1a9a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 31, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Logs

type Logs struct {
	Cluster []string
	Backup  string
}

Logs is the component which displays information relating to the logs that were collected after completing the benchmarking process.

func NewLogs

func NewLogs(options Options) *Logs

NewLogs creates a new 'Logs' component with the provided options.

func (*Logs) String

func (l *Logs) String() string

String returns a string representation of the 'Logs' component which will be output in the report.

type Options

type Options struct {
	Blueprint   *value.Blueprint
	Stats       *value.Stats
	CBMConfig   *value.CBMConfig
	Results     value.BenchmarkResults
	ClusterLogs []string
	BackupLogs  string
}

Options encapsulates the options which may be passed into the 'NewReport' function and avoids having ungainly function signatures.

type Overview

type Overview struct {
	AvgDuration        string `json:"avg_duration,omitempty"`
	AvgADS             string `json:"avg_ads,omitempty"`
	AvgGDS             string `json:"avg_gds,omitempty"`
	AvgTransferRateADS string `json:"avg_transfer_rate_ads,omitempty"`
	AvgTransferRateGDS string `json:"avg_transfer_rate_gds,omitempty"`
}

Overview is the overview component to the report which highlights interesting averages across the benchmark iterations.

func NewOverview

func NewOverview(options Options) *Overview

NewOverview creates a new overview component with the provided options.

func (*Overview) String

func (o *Overview) String() string

String returns a string representation of the 'Logs' component which will be output in the report.

type Report

type Report struct {
	Cluster      *value.ClusterBlueprint      `json:"cluster,omitempty"`
	BackupClient *value.BackupClientBlueprint `json:"backup_client,omitempty"`
	CBM          *value.CBMConfig             `json:"cbbackupmgr,omitempty"`
	Stats        *value.Stats                 `json:"bucket_stats,omitempty"`
	Overview     *Overview                    `json:"overview,omitempty"`
	Rundown      Rundown                      `json:"rundown,omitempty"`
	Logs         *Logs                        `json:"logs,omitempty"`
}

Report is the benchmark report which will be printed to stdout upon completion of the benchmarks.

func NewReport

func NewReport(options Options) *Report

NewReport creates a new report with the provided options.

func (*Report) Print

func (r *Report) Print(jsonOut bool) error

Print displays a string representation of the report, this is either a human readable form or standard JSON.

func (*Report) String

func (r *Report) String() string

String returns a string representation of the report. Components which are empty/unused will be omitted in a similar fashion to that of the 'omitempty' tag.

type Rundown

type Rundown []*rundownResult

Rundown is a component which contains the detailed rundown for each benchmark that was executed.

func NewRundown

func NewRundown(options Options) Rundown

NewRundown creates a new 'Rundown' component with the provided options.

func (Rundown) String

func (r Rundown) String() string

String returns a string representation of the 'Rundown' component which will be output in the report.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL