X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=contrib%2FREADME;h=1ebf1f146e6332ce88f90b894ec233bbbc196946;hb=0bdc3011ce40cbbd23dd62aff56a150d5b921fb9;hp=685903b3f171ffc5a66880fbc24c766cca2c2128;hpb=09c6d16ffba1b1b15e50579bbcf663f05f630932;p=collectd.git diff --git a/contrib/README b/contrib/README index 685903b3..1ebf1f14 100644 --- a/contrib/README +++ b/contrib/README @@ -2,11 +2,6 @@ The files in this directory may be used to perform common tasks that aren't exactly `collectd's job. They may or may not require in-depth knowledge of RRD files and/or `collectd's inner workings. Use at your own risk. -PerlLib/ --------- - Perl modules to be used in conjunction with collectd. See the perldoc -documentation of the .pm-files to find out what they're good for. - add_rra.sh ---------- Before version 3.9.0 collectd used to create a different set of RRAs. The @@ -16,9 +11,20 @@ resolution and 2200 rows (~6 hours). This will make hourly statistics much more interesting. Please note that no sanity- checking whatsoever is performed. You can seriously fuck up your RRD files if you don't know what you're doing. +collectd-network.py +------------------- + This Python module by Adrian Perez implements the collectd network protocol +in pure Python. It currently supports to receive data and notifications from +collectd. + +collectd-unixsock.py +-------------------- + This Python module by Clay Loveless provides an interface to collect's +unixsock plugin. + collectd2html.pl ---------------- - This script by Vincent Stehlé will search for RRD files in + This script by Vincent Stehlé will search for RRD files in `/var/lib/collectd/' and generate an HTML file and a directory containing several PNG files which are graphs of the RRD files found. @@ -38,6 +44,20 @@ should look something like this: datadir: "/var/lib/collectd/rrd/" libdir: "/usr/lib/collectd/" +exec-munin.px +------------- + Script to be used with the exec-plugin (see collectd-exec(5) for details) +which executes munin plugins, parses the output and translates it to a format +the exec-plugin understands. The features are limited - changing the munin +plugins to use the output format understood by the exec-plugin is recommended. +See the embedded POD documentation for more details: + $ perldoc contrib/exec-munin.px + +exec-smartctl +------------- + Sample script for the exec plugin. Please refer to the documentation in the +file - you will have to adapt it to your needs anyway. + extractDS.px ------------ Creates a new RRD-file with only one data-source (DS) of the source-RRD- @@ -50,6 +70,11 @@ fedora/ Init-script and Spec-file that can be used when creating RPM-packages for Fedora. +GenericJMX.conf +--------------- + Example configuration file for the ‘GenericJMX’ Java plugin. Please read the +documentation at the beginning of the file for more details. + migrate-3-4.px -------------- Migration-script to ease the switch from version 3 to version 4. Many @@ -58,3 +83,26 @@ been renamed) and others have bee split up into multiple files. This script prints a bash-script to STDOUT which should do most of the work for you. You may still need to do some things by hand, read `README.migration' for more details. + +redhat/ +------- + Spec-file and affiliated files to build an RedHat RPM package of collectd. + +snmp-data.conf +-------------- + Sample configuration for the SNMP plugin. This config includes a few standard + definitions that you can include in your own config using the +`Include' statement (available since version 4.2.0). The config includes some +data that is defined in the IF-MIB, e. g. octet or packet counters, UPS-MIB and +whatever people have send in. If you have some more definitions please send +them in, so others can profit from it. + +solaris-smf +----------- + Manifest file for the Solaris SMF system and detailed information on how to +register collectd as a service with this system. + +collectd.service +---------------- + Service file for systemd. Please ship this file as + /lib/systemd/system/collectd.service in any linux package of collectd.