cmd

Documentation

Index

• Variables
• type OutputFormat
  • func NewOutputFormat() OutputFormat
• type ScenarioOutputFormat
  • func FormatOutput(results []*bencher.Result, scenarioConfig config.Scenario, err error) ScenarioOutputFormat

Variables

var (
	// RootCmd creates flags
	RootCmd = &cobra.Command{
		Use:   "zstorbench",
		Short: "A tool for benchmarking (and profiling) a zstor client",
		PersistentPreRun: func(*cobra.Command, []string) {
			if rootCfg.debugLog {
				log.SetLevel(log.DebugLevel)
				log.Debug("Debug logging enabled")
			}
		},
		RunE: rootFunc,
	}
)

Types

type OutputFormat

type OutputFormat struct {
	Scenarios map[string]ScenarioOutputFormat
}

OutputFormat represents the output format of a full benchmark

func NewOutputFormat

func NewOutputFormat() OutputFormat

NewOutputFormat returns a new OutputFormat

type ScenarioOutputFormat

type ScenarioOutputFormat struct {
	Results      []*bencher.Result `yaml:"results,omitempty"`
	ScenarioConf config.Scenario   `yaml:"scenario,omitempty"`
	Error        string            `yaml:"error,omitempty"`
}

ScenarioOutputFormat represents a scenario result for outputting

func FormatOutput

func FormatOutput(results []*bencher.Result, scenarioConfig config.Scenario, err error) ScenarioOutputFormat

FormatOutput formats the output of the benchmarking scenario