write_prometheus plugin: Only use SOCK_CLOEXEC if it is defined.

[collectd.git] / README

diff --git a/README b/README
index 15adbf0..803fbaa 100644 (file)
--- a/README
+++ b/README
@@ -96,7 +96,7 @@ Features
       DNS traffic: Query types, response codes, opcodes and traffic/octets
       transferred.
 
       DNS traffic: Query types, response codes, opcodes and traffic/octets
       transferred.
 

-    - dpdk
+    - dpdkstat

       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.
 


@@ -132,9 +132,6 @@ Features
     - gps
       Monitor gps related data through gpsd.
 
     - gps
       Monitor gps related data through gpsd.
 

-    - grpc
-      Send and receive values over the network using the gRPC framework.
-

     - hddtemp
       Hard disk temperatures using hddtempd.
 
     - hddtemp
       Hard disk temperatures using hddtempd.
 


@@ -143,6 +140,15 @@ 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.
 

+    - intel_rdt
+      The intel_rdt plugin collects information provided by monitoring features
+      of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
+      Technology (CMT), Memory Bandwidth Monitoring (MBM). These features
+      provide information about utilization of shared resources like last level
+      cache occupancy, local memory bandwidth usage, remote memory bandwidth
+      usage, instructions per clock.
+      <https://01.org/packet-processing/cache-monitoring-technology-memory-bandwidth-monitoring-cache-allocation-technology-code-and-data>
+

     - interface
       Interface traffic: Number of octets, packets and errors for each
       interface.
     - interface
       Interface traffic: Number of octets, packets and errors for each
       interface.


@@ -192,14 +198,14 @@ Features
       Queries very detailed usage statistics from wireless LAN adapters and
       interfaces that use the Atheros chipset and the MadWifi driver.
 
       Queries very detailed usage statistics from wireless LAN adapters and
       interfaces that use the Atheros chipset and the MadWifi driver.
 

-    - mbmon
-      Motherboard sensors: temperature, fan speed and voltage information,
-      using mbmon(1).
-

     - md
       Linux software-RAID device information (number of active, failed, spare
       and missing disks).
 
     - 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).
+

     - memcachec
       Query and parse data from a memcache daemon (memcached).
 
     - memcachec
       Query and parse data from a memcache daemon (memcached).
 


@@ -219,9 +225,6 @@ Features
       Reads values from Modbus/TCP enabled devices. Supports reading values
       from multiple "slaves" so gateway devices can be used.
 
       Reads values from Modbus/TCP enabled devices. Supports reading values
       from multiple "slaves" so gateway devices can be used.
 

-    - mqtt
-      Publishes and subscribes to MQTT topics.
-

     - multimeter
       Information provided by serial multimeters, such as the `Metex
       M-4650CR'.
     - multimeter
       Information provided by serial multimeters, such as the `Metex
       M-4650CR'.


@@ -400,7 +403,7 @@ Features
       CPU, memory, disk and network I/O statistics from virtual machines.
 
     - vmem
       CPU, memory, disk and network I/O statistics from virtual machines.
 
     - vmem

-      Virtual memory statistics, e. g. the number of page-ins/-outs or the
+      Virtual memory statistics, e.g. the number of page-ins/-outs or the

       number of pagefaults.
 
     - vserver
       number of pagefaults.
 
     - vserver


@@ -438,10 +441,16 @@ Features
       diskspace but is extremely portable and can be analysed with almost
       every program that can analyse anything. Even Microsoft's Excel..
 
       diskspace but is extremely portable and can be analysed with almost
       every program that can analyse anything. Even Microsoft's Excel..
 

+    - grpc
+      Send and receive values over the network using the gRPC framework.
+

     - lua
       It's possible to implement write plugins in Lua using the Lua
       plugin. See collectd-lua(5) for details.
 
     - lua
       It's possible to implement write plugins in Lua using the Lua
       plugin. See collectd-lua(5) for details.
 

+    - mqtt
+      Publishes and subscribes to MQTT topics.
+

     - network
       Send the data to a remote host to save the data somehow. This is useful
       for large setups where the data should be saved by a dedicated machine.
     - network
       Send the data to a remote host to save the data somehow. This is useful
       for large setups where the data should be saved by a dedicated machine.


@@ -491,6 +500,10 @@ Features
     - write_mongodb
       Sends data to MongoDB, a NoSQL database.
 
     - 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.
 
     - write_redis
       Sends the values to a Redis key-value database server.
 


@@ -771,6 +784,10 @@ Prerequisites
     Used by the `memcachec' plugin to connect to a memcache daemon.
     <http://tangent.org/552/libmemcached.html>
 
     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/>
   * libmnl (optional)
     Used by the `netlink' plugin.
     <http://www.netfilter.org/projects/libmnl/>


@@ -826,6 +843,11 @@ Prerequisites
     The PostgreSQL C client library used by the `postgresql' plugin.
     <http://www.postgresql.org/>
 
     The PostgreSQL C client library used by the `postgresql' plugin.
     <http://www.postgresql.org/>
 

+  * libpqos (optional)
+    The PQoS library for Intel(R) Resource Director Technology used by the
+    `intel_rdt' plugin.
+    <https://github.com/01org/intel-cmt-cat>
+

   * libprotobuf, protoc 3.0+ (optional)
     Used by the `grpc' plugin to generate service stubs and code to handle
     network packets of collectd's protobuf-based network protocol.
   * libprotobuf, protoc 3.0+ (optional)
     Used by the `grpc' plugin to generate service stubs and code to handle
     network packets of collectd's protobuf-based network protocol.


@@ -964,6 +986,7 @@ To generate the `configure` script, you'll need the following dependencies:
 
 The `build.sh' script takes no arguments.
 
 
 The `build.sh' script takes no arguments.
 

+

 Crosscompiling
 --------------
 
 Crosscompiling
 --------------
 


@@ -994,11 +1017,16 @@ Crosscompiling
     * `endianflip' (12345678 -> 87654321)
     * `intswap'    (12345678 -> 56781234)
 
     * `endianflip' (12345678 -> 87654321)
     * `intswap'    (12345678 -> 56781234)
 

+

 Contact
 -------
 
 Contact
 -------
 

-  For questions, bug reports, development information and basically all other
-  concerns please send an email to collectd's mailing list at
+  Please use GitHub to report bugs and submit pull requests:
+  <https://github.com/collectd/collectd/>.
+  See CONTRIBUTING.md for details.
+
+  For questions, development information and basically all other concerns please
+  send an email to collectd's mailing list at

   <list at collectd.org>.
 
   For live discussion and more personal contact visit us in IRC, we're in
   <list at collectd.org>.
 
   For live discussion and more personal contact visit us in IRC, we're in


@@ -1012,5 +1040,3 @@ Author
   Sebastian tokkee Harl <sh at tokkee.org>,
   and many contributors (see `AUTHORS').
 
   Sebastian tokkee Harl <sh at tokkee.org>,
   and many contributors (see `AUTHORS').
 

-  Please use GitHub reporting bugs and submitting pull requests.
-  See CONTRIBUTING.md for details.