diff options
authorMaryam Tahhan <>2016-08-14 12:21:34 +0100
committerMaryam Tahhan <>2016-08-14 12:46:02 +0100
commit32a7428ae0c68d02db255e42a921445d2d440ff4 (patch)
parent87a527a3a62d486e950dbc7a358a4678c0e18b18 (diff)
docs: add userguide
Add a userguide that describes the SFQM features. JIRA: DOCS-106 Change-Id: Icd57e7353bc813ed42fa295dee907b3c67f4fb93 Signed-off-by: Maryam Tahhan <>
-rw-r--r--docs/userguide/collectd.userguide.rst (renamed from docs/requirements/02-measuring_telco_traffic_and_performance_KPIs.rst)17
-rw-r--r--docs/userguide/dpdk_ka.png (renamed from docs/requirements/dpdk_ka.png)bin100808 -> 100808 bytes
-rw-r--r--docs/userguide/keepalive.userguide.rst (renamed from docs/requirements/03-dpdk_ka.rst)8
-rw-r--r--docs/userguide/monitoring_interfaces.png (renamed from docs/requirements/monitoring_interfaces.png)bin94097 -> 94097 bytes
-rw-r--r--docs/userguide/stats_and_timestamps.png (renamed from docs/requirements/stats_and_timestamps.png)bin52193 -> 52193 bytes
8 files changed, 36 insertions, 12 deletions
diff --git a/docs/index.rst b/docs/index.rst
index d9d557f..5f0aae4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,4 +25,5 @@ Table of Contents:
+ userguide/index.rst
diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst
index a58b103..a9be153 100644
--- a/docs/requirements/index.rst
+++ b/docs/requirements/index.rst
@@ -7,6 +7,3 @@
- 02-measuring_telco_traffic_and_performance_KPIs.rst
- 03-dpdk_ka.rst
- 04-release_b.rst
diff --git a/docs/requirements/02-measuring_telco_traffic_and_performance_KPIs.rst b/docs/userguide/collectd.userguide.rst
index 7f0d486..0755fdf 100644
--- a/docs/requirements/02-measuring_telco_traffic_and_performance_KPIs.rst
+++ b/docs/userguide/collectd.userguide.rst
@@ -2,8 +2,15 @@
.. (c) OPNFV, Intel Corporation and others.
+collectd plugins description
+The SFQM collectd plugins enable the ability to monitor DPDK interfaces by
+exposing stats and the relevant events to higher level telemetry and fault
+management applications. The following sections will discuss the SFQM features
+in detail.
Measuring Telco Traffic and Performance KPIs
This section will discuss the SFQM features that enable Measuring Telco Traffic
and Performance KPIs.
@@ -32,7 +39,7 @@ and Performance KPIs.
value pairs, improving the overall performance of the API.
Monitoring DPDK interfaces
With the features SFQM enabled in DPDK to enable measuring Telco traffic and
performance KPIs, we can now retrieve NIC statistics including error stats and
relay them to a DPDK user. The next step is to enable monitoring of the DPDK
@@ -41,7 +48,7 @@ the information to a higher level Fault Management entity. To enable this SFQM
has been enabling a number of plugins for collectd.
collectd is a daemon which collects system performance statistics periodically
and provides a variety of mechanisms to publish the collected metrics. It
supports more than 90 different input and output plugins. Input plugins retrieve
@@ -49,8 +56,8 @@ metrics and publish them to the collectd deamon, while output plugins publish
the data they receive to an end point. collectd also has infrastructure to
support thresholding and notification.
-Statistics and Notifications
+collectd statistics and Notifications
Within collectd notifications and performance data are dispatched in the same
way. There are producer plugins (plugins that create notifications/metrics),
and consumer plugins (plugins that receive notifications/metrics and do
diff --git a/docs/requirements/dpdk_ka.png b/docs/userguide/dpdk_ka.png
index 4a45e10..4a45e10 100644
--- a/docs/requirements/dpdk_ka.png
+++ b/docs/userguide/dpdk_ka.png
Binary files differ
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644
index 0000000..994f63c
--- /dev/null
+++ b/docs/userguide/index.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+ ..
+ .. (c) <optionally add copywriters name>
+SFQM user guide
+.. The feature user guide should provide an OPNFV user with enough information to
+ .. use the features provided by the feature project in the supported scenarios.
+ .. This guide should walk a user through the usage of the features once a scenario
+ .. has been deployed and is active according to the installation guide provided
+ .. by the installer project.
+.. toctree::
+ :maxdepth: 3
+ collectd.userguide.rst
+ keepalive.userguide.rst
diff --git a/docs/requirements/03-dpdk_ka.rst b/docs/userguide/keepalive.userguide.rst
index ce3e7e4..4b6e990 100644
--- a/docs/requirements/03-dpdk_ka.rst
+++ b/docs/userguide/keepalive.userguide.rst
@@ -2,8 +2,8 @@
.. (c) OPNFV, Intel Corporation and others.
-DPDK Keep Alive Overview
+DPDK Keep Alive description
SFQM aims to enable fault detection within DPDK, the very first feature to
meet this goal is the DPDK Keep Alive Sample app that is part of DPDK 2.2.
@@ -29,7 +29,7 @@ detection and notification.
heartbeat mechanism.
DPDK Keep Alive Sample App Internals
This section provides some explanation of the The Keep-Alive/'Liveliness'
conceptual scheme as well as the DPDK Keep Alive App. The initialization and
run-time paths are very similar to those of the L2 forwarding application (see
@@ -51,7 +51,7 @@ The Keep-Alive/'Liveliness' conceptual scheme is:
to monitor the Keep Alive Monitor Agent Core.
DPDK Keep Alive Sample App Code Internals
The following section provides some explanation of the code aspects that are
specific to the Keep Alive sample application.
diff --git a/docs/requirements/monitoring_interfaces.png b/docs/userguide/monitoring_interfaces.png
index e57c4aa..e57c4aa 100644
--- a/docs/requirements/monitoring_interfaces.png
+++ b/docs/userguide/monitoring_interfaces.png
Binary files differ
diff --git a/docs/requirements/stats_and_timestamps.png b/docs/userguide/stats_and_timestamps.png
index 84aef72..84aef72 100644
--- a/docs/requirements/stats_and_timestamps.png
+++ b/docs/userguide/stats_and_timestamps.png
Binary files differ