Improve human readable output. (#77)

Improves human-readable output on the CLI

Fixes #69

Signed-off-by: Otto van der Schaaf <oschaaf@we-amp.com>

Author: oschaaf

source/client/output_formatter_impl.cc

@@ -1,5 +1,7 @@
 #include "client/output_formatter_impl.h"
 
+#include <google/protobuf/util/time_util.h>
+
 #include <chrono>
 #include <sstream>
 
@@ -32,10 +34,12 @@ std::string ConsoleOutputFormatterImpl::toString() const {
         if (statistic.count() == 0) {
           continue;
         }
-        ss << fmt::format("{}: {} samples, mean: {}, pstdev: {}", statistic.id(), statistic.count(),
-                          statistic.mean(), statistic.pstdev())
-           << std::endl;
-        ss << fmt::format("{:<{}}{:<{}}{:<{}}", "Percentile", 12, "Count", 12, "Latency", 15)
+        ss << fmt::format("{}", statIdtoFriendlyStatName(statistic.id())) << std::endl;
+        ss << fmt::format("  samples: {}", statistic.count()) << std::endl;
+        ss << fmt::format("  mean:    {}", formatProtoDuration(statistic.mean())) << std::endl;
+        ss << fmt::format("  pstdev:  {}", formatProtoDuration(statistic.pstdev())) << std::endl;
+        ss << std::endl;
+        ss << fmt::format("  {:<{}}{:<{}}{:<{}}", "Percentile", 12, "Count", 12, "Latency", 15)
            << std::endl;
 
         // The proto percentiles are ordered ascending. We write the first match to the stream.
@@ -44,8 +48,9 @@ std::string ConsoleOutputFormatterImpl::toString() const {
           for (const auto& percentile : statistic.percentiles()) {
             if (percentile.percentile() >= p && last_percentile < percentile.percentile()) {
               last_percentile = percentile.percentile();
-              ss << fmt::format("{:<{}}{:<{}}{:<{}}", percentile.percentile(), 12,
-                                percentile.count(), 12, percentile.duration(), 15)
+              ss << fmt::format("  {:<{}}{:<{}}{:<{}}", percentile.percentile(), 12,
+                                percentile.count(), 12, formatProtoDuration(percentile.duration()),
+                                15)
                  << std::endl;
               break;
             }
@@ -66,6 +71,26 @@ std::string ConsoleOutputFormatterImpl::toString() const {
   return ss.str();
 }
 
+std::string
+ConsoleOutputFormatterImpl::formatProtoDuration(const Envoy::Protobuf::Duration& duration) const {
+  auto c = Envoy::ProtobufUtil::TimeUtil::DurationToMicroseconds(duration);
+  return fmt::format("{}s {:03}ms {:03}us", (c % 1'000'000'000) / 1'000'000,
+                     (c % 1'000'000) / 1'000, c % 1'000);
+}
+
+std::string ConsoleOutputFormatterImpl::statIdtoFriendlyStatName(absl::string_view stat_id) const {
+  if (stat_id == "benchmark_http_client.queue_to_connect") {
+    return "Queueing and connection setup latency";
+  } else if (stat_id == "benchmark_http_client.request_to_response") {
+    return "Request start to response end";
+  } else if (stat_id == "sequencer.callback") {
+    return "Initiation to completion";
+  } else if (stat_id == "sequencer.blocking") {
+    return "Blocking. Results are skewed when significant numbers are reported here.";
+  }
+  return std::string(stat_id);
+}
+
 void OutputFormatterImpl::addResult(absl::string_view name,
                                     const std::vector<StatisticPtr>& statistics,
                                     const std::map<std::string, uint64_t>& counters) {

source/client/output_formatter_impl.h

@@ -32,6 +32,10 @@ class ConsoleOutputFormatterImpl : public OutputFormatterImpl {
 public:
   ConsoleOutputFormatterImpl(Envoy::TimeSource& time_source, const Options& options);
   std::string toString() const override;
+
+private:
+  std::string statIdtoFriendlyStatName(absl::string_view stat_id) const;
+  std::string formatProtoDuration(const Envoy::Protobuf::Duration& duration) const;
 };
 
 class JsonOutputFormatterImpl : public OutputFormatterImpl {

test/test_data/output_formatter.txt.gold

@@ -1,7 +1,11 @@
 Nighthawk - A layer 7 protocol benchmarking tool.
 
-stat_id: 3 samples, mean: 0.002s, pstdev: 0.000816497s
-Percentile  Count       Latency        
+stat_id
+  samples: 3
+  mean:    0s 002ms 000us
+  pstdev:  0s 000ms 816us
+
+  Percentile  Count       Latency        
 
 Counter                                 Value       Per second
 bar                                     2           2.00