loates 0.1.0-alpha

Loates is a load testing framework, with focus on ease of use and flexiblity.
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
pub(crate) mod message;
pub(crate) mod task_event;

pub use message::Message;
pub use task_event::{metrics::MetricType, metrics::MetricValue, Attribute, MetricSetKey};

use std::{
    collections::HashMap,
    ops::ControlFlow,
    str::FromStr,
    time::{Duration, Instant},
};

use chrono::{DateTime, Utc};
use task_event::{MetricSet, TaskEvent, TaskSpanData};
use tracing::{
    field::{Field, Visit},
    span::{self, Id},
    Subscriber,
};

use tracing_subscriber::{
    registry::{LookupSpan, SpanRef},
    Layer,
};

use crate::{CRATE_NAME, SPAN_EXEC, SPAN_SCENARIO, SPAN_TASK, USER_TASK};

#[derive(Debug, Default)]
struct ErrorVisitor {
    err: String,
}

/// Tracked data that is associated with a task
#[derive(Debug)]
struct TaskData {
    scenario_id: usize,
    execution_id: usize,
    execution_span_id: Id,
    instant: Instant,
}

/// Tracked data associated with span of an execution.
#[derive(Debug)]
struct ExecutionData {
    id: usize,
    users: u64,
    max_users: u64,
    total_iteration: Option<u64>,
    duration: Duration,
    total_duration: Option<Duration>,
    stage: Option<usize>,
    stage_duration: Option<Duration>,
    total_stages: Option<usize>,
    metrics: MetricSet,
}

impl From<&ExecutionData> for Message {
    fn from(value: &ExecutionData) -> Self {
        Message::ExecutorUpdate {
            id: value.id,
            users: value.users,
            max_users: value.max_users,
            total_iteration: value.total_iteration,
            total_duration: value.total_duration,
            stage: value.stage,
            stages: value.total_stages,
            stage_duration: value.stage_duration,
            metrics: value.metrics.entries().collect(),
        }
    }
}

struct ExecutorTimings {
    start_time: DateTime<Utc>,
    prior_duration: Duration,
}

/// Tracked data associated with a span of a scenario .
struct ScenarioData {
    id: usize,
    executor_timings: HashMap<usize, ExecutorTimings>,
}

impl tracing::field::Visit for ExecutionData {
    fn record_debug(&mut self, _: &Field, _: &dyn std::fmt::Debug) {}

    fn record_u64(&mut self, field: &Field, value: u64) {
        match field.name() {
            "id" => self.id = value as usize,
            "users" => self.users = value,
            "users_max" => self.max_users = value,
            "stages" => self.total_stages = Some(value as usize),
            "stage_duration" => self.stage_duration = Some(Duration::from_secs(value)),
            "stage" => self.stage = Some(value as usize),
            "duration" => self.duration = Duration::from_secs(value),
            "total_duration" => self.total_duration = Some(Duration::from_secs(value)),
            "total_iteration" => self.total_iteration = Some(value),
            _ => (),
        }
    }
}

impl tracing::field::Visit for ScenarioData {
    fn record_debug(&mut self, _: &Field, _: &dyn std::fmt::Debug) {}
    fn record_u64(&mut self, field: &Field, value: u64) {
        if field.name() == "id" {
            self.id = value as usize
        }
    }
}

impl Visit for ErrorVisitor {
    fn record_debug(&mut self, field: &Field, value: &dyn std::fmt::Debug) {
        if field.name() == "err" {
            self.err = format!("{:?}", value)
        }
    }
}

/// Trait for abstracting over sender type of a channel.
pub trait Sender {
    fn send(&self, message: Message);
}

impl Sender for crate::Sender<Message> {
    fn send(&self, message: Message) {
        let _ = self.send(message);
    }
}

impl Sender for tokio::sync::broadcast::Sender<Message> {
    fn send(&self, message: Message) {
        let _ = self.send(message);
    }
}

/// [Tracing subscriber layer](Layer) that tracks and generates [`Message`]s based on tracing events generated during a test.
pub struct TracerLayer<T: Sender> {
    // current_scenario: Mutex<String>,
    stats_sender: T,
}

impl<T: Sender> TracerLayer<T> {
    pub fn new(sender: T) -> Self {
        Self {
            stats_sender: sender,
        }
    }
}

