X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=README;h=c8be7d38e2a17a1533dcfbb3ab60b835316adedf;hp=803fbaaf1d44b5bcad189a3f21a7dc7d3d0f2f14;hb=48efd3deb4c9139fd060ff3d289896e9031bcc7c;hpb=35a6c9c5fcd87cb78451a974c4d5b5707926845c diff --git a/README b/README index 803fbaaf..c8be7d38 100644 --- a/README +++ b/README @@ -54,6 +54,9 @@ Features - chrony Chrony daemon statistics: Local clock drift, offset to peers, etc. + - connectivity + Event-based interface status. + - conntrack Number of nf_conntrack entries. @@ -100,6 +103,9 @@ Features Collect DPDK interface statistics. See docs/BUILD.dpdkstat.md for detailed build instructions. + This plugin should be compiled with compiler defenses enabled, for + example -fstack-protector. + - drbd Collect individual drbd resource statistics. @@ -132,6 +138,9 @@ Features - gps Monitor gps related data through gpsd. + - gpu_nvidia + Monitor NVIDIA GPU statistics available through NVML. + - hddtemp Hard disk temperatures using hddtempd. @@ -140,6 +149,14 @@ Features hugepages can be found here: https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt. + This plugin should be compiled with compiler defenses enabled, for + example -fstack-protector. + + - intel_pmu + The intel_pmu plugin reads performance counters provided by the Linux + kernel perf interface. The plugin uses jevents library to resolve named + events to perf events and access perf interface. + - intel_rdt The intel_rdt plugin collects information provided by monitoring features of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring @@ -190,22 +207,23 @@ Features 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). - - madwifi Queries very detailed usage statistics from wireless LAN adapters and interfaces that use the Atheros chipset and the MadWifi driver. - - 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). + - mcelog + Monitor machine check exceptions (hardware errors detected by hardware + and reported to software) reported by mcelog and generate appropriate + notifications when machine check exceptions are detected. + + - md + Linux software-RAID device information (number of active, failed, spare + and missing disks). + - memcachec Query and parse data from a memcache daemon (memcached). @@ -235,7 +253,7 @@ Features - netapp Plugin to query performance values from a NetApp storage system using the - “Manage ONTAP” SDK provided by NetApp. + “Manage ONTAP” SDK provided by NetApp. - netlink Very detailed Linux network interface and routing statistics. You can get @@ -248,8 +266,7 @@ Features plugin of choice for that. - nfs - NFS Procedures: Which NFS command were called how often. Only NFSv2 and - NFSv3 right now. + NFS Procedures: Which NFS command were called how often. - nginx Collects statistics from `nginx' (speak: engine X), a HTTP and mail @@ -283,6 +300,26 @@ Features - oracle Query data from an Oracle database. + - ovs_events + The plugin monitors the link status of Open vSwitch (OVS) connected + interfaces, dispatches the values to collectd and sends the notification + whenever the link state change occurs in the OVS database. It requires + YAJL library to be installed. + Detailed instructions for installing and setting up Open vSwitch, see + OVS documentation. + + + - ovs_stats + The plugin collects the statistics of OVS connected bridges and + interfaces. It requires YAJL library to be installed. + Detailed instructions for installing and setting up Open vSwitch, see + OVS documentation. + + + - pcie_errors + Read errors from PCI Express Device Status and AER extended capabilities. + + - perl The perl plugin implements a Perl-interpreter into collectd. You can write your own plugins in Perl and return arbitrary values using this @@ -309,6 +346,9 @@ Features - processes Process counts: Number of running, sleeping, zombie, ... processes. + - procevent + Listens for process starts and exits via netlink. + - protocols Counts various aspects of network protocols such as IP, TCP, UDP, etc. @@ -353,6 +393,9 @@ Features Acts as a StatsD server, reading values sent over the network from StatsD clients and calculating rates and other aggregates out of these values. + - sysevent + Listens to rsyslog events and submits matched values. + - swap Pages swapped out onto hard disk or whatever is called `swap' by the OS.. @@ -434,7 +477,11 @@ Features - amqp Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP) - server, such as RabbitMQ. + 0.9.1 server, such as RabbitMQ. + + - amqp1 + Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP) + 1.0 server, such as Qpid Dispatch Router or Apache Artemis Broker. - csv Write to comma separated values (CSV) files. This needs lots of @@ -476,6 +523,13 @@ Features updates to the files and write a bunch of updates at once, which lessens system load a lot. + - snmp_agent + Receives and handles queries from SNMP master agent and returns the data + collected by read plugins. Handles requests only for OIDs specified in + configuration file. To handle SNMP queries the plugin gets data from + collectd and translates requested values from collectd's internal format + to SNMP format. + - unixsock One can query the values from the unixsock plugin whenever they're needed. Please read collectd-unixsock(5) for a description on how that's @@ -514,6 +568,10 @@ Features Sends data to Sensu, a stream processing and monitoring system, via the Sensu client local TCP socket. + - write_syslog + Sends data in syslog format, using TCP, where the message + contains the metric in human or JSON format. + - write_tsdb Sends data OpenTSDB, a scalable no master, no shared state time series database. @@ -703,6 +761,10 @@ Prerequisites particular. + * CUDA (optional) + Used by the `gpu_nvidia' plugin + + * libatasmart (optional) Used by the `smart' plugin. @@ -750,10 +812,6 @@ Prerequisites Used by the `gps' plugin. - * libhal (optional) - If present, the `uuid' plugin will check for UUID from HAL. - - * libi2c-dev (optional) Used for the plugin `barometer', provides just the i2c-dev.h header file for user space i2c development. @@ -762,6 +820,13 @@ Prerequisites For querying iptables counters. + * libjevents (optional) + The jevents library is used by the `intel_pmu' plugin to access the Linux + kernel perf interface. + Note: the library should be build with -fPIC flag to be linked with + intel_pmu shared object correctly. + + * libjvm (optional) Library that encapsulates the `Java Virtual Machine' (JVM). This library is used by the `java' plugin to execute Java bytecode. @@ -776,10 +841,6 @@ Prerequisites Used by the `lua' plugin. Currently, Lua 5.1 and later are supported. - * liblvm2 (optional) - Used by the `lvm' plugin. - - * libmemcached (optional) Used by the `memcachec' plugin to connect to a memcache daemon. @@ -807,7 +868,11 @@ Prerequisites This library is part of the “Manage ONTAP SDK” published by NetApp. * libnetsnmp (optional) - For the `snmp' plugin. + For the `snmp' and 'snmp_agent' plugins. + + + * libnetsnmpagent (optional) + Required for the 'snmp_agent' plugin. * libnotify (optional) @@ -863,8 +928,14 @@ Prerequisites are supported. + * libqpid-proton (optional) + Used by the `amqp1' plugin for AMQP 1.0 connections, for example to + Qdrouterd. + + * librabbitmq (optional; also called “rabbitmq-c”) - Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ. + Used by the `amqp' plugin for AMQP 0.9.1 connections, for example to + RabbitMQ. * librdkafka (optional; also called “rdkafka”) @@ -925,8 +996,8 @@ Prerequisites * libyajl (optional) - Parse JSON data. This is needed for the `ceph', `curl_json' and - `log_logstash' plugins. + Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events', + 'ovs_stats' and `log_logstash' plugins. * libvarnish (optional) @@ -942,9 +1013,8 @@ Configuring / Compiling / Installing ------------------------------------ To configure, build and install collectd with the default settings, run - `./configure && make && make install'. For detailed, generic instructions - see INSTALL. For a complete list of configure options and their description, - run `./configure --help'. + `./configure && make && make install'. For a complete list of configure + options and their description, run `./configure --help'. By default, the configure script will check for all build dependencies and disable all plugins whose requirements cannot be fulfilled (any other plugin @@ -981,12 +1051,42 @@ To generate the `configure` script, you'll need the following dependencies: - flex - bison - libtool -- libtool-ltdl - pkg-config The `build.sh' script takes no arguments. +Building on Windows +----------------------------------------------- + +Collectd can be built on Windows using Cygwin, and the result is a binary that +runs natively on Windows. That is, Cygwin is only needed for building, not running, +collectd. + +You will need to install the following Cygwin packages: +- automake +- bison +- flex +- git +- libtool +- make +- mingw64-x86_64-dlfcn +- mingw64-x86_64-gcc-core +- mingw64-x86_64-zlib +- pkg-config + +To build, just run the `build.sh' script in your Cygwin terminal. By default, it installs +to "C:/Program Files/collectd". You can change the location by setting the INSTALL_DIR +variable: + +$ export INSTALL_DIR="C:/some/other/install/directory" +$ ./build.sh + +or: + +$ INSTALL_DIR="C:/some/other/install/directory" ./build.sh + + Crosscompiling --------------