perf

Documentation

Index

• Constants
• Variables
• func ErrFailMarshal(err error) error
• func ErrFailUnmarshal(err error) error
• func ErrFailUnmarshalFile(err error) error
• func ErrHealthChecker(err error) error
• func ErrInvalidJSONFile() error
• func ErrInvalidOutputChoice() error
• func ErrInvalidTestConfigFile() error
• func ErrNoProfileFound() error
• func ErrNoProfileName() error
• func ErrNoTestURL() error
• func ErrNotValidURL() error
• func ErrPerformanceProfileResult(err error) error
• func ErrReadFilepath(err error) error
• func ErrorArgumentOverflow() error

Constants

const (
	ErrReadFilepathCode             = "1118"
	ErrNoProfileNameCode            = "1119"
	ErrNoTestURLCode                = "1120"
	ErrNotValidURLCode              = "1121"
	ErrFailMarshalCode              = "1122"
	ErrFailUnmarshalCode            = "1123"
	ErrNoProfileFoundCode           = "1124"
	ErrInvalidOutputChoiceCode      = "1125"
	ErrUnauthenticatedCode          = "1126"
	ErrFailUnmarshalFileCode        = "1127"
	ErrInvalidTestConfigFileCode    = "1128"
	ErrArgumentOverflowCode         = "1129"
	ErrInvalidJSONFileCode          = "1130"
	ErrHealthCheckerCode            = "1131"
	ErrPerformanceProfileResultCode = "1132"
)

Please reference the following before contributing an error code: https://docs.meshery.io/project/contributing/contributing-error https://github.com/meshery/meshkit/blob/master/errors/errors.go

Variables

var PerfCmd = &cobra.Command{
	Use:   "perf",
	Short: "Performance Management",
	Long:  `Performance Management & Benchmarking`,
	Example: `
// Run performance test
mesheryctl perf apply test-3 --name "a quick stress test" --url http://192.168.1.15/productpage --qps 300 --concurrent-requests 2 --duration 30s
	
// List performance profiles
mesheryctl perf profile sam-test

// List performance results
mesheryctl perf result sam-test

// Display Perf profile in JSON or YAML
mesheryctl perf result -o json
mesheryctl perf result -o yaml
	`,
	PreRunE: func(cmd *cobra.Command, args []string) error {

		hcOptions := &system.HealthCheckOptions{
			IsPreRunE:  true,
			PrintLogs:  false,
			Subcommand: cmd.Use,
		}
		hc, err := system.NewHealthChecker(hcOptions)
		if err != nil {
			utils.Log.Error(ErrHealthChecker(err))
			return nil
		}
		return hc.RunPreflightHealthChecks()
	},
	RunE: func(cmd *cobra.Command, args []string) error {
		if len(args) == 0 {
			return cmd.Help()
		}
		if ok := utils.IsValidSubcommand(availableSubcommands, args[0]); !ok {
			availableSubCmds := []string{"apply", "profile", "result"}

			suggestedCmd := utils.FindClosestArg(args[0], availableSubCmds)
			if suggestedCmd != "" && suggestedCmd[0] == args[0][0] {
				return errors.New(utils.PerfError(fmt.Sprintf("'%s' is a invalid command for '%s'. Did you mean this?\n\t%s\n", args[0], cmd.CalledAs(), suggestedCmd)))
			}
			return errors.New(utils.PerfError(fmt.Sprintf("'%s' is a invalid command for '%s'. Use 'mesheryctl perf --help' to display usage guide.\n", args[0], cmd.CalledAs())))
		}
		return nil
	},
}

PerfCmd represents the Performance Management CLI command

Functions

func ErrFailMarshal

func ErrFailMarshal(err error) error

func ErrFailUnmarshal

func ErrFailUnmarshal(err error) error

func ErrFailUnmarshalFile

func ErrFailUnmarshalFile(err error) error

func ErrHealthChecker

func ErrHealthChecker(err error) error

func ErrInvalidJSONFile

func ErrInvalidJSONFile() error

func ErrInvalidOutputChoice

func ErrInvalidOutputChoice() error

func ErrInvalidTestConfigFile

func ErrInvalidTestConfigFile() error

func ErrNoProfileFound

func ErrNoProfileFound() error

func ErrNoProfileName

func ErrNoProfileName() error

func ErrNoTestURL

func ErrNoTestURL() error

func ErrNotValidURL

func ErrNotValidURL() error

func ErrPerformanceProfileResult

func ErrPerformanceProfileResult(err error) error

func ErrReadFilepath

func ErrReadFilepath(err error) error

func ErrorArgumentOverflow

func ErrorArgumentOverflow() error