1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
5 =======================
6 KVM4NFV Dashboard Guide
7 =======================
9 Dashboard for KVM4NFV Daily Test Results
10 ----------------------------------------
15 This chapter explains the procedure to configure the InfluxDB and Grafana on Node1 or Node2
16 depending on the testtype to publish KVM4NFV test results. The cyclictest cases are executed
17 and results are published on Yardstick Dashboard(Grafana). InfluxDB is the database which will
18 store the cyclictest results and Grafana is a visualisation suite to view the maximum,minimum and
19 average values of the time series data of cyclictest results.The framework is shown in below image.
21 .. figure:: images/dashboard-architecture.png
22 :name: dashboard-architecture
29 +-----------------------------+--------------------------------------------+
31 | **Release** | **Features** |
33 +=============================+============================================+
34 | | - Data published in Json file format |
35 | Colorado | - No database support to store the test's |
36 | | latency values of cyclictest |
37 | | - For each run, the previous run's output |
38 | | file is replaced with a new file with |
39 | | currents latency values. |
40 +-----------------------------+--------------------------------------------+
41 | | - Test results are stored in Influxdb |
42 | | - Graphical representation of the latency |
43 | Danube | values using Grafana suite. (Dashboard) |
44 | | - Supports graphical view for multiple |
45 | | testcases and test-types (Stress/Idle) |
46 +-----------------------------+--------------------------------------------+
51 To configure Yardstick, InfluxDB and Grafana for KVM4NFV project following sequence of steps are followed:
55 All the below steps are done as per the script, which is a part of CICD integration of kvmfornfv.
60 git clone https://gerrit.opnfv.org/gerrit/yardstick
63 docker pull tutum/influxdb
64 docker run -d --name influxdb -p 8083:8083 -p 8086:8086 --expose 8090 --expose 8099 tutum/influxdb
65 docker exec -it influxdb bash
67 >CREATE USER root WITH PASSWORD 'root' WITH ALL PRIVILEGES
68 >CREATE DATABASE yardstick;
73 docker pull grafana/grafana
74 docker run -d --name grafana -p 3000:3000 grafana/grafana
76 The Yardstick document for Grafana and InfluxDB configuration can be found `here`_.
78 .. _here: https://wiki.opnfv.org/display/yardstick/How+to+deploy+InfluxDB+and+Grafana+locally
80 Configuring the Dispatcher Type:
81 ---------------------------------
82 Need to configure the dispatcher type in /etc/yardstick/yardstick.conf depending on the dispatcher
83 methods which are used to store the cyclictest results. A sample yardstick.conf can be found at
84 /yardstick/etc/yardstick.conf.sample, which can be copied to /etc/yardstick.
88 mkdir -p /etc/yardstick/
89 cp /yardstick/etc/yardstick.conf.sample /etc/yardstick/yardstick.conf
91 **Dispatcher Modules:**
93 Three type of dispatcher methods are available to store the cyclictest results.
99 **1. File**: Default Dispatcher module is file. If the dispatcher module is configured as a file,
100 then the test results are stored in a temporary file yardstick.out(default path: /tmp/yardstick.out).
101 Dispatcher module of "Verify Job" is "Default". So,the results are stored in Yardstick.out file for
102 verify job. Storing all the verify jobs in InfluxDB database causes redundancy of latency values.
103 Hence, a File output format is prefered.
112 file_path = /tmp/yardstick.out
116 **2. Influxdb**: If the dispatcher module is configured as influxdb, then the test results are
117 stored in Influxdb. Users can check test resultsstored in the Influxdb(Database) on Grafana which is
118 used to visualizethe time series data.
120 To configure the influxdb, the following content in /etc/yardstick/yardstick.conf need to updated
126 dispatcher = influxdb
128 [dispatcher_influxdb]
130 target = http://127.0.0.1:8086 ##Mention the IP where influxdb is running
135 Dispatcher module of "Daily Job" is Influxdb. So, the results are stored in influxdb and then
136 published to Dashboard.
138 **3. HTTP**: If the dispatcher module is configured as http, users can check test result on OPNFV
139 testing dashboard which uses MongoDB as backend.
149 target = http://127.0.0.1:8000/results
151 .. figure:: images/UseCaseDashboard.png
154 Detailing the dispatcher module in verify and daily Jobs:
155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
157 KVM4NFV updates the dispatcher module in the yardstick configuration (/etc/yardstick/yardstick.conf)
158 file depending on the Job type(Verify/Daily). Once the test is completed, results are published to
159 the respective dispatcher modules.
161 Dispatcher module is configured for each Job type as mentioned below.
163 1. ``Verify Job`` : Default "DISPATCHER_TYPE" i.e. file(/tmp/yardstick.out) is used. User can also
164 see the test results on Jenkins console log.
168 *"max": "00030", "avg": "00006", "min": "00006"*
170 2. ``Daily Job`` : Opnfv Influxdb url is configured as dispatcher module.
174 DISPATCHER_TYPE=influxdb
175 DISPATCHER_INFLUXDB_TARGET="http://104.197.68.199:8086"
177 Influxdb only supports line protocol, and the json protocol is deprecated.
179 For example, the raw_result of cyclictest in json format is:
183 "timestamp": 1478234859.065317,
196 With the help of "influxdb_line_protocol", the json is transformed as a line string:
199 'kvmfornfv_cyclictest_idle_idle,deploy_scenario=unknown,host=kvm.LF,
200 installer=unknown,pod_name=unknown,runner_id=23,scenarios=Cyclictest,
201 task_id=e7be7516-9eae-406e-84b6-e931866fa793,version=unknown
202 avg="00008",max="00012",min="00007" 1478234859065316864'
206 Influxdb api which is already implemented in `Influxdb`_ will post the data in line format into the
209 ``Displaying Results on Grafana dashboard:``
211 - Once the test results are stored in Influxdb, dashboard configuration file(Json) which used to
212 display the cyclictest results on Grafana need to be created by following the `Grafana-procedure`_
213 and then pushed into `yardstick-repo`_\
215 - Grafana can be accessed at `Login`_ using credentials opnfv/opnfv and used for visualizing the
216 collected test data as shown in `Visual`_\
219 .. figure:: images/Dashboard-screenshot-1.png
220 :name: dashboard-screenshot-1
224 .. figure:: images/Dashboard-screenshot-2.png
225 :name: dashboard-screenshot-2
229 .. _Influxdb: https://git.opnfv.org/cgit/yardstick/tree/yardstick/dispatcher/influxdb.py
231 .. _Visual: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest
233 .. _Login: http://testresults.opnfv.org/grafana/login
235 .. _Grafana-procedure: https://wiki.opnfv.org/display/yardstick/How+to+work+with+grafana+dashboard
237 .. _yardstick-repo: https://git.opnfv.org/cgit/yardstick/tree/dashboard/KVMFORNFV-Cyclictest
239 .. _GrafanaDoc: http://docs.grafana.org/
241 Understanding Kvm4nfv Grafana Dashboard
242 ---------------------------------------
244 The Kvm4nfv dashboard found at http://testresults.opnfv.org/ currently supports graphical view of
245 cyclictest. For viewing Kvm4nfv dashboarduse,
249 http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest
251 The login details are:
259 The JSON of the kvmfonfv-cyclictest dashboard can be found at.,
261 $ git clone https://gerrit.opnfv.org/gerrit/yardstick.git
262 $ cd yardstick/dashboard
263 $ cat KVMFORNFV-Cyclictest
265 The Dashboard has four tables, each representing a specific test-type of cyclictest case,
267 - Kvmfornfv_Cyclictest_Idle-Idle
268 - Kvmfornfv_Cyclictest_CPUstress-Idle
269 - Kvmfornfv_Cyclictest_Memorystress-Idle
270 - Kvmfornfv_Cyclictest_IOstress-Idle
274 - For all graphs, X-axis is marked with time stamps, Y-axis with value in microsecond units.
276 **A brief about what each graph of the dashboard represents:**
280 `Idle-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running
281 Idle_Idle test-type of the cyclictest.
282 Idle_Idle implies that no stress is applied on the Host or the Guest.
284 .. _Idle-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=10&fullscreen
286 .. figure:: images/Idle-Idle.png
287 :name: Idle-Idle graph
291 2. CPU_Stress-Idle Graph
292 ~~~~~~~~~~~~~~~~~~~~~~~~~
293 `Cpu_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by
294 running Cpu-stress_Idle test-type of the cyclictest. Cpu-stress_Idle implies that CPU stress is
295 applied on the Host and no stress on the Guest.
297 .. _Cpu_stress-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=11&fullscreen
299 .. figure:: images/Cpustress-Idle.png
300 :name: cpustress-idle graph
304 3. Memory_Stress-Idle Graph
305 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
306 `Memory_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by
307 running Memory-stress_Idle test-type of the Cyclictest. Memory-stress_Idle implies that Memory
308 stress is applied on the Host and no stress on the Guest.
310 .. _Memory_Stress-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=12&fullscreen
312 .. figure:: images/Memorystress-Idle.png
313 :name: memorystress-idle graph
317 4. IO_Stress-Idle Graph
318 ~~~~~~~~~~~~~~~~~~~~~~~~~
319 `IO_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running
320 IO-stress_Idle test-type of the Cyclictest. IO-stress_Idle implies that IO stress is applied on the
321 Host and no stress on the Guest.
323 .. _IO_Stress-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=13&fullscreen
325 .. figure:: images/IOstress-Idle.png
326 :name: iostress-idle graph
330 Packet Forwarding Results
331 ~~~~~~~~~~~~~~~~~~~~~~~~~
333 Understanding Kvm4nfv Grafana Dashboard
334 ---------------------------------------
336 The Kvm4nfv dashboard found at http://testresults.opnfv.org/grafana/ currently supports graphical
337 view of packet forwarding as well. For viewing Kvm4nfv packet forwarding dashboard use,
341 http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-packet-forwarding
343 The login details are:
351 The JSON of the KVMFORNFV-Packet-Forwarding dashboard can be found at.,
353 $ git clone https://gerrit.opnfv.org/gerrit/yardstick.git
354 $ cd yardstick/dashboard
355 $ cat KVMFORNFV-Packet-Forwarding
357 The Dashboard has five tables for each specific test of packet forwarding, one for each frame size.
359 - KVM4NFV-PHY2PHY-TPUT-OVS_WITH_DPDK_AND_VHOST_USER
360 - KVM4NFV-PVP-TPUT-OVS_WITH_DPDK_AND_VHOST_USER
361 - KVM4NFV-PVP-TPUT-SRIOV
362 - KVM4NFV-PVVP-TPUT-OVS_WITH_DPDK_AND_VHOST_USER
363 - KVM4NFV-PVVP-TPUT-OVS_WITH_DPDK_AND_VHOST_USER
367 - For all graphs, X-axis is marked with time stamps, Y-axis with value in microsecond units.
371 The future work will include adding new tables to packet forwarding Grafana dashboard to publish the
372 results of new packet forwarding test cases to be added if any.