Wrecker.Options

Documentation

data RunType

There are two typical ways to invoke wrecker. RunCount will execute each a script n times on each thread. So a run count of 100 and a concurrency of 10 will run the script a total of 1000 times. Alternatively, wrecker can run for specified number of seconds with RunTimed.

Constructors

RunCount Int

RunTimed Int

Instances

Eq RunType

Methods

(==) :: RunType -> RunType -> Bool

(/=) :: RunType -> RunType -> Bool

Show RunType

Methods

showsPrec :: Int -> RunType -> ShowS

show :: RunType -> String

showList :: [RunType] -> ShowS

data DisplayMode

DisplayMode controls how results are displayed in the console. The default is NonInterative which returns the final results at the end of the program. Interactive will show partial results as the program updates.

Constructors

Interactive

NonInteractive

Instances

Eq DisplayMode

Methods

(==) :: DisplayMode -> DisplayMode -> Bool

(/=) :: DisplayMode -> DisplayMode -> Bool

Read DisplayMode

Methods

readsPrec :: Int -> ReadS DisplayMode

readList :: ReadS [DisplayMode]

readPrec :: ReadPrec DisplayMode

readListPrec :: ReadPrec [DisplayMode]

Show DisplayMode

Methods

showsPrec :: Int -> DisplayMode -> ShowS

show :: DisplayMode -> String

showList :: [DisplayMode] -> ShowS

data URLDisplay

Constructors

Path

Full

Instances

Eq URLDisplay

Methods

(==) :: URLDisplay -> URLDisplay -> Bool

(/=) :: URLDisplay -> URLDisplay -> Bool

Read URLDisplay

Methods

readsPrec :: Int -> ReadS URLDisplay

readList :: ReadS [URLDisplay]

readPrec :: ReadPrec URLDisplay

readListPrec :: ReadPrec [URLDisplay]

Show URLDisplay

Methods

showsPrec :: Int -> URLDisplay -> ShowS

show :: URLDisplay -> String

showList :: [URLDisplay] -> ShowS

data Options

Constructors

Options

Fields

• concurrency :: Int

  The number of simulatanous connections

• binCount :: Int

  The number of bins for the histogram

• runStyle :: RunType

  runStyle determines if the wrecker runs for a specified time period or for a specified number of runs.

• timeoutTime :: Int

  How long to wait after the first benchmark for the other threads to finish

• displayMode :: DisplayMode

  This controls the command line display. It can be either Interactive of NonInteractive

• logLevel :: LogLevel
• match :: String

  Set this to filter the benchmarks using a pattern

• requestNameColumnSize :: Maybe Int

  Limit the request name column to the given size

• outputFilePath :: Maybe FilePath

  Dump the results to JSON file

• silent :: Bool

  Set silent to true to disable all output.

• urlDisplay :: URLDisplay

  Whether to display short of full URLs in the report

• recordQuery :: Bool

  Set recordQuery to consider the query string as a different URL

• listTestGroups :: Bool

  Show the list of exposed test groups, if any

Instances

Eq Options

Methods

(==) :: Options -> Options -> Bool

(/=) :: Options -> Options -> Bool

Show Options

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

defaultOptions :: Options

defaultOptions provides sensible default for the Options types

data PartialOptions

Constructors

PartialOptions

Fields

• mConcurrency :: Maybe Int
• mBinCount :: Maybe Int
• mRunStyle :: Maybe RunType
• mTimeoutTime :: Maybe Int
• mDisplayMode :: Maybe DisplayMode
• mLogLevel :: Maybe LogLevel
• mMatch :: Maybe String
• mRequestNameColumnSize :: Maybe Int
• mOutputFilePath :: Maybe FilePath
• mSilent :: Maybe Bool
• murlDisplay :: Maybe URLDisplay
• mRecordQuery :: Maybe Bool
• mListTestGroups :: Maybe Bool

Instances

Eq PartialOptions

Methods

(==) :: PartialOptions -> PartialOptions -> Bool

(/=) :: PartialOptions -> PartialOptions -> Bool

Show PartialOptions

Methods

showsPrec :: Int -> PartialOptions -> ShowS

show :: PartialOptions -> String

showList :: [PartialOptions] -> ShowS

Monoid PartialOptions

Methods

mempty :: PartialOptions

mappend :: PartialOptions -> PartialOptions -> PartialOptions

mconcat :: [PartialOptions] -> PartialOptions

completeOptions :: PartialOptions -> Maybe Options

optionalOption :: Read a => Mod OptionFields a -> Parser (Maybe a)

optionalStrOption :: Mod OptionFields String -> Parser (Maybe String)

optionalSwitch :: Mod FlagFields Bool -> Parser (Maybe Bool)

pPartialOptions :: Parser PartialOptions

runParser :: IO Options

Run the command line parse and return the Options

runParser can parse the following options

$ wrecker-based-app --help

wrecker - HTTP stress tester and benchmarker

Usage: example [--concurrency ARG] [--bin-count ARG] ([--run-count ARG] |
               [--run-timed ARG]) [--timeout-time ARG] [--display-mode ARG]
               [--log-level ARG] [--match ARG] [--request-name-size ARG]
               [--output-path ARG] [--silent] [--record-query]
 Welcome to wrecker

Available options:
 -h,--help                Show this help text
 --concurrency ARG        Number of threads for concurrent requests
 --bin-count ARG          Number of bins for latency histogram
 --run-count ARG          number of times to repeat
 --run-timed ARG          number of seconds to repeat
 --timeout-time ARG       How long to wait for all requests to finish
 --display-mode ARG       Display results interactively
 --log-level ARG          Display results interactively
 --match ARG              Only run tests that match the glob
 --request-name-size ARG  Request name size for the terminal display
 --output-path ARG        Save a JSON file of the the statistics to given path
 --silent                 Disable all output
 --record-query           Take in consideration the query string for the report
 --list-test-groups       Shows the list of tests to run and exit