goose 0.18.1

A load testing framework inspired by Locust.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
use super::{
    merge_times, per_second_calculations, prepare_status_codes, report, update_max_time,
    update_min_time, CoMetricsSummary, GooseErrorMetricAggregate, GooseMetrics,
};
use crate::{
    report::{
        CORequestMetric, RequestMetric, ResponseMetric, ScenarioMetric, StatusCodeMetric,
        TransactionMetric,
    },
    util,
};
use itertools::Itertools;
use std::collections::{BTreeMap, HashMap};

#[derive(Debug, serde::Serialize)]
pub(crate) struct ReportData<'m> {
    pub raw_metrics: &'m GooseMetrics,

    pub raw_request_metrics: Vec<RequestMetric>,
    pub raw_response_metrics: Vec<ResponseMetric>,

    pub co_request_metrics: Option<Vec<CORequestMetric>>,
    pub co_response_metrics: Option<Vec<ResponseMetric>>,

    pub scenario_metrics: Option<Vec<ScenarioMetric>>,
    pub transaction_metrics: Option<Vec<TransactionMetric>>,

    pub status_code_metrics: Option<Vec<StatusCodeMetric>>,

    pub errors: Option<Vec<&'m GooseErrorMetricAggregate>>,

    pub coordinated_omission_metrics: Option<CoMetricsSummary>,
}

pub struct ReportOptions {
    pub no_transaction_metrics: bool,
    pub no_scenario_metrics: bool,
    pub no_status_codes: bool,
}

