X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=README;h=f2df12cdd34c253dc31d15a30533d90204d64ad9;hb=b7ebbd511e7fb9faf40a50904d6634824f5d8e52;hp=6f2fb7247f7342e72c699ea7c674a1e52a119380;hpb=f64a8b0906df8f97fbe91f15a919c76b83f93ba9;p=collectd.git
diff --git a/README b/README
index 6f2fb724..f2df12cd 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,6 +125,12 @@ 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.
@@ -191,6 +203,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,6 +394,9 @@ Features
- wireless
Link quality of wireless cards. Linux only.
+ - xencpu
+ XEN Hypervisor CPU stats.
+
- xmms
Bitrate and frequency of music played with XMMS.
@@ -468,7 +486,7 @@ Features
database.
* Logging is, as everything in collectd, provided by plugins. The following
- plugins keep up informed about what's going on:
+ plugins keep us informed about what's going on:
- logfile
Writes log messages to a file or STDOUT/STDERR.
@@ -499,6 +517,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).
@@ -673,10 +694,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.
@@ -762,10 +792,14 @@ 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)
@@ -827,6 +861,10 @@ Prerequisites
`virt' plugins.
+ * libxen (optional)
+ Used by the `xencpu' plugin.
+
+
* libxmms (optional)
@@ -840,6 +878,10 @@ Prerequisites
`varnish' plugin.
+ * riemann-c-client (optional)
+ For the `write_riemann' plugin.
+
+
Configuring / Compiling / Installing
------------------------------------
@@ -893,18 +935,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
@@ -921,6 +964,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.