cardamon 0.0.9

Cardamon is a tool to help development teams measure the power consumption and carbon emissions of their software.
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
use crate::{
    dao::{self, pagination::Pages},
    data::Data,
    entities::{iteration::Model as Iteration, metrics::Model as Metrics},
};
use anyhow::Context;
use itertools::Itertools;
use sea_orm::DatabaseConnection;
use std::collections::HashMap;

use super::{ProcessData, ProcessMetrics, RunData, ScenarioData};

pub enum AggregationMethod {
    MostRecent,
    Average,
    Sum,
}

pub enum LiveDataFilter {
    IncludeLive,
    ExcludeLive,
    OnlyLive,
}

/// Associates a single ScenarioIteration with all the metrics captured for it.
#[derive(Debug)]
pub struct IterationMetrics {
    iteration: Iteration,
    metrics: Vec<Metrics>,
}
impl IterationMetrics {
    pub fn new(iteration: Iteration, metrics: Vec<Metrics>) -> Self {
        Self { iteration, metrics }
    }

    pub fn iteration(&self) -> &Iteration {
        &self.iteration
    }

    pub fn metrics(&self) -> &[Metrics] {
        &self.metrics
    }

    pub fn by_process(&self) -> HashMap<String, Vec<&Metrics>> {
        let mut metrics_by_process: HashMap<String, Vec<&Metrics>> = HashMap::new();
        for metric in self.metrics.iter() {
            let proc_name = metric.process_name.clone();
            metrics_by_process
                .entry(proc_name)
                .and_modify(|v| v.push(metric))
                .or_insert(vec![metric]); // if entry doesn't exist then create a new vec
        }

        metrics_by_process
    }
}

