Struct goose::GooseConfiguration

pub struct GooseConfiguration {
    pub help: bool,
    pub version: bool,
    pub list: bool,
    pub host: String,
    pub users: Option<usize>,
    pub hatch_rate: Option<usize>,
    pub run_time: String,
    pub log_level: u8,
    pub log_file: String,
    pub verbose: u8,
    pub only_summary: bool,
    pub no_reset_metrics: bool,
    pub no_metrics: bool,
    pub no_task_metrics: bool,
    pub metrics_file: String,
    pub metrics_format: String,
    pub debug_file: String,
    pub debug_format: String,
    pub status_codes: bool,
    pub throttle_requests: usize,
    pub sticky_follow: bool,
    pub manager: bool,
    pub expect_workers: Option<u16>,
    pub no_hash_check: bool,
    pub manager_bind_host: String,
    pub manager_bind_port: u16,
    pub worker: bool,
    pub manager_host: String,
    pub manager_port: u16,
}

Options available when launching a Goose load test.

Fields

help: bool

Displays this help

version: bool

Prints version information

list: bool

host: String

Defines host to load test (ie http://10.21.32.33)

users: Option<usize>

Sets concurrent users (default: number of CPUs)

hatch_rate: Option<usize>

Sets per-second user hatch rate (default: 1)

run_time: String

Stops after (30s, 20m, 3h, 1h30m, etc)

log_level: u8

Sets log level (-g, -gg, etc)

log_file: String

Enables log file and sets name

verbose: u8

only_summary: bool

Only prints final summary metrics

no_reset_metrics: bool

Doesn't reset metrics after all users have started

no_metrics: bool

Doesn't track metrics

no_task_metrics: bool

Doesn't track task metrics

metrics_file: String

Sets metrics log file name

metrics_format: String

Sets metrics log format (csv, json, raw)

debug_file: String

Sets debug log file name

debug_format: String

Sets debug log format (json, raw)

status_codes: bool

throttle_requests: usize

Sets maximum requests per second

sticky_follow: bool

manager: bool

Enables distributed load test Manager mode

expect_workers: Option<u16>

Sets number of Workers to expect

no_hash_check: bool

Tells Manager to ignore load test checksum

manager_bind_host: String

Sets host Manager listens on (default: 0.0.0.0)

manager_bind_port: u16

Sets port Manager listens on (default: 5115)

worker: bool

Enables distributed load test Worker mode

manager_host: String

Sets host Worker connects to (default: 127.0.0.1)

manager_port: u16

Sets port Worker connects to (default: 5115)

Trait Implementations

impl Clone for GooseConfiguration

fn clone(&self) -> GooseConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GooseConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GooseConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Options for GooseConfiguration

fn parse<__S: AsRef<str>>(_parser: &mut Parser<'_, __S>) -> Result<Self, Error>

Parses arguments until the given parser is exhausted or until an error is encountered.

fn command(&self) -> Option<&dyn Options>

Returns the subcommand instance, if present.

fn command_name(&self) -> Option<&'static str>

Returns the name of a parsed command, if present.

fn help_requested(&self) -> bool

Returns whether the user supplied a "help" option to request usage information about the program or any contained subcommands.

fn parse_command<__S: AsRef<str>>(
    name: &str,
    _parser: &mut Parser<'_, __S>
) -> Result<Self, Error>

Parses options for the named command.

fn usage() -> &'static str

Returns a string showing usage and help for each supported option.

fn self_usage(&self) -> &'static str

Returns a string showing usage and help for this options instance.

fn command_list() -> Option<&'static str>

Returns a string listing available commands and help text.

fn command_usage(_name: &str) -> Option<&'static str>

Returns a usage string for the named command.

fn self_command_list(&self) -> Option<&'static str>

Returns a listing of available commands and help text.

fn parse_args<S>(args: &[S], style: ParsingStyle) -> Result<Self, Error> where
    S: AsRef<str>, 

Parses arguments received from the command line.

fn parse_args_or_exit(style: ParsingStyle) -> Self

Parses arguments from the environment.

fn parse_args_default_or_exit() -> Self

Parses arguments from the environment, using the default parsing style.

fn parse_args_default<S>(args: &[S]) -> Result<Self, Error> where
    S: AsRef<str>, 

Parses arguments received from the command line, using the default parsing style.

impl Serialize for GooseConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.