This page describes the Yardstick grafana dashboard. The Yardstick grafana dashboard can be found here.
Yardstick provids a public account for accessing to the dashboard. The username and password are both set to ‘opnfv’.
Test case dashboard
For each test case, there is a dedicated dashboard. Shown here is the dashboard of TC002.
For each test case dashboard. On the top left, we have a dashboard selection, you can switch to different test cases using this pull-down menu.
Underneath, we have a pod and scenario selection. All the pods and scenarios that have ever published test data to the Influx DB will be shown here. You can check multiple pods or scenarios.
For each test case, we have a short description and a link to detailed test case information in Yardstick user guide.
Underneath, it is the result presentation section. You can use the time period selection on the top right corner to zoom in or zoom out the chart.
For a user with administration rights it is easy to update and save any dashboard configuration.
Saved updates immediately take effect and become live. This may cause issues like:
- Changes and updates made to the live configuration in Grafana can compromise existing Grafana content in an unwanted, unpredicted or incompatible way. Grafana as such is not version controlled, there exists one single Grafana configuration per dashboard.
There is a risk several people can disturb each other when doing updates to the same Grafana dashboard at the same time.
Way of Working with updates:
In the curtain menu of the existing dashboard do a "Save As..." into a new dashboard copy instance, and then continue doing all updates and saves within the dashboard copy.
When finished with all Grafana configuration changes in this temporary dashboard then chose "export" of the updated dashboard copy into a JSON file and put it up for review in Gerrit, in file /yardstick/dashboard/Yardstick-TCxxx-yyyyyyyyyyyyy. For instance a typical default name of the file would be "Yardstick-TC001 Copy-1234567891234".
Also, keep the new, unreviewed dashboard copy saved and running in Grafana, otherwise it is difficult to review and compare the real impacts of the changes. Copy also the dashboard's http-link into the Gerrit commit message for easier review reference as well. After approved review do an "import" of the JSON file and also a "save dashboard" as soon as possible to replace the old live dashboard configuration. Make sure to manually put the correct dashboard name as Title and OriginalTitle in the new JSON file, the same as in the old dashboard. When done also make sure to delete the temporary dashboard in Grafana.
Add a dashboard into yardstick grafana
Due to security concern, users that using the public opnfv account are not able to edit the yardstick grafana directly. It takes a few more steps for a non-yardstick user to add a custom dashboard into yardstick grafana.
There are 6 steps to go.
Here I'll list the recommend steps for you to refer.
1 Preparation local influxdb and grafana
- You need to build a local influxdb and grafana for your yardstick, so you can do the work locally.
You can refer to How to deploy InfluxDB and Grafana locally about how to do this.
- Once step 1 is done, you can fetch the grafana dashboard config yaml from yardstick repo?
- then you can log in gafana web client with admin to import the config file into your local grafana.
- now you'l have the same dashboard just like grafana in the opnfv community.
Take Cyclictest for example:
Cyclictest is a test case from "kvmfornfv" and implemented in yardstick.
2 After above steps are done, kvmfornfv have local grafana and it can run the Cyclictest and upload the test result into local influxdb.
3 Now you can log in the grafana web client to create a dashboard for Cyclictest. The key is to create a dashboard with a graph for Cyclictest to show the result. There's two way for you to choose:
- you can use other dashboard like "Yardstick-tc002" to create a copy and do the modification.
- or you can just add a new dashboard and do the rest of the work.
4 For how to create a dashboard or a graph, please refer to the official document:
5 Once your dashboard is done, you can now export the config as a config file and porpose a patch into yardstick repo