Struct goose::GooseConfiguration

pub struct GooseConfiguration {
    pub host: String,
    pub users: Option<usize>,
    pub hatch_rate: usize,
    pub run_time: String,
    pub no_stats: bool,
    pub status_codes: bool,
    pub only_summary: bool,
    pub reset_stats: bool,
    pub list: bool,
    pub verbose: u8,
    pub log_level: u8,
    pub log_file: String,
    pub stats_log_file: String,
    pub stats_log_format: String,
    pub debug_log_file: String,
    pub debug_log_format: String,
    pub throttle_requests: Option<usize>,
    pub sticky_follow: bool,
    pub manager: bool,
    pub no_hash_check: bool,
    pub expect_workers: u16,
    pub manager_bind_host: String,
    pub manager_bind_port: u16,
    pub worker: bool,
    pub manager_host: String,
    pub manager_port: u16,
}

CLI options available when launching a Goose load test.

Fields

host: String

Host to load test, for example: http://10.21.32.33

users: Option<usize>

Number of concurrent Goose users (defaults to available CPUs).

hatch_rate: usize

How many users to spawn per second.

run_time: String

Stop after e.g. (300s, 20m, 3h, 1h30m, etc.).

no_stats: bool

Don't print stats in the console

status_codes: bool

Includes status code counts in console stats

only_summary: bool

Only prints summary stats

reset_stats: bool

Resets statistics once hatching has been completed

list: bool

Shows list of all possible Goose tasks and exits

verbose: u8

Debug level (-v, -vv, -vvv, etc.)

log_level: u8

Log level (-g, -gg, -ggg, etc.)

log_file: String

Log file name

stats_log_file: String

Statistics log file name

stats_log_format: String

Statistics log format ('csv', 'json', or 'raw')

debug_log_file: String

Debug log file name

debug_log_format: String

Debug log format ('json' or 'raw')

throttle_requests: Option<usize>

Throttle (max) requests per second

sticky_follow: bool

User follows redirect of base_url with subsequent requests

manager: bool

Enables manager mode

no_hash_check: bool

Ignore worker load test checksum

expect_workers: u16

Required when in manager mode, how many workers to expect

manager_bind_host: String

Define host manager listens on, formatted x.x.x.x

manager_bind_port: u16

Define port manager listens on

worker: bool

Enables worker mode

manager_host: String

Host manager is running on

manager_port: u16

Port manager is listening on

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 Default for GooseConfiguration

fn default() -> GooseConfiguration

Returns the "default value" for a type.

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 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.

impl StructOpt for GooseConfiguration

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for GooseConfiguration

fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

fn is_subcommand() -> bool

fn from_subcommand(_sub: (&'b str, Option<&'b ArgMatches<'a>>)) -> Option<Self>