impl<T: Sender + 'static, S: tracing::Subscriber + for<'a> LookupSpan<'a>> Layer<S>
    for TracerLayer<T>
{
    fn enabled(
        &self,
        metadata: &tracing::Metadata<'_>,
        _ctx: tracing_subscriber::layer::Context<'_, S>,
    ) -> bool {
        let target = metadata.target();
        target == USER_TASK || target == CRATE_NAME
    }

    fn on_new_span(
        &self,
        attr: &span::Attributes<'_>,
        id: &span::Id,
        ctx: tracing_subscriber::layer::Context<'_, S>,
    ) {
        let Some(span) = ctx.span(id) else { return };
        if span.metadata().target() == USER_TASK {
            create_task_child_span(&span, attr);
            return;
        }

        if span.metadata().target() != CRATE_NAME {
            return;
        };

        match span.name() {
            SPAN_TASK => {
                create_task_span(&span);
            }
            SPAN_EXEC => {
                let message = create_exec_span(attr, &span);
                self.stats_sender.send(message);
            }
            SPAN_SCENARIO => {
                let id = create_scenario_span(attr, span);
                self.stats_sender
                    .send(Message::ScenarioChanged { scenario_id: id })
            }
            _ => (),
        }
    }

    fn on_event(&self, event: &tracing::Event<'_>, ctx: tracing_subscriber::layer::Context<'_, S>) {
        if event.metadata().target() == USER_TASK {
            handle_user_event(event, &ctx);
            return;
        }
        if event.metadata().target() == CRATE_NAME {
            match event.metadata().name() {
                "runner_exit" => {
                    self.stats_sender.send(Message::End);
                    return;
                }
                "termination_error" => {
                    let mut err = ErrorVisitor::default();
                    event.record(&mut err);
                    self.stats_sender
                        .send(Message::TerminatedError { err: err.err });
                    return;
                }
                "error" => {
                    let mut err = ErrorVisitor::default();
                    event.record(&mut err);
                    self.stats_sender.send(Message::Error { err: err.err });
                    return;
                }
                _ => {}
            }

            if let Some(message) = handle_crate_execution_event(event, &ctx) {
                self.stats_sender.send(message);
            }
        }
    }

    fn on_record(
        &self,
        span: &span::Id,
        values: &span::Record<'_>,
        ctx: tracing_subscriber::layer::Context<'_, S>,
    ) {
        let Some(span) = ctx.span(span) else {
            return;
        };
        let mut span_data = span.extensions_mut();
        let Some(span_data) = span_data.get_mut::<TaskSpanData>() else {
            return;
        };
        values.record(span_data);
    }

    fn on_close(&self, id: span::Id, ctx: tracing_subscriber::layer::Context<'_, S>) {
        let Some(span) = ctx.span(&id) else { return };

        if span.metadata().name() == SPAN_EXEC {
            let message = close_exec_span(span);
            self.stats_sender.send(message);
            return;
        }

        if span.metadata().name() == SPAN_TASK {
            let messages = close_task_span(span, &ctx);
            for message in messages {
                self.stats_sender.send(message);
            }
            return;
        }

        if span.metadata().target() == USER_TASK {
            close_task_child_span(span, &ctx);
        }
    }
}

fn create_scenario_span<S: for<'a> LookupSpan<'a>>(
    attr: &span::Attributes,
    span: SpanRef<S>,
) -> usize {
    let mut visitor = ScenarioData {
        id: usize::MAX,
        executor_timings: HashMap::default(),
    };
    attr.values().record(&mut visitor);
    let id = visitor.id;
    let mut extentions = span.extensions_mut();
    extentions.insert(visitor);
    id
}

fn create_exec_span<'a, S: LookupSpan<'a>>(
    attr: &span::Attributes,
    span: &SpanRef<'a, S>,
) -> Message {
    let mut visitor = ExecutionData {
        id: usize::MAX,
        users: 0,
        max_users: 0,
        total_iteration: None,
        duration: Duration::ZERO,
        total_duration: None,
        total_stages: None,
        stage: None,
        stage_duration: None,
        metrics: MetricSet::default(),
    };
    attr.values().record(&mut visitor);
    let id = visitor.id;
    let mut extentions = span.extensions_mut();
    extentions.insert(visitor);

    let start_time = Utc::now();

    let scenario = span.parent().unwrap();
    let mut scenario = scenario.extensions_mut();
    let scenario_data = scenario
        .get_mut::<ScenarioData>()
        .unwrap()
        .executor_timings
        .entry(id)
        .or_insert_with(|| ExecutorTimings {
            start_time,
            prior_duration: Duration::ZERO,
        });

    scenario_data.start_time = start_time;

    Message::ExecutorStart {
        id,
        start_time,
        prior_executor_duration: scenario_data.prior_duration,
    }
}

fn create_task_span<'a, S: LookupSpan<'a>>(span: &SpanRef<'a, S>) {
    let Some(exec_span) = span.parent() else {
        return;
    };
    let Some(scenario_span) = exec_span.parent() else {
        return;
    };

    let scenario_id = scenario_span
        .extensions()
        .get::<ScenarioData>()
        .expect("exec parent is scenario")
        .id;

    let execution_id = exec_span
        .extensions()
        .get::<ExecutionData>()
        .expect("task parent is exec")
        .id;

    let execution_span_id = exec_span.id();

    let mut extentions = span.extensions_mut();
    extentions.insert(TaskData {
        instant: Instant::now(),
        scenario_id,
        execution_id,
        execution_span_id,
    });
}

fn create_task_child_span<'a, S: LookupSpan<'a>>(span: &SpanRef<'a, S>, attr: &span::Attributes) {
    let task_span = span
        .scope()
        .find(|span| span.metadata().name() == SPAN_TASK)
        .expect("span is child of an executor task");
    let execution_span_id = task_span
        .extensions()
        .get::<TaskData>()
        .unwrap()
        .execution_span_id
        .clone();
    let mut val = TaskSpanData {
        start_time: Instant::now(),
        attributes: vec![],
        execution_span_id,
    };
    attr.record(&mut val);
    span.extensions_mut().insert(val);
}

