Merge "dpdkstat: userguide updated with dpdkstat init notice"
authorMaryam Tahhan <maryam.tahhan@intel.com>
Sun, 26 Mar 2017 16:09:54 +0000 (16:09 +0000)
committerGerrit Code Review <gerrit@opnfv.org>
Sun, 26 Mar 2017 16:09:54 +0000 (16:09 +0000)
1  2 
docs/release/userguide/feature.userguide.rst

@@@ -46,7 -46,7 +46,7 @@@ Barometer has enabled the following col
  * *mcelog plugin*: A read plugin that uses mcelog client protocol to check for
    memory Machine Check Exceptions and sends the stats for reported exceptions
  
 -* *RDT plugin*: A read plugin that provides the last level cache utilitzation and
 +* *RDT plugin*: A read plugin that provides the last level cache utilization and
    memory bandwidth utilization
  
  All the plugins above are available on the collectd master, except for the
@@@ -86,7 -86,7 +86,7 @@@ collectd capabilities and usag
   them as shown in the examples below.
  
   The collectd plugins in OPNFV are configured with reasonable defaults, but can
 - be overriden.
 + be overridden.
  
  Building all Barometer upstreamed plugins from scratch
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@@ -190,9 -190,15 +190,15 @@@ https://github.com/collectd/collectd/bl
   you will need to specify the specific paths to the header files and libraries
   using LIBDPDK_CPPFLAGS and LIBDPDK_LDFLAGS. You will also need to add the DPDK
   library symbols to the shared library path using ldconfig. Note that this
 - update to the shared library path is not persistant (i.e. it will not survive a
 + update to the shared library path is not persistent (i.e. it will not survive a
   reboot).
  
+ .. note:: Plugin initialization time depends on read interval. It requires
+  5 read cycles to set up internal buffers and states. During that time
+  no statistics are submitted. Also if plugin is running and the number of DPDK
+  ports is increased, internal buffers are resized. That requires 3 read cycles
+  and no port statistics are submitted in that time.
  DPDK events plugin
  ^^^^^^^^^^^^^^^^^^^^^^
  Repo: https://github.com/collectd/collectd
@@@ -208,7 -214,7 +214,7 @@@ Building and installing collectd
  
  .. code:: bash
  
 -    $ git clone https://github.com/maryamtahhan/collectd.git
 +    $ git clone https://github.com/collectd/collectd.git
      $ cd collectd
      $ ./build.sh
      $ ./configure --enable-syslog --enable-logfile --enable-debug
@@@ -253,7 -259,7 +259,7 @@@ https://github.com/collectd/collectd/bl
   you will need to specify the specific paths to the header files and libraries
   using LIBDPDK_CPPFLAGS and LIBDPDK_LDFLAGS. You will also need to add the DPDK
   library symbols to the shared library path using ldconfig. Note that this
 - update to the shared library path is not persistant (i.e. it will not survive a
 + update to the shared library path is not persistent (i.e. it will not survive a
   reboot).
  
  .. code:: bash