X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=README;h=c8be7d38e2a17a1533dcfbb3ab60b835316adedf;hp=ca86c84da4692b4d5307ae5ed284b7f0bd64eed5;hb=48efd3deb4c9139fd060ff3d289896e9031bcc7c;hpb=71fb7a5299f307a9261ae69819318f1eda1dd3c7 diff --git a/README b/README index ca86c84d..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,9 @@ 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 @@ -195,10 +207,6 @@ 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. @@ -308,6 +316,10 @@ Features 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 @@ -334,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. @@ -378,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.. @@ -459,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 @@ -546,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. @@ -735,6 +761,10 @@ Prerequisites particular. + * CUDA (optional) + Used by the `gpu_nvidia' plugin + + * libatasmart (optional) Used by the `smart' plugin. @@ -811,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. @@ -902,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”) @@ -981,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 @@ -1025,6 +1056,37 @@ To generate the `configure` script, you'll need the following dependencies: 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 --------------