Code

ChangeLog: Add note about #1665.
[collectd.git] / contrib / README
1 The files in this directory may be used to perform common tasks that aren't
2 exactly `collectd's job. They may or may not require in-depth knowledge of RRD
3 files and/or `collectd's inner workings. Use at your own risk.
5 add_rra.sh
6 ----------
7   Before version 3.9.0 collectd used to create a different set of RRAs. The
8 most detailed of these old RRAs had a one minute resolution. This script can
9 be used to add three more RRAs: minimum, maximum and average with a ten second
10 resolution and 2200 rows (~6 hours). This will make hourly statistics much more
11 interesting. Please note that no sanity- checking whatsoever is performed. You
12 can seriously fuck up your RRD files if you don't know what you're doing.
14 collectd-network.py
15 -------------------
16   This Python module by Adrian Perez implements the collectd network protocol
17 in pure Python. It currently supports to receive data and notifications from
18 collectd.
20 collectd-unixsock.py
21 --------------------
22   This Python module by Clay Loveless provides an interface to collect's
23 unixsock plugin.
25 collectd2html.pl
26 ----------------
27   This script by Vincent Stehlé will search for RRD files in
28 `/var/lib/collectd/' and generate an HTML file and a directory containing
29 several PNG files which are graphs of the RRD files found.
31 collection.cgi
32 --------------
33   Sample CGI script that creates graphs on the fly. The Perl modules `RRDs'
34 (Debian package `librrds-perl'), `URI:Escape' (package liburi-perl),
35 `HTML::Entities' (package libhtml-parser-perl) and a CGI capable web server
36 (e.g. apache2 or boa) are needed. Simply install the script to a place where
37 the webserver will treat it as a CGI script (/usr/lib/cgi-bin/ by default) and
38 visit that page in a browser (http://localhost/cgi-bin/collection.cgi by
39 default). Please refer to your webserver's documentation for more details.
41   Starting with version 4, collection.cgi requires a small config file, which
42 should look something like this:
44   datadir: "/var/lib/collectd/rrd/"
45   libdir: "/usr/lib/collectd/"
47 exec-munin.px
48 -------------
49   Script to be used with the exec-plugin (see collectd-exec(5) for details)
50 which executes munin plugins, parses the output and translates it to a format
51 the exec-plugin understands. The features are limited - changing the munin
52 plugins to use the output format understood by the exec-plugin is recommended.
53 See the embedded POD documentation for more details:
54  $ perldoc contrib/exec-munin.px
56 exec-smartctl
57 -------------
58   Sample script for the exec plugin. Please refer to the documentation in the
59 file - you will have to adapt it to your needs anyway.
61 extractDS.px
62 ------------
63   Creates a new RRD-file with only one data-source (DS) of the source-RRD-
64 file. That is very handy when you realise that you have bundled up DSes in one
65 RRD-file that should have been in multiple RRD-files instead. Is is used by
66 `migrate-3-4.px' to split up the cpu-, nfs-, swap-files and possibly others.
68 fedora/
69 -------
70   Init-script and Spec-file that can be used when creating RPM-packages for
71 Fedora.
73 GenericJMX.conf
74 ---------------
75   Example configuration file for the ‘GenericJMX’ Java plugin. Please read the
76 documentation at the beginning of the file for more details.
78 migrate-3-4.px
79 --------------
80   Migration-script to ease the switch from version 3 to version 4. Many
81 RRD-files are expected in a different place, some have been changed (DSes have
82 been renamed) and others have bee split up into multiple files. This script
83 prints a bash-script to STDOUT which should do most of the work for you. You
84 may still need to do some things by hand, read `README.migration' for more
85 details.
87 redhat/
88 -------
89   Spec-file and affiliated files to build an RedHat RPM package of collectd.
91 snmp-data.conf
92 --------------
93   Sample configuration for the SNMP plugin. This config includes a few standard
94 <Data ..> definitions that you can include in your own config using the
95 `Include' statement (available since version 4.2.0). The config includes some
96 data that is defined in the IF-MIB, e. g. octet or packet counters, UPS-MIB and
97 whatever people have send in. If you have some more definitions please send
98 them in, so others can profit from it.
100 solaris-smf
101 -----------
102   Manifest file for the Solaris SMF system and detailed information on how to
103 register collectd as a service with this system.
105 collectd.service
106 ----------------
107   Service file for systemd. Please ship this file as
108   /lib/systemd/system/collectd.service in any linux package of collectd.