Struct goose::metrics::GooseRequestMetricAggregate

pub struct GooseRequestMetricAggregate {
    pub path: String,
    pub method: GooseMethod,
    pub raw_data: GooseRequestMetricTimingData,
    pub coordinated_omission_data: Option<GooseRequestMetricTimingData>,
    pub status_code_counts: HashMap<u16, usize>,
    pub success_count: usize,
    pub fail_count: usize,
    pub load_test_hash: u64,
}

Metrics collected about a method-path pair, (for example GET /index).

GooseRequestMetrics are sent by GooseUser threads to the Goose parent process where they are aggregated together into this structure, and stored in GooseMetrics::requests.

Fields

path: String

The request path for which metrics are being collected.

For example: “/”.

method: GooseMethod

The method for which metrics are being collected.

For example: GooseMethod::Get.

raw_data: GooseRequestMetricTimingData

The raw data seen from actual requests.

coordinated_omission_data: Option<GooseRequestMetricTimingData>

Combines the raw data with statistically generated Coordinated Omission Metrics.

status_code_counts: HashMap<u16, usize>

Per-status-code counters, tracking how often each response code was returned for this request.

success_count: usize

Total number of times this path-method request resulted in a successful (2xx) status code.

A count of how many requests resulted in a 2xx status code.

fail_count: usize

Total number of times this path-method request resulted in a non-successful (non-2xx) status code.

A count of how many requests resulted in a non-2xx status code.

load_test_hash: u64

Load test hash.

The hash is primarily used when running a distributed Gaggle, allowing the Manager to confirm that all Workers are running the same load test plan.

Trait Implementations

impl Clone for GooseRequestMetricAggregate

fn clone(&self) -> GooseRequestMetricAggregate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GooseRequestMetricAggregate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GooseRequestMetricAggregate

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

Deserialize this value from the given Serde deserializer.

impl Ord for GooseRequestMetricAggregate

Implement ordering for GooseRequestMetricAggregate.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<GooseRequestMetricAggregate> for GooseRequestMetricAggregate

fn eq(&self, other: &GooseRequestMetricAggregate) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<GooseRequestMetricAggregate> for GooseRequestMetricAggregate

Implement partial-ordering for GooseRequestMetricAggregate.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for GooseRequestMetricAggregate

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

Serialize this value into the given Serde serializer.

impl Eq for GooseRequestMetricAggregate

Implement equality for GooseRequestMetricAggregate. We can’t simply derive since we have floats in the struct.

Eq trait has no functions on it - it is there only to inform the compiler that this is an equivalence rather than a partial equivalence.

See https://doc.rust-lang.org/std/cmp/trait.Eq.html for more information.

impl StructuralPartialEq for GooseRequestMetricAggregate