Struct goose::metrics::GooseMetrics

pub struct GooseMetrics {
    pub hash: u64,
    pub started: Option<DateTime<Local>>,
    pub duration: usize,
    pub users: usize,
    pub requests: GooseRequestMetrics,
    pub tasks: GooseTaskMetrics,
    pub errors: BTreeMap<String, GooseErrorMetric>,
    pub final_metrics: bool,
    pub display_status_codes: bool,
    pub display_metrics: bool,
}

Metrics collected during a Goose load test.

Example

use goose::prelude::*;

fn main() -> Result<(), GooseError> {
    let goose_metrics: GooseMetrics = GooseAttack::initialize()?
        .register_taskset(taskset!("ExampleUsers")
            .register_task(task!(example_task))
        )
        // Set a default host so the load test will start.
        .set_default(GooseDefault::Host, "http://localhost/")?
        // Set a default run time so this test runs to completion.
        .set_default(GooseDefault::RunTime, 1)?
        .execute()?;

    // It is now possible to do something with the metrics collected by Goose.
    // For now, we'll just pretty-print the entire object.
    println!("{:#?}", goose_metrics);

    Ok(())
}

async fn example_task(user: &GooseUser) -> GooseTaskResult {
    let _goose = user.get("/").await?;

    Ok(())
}

Fields

hash: u64

A hash of the load test, useful to verify if different metrics are from the same load test.

started: Option<DateTime<Local>>

The system timestamp of when the load test started.

duration: usize

Total number of seconds the load test ran.

users: usize

Total number of users simulated during this load test.

requests: GooseRequestMetrics

Goose request metrics.

tasks: GooseTaskMetrics

Goose task metrics.

errors: BTreeMap<String, GooseErrorMetric>

Error-related metrics.

final_metrics: bool

Flag indicating whether or not these are the final metrics. Because we’re deriving Default, this defaults to false.

display_status_codes: bool

Flag indicating whether or not to display status_codes. Because we’re deriving Default, this defaults to false.

display_metrics: bool

Flag indicating whether or not to display metrics, set to false on Workers. This defaults to false because we’re deriving Default.

Implementations

impl GooseMetrics

pub fn initialize_task_metrics(
    &mut self,
    task_sets: &[GooseTaskSet],
    config: &GooseConfiguration
)

Initialize the task_metrics vector.

pub fn print(&self)

Consumes and display all metrics from a completed load test.

Example

use goose::prelude::*;

fn main() -> Result<(), GooseError> {
    GooseAttack::initialize()?
        .register_taskset(taskset!("ExampleUsers")
            .register_task(task!(example_task))
        )
        // Set a default host so the load test will start.
        .set_default(GooseDefault::Host, "http://localhost/")?
        // Set a default run time so this test runs to completion.
        .set_default(GooseDefault::RunTime, 1)?
        .execute()?
        .print();

    Ok(())
}

async fn example_task(user: &GooseUser) -> GooseTaskResult {
    let _goose = user.get("/").await?;

    Ok(())
}

pub fn print_running(&self)

Consumes and displays metrics from a running load test.

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

Optionally prepares a table of requests and fails.

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

Optionally prepares a table of tasks.

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

Optionally prepares a table of task times.

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

Optionally prepares a table of response times.

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

Optionally prepares a table of slowest response times within several percentiles.

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

Optionally prepares a table of response status codes.

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

Optionally prepares a table of errors.

Trait Implementations

impl Clone for GooseMetrics

fn clone(&self) -> GooseMetrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GooseMetrics

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

Formats the value using the given formatter.

impl Default for GooseMetrics

fn default() -> GooseMetrics

Returns the “default value” for a type.

impl Display for GooseMetrics

Implement format trait to allow displaying metrics.

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

Formats the value using the given formatter.