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