shipyard 0.11.2

Entity Component System
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

# Tracing

Shipyard comes with a `tracing` feature that let you see and inspect systems execution.

You can use various adapters for the `tracing` crate. I'll use [`tracy`](https://github.com/wolfpld/tracy), a C++ profiler.

We'll need to enable the `tracing` feature and add a few dependencies.\
This can all be feature gated to not impact exported binaries performance.

```toml
shipyard = { git = "https://github.com/leudz/shipyard", features = ["tracing"] }
tracy_full = { version = "1.3", features = ["enable", "tracing"] }
tracing = "0.1"
tracing-subscriber = "0.3.18"
```

Enabling tracing is done by adding a few lines to `main`.

```rust,noplaypen
fn main() {
    use tracing_subscriber::layer::SubscriberExt;

    tracing::subscriber::set_global_default(
        tracing_subscriber::registry().with(tracy_full::tracing::TracyLayer),
    )
    .expect("setup tracy layer");

    // The rest of your main function
}
```

You can download the latest [`tracy` release](https://github.com/wolfpld/tracy/releases), run your program alongside `tracy` which will start registering traces once you click the "connect" button in its interface.

You can then get a quick overview of execution times:

![Square eater trace](full-trace.png)

Or more details for specific systems or workloads:

![System trace](system.png)