timetrace 0.1.2

Lightweight Rust profiling library with RAII and Chrome/Perfetto trace support
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

#[cfg(feature = "macros")]
pub use timetrace_macros::{profile_function, profile_session};

pub mod profiler;
pub mod trace_event;

/**
# Timetrace

A lightweight Rust profiling library inspired by Hazel and Tracy-style instrumentation.

Generates JSON traces compatible with Chrome Tracing and Perfetto.


## Features

- RAII profiling (scope-based)
- Function attribute macro: `#[profile_function]`
- Session management: `#[profile_session]`
- Frame indexing in trace (`args.frame`)
- Minimal overhead
- Thread-aware (thread id included)


## Example

```rust
use timetrace::{profile_function, profile_session};

#[profile_session("Example", "trace.json")]
fn main() {
    work();
}

#[profile_function]
fn work() {
    let mut sum = 0.0;

    for i in 0..1_000_000 {
        sum += (i as f64).cos();
    }

    println!("{sum}");
}
```


## Run

```bash
cargo run -p timetrace_example
```


## View Trace

Open in:

- https://ui.perfetto.dev
- Only in Google Chrome: chrome://tracing


## Output Example
```json
{
  "name": "work",
  "cat": "function",
  "ph": "X",
  "ts": 123456789,
  "dur": 23000,
  "pid": 0,
  "tid": 12345,
  "args": {
    "frame": 0
  }
}
```
(Actual output is written as a single line JSON)


## Cargo Features

Enable macros:

```toml
timetrace = { path = "...", features = ["macros"] }
```
(macros are enabled by default)

Disable macros:
```toml
timetrace = { path = "...", default-features = false }
```
*/

#[macro_export]
macro_rules! profile_begin_session {
    ($name:expr, $filepath:expr) => {
        $crate::profiler::Profiler::get()
            .lock()
            .begin_session($name, $filepath);
    };
}

#[macro_export]
macro_rules! profile_begin_session_limited {
    ($name:expr, $path:expr, $frames:expr, $ms:expr) => {
        $crate::profiler::Profiler::get()
            .lock()
            .begin_session_limited($name, $path, $frames, $ms);
    };
}

#[macro_export]
macro_rules! profile_end_session {
    () => {
        $crate::profiler::Profiler::get()
            .lock()
            .end_session()
            .unwrap();
    };
}

#[macro_export]
macro_rules! profile_scope {
    ($name:expr) => {
        let _timer = $crate::profiler::ProfilerTimer::new($name);
    };
}

#[macro_export]
macro_rules! profile_function_scope {
    () => {
        let _timer = $crate::profiler::ProfilerTimer::new(module_path!());
    };
}

#[macro_export]
macro_rules! profile_new_frame {
    () => {
        $crate::profiler::Profiler::get().lock().next_frame();
    };
}
#[macro_export]
macro_rules! profile_update {
    ($name:expr, $value:expr) => {
        profile_new_frame!();
    };
}