Merge "docs: update userguide with merged plugins"
authorAaron Smith <aasmith@redhat.com>
Mon, 20 Nov 2017 18:11:45 +0000 (18:11 +0000)
committerGerrit Code Review <gerrit@opnfv.org>
Mon, 20 Nov 2017 18:11:45 +0000 (18:11 +0000)
1  2 
docs/release/userguide/feature.userguide.rst

@@@ -471,7 -471,7 +471,7 @@@ https://github.com/collectd/collectd/bl
  
  IPMI Plugin
  ^^^^^^^^^^^^
- Repo: https://github.com/maryamtahhan/collectd
+ Repo: https://github.com/collectd/collectd
  
  Branch: feat_ipmi_events, feat_ipmi_analog
  
@@@ -543,16 -543,13 +543,13 @@@ Clone and install the collectd IPMI plu
  
  .. code:: bash
  
-     $ git clone  https://github.com/maryamtahhan/collectd
+     $ git clone https://github.com/collectd/collectd
      $ cd collectd
-     $ git checkout $BRANCH
      $ ./build.sh
      $ ./configure --enable-syslog --enable-logfile --enable-debug
      $ make
      $ sudo make install
  
- Where $BRANCH is feat_ipmi_events or feat_ipmi_analog.
  This will install collectd to default folder ``/opt/collectd``. The collectd
  configuration file (``collectd.conf``) can be found at ``/opt/collectd/etc``.
  To configure the IPMI plugin you need to modify the file to include:
  
      LoadPlugin ipmi
      <Plugin ipmi>
-        SELEnabled true # only feat_ipmi_events branch supports this
+        <Instance "local">
+          SELEnabled true # only feat_ipmi_events branch supports this
+        </Instance>
      </Plugin>
  
  .. note::
    dispatch the values to collectd and send SEL notifications.
  
  For more information on the IPMI plugin parameters and SEL feature configuration,
- please see:
- https://github.com/maryamtahhan/collectd/blob/feat_ipmi_events/src/collectd.conf.pod
+ please see: https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
  
  Extended analog sensors support doesn't require additional configuration. The usual
  collectd IPMI documentation can be used:
@@@ -660,7 -658,7 +658,7 @@@ Clone and install the collectd mcelog p
  
  .. code:: bash
  
-     $ git clone  https://github.com/maryamtahhan/collectd
+     $ git clone https://github.com/collectd/collectd
      $ cd collectd
      $ ./build.sh
      $ ./configure --enable-syslog --enable-logfile --enable-debug
@@@ -678,11 -676,15 +676,15 @@@ include
        Interval 1
      </LoadPlugin>
      <Plugin mcelog>
-        McelogClientSocket "/var/run/mcelog-client"
+       <Memory>
+         McelogClientSocket "/var/run/mcelog-client"
+         PersistentNotification false
+       </Memory>
+       #McelogLogfile "/var/log/mcelog"
      </Plugin>
  
  For more information on the plugin parameters, please see:
- https://github.com/maryamtahhan/collectd/blob/feat_ras/src/collectd.conf.pod
+ https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
  
  Simulating a Machine Check Exception can be done in one of 3 ways:
  
@@@ -712,7 -714,6 +714,7 @@@ Then you can run the mcelog test suite 
  This will inject different classes of errors and check that the mcelog triggers
  runs. There will be some kernel messages about page offlining attempts. The
  test will also lose a few pages of memory in your system (not significant).
 +
  .. note::
    This test will kill any running mcelog, which needs to be restarted
    manually afterwards.
@@@ -891,7 -892,7 +893,7 @@@ ovs_pmd_stat.sh calls the script for OV
  
  SNMP Agent Plugin
  ^^^^^^^^^^^^^^^^^
- Repo: https://github.com/maryamtahhan/collectd/
+ Repo: https://github.com/collectd/collectd
  
  Branch: master
  
@@@ -986,9 -987,8 +988,8 @@@ Clone and install the collectd snmp_age
  .. code:: bash
  
      $ cd ~
-     $ git clone https://github.com/maryamtahhan/collectd
+     $ git clone https://github.com/collectd/collectd
      $ cd collectd
-     $ git checkout feat_snmp
      $ ./build.sh
      $ ./configure --enable-syslog --enable-logfile --enable-debug --enable-snmp --with-libnetsnmp
      $ make
@@@ -1032,16 -1032,14 +1033,16 @@@ The ``snmpwalk`` command can be used t
    retreived using standard IF-MIB tables.
  
  For more information on the plugin parameters, please see:
- https://github.com/maryamtahhan/collectd/blob/feat_snmp/src/collectd.conf.pod
+ https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
  
  For more details on AgentX subagent, please see:
  http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/
  
 +.. _virt-plugin:
 +
  virt plugin
  ^^^^^^^^^^^^
- Repo: https://github.com/maryamtahhan/collectd
+ Repo: https://github.com/collectd/collectd
  
  Branch: master
  
@@@ -1172,10 -1170,8 +1173,10 @@@ statistics are disabled. They can be en
      </Plugin>
  
  For more information on the plugin parameters, please see:
- https://github.com/maryamtahhan/collectd/blob/feat_libvirt_upstream/src/collectd.conf.pod
+ https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
  
 +.. _install-collectd-as-a-service:
 +
  Installing collectd as a service
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  **NOTE**: In an OPNFV installation, collectd is installed and configured as a
@@@ -1212,9 -1208,9 +1213,9 @@@ Reloa
  Additional useful plugins
  ^^^^^^^^^^^^^^^^^^^^^^^^^^
  
 -* **Exec Plugin** : Can be used to show you when notifications are being
 - generated by calling a bash script that dumps notifications to file. (handy
 - for debug). Modify /opt/collectd/etc/collectd.conf:
 +**Exec Plugin** : Can be used to show you when notifications are being
 +generated by calling a bash script that dumps notifications to file. (handy
 +for debug). Modify /opt/collectd/etc/collectd.conf:
  
  .. code:: bash