Merge branch 'collectd-5.7' into collectd-5.8

[collectd.git] / contrib / README

diff --git a/contrib/README b/contrib/README
index 119d866..6e2ea19 100644 (file)
--- a/contrib/README
+++ b/contrib/README
@@ -13,20 +13,23 @@ can seriously fuck up your RRD files if you don't know what you're doing.
 
 collectd-network.py
 -------------------
 
 collectd-network.py
 -------------------

-

   This Python module by Adrian Perez implements the collectd network protocol
 in pure Python. It currently supports to receive data and notifications from
 collectd.
 
   This Python module by Adrian Perez implements the collectd network protocol
 in pure Python. It currently supports to receive data and notifications from
 collectd.
 

+collectd.service
+----------------
+  Service file for systemd. Please ship this file as
+  /lib/systemd/system/collectd.service in any linux package of collectd.
+

 collectd-unixsock.py
 --------------------
 collectd-unixsock.py
 --------------------

-

   This Python module by Clay Loveless provides an interface to collect's
 unixsock plugin.
 
 collectd2html.pl
 ----------------
   This Python module by Clay Loveless provides an interface to collect's
 unixsock plugin.
 
 collectd2html.pl
 ----------------

-  This script by Vincent Stehlé will search for RRD files in
+  This script by Vincent Stehlé will search for RRD files in

 `/var/lib/collectd/' and generate an HTML file and a directory containing
 several PNG files which are graphs of the RRD files found.
 
 `/var/lib/collectd/' and generate an HTML file and a directory containing
 several PNG files which are graphs of the RRD files found.
 


@@ -46,6 +49,21 @@ should look something like this:
   datadir: "/var/lib/collectd/rrd/"
   libdir: "/usr/lib/collectd/"
 
   datadir: "/var/lib/collectd/rrd/"
   libdir: "/usr/lib/collectd/"
 

+docker/
+-------
+Sample docker setup using an LD_PRELOAD wrapper to redirect system calls
+accessing /proc and /sys to prefixed bind-mounts inside the container.
+
+Drop your collectd configuration snippets in the
+contrib/docker/collectd.conf.d/ directory, and build an image including them:
+ $ docker build -t my_collectd ./contrib/docker/
+
+Then run it with the required bind-mounts:
+ $ docker run -it --rm \
+    -v /proc:/rootfs/proc:ro -v /sys:/rootfs/sys:ro \
+    --name collectd my_collectd
+ $ docker exec -it collectd collectdctl listval
+

 exec-munin.px
 -------------
   Script to be used with the exec-plugin (see collectd-exec(5) for details)
 exec-munin.px
 -------------
   Script to be used with the exec-plugin (see collectd-exec(5) for details)


@@ -67,10 +85,10 @@ file. That is very handy when you realise that you have bundled up DSes in one
 RRD-file that should have been in multiple RRD-files instead. Is is used by
 `migrate-3-4.px' to split up the cpu-, nfs-, swap-files and possibly others.
 
 RRD-file that should have been in multiple RRD-files instead. Is is used by
 `migrate-3-4.px' to split up the cpu-, nfs-, swap-files and possibly others.
 

-fedora/
--------
-  Init-script and Spec-file that can be used when creating RPM-packages for
-Fedora.
+GenericJMX.conf
+---------------
+  Example configuration file for the ‘GenericJMX’ Java plugin. Please read the
+documentation at the beginning of the file for more details.

 
 migrate-3-4.px
 --------------
 
 migrate-3-4.px
 --------------