diff --git a/debian/README.Debian b/debian/README.Debian
index 654b5aa6dce4a9d8cde170acc4231517b1e92177..89accb84c6bf04d0d0f32eeaf1771ee588831195 100644 (file)
--- a/debian/README.Debian
+++ b/debian/README.Debian
--------------
- Some plugins require additional libraries. To prevent you from having to
- install dependencies that you don't actually need those libraries are
- recommendations rather than dependencies. See README.Debian.plugins in the
- "collectd" package for details.
+ install dozens of further packages that you don't actually need, there is no
+ strict dependency on those libraries. Rather, they are listed as recommenda-
+ tions ("collectd" package) or suggestions ("collectd-core" package"). See
+ /usr/share/doc/collectd-core/README.Debian.plugins for details.
+
+- The main components of collectd have been split into two packages:
+
+ * "collectd-core":
+ This package contains the main program file and the plugins but no config-
+ uration. It allows sites to, e.g., provide customizations on top of it
+ without having to modify the "collectd" package. For example, a custom
+ configuration and appropriate dependencies may be provided by some package
+ depending on "collectd-core" and conflicting / replacing / providing
+ "collectd".
+
+ * "collectd":
+ This package provides a full installation of the daemon, including a
+ configuration. It is meant to be ready to use for simple setups or first
+ steps.
Configuring collectd:
---------------------
is installed to /etc/collectd/collection.conf. You should not need to change
anything there.
+- collection3: A graphing front-end for the RRD files created by and filled
+ with collectd. See /usr/share/doc/collectd/examples/collection3/README for
+ details. This is a successor for collection.cgi.
+
Building your own plugins:
--------------------------
collectd-dev package and use /usr/share/doc/collectd-dev/examples/myplugin.c
as a starting point (Note: This is already a working example, though it does
not collect any useful data).
-
+
The resulting file can be compiled as follows:
- gcc -shared -fPIC -o myplugin.so myplugin.c
+ gcc -DHAVE_CONFIG_H -shared -fPIC -o myplugin.so myplugin.c
Copy myplugin.so to /usr/lib/collectd and add the following line to your
collectd config file:
global logging of all traffic going in and out of an interface. This
information can then be collected by collectd's iptables plugin.
+- collectd-network.py: Python module implementing the collectd network
+ protocol in pure Python. It currently supports to receive data and
+ notifications from collectd.
+
+- collectd-unixsock.py: Python module providing an interface to collect's
+ unixsock plugin.
+
- cussh.pl: "Collectd Unix Socket SHell" is a small, interactive front-end for
the unixsock plugin. See the embedded POD documentation for details: perldoc
cussh.pl.
it to a format the exec-plugin understands. The features are limited -
changing the munin plugins to use the output format understood by the
exec-plugin is recommended. See the embedded POD documentation for more
- details: perldoc exec-munin.px
+ details: perldoc exec-munin.px.
- exec-smartctl: Sample script for the exec plugin. Please refer to the
documentation in the file - you will have to adapt it to your needs anyway.
packet counters, UPS-MIB and whatever people have send in. If you have some
more definitions please send them in, so others can profit from it.
+- snmp-probe-host.px: Script to be used to automatically generate SNMP
+ configuration snippets for the "snmp" plugin. See the embedded POD
+ documentation for more details: perldoc snmp-probe-host.px.
+
Additional helper scripts:
--------------------------