fn handle_user_event<S: Subscriber + for<'a> LookupSpan<'a>>(
    event: &tracing::Event,
    ctx: &tracing_subscriber::layer::Context<S>,
) -> ControlFlow<(), ()> {
    if event.metadata().target() != USER_TASK {
        return ControlFlow::Break(());
    }

    let Some(parent) = ctx.current_span().id().and_then(|id| ctx.span(id)) else {
        return ControlFlow::Break(());
    };

    let attributes: Vec<_> = parent
        .scope()
        .take_while(|x| x.metadata().target() == USER_TASK)
        .map(|x| x.id())
        .map(|id| {
            let span = ctx.span(&id).unwrap();
            let x = span
                .extensions()
                .get::<TaskSpanData>()
                .unwrap()
                .attributes
                .clone();
            x
        })
        .collect();

    let Some(exec_span) = parent.scope().find(|span| span.name() == SPAN_EXEC) else {
        return ControlFlow::Break(());
    };

    let Some((name, ty_str)) = event.metadata().name().split_once('.') else {
        return ControlFlow::Break(());
    };

    let Ok(metric_type) = MetricType::from_str(ty_str) else {
        return ControlFlow::Break(());
    };

    let mut task_event = TaskEvent::new(
        name,
        metric_type,
        attributes.into_iter().rev().flatten().collect(),
        task_event::Value::Number(0),
    );
    event.record(&mut task_event);

    let data = exec_span.extensions();
    let data = data.get::<ExecutionData>().unwrap();
    data.metrics.update(task_event);

    ControlFlow::Continue(())
}

fn handle_crate_execution_event<S: Subscriber + for<'a> LookupSpan<'a>>(
    event: &tracing::Event,
    ctx: &tracing_subscriber::layer::Context<S>,
) -> Option<Message> {
    if event.metadata().target() != CRATE_NAME {
        return None;
    }
    let parent = ctx.current_span().id().and_then(|id| ctx.span(id))?;
    let exec_span = parent.scope().find(|span| span.name() == SPAN_EXEC)?;
    let mut exec_ext = exec_span.extensions_mut();
    let exec_data = exec_ext.get_mut::<ExecutionData>()?;
    event.record(exec_data);
    Some(Message::from(&*exec_data))
}

fn close_exec_span<S: Subscriber + for<'a> LookupSpan<'a>>(span: SpanRef<S>) -> Message {
    let exec_id = span.extensions().get::<ExecutionData>().unwrap().id;
    let scenario = span.parent().unwrap();
    let mut scenario = scenario.extensions_mut();
    let scenario = scenario.get_mut::<ScenarioData>().unwrap();
    scenario
        .executor_timings
        .entry(exec_id)
        .and_modify(|x| x.prior_duration += (Utc::now() - x.start_time).abs().to_std().unwrap());
    Message::ExecutorEnd { id: exec_id }
}

fn close_task_span<'a, S: Subscriber + for<'lookup> LookupSpan<'lookup>>(
    span: SpanRef<'a, S>,
    ctx: &tracing_subscriber::layer::Context<'a, S>,
) -> [Message; 2] {
    let extention = span.extensions();
    let task_data = extention.get::<TaskData>().unwrap();
    let m1 = Message::TaskTime {
        execution_id: task_data.execution_id,
        scenario_id: task_data.scenario_id,
        duration: task_data.instant.elapsed(),
    };

    let exec = ctx.span(&task_data.execution_span_id).unwrap();
    let ext = exec.extensions();
    let exec_data = ext.get::<ExecutionData>().unwrap();
    let m2 = Message::from(exec_data);
    [m1, m2]
}

fn close_task_child_span<'a, S: Subscriber + for<'lookup> LookupSpan<'lookup>>(
    span: SpanRef<S>,
    ctx: &tracing_subscriber::layer::Context<S>,
) {
    let extention = span.extensions();
    let task_inner_span = extention.get::<TaskSpanData>().unwrap();

    let attributes: Vec<_> = span
        .scope()
        .take_while(|x| x.metadata().target() == USER_TASK)
        .map(|x| x.id())
        .collect();
    let mut attributes: Vec<_> = attributes
        .into_iter()
        .map(|id| {
            let span = ctx.span(&id).unwrap();
            let x = span
                .extensions()
                .get::<TaskSpanData>()
                .unwrap()
                .attributes
                .clone();
            x
        })
        .collect();

    attributes.reverse();
    let event = TaskEvent::new(
        span.name(),
        MetricType::Histogram,
        attributes.into_iter().flatten().collect(),
        task_inner_span.start_time.elapsed().into(),
    );

    let task_span = ctx.span(&task_inner_span.execution_span_id).unwrap();
    task_span
        .extensions()
        .get::<ExecutionData>()
        .unwrap()
        .metrics
        .update(event);
}