X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;ds=sidebyside;f=README;h=e8f0ca1e2aefddc8f6f497ec4fc03901cdc39b22;hb=afb38f31abd27d5b4ce08023f8bbbaeeb353c55f;hp=3e2c0233adc3ea9ccfbcbbf072c107a0f6dcbd5b;hpb=1fc00932fd49fa535551cc4bba09c4e4be059ab4;p=collectd.git
diff --git a/README b/README
index 3e2c0233..e8f0ca1e 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
collectd - System information collection daemon
=================================================
-http://collectd.org/
+https://collectd.org/
About
-----
@@ -51,6 +51,9 @@ Features
- cgroups
CPU accounting information for process groups under Linux.
+ - chrony
+ Chrony daemon statistics: Local clock drift, offset to peers, etc.
+
- conntrack
Number of nf_conntrack entries.
@@ -64,6 +67,9 @@ Features
- cpufreq
CPU frequency (For laptops with speed step or a similar technology)
+ - cpusleep
+ CPU sleep: Time spent in suspend (For mobile devices which enter suspend automatically)
+
- curl
Parse statistics from websites using regular expressions.
@@ -119,9 +125,20 @@ Features
- gmond
Receive multicast traffic from Ganglia instances.
+ - gps
+ Monitor gps related data through gpsd.
+
+ - grpc
+ Receive values over the network using the gRPC framework.
+
- hddtemp
Hard disk temperatures using hddtempd.
+ - hugepages
+ Report the number of used and free hugepages. More info on
+ hugepages can be found here:
+ https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt.
+
- interface
Interface traffic: Number of octets, packets and errors for each
interface.
@@ -156,6 +173,12 @@ Features
Detailed CPU statistics of the âLogical Partitionsâ virtualization
technique built into IBM's POWER processors.
+ - lua
+ The Lua plugin implements a Lua interpreter into collectd. This
+ makes it possible to write plugins in Lua which are executed by
+ collectd without the need to start a heavy interpreter every interval.
+ See collectd-lua(5) for details.
+
- lvm
Size of âLogical Volumesâ (LV) and âVolume Groupsâ (VG) of Linux'
âLogical Volume Managerâ (LVM).
@@ -191,6 +214,9 @@ Features
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'.
@@ -379,12 +405,19 @@ Features
- wireless
Link quality of wireless cards. Linux only.
+ - xencpu
+ XEN Hypervisor CPU stats.
+
- xmms
Bitrate and frequency of music played with XMMS.
- zfs_arc
Statistics for ZFS' âAdaptive Replacement Cacheâ (ARC).
+ - zone
+ Measures the percentage of cpu load per container (zone) under Solaris 10
+ and higher
+
- zookeeper
Read data from Zookeeper's MNTR command.
@@ -400,6 +433,10 @@ Features
diskspace but is extremely portable and can be analysed with almost
every program that can analyse anything. Even Microsoft's Excel..
+ - lua
+ It's possible to implement write plugins in Lua using the Lua
+ plugin. See collectd-lua(5) for details.
+
- 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.
@@ -495,6 +532,9 @@ Features
Send an E-mail with the notification message to the configured
recipients.
+ - notify_nagios
+ Submit notifications as passive check results to a local nagios instance.
+
- exec
Execute a program or script to handle the notification.
See collectd-exec(5).
@@ -669,10 +709,19 @@ Prerequisites
Used by the `gmond' plugin to process data received from Ganglia.
+ * libgrpc (optional)
+ Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
+ C++11 standard.
+
+
* libgcrypt (optional)
Used by the `network' plugin for encryption and authentication.
+ * libgps (optional)
+ Used by the `gps' plugin.
+
+
* libhal (optional)
If present, the `uuid' plugin will check for UUID from HAL.
@@ -695,6 +744,10 @@ Prerequisites
Used by the `openldap' plugin.
+ * liblua (optional)
+ Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
+
+
* liblvm2 (optional)
Used by the `lvm' plugin.
@@ -758,14 +811,18 @@ Prerequisites
The PostgreSQL C client library used by the `postgresql' plugin.
+ * 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-c, protoc-c (optional)
Used by the `pinba' plugin to generate a parser for the network packets
- sent by the Pinba PHP extension, and by the `write_riemann' plugin to
- generate events to be sent to a Riemann server.
+ sent by the Pinba PHP extension.
* libpython (optional)
- Used by the `python' plugin. Currently, Python 2.3 and later and Python 3
+ Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
are supported.
@@ -823,6 +880,10 @@ Prerequisites
`virt' plugins.
+ * libxen (optional)
+ Used by the `xencpu' plugin.
+
+
* libxmms (optional)
@@ -836,6 +897,10 @@ Prerequisites
`varnish' plugin.
+ * riemann-c-client (optional)
+ For the `write_riemann' plugin.
+
+
Configuring / Compiling / Installing
------------------------------------
@@ -889,18 +954,19 @@ Configuring with libjvm
library checks succeed.
If this doesn't work for you, you have the possibility to specify CPP-flags,
- C-flags and LD-flags for the âJavaâ plugin by hand, using the following three
- (environment) variables:
+ C-flags, LD-flags and LIBS for the âJavaâ plugin by hand, using the
+ following environment variables:
- JAVA_CPPFLAGS
- JAVA_CFLAGS
- JAVA_LDFLAGS
+ - JAVA_LIBS
For example (shortened for demonstration purposes):
./configure JAVA_CPPFLAGS="-I$JAVA_HOME/include -I$JAVA_HOME/include/linux"
- Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to
+ Adding "-ljvm" to JAVA_LIBS is done automatically, you don't have to
do that.
Generating the configure script
@@ -917,6 +983,7 @@ To generate the `configure` script, you'll need the following dependencies:
- bison
- libtool
- libtool-ltdl
+- pkg-config
The `build.sh' script takes no arguments.
@@ -969,6 +1036,5 @@ Author
Sebastian tokkee Harl ,
and many contributors (see `AUTHORS').
- Please send bug reports and patches to the mailing list, see `Contact'
- above.
-
+ Please use GitHub reporting bugs and submitting pull requests.
+ See CONTRIBUTING.md for details.