From 26175044cca81cb4a8289841a0c3b458f2d287f1 Mon Sep 17 00:00:00 2001
From: Hayden Stainsby <hds@caffeineconcepts.com>
Date: Wed, 17 May 2023 18:05:57 +0200
Subject: [PATCH] fix(console): remove histogram minimum count (#424)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The sparklines histogram used to visualize poll times and scheduled
times renders a legend for both axes. On the horizontal axis, it
displays the durations for the minimum and maximum buckets. On the
vertical axis, it displays the bucket count minimum and maximums.

Unfortunately, the minimum values for each axis are places together,
which can be confusing:

```text
╭Poll Times Histogram─────────────────────────────────╮
│46█                                                  │
│  █                                                  │
│  █                                                  │
│  █                                                  │
│  █ ▂                                                │
│  █▁█▇▃▁▁           ▁     ▁▁                      ▁ │
│ 031.23µs                                      7.11ms│
╰─────────────────────────────────────────────────────╯
  ^|----|
  │  ╰─ This is the minimum bucket duration value
  ╰── This is the minimum count
```

This can be confusing because it looks like there is an erroneous
leading zero on the minimum bucket duration.

If the minimum value is not zero, then the vertical axis minimum is
updated, but the bottom of the sparkline still represents zero. This
sitaution is unlikely, I had to add a fixed value to the bucket counts
to generate the histogram below.

```text
╭Poll Times Histogram─────────────────────────────────╮
│32██                                                 │
│  ██▇    ▁               ▁   ▁  ▁ ▁                  │
│  ███▇▆▆▆█▇▆▇▆▆▆▆▆▆▆▇▆▆▆▆█▆▇▆█▆▇█▆█▇▇▇▆▇▇▆▇▆▆▇▆▆▆▆▆▇ │
│  ██████████████████████████████████████████████████ │
│  ██████████████████████████████████████████████████ │
│  ██████████████████████████████████████████████████ │
│2033.79µs                                   536.58µs │
╰─────────────────────────────────────────────────────╯
 ^^|----|
  │  ╰─ This is the minimum bucket duration value
  ╰── This is the minimum count
```

This is probably misleading.

This change removes the minimum label on the vertical axis entirely.
This removes the confusion around the "erroneous" leading zero and since
the bottom of the graph is always zero anyway, it should be clear to
users without having to add the label.

The resulting histogram looks like:

```text
╭Poll Times Histogram─────────────────────────────────╮
│27 █▄                                                │
│   ██                                                │
│   ██                                                │
│   ██                                                │
│   ██▂                                               │
│  ▃███▃▁ ▁      ▁▃ ▃▃▃▁▃▅▁▃ ▃▃▃▃▃▁▁▁   ▁  ▁         ▁│
│  28.93µs                                   811.01µs │
╰─────────────────────────────────────────────────────╯
```
---
 tokio-console/src/view/mini_histogram.rs | 15 ---------------
 1 file changed, 15 deletions(-)

diff --git a/tokio-console/src/view/mini_histogram.rs b/tokio-console/src/view/mini_histogram.rs
index 1bdfcbd9e..eb13ee576 100644
--- a/tokio-console/src/view/mini_histogram.rs
+++ b/tokio-console/src/view/mini_histogram.rs
@@ -39,8 +39,6 @@ pub(crate) struct HistogramMetadata {
     pub(crate) min_value: u64,
     /// The value of the bucket with the greatest quantity
     pub(crate) max_bucket: u64,
-    /// The value of the bucket with the smallest quantity
-    pub(crate) min_bucket: u64,
     /// Number of high outliers, if any
     pub(crate) high_outliers: u64,
     pub(crate) highest_outlier: Option<Duration>,
@@ -87,7 +85,6 @@ impl<'a> Widget for MiniHistogram<'a> {
         };
 
         let max_qty_label = metadata.max_bucket.to_string();
-        let min_qty_label = metadata.min_bucket.to_string();
         let max_record_label = format!(
             "{:.prec$?}",
             Duration::from_nanos(metadata.max_value),
@@ -107,7 +104,6 @@ impl<'a> Widget for MiniHistogram<'a> {
             max_record_label,
             min_record_label,
             max_qty_label,
-            min_qty_label,
         );
 
         let legend_height = if metadata.high_outliers > 0 { 2 } else { 1 };
@@ -229,7 +225,6 @@ fn render_legend(
     max_record_label: String,
     min_record_label: String,
     max_qty_label: String,
-    min_qty_label: String,
 ) {
     // If there are outliers, display a note
     let labels_pos = if metadata.high_outliers > 0 {
@@ -253,14 +248,6 @@ fn render_legend(
 
     // top left: max quantity
     buf.set_string(area.left(), area.top(), &max_qty_label, Style::default());
-    // bottom left: 0 aligned to right
-    let zero_label = format!("{:>width$}", &min_qty_label, width = max_qty_label.len());
-    buf.set_string(
-        area.left(),
-        area.bottom() - labels_pos,
-        &zero_label,
-        Style::default(),
-    );
     // bottom left below the chart: min time
     buf.set_string(
         area.left() + max_qty_label.len() as u16,
@@ -311,14 +298,12 @@ fn chart_data(histogram: &DurationHistogram, width: u16) -> (Vec<u64>, Histogram
         Vec::new()
     };
     let max_bucket = data.iter().max().copied().unwrap_or_default();
-    let min_bucket = data.iter().min().copied().unwrap_or_default();
     (
         data,
         HistogramMetadata {
             max_value: histogram.max(),
             min_value: histogram.min(),
             max_bucket,
-            min_bucket,
             high_outliers,
             highest_outlier,
         },