X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?p=kvmfornfv.git;a=blobdiff_plain;f=docs%2Frelease%2Fuserguide%2Fkvmfornfv.cyclictest-dashboard.userguide.rst;fp=docs%2Frelease%2Fuserguide%2Fkvmfornfv.cyclictest-dashboard.userguide.rst;h=e5be012b63362e4c55b9e03bff86ca0062ce8c27;hp=c119b43c721c7c9fedb23efd75103555043438cb;hb=a3923b36b50dbd842ed1151eb5734ba17348b669;hpb=827627ae5f5674775062ab6a8a31a0ae1bbba7c7 diff --git a/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst b/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst index c119b43c7..e5be012b6 100644 --- a/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst +++ b/docs/release/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst @@ -96,10 +96,11 @@ Three type of dispatcher methods are available to store the cyclictest results. - InfluxDB - HTTP -**1. File**: Default Dispatcher module is file. If the dispatcher module is configured as a file,then the test results are stored in a temporary file yardstick.out -( default path: /tmp/yardstick.out). -Dispatcher module of "Verify Job" is "Default". So,the results are stored in Yardstick.out file for verify job. -Storing all the verify jobs in InfluxDB database causes redundancy of latency values. Hence, a File output format is prefered. +**1. File**: Default Dispatcher module is file. If the dispatcher module is configured as a file, +then the test results are stored in a temporary file yardstick.out(default path: /tmp/yardstick.out). +Dispatcher module of "Verify Job" is "Default". So,the results are stored in Yardstick.out file for +verify job. Storing all the verify jobs in InfluxDB database causes redundancy of latency values. +Hence, a File output format is prefered. .. code:: bash @@ -112,8 +113,9 @@ Storing all the verify jobs in InfluxDB database causes redundancy of latency va max_bytes = 0 backup_count = 0 -**2. Influxdb**: If the dispatcher module is configured as influxdb, then the test results are stored in Influxdb. -Users can check test resultsstored in the Influxdb(Database) on Grafana which is used to visualize the time series data. +**2. Influxdb**: If the dispatcher module is configured as influxdb, then the test results are +stored in Influxdb. Users can check test resultsstored in the Influxdb(Database) on Grafana which is +used to visualizethe time series data. To configure the influxdb, the following content in /etc/yardstick/yardstick.conf need to updated @@ -130,9 +132,11 @@ To configure the influxdb, the following content in /etc/yardstick/yardstick.con username = root password = root -Dispatcher module of "Daily Job" is Influxdb. So, the results are stored in influxdb and then published to Dashboard. +Dispatcher module of "Daily Job" is Influxdb. So, the results are stored in influxdb and then +published to Dashboard. -**3. HTTP**: If the dispatcher module is configured as http, users can check test result on OPNFV testing dashboard which uses MongoDB as backend. +**3. HTTP**: If the dispatcher module is configured as http, users can check test result on OPNFV +testing dashboard which uses MongoDB as backend. .. code:: bash @@ -150,12 +154,14 @@ Dispatcher module of "Daily Job" is Influxdb. So, the results are stored in infl Detailing the dispatcher module in verify and daily Jobs: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -KVM4NFV updates the dispatcher module in the yardstick configuration file(/etc/yardstick/yardstick.conf) depending on the Job type(Verify/Daily). -Once the test is completed, results are published to the respective dispatcher modules. +KVM4NFV updates the dispatcher module in the yardstick configuration (/etc/yardstick/yardstick.conf) +file depending on the Job type(Verify/Daily). Once the test is completed, results are published to +the respective dispatcher modules. Dispatcher module is configured for each Job type as mentioned below. -1. ``Verify Job`` : Default "DISPATCHER_TYPE" i.e. file(/tmp/yardstick.out) is used. User can also see the test results on Jenkins console log. +1. ``Verify Job`` : Default "DISPATCHER_TYPE" i.e. file(/tmp/yardstick.out) is used. User can also +see the test results on Jenkins console log. .. code:: bash @@ -197,14 +203,17 @@ With the help of "influxdb_line_protocol", the json is transformed as a line str -Influxdb api which is already implemented in `Influxdb`_ will post the data in line format into the database. +Influxdb api which is already implemented in `Influxdb`_ will post the data in line format into the +database. ``Displaying Results on Grafana dashboard:`` -- Once the test results are stored in Influxdb, dashboard configuration file(Json) which used to display the cyclictest results -on Grafana need to be created by following the `Grafana-procedure`_ and then pushed into `yardstick-repo`_\ +- Once the test results are stored in Influxdb, dashboard configuration file(Json) which used to +display the cyclictest results on Grafana need to be created by following the `Grafana-procedure`_ +and then pushed into `yardstick-repo`_\ -- Grafana can be accessed at `Login`_ using credentials opnfv/opnfv and used for visualizing the collected test data as shown in `Visual`_\ +- Grafana can be accessed at `Login`_ using credentials opnfv/opnfv and used for visualizing the +collected test data as shown in `Visual`_\ .. figure:: images/Dashboard-screenshot-1.png @@ -232,7 +241,8 @@ on Grafana need to be created by following the `Grafana-procedure`_ and then pus Understanding Kvm4nfv Grafana Dashboard --------------------------------------- -The Kvm4nfv dashboard found at http://testresults.opnfv.org/ currently supports graphical view of cyclictest. For viewing Kvm4nfv dashboarduse, +The Kvm4nfv dashboard found at http://testresults.opnfv.org/ currently supports graphical view of +cyclictest. For viewing Kvm4nfv dashboarduse, .. code:: bash @@ -267,7 +277,8 @@ Note: 1. Idle-Idle Graph ~~~~~~~~~~~~~~~~~~~~ -`Idle-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running Idle_Idle test-type of the cyclictest. +`Idle-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running +Idle_Idle test-type of the cyclictest. Idle_Idle implies that no stress is applied on the Host or the Guest. .. _Idle-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=10&fullscreen @@ -279,8 +290,9 @@ Idle_Idle implies that no stress is applied on the Host or the Guest. 2. CPU_Stress-Idle Graph ~~~~~~~~~~~~~~~~~~~~~~~~~ -`Cpu_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running Cpu-stress_Idle test-type of the cyclictest. -Cpu-stress_Idle implies that CPU stress is applied on the Host and no stress on the Guest. +`Cpu_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by +running Cpu-stress_Idle test-type of the cyclictest. Cpu-stress_Idle implies that CPU stress is +applied on the Host and no stress on the Guest. .. _Cpu_stress-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=11&fullscreen @@ -291,8 +303,9 @@ Cpu-stress_Idle implies that CPU stress is applied on the Host and no stress on 3. Memory_Stress-Idle Graph ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`Memory_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running Memory-stress_Idle test-type of the Cyclictest. -Memory-stress_Idle implies that Memory stress is applied on the Host and no stress on the Guest. +`Memory_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by +running Memory-stress_Idle test-type of the Cyclictest. Memory-stress_Idle implies that Memory +stress is applied on the Host and no stress on the Guest. .. _Memory_Stress-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=12&fullscreen @@ -303,8 +316,9 @@ Memory-stress_Idle implies that Memory stress is applied on the Host and no stre 4. IO_Stress-Idle Graph ~~~~~~~~~~~~~~~~~~~~~~~~~ -`IO_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running IO-stress_Idle test-type of the Cyclictest. -IO-stress_Idle implies that IO stress is applied on the Host and no stress on the Guest. +`IO_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running +IO-stress_Idle test-type of the Cyclictest. IO-stress_Idle implies that IO stress is applied on the +Host and no stress on the Guest. .. _IO_Stress-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=13&fullscreen @@ -313,6 +327,46 @@ IO-stress_Idle implies that IO stress is applied on the Host and no stress on th :width: 100% :align: center +Packet Forwarding Results +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Understanding Kvm4nfv Grafana Dashboard +--------------------------------------- + +The Kvm4nfv dashboard found at http://testresults.opnfv.org/grafana/ currently supports graphical +view of packet forwarding as well. For viewing Kvm4nfv packet forwarding dashboard use, + +.. code:: bash + + http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-packet-forwarding + + The login details are: + + Username: opnfv + Password: opnfv + + +.. code:: bash + + The JSON of the KVMFORNFV-Packet-Forwarding dashboard can be found at., + + $ git clone https://gerrit.opnfv.org/gerrit/yardstick.git + $ cd yardstick/dashboard + $ cat KVMFORNFV-Packet-Forwarding + +The Dashboard has five tables for each specific test of packet forwarding, one for each frame size. + +- KVM4NFV-PHY2PHY-TPUT-OVS_WITH_DPDK_AND_VHOST_USER +- KVM4NFV-PVP-TPUT-OVS_WITH_DPDK_AND_VHOST_USER +- KVM4NFV-PVP-TPUT-SRIOV +- KVM4NFV-PVVP-TPUT-OVS_WITH_DPDK_AND_VHOST_USER +- KVM4NFV-PVVP-TPUT-OVS_WITH_DPDK_AND_VHOST_USER + +Note: + +- For all graphs, X-axis is marked with time stamps, Y-axis with value in microsecond units. + Future Scope -------------- -The future work will include adding the kvmfornfv_Packet-forwarding test results into Grafana and influxdb. +------------ +The future work will include adding new tables to packet forwarding Grafana dashboard to publish the +results of new packet forwarding test cases to be added if any.