Merge pull request #21 from szkiba/feature/report

Feature/report

.dashboard.js

@@ -41,7 +41,8 @@ const customTab = {
   title: 'Custom',
   event: overview.event,
   panels: customPanels,
-  charts: [overview.chart('http_reqs'), durationChart]
+  charts: [overview.chart('http_reqs'), durationChart],
+  description: 'Example of customizing the display of metrics.'
 }
 
 // add custom tab to configuration

README.md

@@ -12,20 +12,45 @@ By using **xk6-dashboard** output extension you can access metrics from [k6](htt
 **Screenshots**
 
 *Overview*
+
+The overview tabs provides an overview of the most important metrics of the test run. Graphs plot the value of metrics over time.
+
 ![k6 dashboard overview snapshot](screenshot/k6-dashboard-overview-snapshot.png)
 
 *Overview Cumulative*
 ![k6 dashboard overview cumulative](screenshot/k6-dashboard-overview-cumulative.png)
 
 *Timings*
+
+The timings tabs provides an overview of test run HTTP timing metrics. Graphs plot the value of metrics over time.
+
 ![k6 dashboard timings snapshot](screenshot/k6-dashboard-timings-snapshot.png)
 
 *Timings Cumulative*
 ![k6 dashboard timings cumulative](screenshot/k6-dashboard-timings-cumulative.png)
 
 *Custom Tab*
+
+Example of customizing the display of metrics.
+
 ![k6 dashboard custom](screenshot/k6-dashboard-custom.png)
 
+*Summary Tab*
+
+Summary tab contains a summary of the test run metrics. The tables contains the aggregated values of the metrics for the entire test run.
+
+![k6 dashboard summary](screenshot/k6-dashboard-summary.png)
+
+**Report**
+
+The report tab contains a test run report in a printable (or saveable to PDF) format.
+
+*Report Tab*
+![k6 dashboard report](screenshot/k6-dashboard-report.png)
+
+*Report PDF*
+
+See [sample PDF report](screenshot/k6-dashboard-report.pdf)
 
 **Table of Contents**
 
@@ -198,7 +223,8 @@ const customTab = {
   title: 'Custom',
   event: overview.event,
   panels: customPanels,
-  charts: [overview.chart('http_reqs'), durationChart]
+  charts: [overview.chart('http_reqs'), durationChart],
+  description: 'Example of customizing the display of metrics.'
 }
 
 // add custom tab to configuration

dashboard/extension_test.go

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
 package dashboard
 
 import (

dashboard/helper_test.go

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
 package dashboard
 
 import (

dashboard/meter_test.go

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
 package dashboard
 
 import (

dashboard/options_test.go

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
 package dashboard
 
 import (

dashboard/registry_test.go

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
 package dashboard
 
 import (

dashboard/sse.go

@@ -50,5 +50,7 @@ func (esrc *eventSource) ServeHTTP(res http.ResponseWriter, req *http.Request) {
 	values.Add("stream", esrc.channel)
 	req.URL.RawQuery = values.Encode()
 
+	res.Header().Set("Access-Control-Allow-Origin", "*")
+
 	esrc.Server.ServeHTTP(res, req)
 }

dashboard/sse_test.go

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
 package dashboard
 
 import (

dashboard/web_test.go

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023 Iván Szkiba
+//
+// SPDX-License-Identifier: MIT
+
 package dashboard
 
 import (

magefiles/magefile.go

@@ -148,6 +148,7 @@ func Exif() error {
 		`exiftool -ext png -overwrite_original -XMP:Subject+="k6 dashboard xk6" -Title="k6 dashboard screenshot" -Description="Screenshot of xk6-dashboard extension that enables creating web based metrics dashboard for k6." -Author="Ivan SZKIBA" screenshot`,
 		`exiftool -all= -overwrite_original -ext png .github`,
 		`exiftool -ext png -overwrite_original -XMP:Subject+="k6 dashboard xk6" -Title="k6 dashboard screenshot" -Description="Screenshot of xk6-dashboard extension that enables creating web based metrics dashboard for k6." -Author="Ivan SZKIBA" .github`,
+		`exiftool -ext pdf -overwrite_original -Subject+="k6 dashboard report" -Title="k6 dashboard report" -Description="Example report of xk6-dashboard extension that enables creating web based metrics dashboard for k6." -Author="Ivan SZKIBA" screenshot`,
 	)
 }