Wrecker.Runner

Documentation

data Environment

The Environment holds state necessary to make and record HTTP calls.

Constructors

Environment

Fields

• recorder :: Recorder

  The Recorder can be used with the record function to ... record times.

• context :: ConnectionContext

  Provided as a convience, this is a shared TLS context to reuse for better performance.

newStandaloneRecorder :: IO (NextRef AllStats, Thread, Recorder)

Typically wrecker will control benchmarking actions. However in some situations a benchmark might require more control.

To facilitate more complex scenarios wrecker provide newStandaloneRecorder which provides a Recorder and Thread that processes the events, and a reference to the current stats.

sinkRecorder :: Logger -> Recorder -> IO (NextRef AllStats, Thread)

updateSampler :: NextRef AllStats -> Event -> IO AllStats

collectEvent :: Logger -> NextRef AllStats -> Recorder -> IO ()

runAction :: Logger -> Int -> Int -> RunType -> (Environment -> IO ()) -> Environment -> IO ()

runWithNextVar

Arguments

:: Options

The run options as passed from the CLI

-> (NextRef AllStats -> IO ())

The statistics consumer action. Use this for example to present a summary of the stast

-> (NextRef AllStats -> IO ())

The final consumer action. Maybe to present a final chart of the stats.

-> (Environment -> IO ())

The load test action

-> IO AllStats

printLastSamples :: Options -> NextRef AllStats -> IO ()

runNonInteractive :: Options -> (Environment -> IO ()) -> IO AllStats

printLoop :: Options -> DisplayContext -> Vty -> NextRef AllStats -> IO ()

processInputForCtrlC :: TChan Event -> IO ThreadId

updateUI :: Maybe Int -> URLDisplay -> DisplayContext -> AllStats -> IO ()

runInteractive :: Options -> (Environment -> IO ()) -> IO AllStats

run :: Options -> [(String, Environment -> IO ())] -> IO (HashMap String AllStats)

run is the a lower level entry point, compared to defaultMain. Unlike defaultMain no command line argument parsing is performed. Instead, Options are directly passed in. defaultOptions can be used as a default argument for run.

Like defaultMain, run creates a Recorder and passes it each benchmark.

showTestGroups :: [(String, Environment -> IO ())] -> IO ()

runOne :: Options -> (Environment -> IO ()) -> IO AllStats

Run a single benchmark