From: Marc Fournier <marc.fournier@camptocamp.com>
Date: Tue, 28 Oct 2014 23:38:21 +0000 (+0100)
Subject: varnish: manpage & example cleanup
X-Git-Tag: collectd-5.5.0~138^2~1
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=a056d347e1c427512c2f4050161d96748e3b34fb;p=collectd.git

varnish: manpage & example cleanup

Consitently alphabetically ordered options and ensured all version
limitations are mentioned.
---

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 0583c006..19b3854e 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -1159,27 +1159,27 @@
 #   If you prefer defining another instance you can do
 #   so by using <Instance "myinstance">
 #   <Instance>
-#      CollectCache true
 #      CollectBackend true
-#      CollectBan false           # Varnish 3 only
+#      CollectBan false           # Varnish 3 and above
+#      CollectCache true
 #      CollectConnections true
 #      CollectDirectorDNS false   # Varnish 3 only
-#      CollectSHM true
 #      CollectESI false
 #      CollectFetch false
 #      CollectHCB false
 #      CollectObjects false
 #      CollectPurge false         # Varnish 2 only
 #      CollectSession false
+#      CollectSHM true
 #      CollectSMA false           # Varnish 2 only
 #      CollectSMS false
 #      CollectSM false            # Varnish 2 only
 #      CollectStruct false
 #      CollectTotals false
-#      CollectUptime false
+#      CollectUptime false        # Varnish 3 and above
 #      CollectVCL false
-#      CollectWorkers false
 #      CollectVSM false           # Varnish 4 only
+#      CollectWorkers false
 #   </Instance>
 #</Plugin>
 
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 1ba85006..dac1842b 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -6310,19 +6310,27 @@ Synopsis:
 
  <Plugin "varnish">
    <Instance "example">
+     CollectBackend     true
+     CollectBan         false
      CollectCache       true
      CollectConnections true
-     CollectBackend     true
-     CollectSHM         true
+     CollectDirectorDNS false
      CollectESI         false
      CollectFetch       false
      CollectHCB         false
+     CollectObjects     false
+     CollectPurge       false
+     CollectSession     false
+     CollectSHM         true
      CollectSMA         false
      CollectSMS         false
      CollectSM          false
+     CollectStruct      false
      CollectTotals      false
-     CollectWorkers     false
+     CollectUptime      false
+     CollectVCL         false
      CollectVSM         false
+     CollectWorkers     false
    </Instance>
  </Plugin>
 
@@ -6335,29 +6343,24 @@ Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
 
 =over 4
 
-=item B<CollectCache> B<true>|B<false>
-
-Cache hits and misses. True by default.
-
-=item B<CollectConnections> B<true>|B<false>
-
-Number of client connections received, accepted and dropped. True by default.
-
 =item B<CollectBackend> B<true>|B<false>
 
 Back-end connection statistics, such as successful, reused,
 and closed connections. True by default.
 
-=item B<CollectSHM> B<true>|B<false>
-
-Statistics about the shared memory log, a memory region to store
-log messages which is flushed to disk when full. True by default.
-
 =item B<CollectBan> B<true>|B<false>
 
 Statistics about ban operations, such as number of bans added, retired, and
 number of objects tested against ban operations. Only available with Varnish
-3.x. False by default.
+3.x and above. False by default.
+
+=item B<CollectCache> B<true>|B<false>
+
+Cache hits and misses. True by default.
+
+=item B<CollectConnections> B<true>|B<false>
+
+Number of client connections received, accepted and dropped. True by default.
 
 =item B<CollectDirectorDNS> B<true>|B<false>
 
@@ -6391,7 +6394,14 @@ number of objects tested against purge operations. Only available with Varnish
 =item B<CollectSession> B<true>|B<false>
 
 Client session statistics. Number of past and current sessions, session herd and
-linger counters, etc. False by default.
+linger counters, etc. False by default. Note that if using Varnish 4.x, some
+metrics found in the Connections and Threads sections with previous versions of
+Varnish have been moved here.
+
+=item B<CollectSHM> B<true>|B<false>
+
+Statistics about the shared memory log, a memory region to store
+log messages which is flushed to disk when full. True by default.
 
 =item B<CollectSMA> B<true>|B<false>
 
@@ -6422,20 +6432,20 @@ the number of requests and bytes transferred. False by default.
 
 =item B<CollectUptime> B<true>|B<false>
 
-Varnish uptime. False by default.
+Varnish uptime. Only available with Varnish 3.x and above. False by default.
 
 =item B<CollectVCL> B<true>|B<false>
 
 Number of total (available + discarded) VCL (config files). False by default.
 
-=item B<CollectWorkers> B<true>|B<false>
-
-Collect statistics about worker threads. False by default.
-
 =item B<CollectVSM> B<true>|B<false>
 
 Collect statistics about Varnish's shared memory usage (used by the logging and
-statisticss subsystems). False by default.
+statistics subsystems). Only available with Varnish 4.x. False by default.
+
+=item B<CollectWorkers> B<true>|B<false>
+
+Collect statistics about worker threads. False by default.
 
 =back