docs: adding license to all rst files.
[barometer.git] / docs / requirements / 02-measuring_telco_traffic_and_performance_KPIs.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) OPNFV, Intel Corporation and others.
4
5 Measuring Telco Traffic and Performance KPIs
6 ============================================
7 This section will look at what SFQM has done to enable Measuring Telco Traffic
8 and Performance KPIs.
9
10 .. Figure:: stats_and_timestamps.png
11
12    Measuring Telco Traffic and Performance KPIs
13
14 * The very first thing SFQM enabled was a call-back API in DPDK and an
15   associated application that used the API to demonstrate how to timestamp
16   packets and measure packet latency in DPDK (the sample app is called
17   rxtx_callbacks). This was upstreamed to DPDK 2.0 and is represented by
18   the interfaces 1 and 2 in Figure 1.2.
19
20 * The second thing SFQM implemented in DPDK is the extended NIC statistics API,
21   which exposes NIC stats including error stats to the DPDK user by reading the
22   registers on the NIC. This is represented by interface 3 in Figure 1.2.
23
24   * For DPDK 2.1 this API was only implemented for the ixgbe (10Gb) NIC driver,
25     in association with a sample application that runs as a DPDK secondary
26     process and retrieves the extended NIC stats.
27
28   * For DPDK 2.2 the API was implemented for igb, i40e and all the Virtual
29     Functions (VFs) for all drivers.
30
31 Monitoring DPDK interfaces
32 ===========================
33 With the features SFQM enabled in DPDK to enable measuring Telco traffic and
34 performance KPIs, we can now retrieve NIC statistics including error stats and
35 relay them to a DPDK user. The next step is to enable monitoring of the DPDK
36 interfaces based on the stats that we are retrieving from the NICs, and relay
37 the information to a higher level Fault Management entity. To enable this SFQM
38 has been enabling a number of plugins for collectd.
39
40 collectd is is a daemon which collects system performance statistics periodically
41 and provides mechanisms to store the values in a variety of ways. It supports
42 more than 90 different plugins to retrieve platform information, such as CPU
43 utilization, and is capable of publishing/writing the information is gathers to
44 a number of endpoints through its write plugins.
45
46 SFQM has been enabling two collectd plugins to collect DPDK NIC statistics and
47 push the stats to Ceilometer:
48
49 * dpdkstat plugin: A read plugin that retrieve stats from the DPDK extended NIC
50   stats API.
51 * ceilometer plugin: A write plugin that pushes the retrieved stats to
52   Ceilometer. It's capable of pushing any stats read through collectd to
53   Ceilometer, not just the DPDK stats.
54
55 .. Figure:: monitoring_interfaces.png
56
57    Monitoring Interfaces and Openstack Support
58
59 The figure above shows the DPDK L2 forwarding application running on a compute
60 node, sending and receiving traffic. collectd is also running on this compute
61 node retrieving the stats periodically from DPDK through the dpdkstat plugin
62 and publishing the retrieved stats to Ceilometer through the ceilometer plugin.
63
64 To see this demo in action please checkout: `SFQM OPNFV Summit demo`_
65
66 Future enahancements to the DPDK stats plugin include:
67
68 * Integration of DPDK Keep Alive functionality.
69 * Implementation of the ability to retrieve link status.
70
71 .. _SFQM OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/