bevy_metrics_dashboard 0.8.0

Metrics dashboard for Bevy apps
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

use bevy::prelude::*;
use bevy_egui::EguiPlugin;
use bevy_metrics_dashboard::{DashboardPlugin, DashboardWindow, RegistryPlugin};
use metrics::{
    counter, describe_counter, describe_gauge, describe_histogram, gauge, histogram, Unit,
};
use rand::Rng;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(EguiPlugin::default())
        .add_plugins(RegistryPlugin::default())
        .add_plugins(DashboardPlugin)
        .add_systems(Startup, (describe_metrics, create_dashboard))
        .add_systems(Update, update_metrics)
        .run();
}

fn describe_metrics() {
    describe_counter!("foo::bar::baz", Unit::Count, "Lorem ipsum");
    describe_counter!("foo::bar::fizz", Unit::Count, "Lorem ipsum");
    describe_counter!("foo::foo::baz", Unit::Count, "Lorem ipsum");
    describe_counter!("fizz::bat", Unit::Count, "Lorem ipsum");

    describe_gauge!("foo::bar::baz", Unit::Count, "Lorem ipsum");
    describe_gauge!("foo::bar::fizz", Unit::Count, "Lorem ipsum");
    describe_gauge!("foo::foo::baz", Unit::Count, "Lorem ipsum");
    describe_gauge!("fizz::bat", Unit::Count, "Lorem ipsum");

    describe_histogram!("foo::bar::baz", Unit::Count, "Lorem ipsum");
    describe_histogram!("foo::bar::fizz", Unit::Count, "Lorem ipsum");
    describe_histogram!("foo::foo::baz", Unit::Count, "Lorem ipsum");
    describe_histogram!("fizz::bat", Unit::Count, "Lorem ipsum");

    describe_counter!("fizz::partial::collapsed", Unit::Count, "Lorem ipsum");
    describe_counter!("fully::collapsed::path", Unit::Count, "Lorem ipsum");

    // Invalid paths.
    describe_counter!("edge::case::", Unit::Count, "Lorem ipsum");
    describe_counter!("edge::::case", Unit::Count, "Lorem ipsum");
    describe_counter!("edge:::case", Unit::Count, "Lorem ipsum");
    describe_counter!("::edge", Unit::Count, "Lorem ipsum");
    describe_counter!("::edge::", Unit::Count, "Lorem ipsum");
    describe_counter!(":edge", Unit::Count, "Lorem ipsum");
    describe_counter!("edge:", Unit::Count, "Lorem ipsum");
    describe_counter!(":edge:", Unit::Count, "Lorem ipsum");
    describe_counter!("::", Unit::Count, "Lorem ipsum");
    describe_counter!(":", Unit::Count, "Lorem ipsum");
    describe_counter!("", Unit::Count, "Lorem ipsum");
}

fn create_dashboard(mut commands: Commands) {
    commands.spawn(Camera2d);
    commands.spawn(DashboardWindow::new("Dashboard"));
}

fn update_metrics() {
    let mut rng = rand::thread_rng();

    counter!("foo::bar::baz").increment(rng.gen_range(0..10));
    counter!("foo::bar::fizz").increment(rng.gen_range(0..10));
    counter!("foo::foo::baz").increment(rng.gen_range(0..10));
    counter!("fizz::bat").increment(rng.gen_range(0..10));

    gauge!("foo::bar::baz").set(rng.gen_range(0.0..10.0));
    gauge!("foo::bar::fizz").set(rng.gen_range(0.0..10.0));
    gauge!("foo::foo::baz").set(rng.gen_range(0.0..10.0));
    gauge!("fizz::bat").set(rng.gen_range(0.0..10.0));

    histogram!("foo::bar::baz").record(rng.gen_range(0.0..10.0));
    histogram!("foo::bar::fizz").record(rng.gen_range(0.0..10.0));
    histogram!("foo::foo::baz").record(rng.gen_range(0.0..10.0));
    histogram!("fizz::bat").record(rng.gen_range(0.0..10.0));

    counter!("fizz::partial::collapsed").increment(rng.gen_range(0..10));
    counter!("fully::collapsed::path").increment(rng.gen_range(0..10));

    // Invalid paths.
    counter!("edge::case::").increment(rng.gen_range(0..10));
    counter!("edge::::case").increment(rng.gen_range(0..10));
    counter!("edge:::case").increment(rng.gen_range(0..10));
    counter!("::edge").increment(rng.gen_range(0..10));
    counter!("::edge::").increment(rng.gen_range(0..10));
    counter!(":edge").increment(rng.gen_range(0..10));
    counter!("edge:").increment(rng.gen_range(0..10));
    counter!(":edge:").increment(rng.gen_range(0..10));
    counter!("::").increment(rng.gen_range(0..10));
    counter!(":").increment(rng.gen_range(0..10));
    counter!("").increment(rng.gen_range(0..10));
}