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 (or recommended packages) that you don't actually need.
   9   Any plugin that has 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 - You can use /usr/share/doc/collectd/examples/collectd.conf as a starting
  21   point for writing your own configuration file(s).
  22
  23 Building your own plugins:
  24 --------------------------
  25
  26 - If you want to contribute plugins to the official distribution you should
  27   read http://collectd.org/dev-info.shtml.
  28
  29 - If you want to build plugins for your personal use only simply install the
  30   collectd-dev package and use /usr/share/doc/collectd-dev/examples/myplugin.c
  31   as a starting point (Note: This is already a working example, though it does
  32   not collect any useful data).
  33
  34   The resulting file can be compiled as follows:
  35
  36     gcc -shared -o myplugin.so myplugin.c
  37
  38   Copy myplugin.so to /usr/lib/collectd and add the following line to your
  39   collectd config file:
  40
  41     LoadPlugin myplugin
  42
  43   Restart collectd and you're done.
  44