cmd

Documentation

Index

• Variables
• func Execute()
• type Config
  • func (c Config) Apply(cfg Config) Config
• type ExitCode
• type RawFormater
  • func (f RawFormater) Format(entry *log.Entry) ([]byte, error)

Variables

var (
	ErrTagEmptyName   = errors.New("Invalid tag, empty name")
	ErrTagEmptyValue  = errors.New("Invalid tag, empty value")
	ErrTagEmptyString = errors.New("Invalid tag, empty string")
)

var Banner = strings.Join([]string{
	`          /\      |‾‾|  /‾‾/  /‾/   `,
	`     /\  /  \     |  |_/  /  / /    `,
	`    /  \/    \    |      |  /  ‾‾\  `,
	`   /          \   |  |‾\  \ | (_) | `,
	`  / __________ \  |__|  \__\ \___/ .io`,
}, "\n")

Banner contains the ASCII-art banner with the k6 logo and stylized website URL TODO: make these into methods, only the version needs to be a variable

var BannerColor = color.New(color.FgCyan)

var RootCmd = &cobra.Command{
	Use:           "k6",
	Short:         "a next-generation load generator",
	Long:          BannerColor.Sprintf("\n%s", Banner),
	SilenceUsage:  true,
	SilenceErrors: true,
	PersistentPreRun: func(cmd *cobra.Command, args []string) {
		setupLoggers(logFmt)
		if noColor {
			stdout.Writer = colorable.NewNonColorable(os.Stdout)
			stderr.Writer = colorable.NewNonColorable(os.Stderr)
		}
		golog.SetOutput(log.StandardLogger().Writer())
	},
}

RootCmd represents the base command when called without any subcommands.

var Version = "0.24.0"

Version contains the current semantic version of k6.

Functions

func Execute

func Execute()

Execute adds all child commands to the root command sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type Config

type Config struct {
	lib.Options

	Out           []string  `json:"out" envconfig:"out"`
	Linger        null.Bool `json:"linger" envconfig:"linger"`
	NoUsageReport null.Bool `json:"noUsageReport" envconfig:"no_usage_report"`
	NoThresholds  null.Bool `json:"noThresholds" envconfig:"no_thresholds"`
	NoSummary     null.Bool `json:"noSummary" envconfig:"no_summary"`

	Collectors struct {
		InfluxDB influxdb.Config `json:"influxdb"`
		Kafka    kafka.Config    `json:"kafka"`
		Cloud    cloud.Config    `json:"cloud"`
		StatsD   common.Config   `json:"statsd"`
		Datadog  datadog.Config  `json:"datadog"`
	} `json:"collectors"`
}

func (Config) Apply

func (c Config) Apply(cfg Config) Config

type ExitCode

type ExitCode struct {
	Code int
	// contains filtered or unexported fields
}

Silently set an exit code.

type RawFormater

type RawFormater struct{}

RawFormatter it does nothing with the message just prints it

func (RawFormater) Format

func (f RawFormater) Format(entry *log.Entry) ([]byte, error)

Format renders a single log entry