Struct Wrk 

pub struct Wrk { /* private fields */ }

Wrapper around Wrk enabling to run benchmarks, record historical data and plot graphs.

Implementations

impl Wrk

pub fn url(&self) -> &String

Url of the service to benchmark against. Use the full URL of the request. IE: http://localhost:1234/some/uri.

pub fn timeout(&self) -> &u8

Wrk timeout in seconds

pub fn benchmarks(&self) -> &Benchmarks

Set of benchmarks for the current instance.

pub fn benchmarks_history(&self) -> &Benchmarks

Historical benchmarks data, indexed by dates.

pub fn history_dir(&self) -> &PathBuf

Directory on disk where to store and read the historical benchmark data.

pub fn user_script(&self) -> &Option<PathBuf>

User defined LUA script to run through wrk. **NOTE: This script MUST not override the wrk function done() as it already overriden by this crate to allow wrk to spit out a parsable JSON output.

pub fn headers(&self) -> &Headers

Header to add to the wrk request.

pub fn method(&self) -> &String

Method for the wrk request.

pub fn body(&self) -> &String

Body for the wrk request.

pub fn max_error_percentage(&self) -> &u8

Max percentage of errors vs total request to conside a benchmark healthy.

pub fn benchmark_date(&self) -> &Option<DateTime<Utc>>

Current benchmark date and time.

impl Wrk

pub fn set_url(&mut self, val: String) -> &mut Self

Url of the service to benchmark against. Use the full URL of the request. IE: http://localhost:1234/some/uri.

pub fn set_timeout(&mut self, val: u8) -> &mut Self

Wrk timeout in seconds

pub fn set_benchmarks(&mut self, val: Benchmarks) -> &mut Self

Set of benchmarks for the current instance.

pub fn set_benchmarks_history(&mut self, val: Benchmarks) -> &mut Self

Historical benchmarks data, indexed by dates.

pub fn set_history_dir(&mut self, val: PathBuf) -> &mut Self

Directory on disk where to store and read the historical benchmark data.

pub fn set_user_script(&mut self, val: Option<PathBuf>) -> &mut Self

User defined LUA script to run through wrk. **NOTE: This script MUST not override the wrk function done() as it already overriden by this crate to allow wrk to spit out a parsable JSON output.

pub fn set_headers(&mut self, val: Headers) -> &mut Self

Header to add to the wrk request.

pub fn set_method(&mut self, val: String) -> &mut Self

Method for the wrk request.

pub fn set_body(&mut self, val: String) -> &mut Self

Body for the wrk request.

pub fn set_max_error_percentage(&mut self, val: u8) -> &mut Self

Max percentage of errors vs total request to conside a benchmark healthy.

pub fn set_benchmark_date(&mut self, val: Option<DateTime<Utc>>) -> &mut Self

Current benchmark date and time.

impl Wrk

pub fn url_mut(&mut self) -> &mut String

Url of the service to benchmark against. Use the full URL of the request. IE: http://localhost:1234/some/uri.

pub fn timeout_mut(&mut self) -> &mut u8

Wrk timeout in seconds

pub fn benchmarks_mut(&mut self) -> &mut Benchmarks

Set of benchmarks for the current instance.

pub fn benchmarks_history_mut(&mut self) -> &mut Benchmarks

Historical benchmarks data, indexed by dates.

pub fn history_dir_mut(&mut self) -> &mut PathBuf

Directory on disk where to store and read the historical benchmark data.

pub fn user_script_mut(&mut self) -> &mut Option<PathBuf>

User defined LUA script to run through wrk. **NOTE: This script MUST not override the wrk function done() as it already overriden by this crate to allow wrk to spit out a parsable JSON output.

pub fn headers_mut(&mut self) -> &mut Headers

Header to add to the wrk request.

pub fn method_mut(&mut self) -> &mut String

Method for the wrk request.

pub fn body_mut(&mut self) -> &mut String

Body for the wrk request.

pub fn max_error_percentage_mut(&mut self) -> &mut u8

Max percentage of errors vs total request to conside a benchmark healthy.

pub fn benchmark_date_mut(&mut self) -> &mut Option<DateTime<Utc>>

Current benchmark date and time.

impl Wrk

pub fn bench(&mut self, benchmarks: &Vec<Benchmark>) -> Result<(), WrkError>

pub fn bench_exponential( &mut self, duration: Option<Duration>, ) -> Result<(), WrkError>

pub fn all_benchmarks(&self) -> Benchmarks

pub fn deviation( &mut self, period: HistoryPeriod, ) -> Result<Deviation, WrkError>

pub fn plot( &self, title: &str, output: &Path, benchmarks: &Benchmarks, ) -> Result<(), WrkError>

Trait Implementations

impl Clone for Wrk

fn clone(&self) -> Wrk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Wrk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Wrk

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Wrk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.