X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=e8f0ca1e2aefddc8f6f497ec4fc03901cdc39b22;hb=bbf3f23aee672042cf5405baa01463f70bf5bb9d;hp=0484867539025b8fd24a53c6b0deb7085fa66de0;hpb=cfe801cf0236ea2fade924e0f2b5ce3d1a51698a;p=collectd.git diff --git a/README b/README index 04848675..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. @@ -107,6 +113,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. @@ -116,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. @@ -127,13 +147,13 @@ Features 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. - - ipmi - IPMI (Intelligent Platform Management Interface) sensors information. - - ipvs IPVS connection statistics (number of connections, octets and packets for each service and destination). @@ -153,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). @@ -188,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'. @@ -221,13 +250,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. @@ -349,6 +378,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. @@ -372,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. @@ -393,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. @@ -428,10 +472,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 @@ -456,8 +496,12 @@ Features 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. @@ -488,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). @@ -632,6 +679,12 @@ Prerequisites 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. @@ -656,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. @@ -682,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. @@ -745,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. @@ -810,6 +880,10 @@ Prerequisites `virt' plugins. + * libxen (optional) + Used by the `xencpu' plugin. + + * libxmms (optional) @@ -823,6 +897,10 @@ Prerequisites `varnish' plugin. + * riemann-c-client (optional) + For the `write_riemann' plugin. + + Configuring / Compiling / Installing ------------------------------------ @@ -876,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 @@ -904,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. @@ -956,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.