#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

#972 in Asynchronous

Download history 466/week @ 2024-01-07 489/week @ 2024-01-14 454/week @ 2024-01-21 255/week @ 2024-01-28 376/week @ 2024-02-04 574/week @ 2024-02-11 823/week @ 2024-02-18 524/week @ 2024-02-25 626/week @ 2024-03-03 483/week @ 2024-03-10 692/week @ 2024-03-17 719/week @ 2024-03-24 903/week @ 2024-03-31 506/week @ 2024-04-07 795/week @ 2024-04-14 642/week @ 2024-04-21

2,944 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–3.5MB
~65K SLoC