jonhoo / jonhoo/tracing-timing

The current starting experience is not user friendly

Open
#17 3 comments 4 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
136
Forks
13
PR merge metrics
No merged PRs in 30d

Description

> The crate does not implement a mechanism for recording the resulting histograms. Instead, you can implement this as you see fit using [TimingSubscriber::with_histograms](https://docs.rs/tracing-timing/latest/tracing_timing/struct.TimingSubscriber.html#method.with_histograms).

From my point of view of total noob of this crate, this is very harsh for new user to say "do it yourself", specially:

> It gives you access to the histograms for all groups. Note that you must call refresh() on each histogram to see its latest values (see [hdrhistogram::SyncHistogram](https://docs.rs/hdrhistogram/6/hdrhistogram/sync/struct.SyncHistogram.html)). Note that calling refresh() will block until the next event is posted, so you may want [TimingSubscriber::force_synchronize](https://docs.rs/tracing-timing/latest/tracing_timing/struct.TimingSubscriber.html#method.force_synchronize) instead.

Look like it's easy to mess up. While I understand the point of not implement any form of output I think have a "Q&D" way build-in would be a big plus. I think having a simple Debug alternative implementation would be nice to have, something that is not guarantee to not change but still allow to not deal with https://github.com/jonhoo/tracing-timing/blob/main/examples/pretty.rs code, you ask user to downcast and manipulate very low level api here.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.