debian/README.Debian

   1 collectd on Debian
   2 ==================
   3
   4 General notes:
   5 --------------
   6
   7 - This package is split up into several packages to prevent you from having to
   8   install dependencies that you don't actually need. Any plugin that has
   9   dependencies other than libc gets its own package.
  10
  11 Configuring collectd:
  12 ---------------------
  13
  14 - collectd uses a similar configuration layout as openvpn does. That is to
  15   say that one daemon process is started for each configuration file found in
  16   /etc/collectd/.
  17
  18 - See collectd.conf(5) for details about configuring collectd.
  19
  20 Building your own plugins:
  21 --------------------------
  22
  23 - Originally, plugins for collectd had to be written in C and linked as shared
  24   objects. Starting with version 4.0.0, it is also possible to use plugins
  25   written in the scripting language Perl or implemented as separate processes.
  26   See section "SPECIAL PLUGINS" in collectd(1) for details.
  27
  28 - If you want to contribute plugins to the official distribution you should
  29   read http://collectd.org/dev-info.shtml.
  30
  31 - If you want to build plugins for your personal use only simply install the
  32   collectd-dev package and use /usr/share/doc/collectd-dev/examples/myplugin.c
  33   as a starting point (Note: This is already a working example, though it does
  34   not collect any useful data).
  35
  36   The resulting file can be compiled as follows:
  37
  38     gcc -shared -fPIC -o myplugin.so myplugin.c
  39
  40   Copy myplugin.so to /usr/lib/collectd and add the following line to your
  41   collectd config file:
  42
  43     LoadPlugin myplugin
  44
  45   Restart collectd and you're done.
  46