update reports doc, include WASP fix

Author: Tofel

book/src/libs/wasp/benchspy/reports/new_executor.md

@@ -1,5 +1,7 @@
 # BenchSpy - Adding a New QueryExecutor
 
+# QueryExecutor interface
+
 As mentioned earlier, the `StandardReport` supports three different data sources:
 - `Direct`
 - `Loki`
@@ -48,4 +50,18 @@ By default, `StandardReport` calculates the test time range automatically by ana
 
 ---
 
-With these details in mind, you should have a clear path to implementing your own `QueryExecutor` and integrating it seamlessly with `BenchSpy`'s `StandardReport`.
+With these details in mind, you should have a clear path to implementing your own `QueryExecutor` and integrating it seamlessly with `BenchSpy`'s `StandardReport`.
+
+# NamedGenerator interface
+
+Executors that query load generation metrics should also implement this simple interface:
+```go
+type NamedGenerator interface {
+	// GeneratorName returns the name of the generator
+	GeneratorName() string
+}
+```
+
+It is used primarly, when casting results from `map[string]interface{}` to target type, while splitting them between different generators.
+
+Currently, this interface is implemented by `Direct` and `Loki` exectors, but not by `Prometheus`.

book/src/libs/wasp/benchspy/reports/standard_report.md

@@ -18,6 +18,7 @@ Both query executors focus on the characteristics of the load generated by `WASP
 Predefined metrics for both include:
 - Median latency
 - 95th percentile latency
+- Max latency
 - Error rate
 
 **Latency** is the round-trip time from sending a request to receiving a response from the Application Under Test (AUT).
@@ -31,8 +32,10 @@ Predefined metrics for both include:
 Prometheus metrics focus on resource consumption by the AUT rather than load generation. These metrics include:
 - Median CPU usage
 - 95th percentile CPU usage
+- Max CPU usage
 - Median memory usage
 - 95th percentile memory usage
+- Max memory usage
 
 Prometheus queries focus on **total** consumption, which combines the usage of the underlying system and your application.
 
@@ -44,7 +47,7 @@ To use pre-defined metrics, call the `NewStandardReport` method:
 
 ```go
 report, err := benchspy.NewStandardReport(
-    "91ee9e3c903d52de12f3d0c1a07ac3c2a6d141fb",
+    "v1.1.1",
     // Query executor types for which standard metrics should be generated
     benchspy.WithStandardQueries(
         benchspy.StandardQueryExecutor_Prometheus,
@@ -69,7 +72,7 @@ Since `WASP` stores AUT responses in each generator, you can create custom metri
 ```go
 var generator *wasp.Generator
 
-var timeouts = func(responses *wasp.SliceBuffer[wasp.Response]) (float64, error) {
+var timeouts = func(responses *wasp.SliceBuffer[*wasp.Response]) (float64, error) {
     if len(responses.Data) == 0 {
         return 0, nil
     }
@@ -104,7 +107,7 @@ var generator *wasp.Generator
 
 lokiQueryExecutor := benchspy.NewLokiQueryExecutor(
     map[string]string{
-        "responses_over_time": fmt.Sprintf("sum(count_over_time({my_label=~\"%s\", test_data_type=~\"responses\", gen_name=~\"%s\"} [1s])) by (node_id, gen_name)", label, gen.Cfg.GenName),
+        "responses_over_time": fmt.Sprintf("sum(count_over_time({my_label=~\"%s\", test_data_type=~\"responses\", gen_name=~\"%s\"} [5s])) by (node_id, gen_name)", label, gen.Cfg.GenName),
     },
     generator.Cfg.LokiConfig,
 )
@@ -139,7 +142,7 @@ To use custom queries in a `StandardReport`, pass the custom `QueryExecutors` cr
 
 ```go
 report, err := benchspy.NewStandardReport(
-    "2d1fa3532656c51991c0212afce5f80d2914e34e",
+    "v1.2.3",
     benchspy.WithQueryExecutors(directExecutor, lokiQueryExecutor, prometheusExecutor),
     benchspy.WithGenerators(gen),
 )

wasp/benchspy/types.go

@@ -46,6 +46,7 @@ type QueryExecutor interface {
 }
 
 type NamedGenerator interface {
+	// GeneratorName returns the name of the generator
 	GeneratorName() string
 }
 

wasp/wasp.go

@@ -713,8 +713,6 @@ func (g *Generator) Wait() (interface{}, bool) {
 	g.dataCancel()
 	g.dataWaitGroup.Wait()
 	if g.Cfg.LokiConfig != nil {
-		// g.dataCancel()
-		// g.dataWaitGroup.Wait()
 		g.stopLokiStream()
 	}
 	return g.GetData(), g.stats.RunFailed.Load()