types.db(5): Explain in more detail how custom types should be added.
[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.
4
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.
13
14 collectd2html.pl
15 ----------------
16   This script by Vincent StehlĂ© will search for RRD files in
17 `/var/lib/collectd/' and generate an HTML file and a directory containing
18 several PNG files which are graphs of the RRD files found.
19
20 collection.cgi
21 --------------
22   Sample CGI script that creates graphs on the fly. The Perl modules `RRDs'
23 (Debian package `librrds-perl'), `URI:Escape' (package liburi-perl),
24 `HTML::Entities' (package libhtml-parser-perl) and a CGI capable web server
25 (e.g. apache2 or boa) are needed. Simply install the script to a place where
26 the webserver will treat it as a CGI script (/usr/lib/cgi-bin/ by default) and
27 visit that page in a browser (http://localhost/cgi-bin/collection.cgi by
28 default). Please refer to your webserver's documentation for more details.
29
30   Starting with version 4, collection.cgi requires a small config file, which
31 should look something like this:
32
33   datadir: "/var/lib/collectd/rrd/"
34   libdir: "/usr/lib/collectd/"
35
36 exec-munin.px
37 -------------
38   Script to be used with the exec-plugin (see collectd-exec(5) for details)
39 which executes munin plugins, parses the output and translates it to a format
40 the exec-plugin understands. The features are limited - changing the munin
41 plugins to use the output format understood by the exec-plugin is recommended.
42 See the embedded POD documentation for more details:
43  $ perldoc contrib/exec-munin.px
44
45 exec-smartctl
46 -------------
47   Sample script for the exec plugin. Please refer to the documentation in the
48 file - you will have to adapt it to your needs anyway.
49
50 extractDS.px
51 ------------
52   Creates a new RRD-file with only one data-source (DS) of the source-RRD-
53 file. That is very handy when you realise that you have bundled up DSes in one
54 RRD-file that should have been in multiple RRD-files instead. Is is used by
55 `migrate-3-4.px' to split up the cpu-, nfs-, swap-files and possibly others.
56
57 fedora/
58 -------
59   Init-script and Spec-file that can be used when creating RPM-packages for
60 Fedora.
61
62 migrate-3-4.px
63 --------------
64   Migration-script to ease the switch from version 3 to version 4. Many
65 RRD-files are expected in a different place, some have been changed (DSes have
66 been renamed) and others have bee split up into multiple files. This script
67 prints a bash-script to STDOUT which should do most of the work for you. You
68 may still need to do some things by hand, read `README.migration' for more
69 details.
70
71 redhat/
72 -------
73   Spec-file and affiliated files to build an RedHat RPM package of collectd.
74
75 snmp-data.conf
76 --------------
77   Sample configuration for the SNMP plugin. This config includes a few standard
78 <Data ..> definitions that you can include in your own config using the
79 `Include' statement (available since version 4.2.0). The config includes some
80 data that is defined in the IF-MIB, e. g. octet or packet counters, UPS-MIB and
81 whatever people have send in. If you have some more definitions please send
82 them in, so others can profit from it.