X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=README;h=3e2c0233adc3ea9ccfbcbbf072c107a0f6dcbd5b;hb=f3b18c23c1ec9b844a84894ef6b3de804e4a840a;hp=90550afab99ccfa93e9c40a5e7381d8160163826;hpb=598251d8d18b56dabf95b2075428a80081734b84;p=collectd.git
diff --git a/README b/README
index 90550afa..3e2c0233 100644
--- a/README
+++ b/README
@@ -33,9 +33,9 @@ Features
Statistics about Ascent, a free server for the game `World of Warcraft'.
- barometer
- Using digital barometer sensor MPL115A2 or MPL3115 from Freescale
- provides absolute barometric pressure, air pressure reduced to sea level
- and temperature.
+ Reads absolute barometric pressure, air pressure reduced to sea level and
+ temperature. Supported sensors are MPL115A2 and MPL3115 from Freescale
+ and BMP085 from Bosch.
- battery
Batterycharge, -current and voltage of ACPI and PMU based laptop
@@ -45,6 +45,9 @@ Features
Name server and resolver statistics from the `statistics-channel'
interface of BIND 9.5, 9,6 and later.
+ - ceph
+ Statistics from the Ceph distributed storage system.
+
- cgroups
CPU accounting information for process groups under Linux.
@@ -104,6 +107,9 @@ Features
Values gathered by a custom program or script.
See collectd-exec(5).
+ - fhcount
+ File handles statistics.
+
- filecount
Count the number of files in directories.
@@ -120,13 +126,17 @@ Features
Interface traffic: Number of octets, packets and errors for each
interface.
- - iptables
- Iptables' counters: Number of bytes that were matched by a certain
- iptables rule.
+ - ipc
+ IPC counters: semaphores used, number of allocated segments in shared
+ memory and more.
- ipmi
IPMI (Intelligent Platform Management Interface) sensors information.
+ - iptables
+ Iptables' counters: Number of bytes that were matched by a certain
+ iptables rule.
+
- ipvs
IPVS connection statistics (number of connections, octets and packets
for each service and destination).
@@ -146,9 +156,6 @@ Features
Detailed CPU statistics of the âLogical Partitionsâ virtualization
technique built into IBM's POWER processors.
- - libvirt
- CPU, memory, disk and network I/O statistics from virtual machines.
-
- lvm
Size of âLogical Volumesâ (LV) and âVolume Groupsâ (VG) of Linux'
âLogical Volume Managerâ (LVM).
@@ -217,13 +224,13 @@ Features
- ntpd
NTP daemon statistics: Local clock drift, offset to peers, etc.
+ - numa
+ Information about Non-Uniform Memory Access (NUMA).
+
- nut
Network UPS tools: UPS current, voltage, power, charge, utilisation,
temperature, etc. See upsd(8).
- - numa
- Information about Non-Uniform Memory Access (NUMA).
-
- olsrd
Queries routing information from the âOptimized Link State Routingâ
daemon.
@@ -299,6 +306,10 @@ Features
to have its measurements fed to collectd. This includes multimeters,
sound level meters, thermometers, and much more.
+ - smart
+ Collect SMART statistics, notably load cycle count, temperature
+ and bad sectors.
+
- snmp
Read values from SNMP (Simple Network Management Protocol) enabled
network devices such as switches, routers, thermometers, rack monitoring
@@ -341,6 +352,10 @@ Features
Reads the number of records and file size from a running Tokyo Tyrant
server.
+ - turbostat
+ Reads CPU frequency and C-state residency on modern Intel
+ turbo-capable processors.
+
- uptime
System uptime statistics.
@@ -350,6 +365,9 @@ Features
- varnish
Various statistics from Varnish, an HTTP accelerator.
+ - virt
+ 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
number of pagefaults.
@@ -367,6 +385,9 @@ Features
- zfs_arc
Statistics for ZFS' âAdaptive Replacement Cacheâ (ARC).
+ - zookeeper
+ Read data from Zookeeper's MNTR command.
+
* Output can be written or sent to various destinations by the following
plugins:
@@ -414,10 +435,6 @@ Features
can be configured to avoid logging send errors (especially useful when
using UDP).
- - write_tsdb
- Sends data OpenTSDB, a scalable no master, no shared state time series
- database.
-
- write_http
Sends the values collected by collectd to a web-server using HTTP POST
requests. The transmitted data is either in a form understood by the
@@ -426,6 +443,9 @@ Features
- write_kafka
Sends data to Apache Kafka, a distributed queue.
+ - write_log
+ Writes data to the log
+
- write_mongodb
Sends data to MongoDB, a NoSQL database.
@@ -435,8 +455,16 @@ Features
- write_riemann
Sends data to Riemann, a stream processing and monitoring system.
+ - write_sensu
+ Sends data to Sensu, a stream processing and monitoring system, via the
+ Sensu client local TCP socket.
+
+ - write_tsdb
+ Sends data OpenTSDB, a scalable no master, no shared state time series
+ 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.
@@ -607,12 +635,22 @@ Prerequisites
particular.
+ * libatasmart (optional)
+ Used by the `smart' plugin.
+
+
+ * libcap (optional)
+ The `turbostat' plugin can optionally build Linux Capabilities support,
+ which avoids full privileges requirement (aka. running as root) to read
+ values.
+
+
* libclntsh (optional)
Used by the `oracle' plugin.
- * libcredis (optional)
- Used by the `redis' plugin. Please note that you require a 0.2.2 version
- or higher.
+ * libhiredis (optional)
+ Used by the redis plugin. Please note that you require a 0.10.0 version
+ or higher.
* libcurl (optional)
If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
@@ -782,15 +820,15 @@ Prerequisites
* libxml2 (optional)
Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
- `libvirt' plugins.
+ `virt' plugins.
* libxmms (optional)
* libyajl (optional)
- Parse JSON data. This is needed for the `curl_json' and `log_logstash'
- plugins.
+ Parse JSON data. This is needed for the `ceph', `curl_json' and
+ `log_logstash' plugins.
* libvarnish (optional)
@@ -865,6 +903,23 @@ Configuring with libjvm
Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to
do that.
+Generating the configure script
+-------------------------------
+
+Collectd ships with a `build.sh' script to generate the `configure'
+script shipped with releases.
+
+To generate the `configure` script, you'll need the following dependencies:
+
+- autoconf
+- automake
+- flex
+- bison
+- libtool
+- libtool-ltdl
+
+The `build.sh' script takes no arguments.
+
Crosscompiling
--------------