Skip to content

Commit

Permalink
Update dashboards instructions (#150)
Browse files Browse the repository at this point in the history
  • Loading branch information
ppcano authored Sep 28, 2023
1 parent e3ccd59 commit ff6a28f
Show file tree
Hide file tree
Showing 17 changed files with 17 additions and 91 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,12 @@ Check [the documentation](https://k6.io/docs/results-output/real-time/prometheus

## Dashboards

[<img src="./images/prometheus-dashboard-k6-test-result.png" width="500"/>](./images/prometheus-dashboard-k6-test-result.png)
<p>&nbsp;</p>

Pre-built Grafana dashboards are available. Check the [dashboard guide](https://k6.io/docs/results-output/real-time/prometheus-remote-write/#time-series-visualization) how to import and use it from the source code or directly from [Grafana.com](https://grafana.com/grafana/dashboards/18030-test-result).
[<img src="./images/dashboard-k6-prometheus-upper-section.png" width="500"/>](./images/dashboard-k6-prometheus.png)

>Note: The dashboards work with the Native Histogram mapping so it is required to enable it.
This repo contains the [source code](./grafana/dashboards) of two Grafana dashboards designed to visualize test results: [`k6 Prometheus`](https://grafana.com/grafana/dashboards/19665-k6-prometheus/) and [k6 Prometheus (Native Histograms)](https://grafana.com/grafana/dashboards/18030-k6-prometheus-native-histograms/).

Refer to the [documentation](https://k6.io/docs/results-output/real-time/prometheus-remote-write/#time-series-visualization) to learn more about these dashboards. You can import them to your Grafana instance or with the docker-compose example on this repo.

🌟 Special thanks to [jwcastillo](https://github.com/jwcastillo) for his contributions and dedication to improving the dashboards.
73 changes: 0 additions & 73 deletions grafana/dashboards/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion grafana/dashboards/k6-prometheus-native-histogram.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
}
]
},
"description": "Visualize k6 OSS results stored in Prometheus with Native Histogram. K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM option must be true. ",
"description": "Visualize k6 OSS results stored in Prometheus with Native Histograms.",
"editable": true,
"fiscalYearStartMonth": 0,
"graphTooltip": 0,
Expand Down
23 changes: 9 additions & 14 deletions grafana/dashboards/k6-prometheus.json
Original file line number Diff line number Diff line change
Expand Up @@ -827,8 +827,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
}
]
},
Expand Down Expand Up @@ -1002,8 +1001,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
}
]
},
Expand Down Expand Up @@ -1182,8 +1180,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
}
]
},
Expand Down Expand Up @@ -1352,8 +1349,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
}
]
}
Expand Down Expand Up @@ -1640,8 +1636,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
}
]
}
Expand Down Expand Up @@ -1844,8 +1839,7 @@
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
"color": "green"
}
]
},
Expand Down Expand Up @@ -1977,9 +1971,10 @@
},
{
"current": {
"isNone": true,
"selected": false,
"text": "p99",
"value": "p99"
"text": "None",
"value": ""
},
"datasource": {
"type": "prometheus",
Expand Down
Binary file added images/dashboard-k6-prometheus-lower-section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboard-k6-prometheus-nh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboard-k6-prometheus-upper-section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboard-k6-prometheus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file removed images/prometheus-dashboard-k6-test-result-http.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed images/prometheus-dashboard-k6-test-result.png
Binary file not shown.
Binary file removed images/prometheus-dashboard-k6-test-runs.png
Binary file not shown.

0 comments on commit ff6a28f

Please sign in to comment.