apache plugin: modernize the code a bit

[collectd.git] / README

diff --git a/README b/README
index b0b5921..43df03b 100644 (file)
--- a/README
+++ b/README
@@ -100,6 +100,9 @@ Features
       Collect DPDK interface statistics.
       See docs/BUILD.dpdkstat.md for detailed build instructions.
 
       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.
 
     - drbd
       Collect individual drbd resource statistics.
 


@@ -140,6 +143,14 @@ Features
       hugepages can be found here:
       https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt.
 
       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
     - intel_rdt
       The intel_rdt plugin collects information provided by monitoring features
       of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring


@@ -240,7 +251,7 @@ Features
 
     - netapp
       Plugin to query performance values from a NetApp storage system using the
 
     - 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
 
     - netlink
       Very detailed Linux network interface and routing statistics. You can get


@@ -253,8 +264,7 @@ Features
       plugin of choice for that.
 
     - nfs
       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
 
     - nginx
       Collects statistics from `nginx' (speak: engine X), a HTTP and mail


@@ -786,6 +796,13 @@ Prerequisites
     For querying iptables counters.
     <http://netfilter.org/>
 
     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.
   * libjvm (optional)
     Library that encapsulates the `Java Virtual Machine' (JVM). This library is
     used by the `java' plugin to execute Java bytecode.


@@ -970,9 +987,8 @@ Configuring / Compiling / Installing
 ------------------------------------
 
   To configure, build and install collectd with the default settings, run
 ------------------------------------
 
   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
 
   By default, the configure script will check for all build dependencies and
   disable all plugins whose requirements cannot be fulfilled (any other plugin