Struct goose::metrics::GooseMetrics

pub struct GooseMetrics {
    pub hash: u64,
    pub starting: Option<DateTime<Local>>,
    pub started: Option<DateTime<Local>>,
    pub stopping: Option<DateTime<Local>>,
    pub stopped: Option<DateTime<Local>>,
    pub duration: usize,
    pub users: usize,
    pub requests: GooseRequestMetrics,
    pub tasks: GooseTaskMetrics,
    pub errors: GooseErrorMetrics,
    pub hosts: HashSet<String>,
    // some fields omitted
}

All metrics optionally collected during a Goose load test.

By default, Goose collects metrics during a load test in a GooseMetrics object that is returned by GooseAttack::execute() when a load test finishes.

Example

use goose::prelude::*;

#[tokio::main]
async 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()
        .await?;

    // 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);

    /**
    // For example:
    $ cargo run -- -H http://example.com -v -u1 -t1
    GooseMetrics {
        hash: 0,
        started: Some(
            2021-06-15T09:32:49.888147+02:00,
        ),
        duration: 1,
        users: 1,
        requests: {
            "GET /": GooseRequestMetricAggregate {
                path: "/",
                method: Get,
                response_times: {
                    3: 14,
                    4: 163,
                    5: 36,
                    6: 8,
                },
                min_response_time: 3,
                max_response_time: 6,
                total_response_time: 922,
                response_time_counter: 221,
                status_code_counts: {},
                success_count: 0,
                fail_count: 221,
                load_test_hash: 0,
            },
        },
        tasks: [
            [
                GooseTaskMetricAggregate {
                    taskset_index: 0,
                    taskset_name: "ExampleUsers",
                    task_index: 0,
                    task_name: "",
                    times: {
                        3: 14,
                        4: 161,
                        5: 38,
                        6: 8,
                    },
                    min_time: 3,
                    max_time: 6,
                    total_time: 924,
                    counter: 221,
                    success_count: 221,
                    fail_count: 0,
                },
            ],
        ],
        errors: {
            "503 Service Unavailable: /.GET./": GooseErrorMetric {
                method: Get,
                name: "/",
                error: "503 Service Unavailable: /",
                occurrences: 221,
            },
        },
        final_metrics: true,
        display_status_codes: false,
        display_metrics: true,
    }
    **/

    Ok(())
}

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

    Ok(())
}

Fields

hash: u64

A hash of the load test, primarily used to validate all Workers in a Gaggle are running the same load test.

starting: Option<DateTime<Local>>

Tracks when the load test first started with an optional system timestamp.

started: Option<DateTime<Local>>

Tracks when all GooseUser threads fully started with an optional system timestamp.

stopping: Option<DateTime<Local>>

Tracks when the load test first began stopping with an optional system timestamp.

stopped: Option<DateTime<Local>>

Tracks when the load test stopped with an optional system timestamp.

duration: usize

Total number of seconds the load test ran.

users: usize

Total number of users simulated during this load test.

This value may be smaller than what was configured at start time if the test didn’t run long enough for all configured users to start.

requests: GooseRequestMetrics

Tracks details about each request made during the load test.

Can be disabled with the --no-metrics run-time option, or with GooseDefault::NoMetrics.

tasks: GooseTaskMetrics

Tracks details about each task that is invoked during the load test.

Can be disabled with either the --no-task-metrics or --no-metrics run-time options, or with either the GooseDefault::NoTaskMetrics or GooseDefault::NoMetrics.

errors: GooseErrorMetrics

Tracks and counts each time an error is detected during the load test.

Can be disabled with either the --no-error-summary or --no-metrics run-time options, or with either the GooseDefault::NoErrorSummary or GooseDefault::NoMetrics.

hosts: HashSet<String>

Tracks all hosts that the load test is run against.

Implementations

impl GooseMetrics

pub fn print(&self)

Consumes and display all enabled metrics from a completed load test.

Example

use goose::prelude::*;

#[tokio::main]
async 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()
        .await?
        .print();

    Ok(())
}

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

    Ok(())
}

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.

impl Serialize for GooseMetrics

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

Serialize this value into the given Serde serializer.