.・゜゜ 𝕊ℙ𝔸ℝ𝕂𝕃𝔼𝕊 ・゜゜・

Performance-focused library for capturing execution flow of application.

What? Just add instant_event! macro to your code and see all events in a timeline with CPU cycle precision.
How? Fast. Blazingly fast. 🚀 Single event overhead is 9ns.

✧ Main parts

sparkles: Ready-to-use library for capturing events and streaming them to receiving app over TCP
sparkles-core: Common functionality for std and no_std (todo) version of sparkles.
sparkles-macro: instant_event! and range_event_start! macro to encode event name into integer value.
sparkles-parser: This binary will listen to TCP port, capture and decode incoming events and save them to JSON file (Perfetto format).

✧ How to use

Add sparkles as a dependency to your project

cargo add sparkles 
cargo add sparkles-macro

Run receiving app in background

cd sparkles-receiver
cargo run --release --example listen_and_print

Add some events to your code

use std::time::Duration;
use sparkles_macro::{instant_event, range_event_start};

// Refer to sparkles/examples/how_to_use.rs
fn main() {
    let finalize_guard = sparkles::init_default();
    let g = range_event_start!("main()");

    let jh = std::thread::Builder::new().name(String::from("joined thread")).spawn(|| {
        for _ in 0..100 {
            instant_event!("^-^");
            std::thread::sleep(Duration::from_micros(1_000));
        }
    }).unwrap();
    
    let jh = std::thread::Builder::new().name(String::from("detached thread")).spawn(|| {
        for _ in 0..30 {
            instant_event!("*_*");
            std::thread::sleep(Duration::from_micros(1_000));
        }
    }).unwrap();

    for i in 0..1_000 {
        instant_event!("✨✨✨");
        std::thread::sleep(Duration::from_micros(10));
    }

    jh.join().unwrap();
}

Run your code. As it finishes, trace.json is generated.
Go to https://ui.perfetto.dev and drag'n'drop resulting json file.
Observe the result:

✧ Requirements

🌟 STD support (works better on x86 architecture)

✧ Benches

Single event overhead on average x86 machine (Intel i5-12400) is 9ns.

˚ ༘ ⋆｡˚ ✧ ˚ ༘ ⋆｡˚ ༘ ⋆｡˚ ✧ ˚ ༘ ⋆｡˚˚ ༘ ⋆｡˚ ✧ ˚ ༘ ⋆｡˚ ༘ ⋆｡˚ ✧ ˚ ༘ ⋆｡˚༘ ⋆｡˚ ✧ ˚ ༘
Up to 🫸100kk🫷 events can be captured in a local environment with no data loss.
༘ ⋆｡˚ ༘ ⋆｡˚ ✧ ˚ ༘ ⋆｡˚༘ ⋆｡˚ ✧ ˚ ༘ ⋆｡˚༘ ⋆｡˚ ✧ ˚ ༘ ⋆｡˚༘ ⋆｡˚ ✧ ˚ ༘ ⋆｡˚༘ ⋆｡˚ ✧ ˚

✧ Implementation status

Ready:
🌟 Timestamp provider
🌟 Event name hashing
🌟 Perfetto json format compatibility 🌟 Ranges (scopes) support 🌟 Configuration support \

TODO:
⚙️ Abstraction over events transfer type (TCP/UDP/IPC/File)
⚙️ Perfetto binary format support
⚙️ Additional attached binary data
⚙️ Module info support: full module path, line of code
⚙️ Capture and transfer loss detection with no corruption to other captured and transmitted data
⚙️ Async support
⚙️ NO_STD implementation
⚙️ tags / hierarchy of events
⚙️ Viewer app
⚙️ Multi-app sync
⚙️ Global ranges
⚙️ Measurement overhead self-test