that3percent / firestorm Goto Github PK

cargo doc output on firestorm without the enable_system_time flag does not include methods like enabled, bench, clear, and save, even though they exist. It also means that they don't show on docs.rs. They should be documented even if they are disabled.

Hey,

I'm using rayon to parallelize some data processing and I noticed that the profile_fn and profile_section instances don't show when called inside a rayon thread. Is there a way to record them?

Cheers,
Alex

The firestorm crate published on crates.io does not include the license file.
This makes difficult to re-package the crate for distributions like Fedora.

The crates in this repo reference the MIT license in their Cargo.toml files.

However, the license text is not included in the repository. Could you please put the license file into the repository root such that the project is unambiguously usable under the MIT license? Thanks

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository

I want to use name to get the time-consuming of a method in the program, not through flamegraph.
Maybe add a similar function?

if firestorm::enabled() {
  let time = get_time(name: String);
}

How do I enable firestorm? Is there an example in the README? An environment variable I have to set?

Thanks for making this. Does it work on Windows (8.1)?

I think it will be more idiomatic to mark the profiling function like this

#[profile_fn]
fn fn_name<T>(param: T) {
    // If a function is complex, profile a section.
    #[profile_section]
    {
        // Optional: manually drop.
        // Section automatically drops when going out of scope.
        drop(inner);
    }
}

This API looks like the profiling crate, and it looks more ergonomic to me.