Comments

Author: liammclennan

src/SeqCli/Cli/Commands/Bench/BenchCaseTimings.cs

@@ -19,14 +19,15 @@
 
 namespace SeqCli.Cli.Commands;
 
+/*
+ * Collects benchmarking elapsed time measurements and calculates statistics. 
+ */
 class BenchCaseTimings
 {
     List<double> _elaspseds = new() { };
-
     public double MeanElapsed => _elaspseds.Sum() / _elaspseds.Count;
     public double MinElapsed => _elaspseds.Min();
     public double MaxElapsed => _elaspseds.Max();
-
     public double StandardDeviationElapsed => StandardDeviation(_elaspseds); 
     public double RelativeStandardDeviationElapsed => StandardDeviation(_elaspseds) / MeanElapsed;
 

src/SeqCli/Cli/Commands/Bench/BenchCommand.cs

@@ -77,26 +77,20 @@ namespace SeqCli.Cli.Commands;
 class BenchCommand : Command
 {
     readonly SeqConnectionFactory _connectionFactory;
-    int _runs = 0;
+    int _runs = 3;
     readonly ConnectionFeature _connection;
     readonly DateRangeFeature _range;
     string _cases = "";
     string _reportingServerUrl = "";
     string _reportingServerApiKey = "";
     ILogger? _reportingLogger = null;
 
-    const int DefaultRuns = 3;
-
     public BenchCommand(SeqConnectionFactory connectionFactory)
     {
         _connectionFactory = connectionFactory;
-        _runs = DefaultRuns;
         Options.Add("r|runs=", "The number of runs to execute", r =>
         {
-            if (!int.TryParse(r, out _runs))
-            {
-                _runs = DefaultRuns;
-            }
+            int.TryParse(r, out _runs);
         });
 
         Options.Add(
@@ -123,7 +117,6 @@ protected override async Task<int> Run()
         {
             var connection = _connectionFactory.Connect(_connection);
             _reportingLogger = BuildReportingLogger();
-        
             var cases = ReadCases(_cases);
             var runId = Guid.NewGuid().ToString("N").Substring(0, 4);
             var start = _range.Start ?? DateTime.UtcNow.AddDays(-7);
@@ -178,6 +171,9 @@ protected override async Task<int> Run()
         }
     }
 
+    /// <summary>
+    /// Build a second Serilog logger for logging benchmark results. 
+    /// </summary>
     Logger BuildReportingLogger()
     {
         return string.IsNullOrWhiteSpace(_reportingServerUrl) 
@@ -195,6 +191,9 @@ Logger BuildReportingLogger()
                 .CreateLogger();
     }
 
+    /// <summary>
+    /// Read and parse the bench test cases from the file supplied or else from a default file. 
+    /// </summary>
     static BenchCasesCollection ReadCases(string filename)
     {
         var defaultCasesPath = Path.Combine(Path.GetDirectoryName(typeof(BenchCommand).Assembly.Location)!, "Cli/Commands/Bench/BenchCases.json");

src/SeqCli/SeqCli.csproj

@@ -46,9 +46,6 @@
   <ItemGroup>
     <ProjectReference Include="..\Roastery\Roastery.csproj" />
   </ItemGroup>
-  <ItemGroup>
-    <Folder Include="Bench" />
-  </ItemGroup>
   <ItemGroup>
     <Compile Remove="Bench\JsonCaseReader.cs" />
   </ItemGroup>