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 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 had 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 hourly 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 modules `RRDs'
  28 (Debian package `librrds-perl'), `URI:Escape' (package liburi-perl),
  29 `HTML::Entities' (package libhtml-parser-perl) and a CGI capable web server
  30 (e.g. apache2 or boa) are needed. Simply install the script to a place where
  31 the webserver will treat it as a CGI script (/usr/lib/cgi-bin/ by default) and
  32 visit that page in a browser (http://localhost/cgi-bin/collection.cgi by
  33 default). Please refer to your webserver's documentation for more details.
  34
  35   Starting with version 4, collection.cgi requires a small config file, which
  36 should look something like this:
  37
  38   datadir: "/var/lib/collectd/rrd/"
  39   libdir: "/usr/lib/collectd/"
  40
  41 exec-smartctl
  42 -------------
  43   Sample script for the exec plugin. Please refer to the documentation in the
  44 file - you will have to adapt it to your needs anyway.
  45
  46 extractDS.px
  47 ------------
  48   Creates a new RRD-file with only one data-source (DS) of the source-RRD-
  49 file. That is very handy when you realise that you have bundled up DSes in one
  50 RRD-file that should have been in multiple RRD-files instead. Is is used by
  51 `migrate-3-4.px' to split up the cpu-, nfs-, swap-files and possibly others.
  52
  53 fedora/
  54 -------
  55   Init-script and Spec-file that can be used when creating RPM-packages for
  56 Fedora.
  57
  58 migrate-3-4.px
  59 --------------
  60   Migration-script to ease the switch from version 3 to version 4. Many
  61 RRD-files are expected in a different place, some have been changed (DSes have
  62 been renamed) and others have bee split up into multiple files. This script
  63 prints a bash-script to STDOUT which should do most of the work for you. You
  64 may still need to do some things by hand, read `README.migration' for more
  65 details.
  66
  67 snmp-data.conf
  68 --------------
  69   Sample configuration for the SNMP plugin. This config includes a few standard
  70 <Data ..> definitions that you can include in your own config using the
  71 `Include' statement (available since version 4.2.0). The config includes some
  72 data that is defined in the IF-MIB, e. g. octet or packet counters, UPS-MIB and
  73 whatever people have send in. If you have some more definitions please send
  74 them in, so others can profit from it.