#future #spawn #diagnostics #wraps #logs #task #lots

futures-diagnose

Wraps around a Spawn and provides lots of diagnostics

3 releases (stable)

1.0.1 Feb 5, 2020
1.0.0 Jan 22, 2020
0.1.0 Jan 22, 2020

#929 in Asynchronous

Download history 307/week @ 2023-12-04 429/week @ 2023-12-11 443/week @ 2023-12-18 317/week @ 2023-12-25 169/week @ 2024-01-01 474/week @ 2024-01-08 435/week @ 2024-01-15 449/week @ 2024-01-22 256/week @ 2024-01-29 497/week @ 2024-02-05 566/week @ 2024-02-12 708/week @ 2024-02-19 561/week @ 2024-02-26 688/week @ 2024-03-04 471/week @ 2024-03-11 602/week @ 2024-03-18

2,324 downloads per month
Used in 40 crates (via tc-transaction-pool)

MIT license

22KB
361 lines

This crate allows one to generate logs about how tasks are scheduled, in order to generate a profile of the CPU usage of the binary.

This crate leverages https://github.com/catapult-project/catapult/tree/11513e359cd60e369bbbd1f4f2ef648c1bccabd0/tracing

Usage

First, import the traits:

use futures_diagnose_exec::{FutureExt as _, Future01Ext as _};

Then whenever you create a Future, append .with_diagnostics("name"). For example:

async_std::spawn(future.with_diagnostics("my-task-name"))

Set the environment variable PROFILE_DIR to a directory of your choice (e.g. profile) and then, run your code. Files named profile.<pid>.<num>.json will be generated in the directory set beforehand.

Then, open Chrome and go to the URL chrome://tracing, and load the profile.json.

FAQ

  • Chrome tells me chrome://tracing "can't be reached".

    Chromium shipped with recent Debian versions has the tracing feature disabled. See the Debian bug report for details.

Dependencies

~2.7–4MB
~79K SLoC