Question 1

How do I add hotpath to my existing Rust project?

Accepted Answer

Add hotpath to Cargo.toml with feature flags, annotate your main function with #[hotpath::main] and key functions with #[hotpath::measure], then run with features enabled. The README provides a basic setup example with installation steps.

Question 2

hotpath vs tokio-console for monitoring async Rust?

Accepted Answer

hotpath offers broader profiling including time, memory, and data flow with a TUI dashboard, while tokio-console focuses specifically on Tokio runtime metrics. hotpath is more comprehensive but requires code instrumentation, whereas tokio-console is more targeted and less intrusive.

Question 3

Can I use hotpath with async-std or other runtimes?

Accepted Answer

hotpath has built-in Tokio runtime monitoring, and async function instrumentation may work with other runtimes, but features like worker thread tracking are optimized for Tokio. Check the documentation for compatibility details, as support for non-Tokio runtimes is not explicitly guaranteed.

Question 4

How to monitor memory allocations with hotpath?

Accepted Answer

Enable the hotpath-alloc feature and use #[hotpath::measure] on functions to track bytes allocated and allocation counts per function. The README shows alloc reports with metrics like total and average allocations, making it easy to identify memory bottlenecks.

Question 5

What's the performance impact when hotpath is enabled?

Accepted Answer

hotpath is designed for low overhead, but instrumentation adds some runtime cost. The README emphasizes minimal impact, but for highly sensitive applications, benchmark with and without profiling to assess the exact effect on performance.

Question 6

How to set up automated benchmarks in GitHub Actions?

Accepted Answer

Use hotpath's GitHub Actions integration to configure CI pipelines that automatically benchmark your program against a base branch. This detects performance regressions in each PR, as detailed in the docs, with options for comparing metrics between commits.

Question 7

Does hotpath support flame graphs or CPU sampling?

Accepted Answer

No, hotpath uses instrumentation-based profiling, not sampling. For CPU sampling and flame graphs, you should use tools like perf or sampling profilers, as mentioned in the sampling comparison guide on hotpath.rs, which outlines when to choose each approach.

pawurb/hotpath

What is pawurb/hotpath?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions