Code

control: Documented some B-Ds and collectd-core suggestions.
[pkg-collectd.git] / debian / README.Debian
index 4c22f5edcdb0546be2528b5ab41148f56b1bb16d..89accb84c6bf04d0d0f32eeaf1771ee588831195 100644 (file)
@@ -5,9 +5,25 @@ General notes:
 --------------
 
 - 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:
 ---------------------
@@ -28,17 +44,6 @@ solutions are welcome.
   "/var/lib/collectd/" and generate a static HTML file and a directory
   containing several PNG files which are graphs of the RRD files found.
 
-  This script was intended to be used with version 3 of collectd but still
-  seems to be in use by some people. To get it working with version 4, you
-  have to call it once for each subdirectory containing RRD files. A sample
-  wrapper might look like this:
-
-    for dir in /var/lib/collectd/rrd/$hostname/*; do
-        out_dir=`basename "$dir"`
-        mkdir -p $out_dir
-        ( cd $out_dir && collectd2html.pl --data-dir="$dir" )
-    done
-
 - collection.cgi: Sample CGI script that creates graphs on the fly. The Perl
   modules "RRDs" (package librrds-perl), "URI:Escape" (package liburi-perl),
   "HTML::Entities" (package libhtml-parser-perl) and a CGI capable web server
@@ -74,7 +79,7 @@ Building your own plugins:
 
   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:
@@ -113,6 +118,13 @@ Examples:
   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.
@@ -122,7 +134,7 @@ Examples:
   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.
@@ -136,6 +148,10 @@ Examples:
   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:
 --------------------------