fix: add benchmark legend

SockworkOrange · SockworkOrange · commit 43b7d86470c6 · 2025-12-17T13:03:12.000+01:00
diff --git a/benchmark/BenchmarkRunner/Benchmarks/BaseReadBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/BaseReadBenchmark.cs
@@ -8,11 +8,13 @@ public readonly record struct ReadBenchmarkParams(
     int QueriesToSubmit
 )
 {
-    public override string ToString() => $"Limit={Limit.StringifyLargeNumbers()}, Concurrency={Concurrency.StringifyLargeNumbers()}, Queries={QueriesToSubmit.StringifyLargeNumbers()}";
+    public override string ToString() => $"L={Limit.StringifyLargeNumbers()}, C={Concurrency.StringifyLargeNumbers()}, Q={QueriesToSubmit.StringifyLargeNumbers()}";
 }
 
 public abstract class BaseReadBenchmark
 {
+    protected const string BenchmarkLegend = "Legend: L=Query Limit, C=Concurrency, Q=Queries To Submit";
+
     [IterationSetup]
     public static void IterationSetup() => Helpers.InvokeGarbageCollection();
     public abstract Task Sqlc_GetCustomerOrders();
diff --git a/benchmark/BenchmarkRunner/Benchmarks/BaseWriteBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/BaseWriteBenchmark.cs
@@ -5,11 +5,12 @@ public readonly record struct WriteBenchmarkArgs(
     int BatchSize
 )
 {
-    public override string ToString() => $"Records={TotalRecordsToLoad.StringifyLargeNumbers()}, BatchSize={BatchSize.StringifyLargeNumbers()}";
+    public override string ToString() => $"R={TotalRecordsToLoad.StringifyLargeNumbers()}, B={BatchSize.StringifyLargeNumbers()}";
 }
 
 public abstract class BaseWriteBenchmark
 {
+    protected const string BenchmarkLegend = "Legend: R=Total Records, B=Batch Size";
     public const int TotalRecordsForSetup = 300000; // 3 million records
     public const int OrderIdsCountForSetup = 1000;
     public const int ProductIdsCountForSetup = 1000;
diff --git a/benchmark/BenchmarkRunner/Benchmarks/MysqlReadBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/MysqlReadBenchmark.cs
@@ -11,7 +11,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
 [CategoriesColumn]
 public class MysqlReadBenchmark : BaseReadBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/MysqlWriteBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/MysqlWriteBenchmark.cs
@@ -13,7 +13,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
 [CategoriesColumn]
 public class MysqlWriteBenchmark : BaseWriteBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/PostgresqlReadBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/PostgresqlReadBenchmark.cs
@@ -11,7 +11,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
 [CategoriesColumn]
 public class PostgresqlReadBenchmark : BaseReadBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/PostgresqlWriteBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/PostgresqlWriteBenchmark.cs
@@ -12,7 +12,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
 [CategoriesColumn]
 public class PostgresqlWriteBenchmark : BaseWriteBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/SqliteReadBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/SqliteReadBenchmark.cs
@@ -12,7 +12,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
 [CategoriesColumn]
 public class SqliteReadBenchmark : BaseReadBenchmark
 {
diff --git a/benchmark/BenchmarkRunner/Benchmarks/SqliteWriteBenchmark.cs b/benchmark/BenchmarkRunner/Benchmarks/SqliteWriteBenchmark.cs
@@ -13,7 +13,7 @@ namespace BenchmarkRunner.Benchmarks;
 [SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]
 [MemoryDiagnoser]
 [MarkdownExporterAttribute.GitHub]
-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]
+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]
 [CategoriesColumn]
 public class SqliteWriteBenchmark : BaseWriteBenchmark
 {

Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,13 @@ public readonly record struct ReadBenchmarkParams(`
`8`	`8`	`int QueriesToSubmit`
`9`	`9`	`)`
`10`	`10`	`{`
`11`		`- public override string ToString() => $"Limit={Limit.StringifyLargeNumbers()}, Concurrency={Concurrency.StringifyLargeNumbers()}, Queries={QueriesToSubmit.StringifyLargeNumbers()}";`
	`11`	`+ public override string ToString() => $"L={Limit.StringifyLargeNumbers()}, C={Concurrency.StringifyLargeNumbers()}, Q={QueriesToSubmit.StringifyLargeNumbers()}";`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`public abstract class BaseReadBenchmark`
`15`	`15`	`{`
	`16`	`+ protected const string BenchmarkLegend = "Legend: L=Query Limit, C=Concurrency, Q=Queries To Submit";`
	`17`	`+`
`16`	`18`	`[IterationSetup]`
`17`	`19`	`public static void IterationSetup() => Helpers.InvokeGarbageCollection();`
`18`	`20`	`public abstract Task Sqlc_GetCustomerOrders();`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,12 @@ public readonly record struct WriteBenchmarkArgs(`
`5`	`5`	`int BatchSize`
`6`	`6`	`)`
`7`	`7`	`{`
`8`		`- public override string ToString() => $"Records={TotalRecordsToLoad.StringifyLargeNumbers()}, BatchSize={BatchSize.StringifyLargeNumbers()}";`
	`8`	`+ public override string ToString() => $"R={TotalRecordsToLoad.StringifyLargeNumbers()}, B={BatchSize.StringifyLargeNumbers()}";`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`public abstract class BaseWriteBenchmark`
`12`	`12`	`{`
	`13`	`+ protected const string BenchmarkLegend = "Legend: R=Total Records, B=Batch Size";`
`13`	`14`	`public const int TotalRecordsForSetup = 300000; // 3 million records`
`14`	`15`	`public const int OrderIdsCountForSetup = 1000;`
`15`	`16`	`public const int ProductIdsCountForSetup = 1000;`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ namespace BenchmarkRunner.Benchmarks;`
`11`	`11`	`[SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]`
`12`	`12`	`[MemoryDiagnoser]`
`13`	`13`	`[MarkdownExporterAttribute.GitHub]`
`14`		`-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]`
	`14`	`+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]`
`15`	`15`	`[CategoriesColumn]`
`16`	`16`	`public class MysqlReadBenchmark : BaseReadBenchmark`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ namespace BenchmarkRunner.Benchmarks;`
`13`	`13`	`[SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]`
`14`	`14`	`[MemoryDiagnoser]`
`15`	`15`	`[MarkdownExporterAttribute.GitHub]`
`16`		`-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]`
	`16`	`+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]`
`17`	`17`	`[CategoriesColumn]`
`18`	`18`	`public class MysqlWriteBenchmark : BaseWriteBenchmark`
`19`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace BenchmarkRunner.Benchmarks;`
`12`	`12`	`[SimpleJob(RuntimeMoniker.Net80, warmupCount: 2, iterationCount: 10)]`
`13`	`13`	`[MemoryDiagnoser]`
`14`	`14`	`[MarkdownExporterAttribute.GitHub]`
`15`		`-[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory)]`
	`15`	`+[GroupBenchmarksBy(BenchmarkLogicalGroupRule.ByCategory), Description(BenchmarkLegend)]`
`16`	`16`	`[CategoriesColumn]`
`17`	`17`	`public class PostgresqlWriteBenchmark : BaseWriteBenchmark`
`18`	`18`	`{`