#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

#999 in Asynchronous

Download history 421/week @ 2024-03-13 808/week @ 2024-03-20 709/week @ 2024-03-27 801/week @ 2024-04-03 637/week @ 2024-04-10 667/week @ 2024-04-17 693/week @ 2024-04-24 520/week @ 2024-05-01 552/week @ 2024-05-08 641/week @ 2024-05-15 743/week @ 2024-05-22 833/week @ 2024-05-29 705/week @ 2024-06-05 597/week @ 2024-06-12 510/week @ 2024-06-19 591/week @ 2024-06-26

2,538 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

~3–4MB
~82K SLoC