bevy_diagnostic 0.9.0

Provides diagnostic functionality for Bevy Engine
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

use super::{Diagnostic, DiagnosticId, Diagnostics};
use bevy_app::prelude::*;
use bevy_ecs::system::{Res, ResMut, Resource};
use bevy_log::{debug, info};
use bevy_time::{Time, Timer, TimerMode};
use bevy_utils::Duration;

/// An App Plugin that logs diagnostics to the console
pub struct LogDiagnosticsPlugin {
    pub debug: bool,
    pub wait_duration: Duration,
    pub filter: Option<Vec<DiagnosticId>>,
}

/// State used by the [`LogDiagnosticsPlugin`]
#[derive(Resource)]
struct LogDiagnosticsState {
    timer: Timer,
    filter: Option<Vec<DiagnosticId>>,
}

impl Default for LogDiagnosticsPlugin {
    fn default() -> Self {
        LogDiagnosticsPlugin {
            debug: false,
            wait_duration: Duration::from_secs(1),
            filter: None,
        }
    }
}

impl Plugin for LogDiagnosticsPlugin {
    fn build(&self, app: &mut App) {
        app.insert_resource(LogDiagnosticsState {
            timer: Timer::new(self.wait_duration, TimerMode::Repeating),
            filter: self.filter.clone(),
        });

        if self.debug {
            app.add_system_to_stage(CoreStage::PostUpdate, Self::log_diagnostics_debug_system);
        } else {
            app.add_system_to_stage(CoreStage::PostUpdate, Self::log_diagnostics_system);
        }
    }
}

impl LogDiagnosticsPlugin {
    pub fn filtered(filter: Vec<DiagnosticId>) -> Self {
        LogDiagnosticsPlugin {
            filter: Some(filter),
            ..Default::default()
        }
    }

    fn log_diagnostic(diagnostic: &Diagnostic) {
        if let Some(value) = diagnostic.smoothed() {
            if diagnostic.get_max_history_length() > 1 {
                if let Some(average) = diagnostic.average() {
                    info!(
                        target: "bevy diagnostic",
                        // Suffix is only used for 's' or 'ms' currently,
                        // so we reserve two columns for it; however,
                        // Do not reserve columns for the suffix in the average
                        // The ) hugging the value is more aesthetically pleasing
                        "{name:<name_width$}: {value:>11.6}{suffix:2} (avg {average:>.6}{suffix:})",
                        name = diagnostic.name,
                        suffix = diagnostic.suffix,
                        name_width = crate::MAX_DIAGNOSTIC_NAME_WIDTH,
                    );
                    return;
                }
            }
            info!(
                target: "bevy diagnostic",
                "{name:<name_width$}: {value:>.6}{suffix:}",
                name = diagnostic.name,
                suffix = diagnostic.suffix,
                name_width = crate::MAX_DIAGNOSTIC_NAME_WIDTH,
            );
        }
    }

    fn log_diagnostics_system(
        mut state: ResMut<LogDiagnosticsState>,
        time: Res<Time>,
        diagnostics: Res<Diagnostics>,
    ) {
        if state.timer.tick(time.raw_delta()).finished() {
            if let Some(ref filter) = state.filter {
                for diagnostic in filter.iter().flat_map(|id| {
                    diagnostics
                        .get(*id)
                        .filter(|diagnostic| diagnostic.is_enabled)
                }) {
                    Self::log_diagnostic(diagnostic);
                }
            } else {
                for diagnostic in diagnostics
                    .iter()
                    .filter(|diagnostic| diagnostic.is_enabled)
                {
                    Self::log_diagnostic(diagnostic);
                }
            }
        }
    }

    fn log_diagnostics_debug_system(
        mut state: ResMut<LogDiagnosticsState>,
        time: Res<Time>,
        diagnostics: Res<Diagnostics>,
    ) {
        if state.timer.tick(time.raw_delta()).finished() {
            if let Some(ref filter) = state.filter {
                for diagnostic in filter.iter().flat_map(|id| {
                    diagnostics
                        .get(*id)
                        .filter(|diagnostic| diagnostic.is_enabled)
                }) {
                    debug!("{:#?}\n", diagnostic);
                }
            } else {
                for diagnostic in diagnostics
                    .iter()
                    .filter(|diagnostic| diagnostic.is_enabled)
                {
                    debug!("{:#?}\n", diagnostic);
                }
            }
        }
    }
}