Merge pull request #2045 from rubenk/fix-readme
authorRuben Kerkhof <ruben@rubenkerkhof.com>
Tue, 3 Apr 2018 21:28:03 +0000 (23:28 +0200)
committerGitHub <noreply@github.com>
Tue, 3 Apr 2018 21:28:03 +0000 (23:28 +0200)
README: do not point users to non-existing file

1  2 
README

diff --combined README
--- 1/README
--- 2/README
+++ b/README
@@@ -100,9 -100,6 +100,9 @@@ Feature
        Collect DPDK interface statistics.
        See docs/BUILD.dpdkstat.md for detailed build instructions.
  
 +      This plugin should be compiled with compiler defenses enabled, for
 +      example -fstack-protector.
 +
      - drbd
        Collect individual drbd resource statistics.
  
        hugepages can be found here:
        https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt.
  
 +      This plugin should be compiled with compiler defenses enabled, for
 +      example -fstack-protector.
 +
 +    - intel_pmu
 +      The intel_pmu plugin reads performance counters provided by the Linux
 +      kernel perf interface. The plugin uses jevents library to resolve named
 +      events to perf events and access perf interface.
 +
      - intel_rdt
        The intel_rdt plugin collects information provided by monitoring features
        of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
        Queries very detailed usage statistics from wireless LAN adapters and
        interfaces that use the Atheros chipset and the MadWifi driver.
  
 -    - md
 -      Linux software-RAID device information (number of active, failed, spare
 -      and missing disks).
 -
      - mbmon
        Motherboard sensors: temperature, fan speed and voltage information,
        using mbmon(1).
  
 +    - mcelog
 +      Monitor machine check exceptions (hardware errors detected by hardware
 +      and reported to software) reported by mcelog and generate appropriate
 +      notifications when machine check exceptions are detected.
 +
 +    - md
 +      Linux software-RAID device information (number of active, failed, spare
 +      and missing disks).
 +
      - memcachec
        Query and parse data from a memcache daemon (memcached).
  
  
      - netapp
        Plugin to query performance values from a NetApp storage system using the
 -      “Manage ONTAP” SDK provided by NetApp.
 +      “Manage ONTAP” SDK provided by NetApp.
  
      - netlink
        Very detailed Linux network interface and routing statistics. You can get
        plugin of choice for that.
  
      - nfs
 -      NFS Procedures: Which NFS command were called how often. Only NFSv2 and
 -      NFSv3 right now.
 +      NFS Procedures: Which NFS command were called how often.
  
      - nginx
        Collects statistics from `nginx' (speak: engine X), a HTTP and mail
      - oracle
        Query data from an Oracle database.
  
 +    - ovs_events
 +      The plugin monitors the link status of Open vSwitch (OVS) connected
 +      interfaces, dispatches the values to collectd and sends the notification
 +      whenever the link state change occurs in the OVS database. It requires
 +      YAJL library to be installed.
 +      Detailed instructions for installing and setting up Open vSwitch, see
 +      OVS documentation.
 +      <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
 +
 +    - ovs_stats
 +      The plugin collects the statistics of OVS connected bridges and
 +      interfaces. It requires YAJL library to be installed.
 +      Detailed instructions for installing and setting up Open vSwitch, see
 +      OVS documentation.
 +      <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
 +
      - perl
        The perl plugin implements a Perl-interpreter into collectd. You can
        write your own plugins in Perl and return arbitrary values using this
        updates to the files and write a bunch of updates at once, which lessens
        system load a lot.
  
 +    - snmp_agent
 +      Receives and handles queries from SNMP master agent and returns the data
 +      collected by read plugins. Handles requests only for OIDs specified in
 +      configuration file. To handle SNMP queries the plugin gets data from
 +      collectd and translates requested values from collectd's internal format
 +      to SNMP format.
 +
      - unixsock
        One can query the values from the unixsock plugin whenever they're
        needed. Please read collectd-unixsock(5) for a description on how that's
      - write_mongodb
        Sends data to MongoDB, a NoSQL database.
  
 +    - write_prometheus
 +      Publish values using an embedded HTTP server, in a format compatible
 +      with Prometheus' collectd_exporter.
 +
      - write_redis
        Sends the values to a Redis key-value database server.
  
@@@ -788,6 -746,10 +788,6 @@@ Prerequisite
      Used by the `gps' plugin.
      <http://developer.berlios.de/projects/gpsd/>
  
 -  * libhal (optional)
 -    If present, the `uuid' plugin will check for UUID from HAL.
 -    <http://hal.freedesktop.org/>
 -
    * libi2c-dev (optional)
      Used for the plugin `barometer', provides just the i2c-dev.h header file
      for user space i2c development.
      For querying iptables counters.
      <http://netfilter.org/>
  
 +  * libjevents (optional)
 +    The jevents library is used by the `intel_pmu' plugin to access the Linux
 +    kernel perf interface.
 +    Note: the library should be build with -fPIC flag to be linked with
 +    intel_pmu shared object correctly.
 +    <https://github.com/andikleen/pmu-tools>
 +
    * libjvm (optional)
      Library that encapsulates the `Java Virtual Machine' (JVM). This library is
      used by the `java' plugin to execute Java bytecode.
      Used by the `memcachec' plugin to connect to a memcache daemon.
      <http://tangent.org/552/libmemcached.html>
  
 +  * libmicrohttpd (optional)
 +    Used by the write_prometheus plugin to run an http daemon.
 +    <http://www.gnu.org/software/libmicrohttpd/>
 +
    * libmnl (optional)
      Used by the `netlink' plugin.
      <http://www.netfilter.org/projects/libmnl/>
      This library is part of the “Manage ONTAP SDK” published by NetApp.
  
    * libnetsnmp (optional)
 -    For the `snmp' plugin.
 +    For the `snmp' and 'snmp_agent' plugins.
 +    <http://www.net-snmp.org/>
 +
 +  * libnetsnmpagent (optional)
 +    Required for the 'snmp_agent' plugin.
      <http://www.net-snmp.org/>
  
    * libnotify (optional)
      <http://www.xmms.org/>
  
    * libyajl (optional)
 -    Parse JSON data. This is needed for the `ceph', `curl_json' and
 -    `log_logstash' plugins.
 +    Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events',
 +    'ovs_stats' and `log_logstash' plugins.
      <http://github.com/lloyd/yajl>
  
    * libvarnish (optional)
@@@ -987,9 -934,8 +987,8 @@@ Configuring / Compiling / Installin
  ------------------------------------
  
    To configure, build and install collectd with the default settings, run
-   `./configure && make && make install'.  For detailed, generic instructions
-   see INSTALL. For a complete list of configure options and their description,
-   run `./configure --help'.
+   `./configure && make && make install'.  For a complete list of configure
+   options and their description, run `./configure --help'.
  
    By default, the configure script will check for all build dependencies and
    disable all plugins whose requirements cannot be fulfilled (any other plugin
@@@ -1026,6 -972,7 +1025,6 @@@ To generate the `configure` script, you
  - flex
  - bison
  - libtool
 -- libtool-ltdl
  - pkg-config
  
  The `build.sh' script takes no arguments.