X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=b0b59214d6550b1071dcbcc25bd2d4a95c95c1fa;hb=3259a9bec97cf502a780d70c0ab2a3394f8a6407;hp=15adbf0540ca19faea7a023bb8845b12dced8f03;hpb=f28e7b7a677dd52449fda84a19c010a5a2b6bace;p=collectd.git diff --git a/README b/README index 15adbf05..b0b59214 100644 --- a/README +++ b/README @@ -96,7 +96,7 @@ Features DNS traffic: Query types, response codes, opcodes and traffic/octets transferred. - - dpdk + - dpdkstat Collect DPDK interface statistics. See docs/BUILD.dpdkstat.md for detailed build instructions. @@ -132,9 +132,6 @@ Features - gps Monitor gps related data through gpsd. - - grpc - Send and receive values over the network using the gRPC framework. - - hddtemp Hard disk temperatures using hddtempd. @@ -143,6 +140,15 @@ Features hugepages can be found here: https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt. + - intel_rdt + The intel_rdt plugin collects information provided by monitoring features + of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring + Technology (CMT), Memory Bandwidth Monitoring (MBM). These features + provide information about utilization of shared resources like last level + cache occupancy, local memory bandwidth usage, remote memory bandwidth + usage, instructions per clock. + + - interface Interface traffic: Number of octets, packets and errors for each interface. @@ -196,6 +202,11 @@ Features 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). @@ -219,9 +230,6 @@ 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'. @@ -280,6 +288,22 @@ 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. + + - perl The perl plugin implements a Perl-interpreter into collectd. You can write your own plugins in Perl and return arbitrary values using this @@ -400,7 +424,7 @@ Features 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 + Virtual memory statistics, e.g. the number of page-ins/-outs or the number of pagefaults. - vserver @@ -438,10 +462,16 @@ Features diskspace but is extremely portable and can be analysed with almost every program that can analyse anything. Even Microsoft's Excel.. + - grpc + Send and receive values over the network using the gRPC framework. + - lua It's possible to implement write plugins in Lua using the Lua plugin. See collectd-lua(5) for details. + - mqtt + Publishes and subscribes to MQTT topics. + - 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. @@ -467,6 +497,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 @@ -491,6 +528,10 @@ Features - write_mongodb Sends data to MongoDB, a NoSQL database. + - write_prometheus + Publish values using an embedded HTTP server, in a format compatible + with Prometheus' collectd_exporter. + - write_redis Sends the values to a Redis key-value database server. @@ -737,10 +778,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. @@ -771,6 +808,10 @@ Prerequisites Used by the `memcachec' plugin to connect to a memcache daemon. + * libmicrohttpd (optional) + Used by the write_prometheus plugin to run an http daemon. + + * libmnl (optional) Used by the `netlink' plugin. @@ -790,7 +831,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) @@ -826,6 +871,11 @@ Prerequisites The PostgreSQL C client library used by the `postgresql' plugin. + * libpqos (optional) + The PQoS library for Intel(R) Resource Director Technology used by the + `intel_rdt' 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. @@ -903,8 +953,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) @@ -959,11 +1009,11 @@ 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. + Crosscompiling -------------- @@ -994,11 +1044,16 @@ Crosscompiling * `endianflip' (12345678 -> 87654321) * `intswap' (12345678 -> 56781234) + Contact ------- - For questions, bug reports, development information and basically all other - concerns please send an email to collectd's mailing list at + Please use GitHub to report bugs and submit pull requests: + . + See CONTRIBUTING.md for details. + + For questions, development information and basically all other concerns please + send an email to collectd's mailing list at . For live discussion and more personal contact visit us in IRC, we're in @@ -1012,5 +1067,3 @@ Author Sebastian tokkee Harl , and many contributors (see `AUTHORS'). - Please use GitHub reporting bugs and submitting pull requests. - See CONTRIBUTING.md for details.