pub fn prepare_data(options: ReportOptions, metrics: &GooseMetrics) -> ReportData<'_> {
    // Prepare requests and responses variables.
    let mut raw_request_metrics = Vec::new();
    let mut co_request_metrics = Vec::new();
    let mut raw_response_metrics = Vec::new();
    let mut co_response_metrics = Vec::new();
    let mut raw_aggregate_total_count = 0;
    let mut co_aggregate_total_count = 0;
    let mut raw_aggregate_fail_count = 0;
    let mut raw_aggregate_response_time_counter: usize = 0;
    let mut raw_aggregate_response_time_minimum: usize = 0;
    let mut raw_aggregate_response_time_maximum: usize = 0;
    let mut raw_aggregate_response_times: BTreeMap<usize, usize> = BTreeMap::new();
    let mut co_aggregate_response_time_counter: usize = 0;
    let mut co_aggregate_response_time_maximum: usize = 0;
    let mut co_aggregate_response_times: BTreeMap<usize, usize> = BTreeMap::new();
    let mut co_data = false;

    for (request_key, request) in metrics.requests.iter().sorted() {
        // Determine whether or not to include Coordinated Omission data.
        if !co_data && request.coordinated_omission_data.is_some() {
            co_data = true;
        }
        let method = format!("{}", request.method);
        // The request_key is "{method} {name}", so by stripping the "{method} "
        // prefix we get the name.
        let name = request_key
            .strip_prefix(&format!("{} ", request.method))
            .unwrap()
            .to_string();
        let total_request_count = request.success_count + request.fail_count;
        let (requests_per_second, failures_per_second) =
            per_second_calculations(metrics.duration, total_request_count, request.fail_count);
        // Prepare per-request metrics.
        raw_request_metrics.push(report::RequestMetric {
            method: method.to_string(),
            name: name.to_string(),
            number_of_requests: total_request_count,
            number_of_failures: request.fail_count,
            response_time_average: request.raw_data.total_time as f32
                / request.raw_data.counter as f32,
            response_time_minimum: request.raw_data.minimum_time,
            response_time_maximum: request.raw_data.maximum_time,
            requests_per_second,
            failures_per_second,
        });

        // Prepare per-response metrics.
        raw_response_metrics.push(report::get_response_metric(
            &method,
            &name,
            &request.raw_data.times,
            request.raw_data.counter,
            request.raw_data.minimum_time,
            request.raw_data.maximum_time,
        ));

        // Collect aggregated request and response metrics.
        raw_aggregate_total_count += total_request_count;
        raw_aggregate_fail_count += request.fail_count;
        raw_aggregate_response_time_counter += request.raw_data.total_time;
        raw_aggregate_response_time_minimum = update_min_time(
            raw_aggregate_response_time_minimum,
            request.raw_data.minimum_time,
        );
        raw_aggregate_response_time_maximum = update_max_time(
            raw_aggregate_response_time_maximum,
            request.raw_data.maximum_time,
        );
        raw_aggregate_response_times =
            merge_times(raw_aggregate_response_times, request.raw_data.times.clone());
    }

    // Prepare aggregate per-request metrics.
    let (raw_aggregate_requests_per_second, raw_aggregate_failures_per_second) =
        per_second_calculations(
            metrics.duration,
            raw_aggregate_total_count,
            raw_aggregate_fail_count,
        );
    raw_request_metrics.push(report::RequestMetric {
        method: "".to_string(),
        name: "Aggregated".to_string(),
        number_of_requests: raw_aggregate_total_count,
        number_of_failures: raw_aggregate_fail_count,
        response_time_average: raw_aggregate_response_time_counter as f32
            / raw_aggregate_total_count as f32,
        response_time_minimum: raw_aggregate_response_time_minimum,
        response_time_maximum: raw_aggregate_response_time_maximum,
        requests_per_second: raw_aggregate_requests_per_second,
        failures_per_second: raw_aggregate_failures_per_second,
    });

    // Prepare aggregate per-response metrics.
    raw_response_metrics.push(report::get_response_metric(
        "",
        "Aggregated",
        &raw_aggregate_response_times,
        raw_aggregate_total_count,
        raw_aggregate_response_time_minimum,
        raw_aggregate_response_time_maximum,
    ));

    let (co_request_metrics, co_response_metrics) = if co_data {
        for (request_key, request) in metrics.requests.iter().sorted() {
            if let Some(coordinated_omission_data) = request.coordinated_omission_data.as_ref() {
                let method = format!("{}", request.method);
                // The request_key is "{method} {name}", so by stripping the "{method} "
                // prefix we get the name.
                let name = request_key
                    .strip_prefix(&format!("{} ", request.method))
                    .unwrap()
                    .to_string();
                let raw_average =
                    request.raw_data.total_time as f32 / request.raw_data.counter as f32;
                let co_average = coordinated_omission_data.total_time as f32
                    / coordinated_omission_data.counter as f32;
                // Prepare per-request metrics.
                co_request_metrics.push(report::CORequestMetric {
                    method: method.to_string(),
                    name: name.to_string(),
                    response_time_average: co_average,
                    response_time_standard_deviation: util::standard_deviation(
                        raw_average,
                        co_average,
                    ),
                    response_time_maximum: coordinated_omission_data.maximum_time,
                });

                // Prepare per-response metrics.
                co_response_metrics.push(report::get_response_metric(
                    &method,
                    &name,
                    &coordinated_omission_data.times,
                    coordinated_omission_data.counter,
                    coordinated_omission_data.minimum_time,
                    coordinated_omission_data.maximum_time,
                ));

                // Collect aggregated request and response metrics.
                co_aggregate_response_time_counter += coordinated_omission_data.total_time;
                co_aggregate_response_time_maximum = update_max_time(
                    co_aggregate_response_time_maximum,
                    coordinated_omission_data.maximum_time,
                );
                co_aggregate_response_times = merge_times(
                    co_aggregate_response_times,
                    coordinated_omission_data.times.clone(),
                );
            }
            let total_request_count = request.success_count + request.fail_count;
            co_aggregate_total_count += total_request_count;
        }
        let co_average =
            co_aggregate_response_time_counter as f32 / co_aggregate_total_count as f32;
        let raw_average =
            raw_aggregate_response_time_counter as f32 / raw_aggregate_total_count as f32;
        co_request_metrics.push(report::CORequestMetric {
            method: "".to_string(),
            name: "Aggregated".to_string(),
            response_time_average: co_aggregate_response_time_counter as f32
                / co_aggregate_total_count as f32,
            response_time_standard_deviation: util::standard_deviation(raw_average, co_average),
            response_time_maximum: co_aggregate_response_time_maximum,
        });

        // Prepare aggregate per-response metrics.
        co_response_metrics.push(report::get_response_metric(
            "",
            "Aggregated",
            &co_aggregate_response_times,
            co_aggregate_total_count,
            raw_aggregate_response_time_minimum,
            co_aggregate_response_time_maximum,
        ));

        (Some(co_request_metrics), Some(co_response_metrics))
    } else {
        (None, None)
    };

    // Only build the transactions template if --no-transaction-metrics isn't enabled.
    let transaction_metrics = if !options.no_transaction_metrics {
        let mut transaction_metrics = Vec::new();
        let mut aggregate_total_count = 0;
        let mut aggregate_fail_count = 0;
        let mut aggregate_transaction_time_counter: usize = 0;
        let mut aggregate_transaction_time_minimum: usize = 0;
        let mut aggregate_transaction_time_maximum: usize = 0;
        let mut aggregate_transaction_times: BTreeMap<usize, usize> = BTreeMap::new();
        for (scenario_counter, scenario) in metrics.transactions.iter().enumerate() {
            for (transaction_counter, transaction) in scenario.iter().enumerate() {
                if transaction_counter == 0 {
                    // Only the scenario_name is used for scenarios.
                    transaction_metrics.push(report::TransactionMetric {
                        is_scenario: true,
                        transaction: "".to_string(),
                        name: transaction.scenario_name.to_string(),
                        number_of_requests: 0,
                        number_of_failures: 0,
                        response_time_average: None,
                        response_time_minimum: 0,
                        response_time_maximum: 0,
                        requests_per_second: None,
                        failures_per_second: None,
                    });
                }
                let total_run_count = transaction.success_count + transaction.fail_count;
                let (requests_per_second, failures_per_second) = per_second_calculations(
                    metrics.duration,
                    total_run_count,
                    transaction.fail_count,
                );
                let average = match transaction.counter {
                    0 => 0.00,
                    _ => transaction.total_time as f32 / transaction.counter as f32,
                };
                transaction_metrics.push(report::TransactionMetric {
                    is_scenario: false,
                    transaction: format!("{scenario_counter}.{transaction_counter}"),
                    name: transaction.transaction_name.to_string(),
                    number_of_requests: total_run_count,
                    number_of_failures: transaction.fail_count,
                    response_time_average: Some(average),
                    response_time_minimum: transaction.min_time,
                    response_time_maximum: transaction.max_time,
                    requests_per_second: Some(requests_per_second),
                    failures_per_second: Some(failures_per_second),
                });

                aggregate_total_count += total_run_count;
                aggregate_fail_count += transaction.fail_count;
                aggregate_transaction_times =
                    merge_times(aggregate_transaction_times, transaction.times.clone());
                aggregate_transaction_time_counter += &transaction.counter;
                aggregate_transaction_time_minimum =
                    update_min_time(aggregate_transaction_time_minimum, transaction.min_time);
                aggregate_transaction_time_maximum =
                    update_max_time(aggregate_transaction_time_maximum, transaction.max_time);
            }
        }

        let (aggregate_requests_per_second, aggregate_failures_per_second) =
            per_second_calculations(
                metrics.duration,
                aggregate_total_count,
                aggregate_fail_count,
            );
        transaction_metrics.push(report::TransactionMetric {
            is_scenario: false,
            transaction: "".to_string(),
            name: "Aggregated".to_string(),
            number_of_requests: aggregate_total_count,
            number_of_failures: aggregate_fail_count,
            response_time_average: Some(
                raw_aggregate_response_time_counter as f32 / aggregate_total_count as f32,
            ),
            response_time_minimum: aggregate_transaction_time_minimum,
            response_time_maximum: aggregate_transaction_time_maximum,
            requests_per_second: Some(aggregate_requests_per_second),
            failures_per_second: Some(aggregate_failures_per_second),
        });
        Some(transaction_metrics)
    } else {
        None
    };

    // Only build the scenarios template if --no-senario-metrics isn't enabled.
    let scenario_metrics = if !options.no_scenario_metrics {
        let mut scenario_metrics = Vec::new();
        let mut aggregate_users = 0;
        let mut aggregate_count = 0;
        let mut aggregate_scenario_time_counter: usize = 0;
        let mut aggregate_scenario_time_minimum: usize = 0;
        let mut aggregate_scenario_time_maximum: usize = 0;
        let mut aggregate_scenario_times: BTreeMap<usize, usize> = BTreeMap::new();
        let mut aggregate_iterations = 0.0;
        let mut aggregate_response_time_counter = 0.0;
        for scenario in &metrics.scenarios {
            let (count_per_second, _failures_per_second) =
                per_second_calculations(metrics.duration, scenario.counter, 0);
            let average = match scenario.counter {
                0 => 0.00,
                _ => scenario.total_time as f32 / scenario.counter as f32,
            };
            let iterations = scenario.counter as f32 / scenario.users.len() as f32;
            scenario_metrics.push(report::ScenarioMetric {
                name: scenario.name.to_string(),
                users: scenario.users.len(),
                count: scenario.counter,
                response_time_average: average,
                response_time_minimum: scenario.min_time,
                response_time_maximum: scenario.max_time,
                count_per_second,
                iterations,
            });

            aggregate_users += scenario.users.len();
            aggregate_count += scenario.counter;
            aggregate_scenario_times =
                merge_times(aggregate_scenario_times, scenario.times.clone());
            aggregate_scenario_time_counter += &scenario.counter;
            aggregate_scenario_time_minimum =
                update_min_time(aggregate_scenario_time_minimum, scenario.min_time);
            aggregate_scenario_time_maximum =
                update_max_time(aggregate_scenario_time_maximum, scenario.max_time);
            aggregate_iterations += iterations;
            aggregate_response_time_counter += scenario.total_time as f32;
        }

        let (aggregate_count_per_second, _aggregate_failures_per_second) =
            per_second_calculations(metrics.duration, aggregate_count, 0);
        scenario_metrics.push(report::ScenarioMetric {
            name: "Aggregated".to_string(),
            users: aggregate_users,
            count: aggregate_count,
            response_time_average: aggregate_response_time_counter / aggregate_count as f32,
            response_time_minimum: aggregate_scenario_time_minimum,
            response_time_maximum: aggregate_scenario_time_maximum,
            count_per_second: aggregate_count_per_second,
            iterations: aggregate_iterations,
        });

        Some(scenario_metrics)
    } else {
        None
    };

    let status_code_metrics = if !options.no_status_codes {
        let mut status_code_metrics = Vec::new();
        let mut aggregated_status_code_counts: HashMap<u16, usize> = HashMap::new();
        for (request_key, request) in metrics.requests.iter().sorted() {
            let method = format!("{}", request.method);
            // The request_key is "{method} {name}", so by stripping the "{method} "
            // prefix we get the name.
            let name = request_key
                .strip_prefix(&format!("{} ", request.method))
                .unwrap()
                .to_string();

            // Build a list of status codes, and update the aggregate record.
            let codes = prepare_status_codes(
                &request.status_code_counts,
                &mut Some(&mut aggregated_status_code_counts),
            );

            // Add a row of data for the status code table.
            status_code_metrics.push(report::StatusCodeMetric {
                method,
                name,
                status_codes: codes,
            });
        }

        // Build a list of aggregate status codes.
        let aggregated_codes = prepare_status_codes(&aggregated_status_code_counts, &mut None);

        // Add a final row of aggregate data for the status code table.
        status_code_metrics.push(report::StatusCodeMetric {
            method: "".to_string(),
            name: "Aggregated".to_string(),
            status_codes: aggregated_codes,
        });

        Some(status_code_metrics)
    } else {
        None
    };

    ReportData {
        raw_metrics: metrics,
        raw_request_metrics,
        raw_response_metrics,
        co_request_metrics,
        co_response_metrics,
        scenario_metrics,
        transaction_metrics,
        status_code_metrics,
        errors: (!metrics.errors.is_empty()).then(|| metrics.errors.values().collect::<Vec<_>>()),
        coordinated_omission_metrics: metrics
            .coordinated_omission_metrics
            .as_ref()
            .map(|co| co.get_summary()),
    }
}