Struct goose::metrics::GooseMetrics
source · [−]pub struct GooseMetrics {
pub hash: u64,
pub history: Vec<TestPlanHistory>,
pub duration: usize,
pub maximum_users: usize,
pub total_users: usize,
pub requests: GooseRequestMetrics,
pub transactions: TransactionMetrics,
pub scenarios: ScenarioMetrics,
pub errors: GooseErrorMetrics,
pub hosts: HashSet<String>,
/* private fields */
}
Expand description
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_scenario(scenario!("ExampleUsers")
.register_transaction(transaction!(example_transaction))
)
// 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 -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,
},
},
transactions: [
[
TransactionMetricAggregate {
scenario_index: 0,
scenario_name: "ExampleUsers",
transaction_index: 0,
transaction_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_transaction(user: &mut GooseUser) -> TransactionResult {
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.
history: Vec<TestPlanHistory>
A vector recording the history of each load test step.
duration: usize
Total number of seconds the load test ran.
maximum_users: usize
Maximum 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.
total_users: usize
Total number of users simulated during this load test.
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.
transactions: TransactionMetrics
Transactions details about each transaction that is invoked during the load test.
Can be disabled with either the --no-transaction-metrics
or --no-metrics
run-time options,
or with either the
GooseDefault::NoTransactionMetrics or
GooseDefault::NoMetrics.
scenarios: ScenarioMetrics
Transactions details about each scenario that is invoked during the load test.
Can be disabled with either the --no-scenario-metrics
or --no-metrics
run-time options,
or with either the
GooseDefault::NoTransactionMetrics 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.
Trait Implementations
sourceimpl Clone for GooseMetrics
impl Clone for GooseMetrics
sourcefn clone(&self) -> GooseMetrics
fn clone(&self) -> GooseMetrics
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for GooseMetrics
impl Debug for GooseMetrics
sourceimpl Default for GooseMetrics
impl Default for GooseMetrics
sourcefn default() -> GooseMetrics
fn default() -> GooseMetrics
sourceimpl Display for GooseMetrics
impl Display for GooseMetrics
Implement format trait to allow displaying metrics.
sourceimpl Serialize for GooseMetrics
impl Serialize for GooseMetrics
Auto Trait Implementations
impl RefUnwindSafe for GooseMetrics
impl Send for GooseMetrics
impl Sync for GooseMetrics
impl Unpin for GooseMetrics
impl UnwindSafe for GooseMetrics
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read moresourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read moresourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read moresourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more