contrib/: Updated the `README' file.
[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 knowlege of RRD
3 files and/or `collectd's inner workings. Use at your own risk.
4
5 PerlLib/
6 --------
7   Perl modules to be used in conjunction with collectd. See the perldoc
8 documentation of the .pm-files to find out what they're good for.
9
10 add_rra.sh
11 ----------
12   Before version 3.9.0 collectd used to create a different set of RRAs. The
13 most detailed of these old RRAs hat a one minute resolution. This script can
14 be used to add three more RRAs: minimum, maximum and average with a ten second
15 resolution and 2200 rows (~6 hours). This will make houly statistics much more
16 interesting. Please note that no sanity- checking whatsoever is performed. You
17 can seriously fuck up your RRD files if you don't know what you're doing.
18
19 collectd2html.pl
20 ----------------
21   This script by Vincent StehlĂ© will search for RRD files in
22 `/var/lib/collectd/' and generate an HTML file and a directory containing
23 several PNG files which are graphs of the RRD files found.
24
25 collection.cgi
26 --------------
27   Sample CGI script that creates graphs on the fly. The Perl module `RRDs' is
28 needed (Debian package `librrds-perl').
29
30 extractDS.px
31 ------------
32   Creates a new RRD-file with only one data-source (DS) of the source-RRD-
33 file. That is very handy when you realise that you have bundled up DSes in one
34 RRD-file that should have been in multiple RRD-files instead. Is is used by
35 `migrate-3-4.px' to split up the cpu-, nfs-, swap-files and possibly others.
36
37 fedora/
38 -------
39   Init-script and Spec-file that can be used when creating RPM-packages for
40 Fedora.
41
42 migrate-3-4.px
43 --------------
44   Migration-script to ease the switch from version 3 to version 4. Many
45 RRD-files are expected in a different place, some have been changed (DSes have
46 been renamed) and others have bee split up into multiple files. This script
47 prints a bash-script to STDOUT which should do most of the work for you. You
48 may still need to do some things by hand, read `README.migration' for more
49 details.