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