From: Sebastian Harl <sh@tokkee.org>
Date: Wed, 6 Feb 2008 21:04:37 +0000 (+0100)
Subject: README.Debian: Added "Examples" section.
X-Git-Tag: collectd-4.3.0-1~17
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=1f4d0c048d697d60555df238f8c0d9598cc4262a;p=pkg-collectd.git

README.Debian: Added "Examples" section.

This section documents the following contents of
/usr/share/doc/collectd/examples/:

 * SpamAssassin/
 * iptables/
 * cussh.pl
 * exec-munin.px
 * exec-smartctl
 * network-proxy.py
 * snmp-data.conf
---

diff --git a/debian/README.Debian b/debian/README.Debian
index fb85769..654b5aa 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -86,6 +86,41 @@ Building your own plugins:
 
   Restart collectd and you're done.
 
+Examples:
+---------
+
+- SpamAssassin/: This directory contains a SpamAssassin plugin which passes
+  statistics to collectd using the email plugin. See the embedded POD
+  documentation for information about setup and configuration: perldoc
+  Collectd.pm.
+
+- iptables/: This directory contains a script which will setup iptables to do
+  global logging of all traffic going in and out of an interface. This
+  information can then be collected by collectd's iptables 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.
+
+- exec-munin.px: Script to be used with the exec-plugin (see collectd-exec(5)
+  for details) which executes munin plugins, parses the output and translates
+  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
+
+- 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.
+
+- network-proxy.py: A simple unicast proxy for collectd traffic.
+
+- snmp-data.conf: Sample configuration for the SNMP plugin. This config
+  includes a few standard <Data ..> definitions that you can include in your
+  own config using the `Include' statement (available since version 4.2.0).
+  The config includes some data that is defined in the IF-MIB, e. g. octet or
+  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.
+
 Additional helper scripts:
 --------------------------