tracing-indicatif

A tracing layer that automatically creates and manages indicatif progress bars for active spans.

Progress bars are a great way to make your CLIs feel more responsive. However, adding and managing progress bars in your libraries can be invasive, unergonomic, and difficult to keep track of.

This library aims to make it easy to show progress bars for your CLI by tying progress bars to tracing spans. For CLIs/libraries already using tracing spans, this allow for a dead simple (3 line) code change to enable a smooth progress bar experience for your program. This eliminates having to have code in your libraries to manually manage progress bar instances.

This ends up working quite well as progress bars are fundamentally tracking the lifetime of some "span" (whether that "span" is defined explicitly or implicitly), so might as well make that relationship explicit.

Demo

See the examples folder for demo code.

Default Configuration

Default Configuration with Child Spans

Progress Bar

Build Console Like

A recreation of buck2's superconsole.

Features

• Customize progress bars using the same ProgressStyle API as indicatif.
• Supports displaying parent-child span relationship between progress bars.
• Limit the number of progress bars visible on the terminal.
• Prevents progress bars from clobbering tracing logs.

Future Features

These features are not yet available, but are a work in progress:

• Support pinning specific progress bar fields (e.g. position) to span fields.
• Update progress bars when a field is recorded to a span.