/// Data in cardamon is organised as a table. Each row is a scenario and each column is a run
/// of that scenario.
///
/// Example: Dataset containing the most recent 3 runs of 3 different scenarios.
///  ============================================
/// ||  scenarios   || run_1  | run_2  | run_3  ||
/// ||--------------||--------------------------||
/// || add_10_items || <data> | <data> |        ||
/// || add_10_users ||        | <data> | <data> ||
/// || checkout     || <data> |        | <data> ||
///  ============================================
///
/// Example: Dataset containing the 2nd page of runs for the `add_10_items` scenario.
///  ================================================================================
/// ||  scenarios   || run_1  | run_2  | run_3  |   run_4   |   run_5   |   run_6   ||
/// ||--------------||--------|--------|--------|-----------|-----------|-----------||
/// ||              ||        |        |        | ********************************* ||
/// || add_10_items || <data> | <data> | <data> | * <data>  |  <data>   |  <data> * ||
/// ||              ||        |        |        | ********************************* ||
///  ================================================================================
///
#[derive(Debug)]
pub struct Dataset {
    data: Vec<IterationMetrics>,
    pub total_scenarios: Pages,
    pub total_runs: Pages,
}
impl<'a> Dataset {
    pub fn new(data: Vec<IterationMetrics>, total_scenarios: Pages, total_runs: Pages) -> Self {
        Self {
            data,
            total_scenarios,
            total_runs,
        }
    }

    pub fn data(&'a self) -> &'a [IterationMetrics] {
        &self.data
    }

    pub fn is_empty(&'a self) -> bool {
        self.data.is_empty()
    }

    pub fn by_scenario(&'a self, live_data_filter: LiveDataFilter) -> Vec<ScenarioDataset<'a>> {
        // get all the scenarios in the dataset
        let unique_scenario_names = self
            .data
            .iter()
            .map(|x| &x.iteration.scenario_name)
            .unique();
        let scenario_names = match live_data_filter {
            LiveDataFilter::IncludeLive => unique_scenario_names.collect_vec(),
            LiveDataFilter::ExcludeLive => unique_scenario_names
                .filter(|name| !name.starts_with("live"))
                .collect_vec(),
            LiveDataFilter::OnlyLive => unique_scenario_names
                .filter(|name| name.starts_with("live"))
                .collect_vec(),
        };

        scenario_names
            .into_iter()
            .map(|scenario_name| {
                let data = self
                    .data
                    .iter()
                    .filter(|x| &x.iteration.scenario_name == scenario_name)
                    .collect::<Vec<_>>();

                ScenarioDataset {
                    scenario_name,
                    data,
                }
            })
            .collect::<Vec<_>>()
    }
}

/// Dataset containing data associated with a single scenario but potentially containing data
/// taken from multiple cardamon runs.
///
/// Guarenteed to contain only data associated with a single scenario.
#[derive(Debug)]
pub struct ScenarioDataset<'a> {
    scenario_name: &'a str,
    data: Vec<&'a IterationMetrics>,
}
impl<'a> ScenarioDataset<'a> {
    pub fn scenario_name(&'a self) -> &'a str {
        self.scenario_name
    }

    pub fn data(&'a self) -> &'a [&'a IterationMetrics] {
        &self.data
    }

    pub fn by_run(&'a self) -> Vec<ScenarioRunDataset<'a>> {
        let runs = self
            .data
            .iter()
            // TODO: Check that this is ascending order
            .map(|x| &x.iteration.run_id)
            .unique()
            .collect::<Vec<_>>();

        runs.into_iter()
            .map(|run_id| {
                let data = self
                    .data
                    .iter()
                    .filter(|x| &x.iteration.run_id == run_id)
                    .cloned()
                    .collect::<Vec<_>>();

                ScenarioRunDataset {
                    scenario_name: self.scenario_name,
                    run_id: *run_id,
                    data,
                }
            })
            .collect::<Vec<_>>()
    }

    pub async fn apply_model(
        &'a self,
        db: &DatabaseConnection,
        model: &impl Fn(&Vec<&Metrics>, f32) -> Data,
        aggregation_method: AggregationMethod,
    ) -> anyhow::Result<ScenarioData> {
        let mut all_run_data = vec![];
        for scenario_run_dataset in self.by_run() {
            let run_data = scenario_run_dataset.apply_model(db, model).await?;
            all_run_data.push(run_data);
        }

        // use the aggregation method to calculate the data for this scenario
        let data = match aggregation_method {
            AggregationMethod::MostRecent => all_run_data.first().context("no data!")?.data.clone(),

            AggregationMethod::Average => Data::mean(
                &all_run_data
                    .iter()
                    .map(|run_data| &run_data.data)
                    .collect_vec(),
            ),

            AggregationMethod::Sum => Data::sum(
                &all_run_data
                    .iter()
                    .map(|run_data| &run_data.data)
                    .collect_vec(),
            ),
        };

        // calculate trend
        let mut delta_sum = 0_f64;
        let mut delta_sum_abs = 0_f64;
        for i in 0..all_run_data.len() - 1 {
            let delta = all_run_data[i + 1].data.pow - all_run_data[i].data.pow;
            delta_sum += delta;
            delta_sum_abs += delta.abs();
        }

        Ok(ScenarioData {
            scenario_name: self.scenario_name.to_string(),
            data,
            run_data: all_run_data,
            trend: if delta_sum_abs != 0_f64 {
                delta_sum / delta_sum_abs
            } else {
                0_f64
            },
        })
    }
}

/// Dataset containing data associated with a single scenario in a single cardamon run but
/// potentially containing data taken from multiple scenario iterations.
///
/// Guarenteed to contain only data associated with a single scenario and cardamon run.
#[derive(Debug)]
pub struct ScenarioRunDataset<'a> {
    scenario_name: &'a str,
    run_id: i32,
    data: Vec<&'a IterationMetrics>,
}
impl<'a> ScenarioRunDataset<'a> {
    pub fn scenario_name(&'a self) -> &'a str {
        self.scenario_name
    }

    pub fn run_id(&'a self) -> i32 {
        self.run_id
    }

    pub fn data(&'a self) -> &'a [&'a IterationMetrics] {
        &self.data
    }

    pub fn by_iteration(&'a self) -> ScenarioRunIterationDataset {
        &self.data
    }

    pub async fn apply_model(
        &'a self,
        db: &DatabaseConnection,
        model: &impl Fn(&Vec<&Metrics>, f32) -> Data,
    ) -> anyhow::Result<RunData> {
        let run = dao::run::fetch(self.run_id, &db).await?;
        let cpu_avg_pow = run.cpu_avg_power;
        let start_time = run.start_time;
        let stop_time = run.stop_time;

        // build up process map
        // proc_id  |  data & metrics per iteration for proc per iteration
        // =======================================
        // proc_id -> [<(data, [metrics)>, <(data, metrics)>]    <- 2 iterations
        // proc_id -> [<(data, metrics)>, <(data, metrics)>]    <- 2 iterations
        let mut proc_iteration_data_map: HashMap<String, (Vec<Data>, Vec<Vec<ProcessMetrics>>)> =
            HashMap::new();
        for scenario_run_iteration_dataset in self.by_iteration() {
            for (proc_id, metrics) in scenario_run_iteration_dataset.by_process() {
                // run the RAB model to get power and co2 emissions
                let cardamon_data = model(&metrics, cpu_avg_pow);

                // convert the metrics database model into metrics data
                let proc_metrics = metrics
                    .iter()
                    .map(|metrics| ProcessMetrics {
                        timestamp: metrics.time_stamp,
                        cpu_usage: metrics.cpu_usage,
                    })
                    .collect_vec();

                // if key already exists in map the append cardamon_data to the end of the
                // iteration data vector for that key, else create a new vector for that key.
                let data_vec = match proc_iteration_data_map.get_mut(&proc_id) {
                    Some((proc_data, iteration_metrics)) => {
                        let mut data = vec![];
                        data.append(proc_data);
                        data.push(cardamon_data);

                        let mut metrics = vec![];
                        metrics.append(iteration_metrics);
                        metrics.push(proc_metrics);

                        (data, metrics)
                    }

                    None => (vec![cardamon_data], vec![proc_metrics]),
                };
                proc_iteration_data_map.insert(proc_id.to_string(), data_vec);
            }
        }

        // average data for each process across all iterations
        let proc_data_map: HashMap<String, (Data, Vec<Vec<ProcessMetrics>>)> =
            proc_iteration_data_map
                .into_iter()
                .map(|(k, (data, metrics))| {
                    (
                        k.to_string(),
                        (Data::mean(&data.iter().collect_vec()), metrics),
                    )
                })
                .collect();

        // calculate total run data (pow + co2)
        let total_run_data = Data::sum(&proc_data_map.values().map(|(data, _)| data).collect_vec());

        // convert proc_data_map to vector of ProcessData
        let process_data = proc_data_map
            .into_iter()
            .map(|(process_id, (data, iteration_metrics))| ProcessData {
                process_id,
                pow_perc: data.pow / total_run_data.pow,
                data,
                iteration_metrics,
            })
            .collect_vec();

        Ok(RunData {
            run_id: self.run_id,
            start_time,
            stop_time,
            data: total_run_data,
            process_data,
        })
    }
}

type ScenarioRunIterationDataset<'a> = &'a [&'a IterationMetrics];

#[cfg(test)]
mod tests {
    use itertools::Itertools;

    use crate::{
        data::{dataset::LiveDataFilter, dataset_builder::DatasetBuilder},
        db_connect, db_migrate,
        tests::setup_fixtures,
    };

    #[tokio::test]
    async fn dataset_builder_should_build_a_correct_dataset() -> anyhow::Result<()> {
        let db = db_connect("sqlite::memory:", None).await?;
        db_migrate(&db).await?;
        setup_fixtures(
            &[
                "./fixtures/runs.sql",
                "./fixtures/iterations.sql",
                "./fixtures/metrics.sql",
            ],
            &db,
        )
        .await?;

        let dataset = DatasetBuilder::new()
            .scenarios_all()
            .all()
            .last_n_runs(3)
            .all()
            .build(&db)
            .await?;

        assert_eq!(dataset.data.len(), 14);

        Ok(())
    }

    #[tokio::test]
    async fn dataset_can_be_broken_down_to_scenario_datasets() -> anyhow::Result<()> {
        let db = db_connect("sqlite::memory:", None).await?;
        db_migrate(&db).await?;
        setup_fixtures(
            &[
                "./fixtures/runs.sql",
                "./fixtures/iterations.sql",
                "./fixtures/metrics.sql",
            ],
            &db,
        )
        .await?;

        let dataset = DatasetBuilder::new()
            .scenarios_all()
            .all()
            .last_n_runs(3)
            .all()
            .build(&db)
            .await?;

        let scenario_datasets = dataset.by_scenario(LiveDataFilter::ExcludeLive);
        assert_eq!(scenario_datasets.len(), 3);

        // make sure the scenario names are correct
        let scenario_names = scenario_datasets
            .iter()
            .map(|ds| ds.scenario_name)
            .collect::<Vec<_>>();
        assert_eq!(
            vec!["scenario_1", "scenario_2", "scenario_3"],
            scenario_names
        );

        // make sure the data in the datasets are correct
        for scenario_dataset in scenario_datasets {
            match scenario_dataset.scenario_name {
                "scenario_1" => {
                    assert_eq!(scenario_dataset.data.len(), 1);
                    assert!(
                        scenario_dataset
                            .data
                            .iter()
                            .flat_map(|x| &x.metrics)
                            .collect_vec()
                            .len()
                            == 10
                    );
                }

                "scenario_2" => {
                    assert_eq!(scenario_dataset.data.len(), 4);
                    assert!(
                        scenario_dataset
                            .data
                            .iter()
                            .flat_map(|x| &x.metrics)
                            .collect_vec()
                            .len()
                            == 40
                    );
                }

                "scenario_3" => {
                    assert_eq!(scenario_dataset.data.len(), 9);
                    assert!(
                        scenario_dataset
                            .data
                            .iter()
                            .flat_map(|x| &x.metrics)
                            .collect_vec()
                            .len()
                            == 90
                    );
                }

                _ => panic!("Unknown scenario in dataset"),
            }
        }

        Ok(())
    }

    #[tokio::test]
    async fn scenario_dataset_can_be_broken_down_to_scenario_run_datasets() -> anyhow::Result<()> {
        let db = db_connect("sqlite::memory:", None).await?;
        db_migrate(&db).await?;
        setup_fixtures(
            &[
                "./fixtures/runs.sql",
                "./fixtures/iterations.sql",
                "./fixtures/metrics.sql",
            ],
            &db,
        )
        .await?;

        let dataset = DatasetBuilder::new()
            .scenarios_all()
            .all()
            .last_n_runs(3)
            .all()
            .build(&db)
            .await?;

        for scenario_dataset in dataset.by_scenario(LiveDataFilter::ExcludeLive) {
            let scenario_run_datasets = scenario_dataset.by_run();

            match scenario_dataset.scenario_name {
                "scenario_1" => {
                    assert_eq!(scenario_run_datasets.len(), 1);
                    let run_ids = scenario_run_datasets
                        .iter()
                        .map(|ds| ds.run_id)
                        .collect::<Vec<_>>();
                    assert_eq!(vec![1], run_ids);
                }

                "scenario_2" => {
                    assert_eq!(scenario_run_datasets.len(), 2);
                    let run_ids = scenario_run_datasets
                        .iter()
                        .map(|ds| ds.run_id)
                        .collect::<Vec<_>>();
                    assert_eq!(vec![1, 2], run_ids);
                }

                "scenario_3" => {
                    assert_eq!(scenario_run_datasets.len(), 3);
                    let run_ids = scenario_run_datasets
                        .iter()
                        .map(|ds| ds.run_id)
                        .collect::<Vec<_>>();
                    assert_eq!(vec![1, 2, 3], run_ids);
                }

                _ => panic!("unknown scenario in dataset!"),
            }
        }

        Ok(())
    }

    #[tokio::test]
    async fn scenario_run_dataset_can_be_broken_down_to_scenario_run_iteration_datasets(
    ) -> anyhow::Result<()> {
        let db = db_connect("sqlite::memory:", None).await?;
        db_migrate(&db).await?;
        setup_fixtures(
            &[
                "./fixtures/runs.sql",
                "./fixtures/iterations.sql",
                "./fixtures/metrics.sql",
            ],
            &db,
        )
        .await?;

        let dataset = DatasetBuilder::new()
            .scenarios_all()
            .all()
            .last_n_runs(3)
            .all()
            .build(&db)
            .await?;

        for scenario_dataset in dataset.by_scenario(LiveDataFilter::ExcludeLive) {
            for scenario_run_dataset in scenario_dataset.by_run() {
                let scenario_run_iteration_datasets = scenario_run_dataset.by_iteration();

                match scenario_dataset.scenario_name {
                    "scenario_1" => {
                        assert_eq!(scenario_run_iteration_datasets.len(), 1);
                        let it_ids = scenario_run_iteration_datasets
                            .iter()
                            .map(|ds| ds.iteration.count)
                            .collect::<Vec<_>>();
                        assert_eq!(vec![1], it_ids);
                    }

                    "scenario_2" => {
                        assert_eq!(scenario_run_iteration_datasets.len(), 2);
                        let it_ids = scenario_run_iteration_datasets
                            .iter()
                            .map(|ds| ds.iteration.count)
                            .collect::<Vec<_>>();
                        assert_eq!(vec![1, 2], it_ids);
                    }

                    "scenario_3" => {
                        assert_eq!(scenario_run_iteration_datasets.len(), 3);
                        let it_ids = scenario_run_iteration_datasets
                            .iter()
                            .map(|ds| ds.iteration.count)
                            .collect::<Vec<_>>();
                        assert_eq!(vec![1, 2, 3], it_ids);
                    }

                    _ => panic!("unknown scenario in dataset!"),
                }
            }
        }

        Ok(())
    }
}