Merge remote-tracking branch 'github/pr/2469'

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 3b9d664..7b037bc 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1888,6 +1888,7 @@ The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
  <Plugin "curl_xml">
    <URL "http://localhost/stats.xml">
      Host "my_host"
  <Plugin "curl_xml">
    <URL "http://localhost/stats.xml">
      Host "my_host"

+     #Plugin "curl_xml"

      Instance "some_instance"
      User "collectd"
      Password "thaiNg0I"
      Instance "some_instance"
      User "collectd"
      Password "thaiNg0I"


@@ -1901,6 +1902,7 @@ The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
        Type "magic_level"
        #InstancePrefix "prefix-"
        InstanceFrom "td[1]"
        Type "magic_level"
        #InstancePrefix "prefix-"
        InstanceFrom "td[1]"

+       #PluginInstanceFrom "td[1]"

        ValuesFrom "td[2]/span[@class=\"level\"]"
      </XPath>
    </URL>
        ValuesFrom "td[2]/span[@class=\"level\"]"
      </XPath>
    </URL>


@@ -1926,10 +1928,16 @@ Within the B<URL> block the following options are accepted:
 Use I<Name> as the host name when submitting values. Defaults to the global
 host name setting.
 
 Use I<Name> as the host name when submitting values. Defaults to the global
 host name setting.
 

+=item B<Plugin> I<Plugin>
+
+Use I<Plugin> as the plugin name when submitting values.
+Defaults to 'curl_xml'.
+

 =item B<Instance> I<Instance>
 
 =item B<Instance> I<Instance>
 

-Use I<Instance> as the plugin instance when submitting values. Defaults to an
-empty string (no plugin instance).
+Use I<Instance> as the plugin instance when submitting values.
+May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
+Defaults to an empty string (no plugin instance).

 
 =item B<Namespace> I<Prefix> I<URL>
 
 
 =item B<Namespace> I<Prefix> I<URL>
 


@@ -2000,9 +2008,19 @@ Specifies a XPath expression to use for determining the I<type instance>. The
 XPath expression must return exactly one element. The element's value is then
 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
 
 XPath expression must return exactly one element. The element's value is then
 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
 

-This value is required. As a special exception, if the "base XPath expression"
-(the argument to the B<XPath> block) returns exactly one argument, then this
-option may be omitted.
+=item B<PluginInstanceFrom> I<PluginInstanceFrom>
+
+Specifies a XPath expression to use for determining the I<plugin instance>. The
+XPath expression must return exactly one element. The element's value is then
+used as I<plugin instance>.
+
+=back
+
+If the "base XPath expression" (the argument to the B<XPath> block) returns
+exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
+Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
+
+=over 4

 
 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
 
 
 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
 


@@ -2011,6 +2029,7 @@ number of XPath expressions must match the number of data sources in the
 I<type> specified with B<Type> (see above). Each XPath expression must return
 exactly one element. The element's value is then parsed as a number and used as
 value for the appropriate value in the value list dispatched to the daemon.
 I<type> specified with B<Type> (see above). Each XPath expression must return
 exactly one element. The element's value is then parsed as a number and used as
 value for the appropriate value in the value list dispatched to the daemon.

+This option is required.

 
 =back
 
 
 =back
 


@@ -2041,6 +2060,7 @@ than those of other plugins. It usually looks something like this:
       </Result>
     </Query>
     <Database "product_information">
       </Result>
     </Query>
     <Database "product_information">

+      #Plugin "warehouse"

       Driver "mysql"
       Interval 120
       DriverOption "host" "localhost"
       Driver "mysql"
       Interval 120
       DriverOption "host" "localhost"


@@ -2222,6 +2242,11 @@ the daemon. Other than that, that name is not used.
 
 =over 4
 
 
 =over 4
 

+=item B<Plugin> I<Plugin>
+
+Use I<Plugin> as the plugin name when submitting query results from
+this B<Database>. Defaults to C<dbi>.
+

 =item B<Interval> I<Interval>
 
 Sets the interval (in seconds) in which the values will be collected from this
 =item B<Interval> I<Interval>
 
 Sets the interval (in seconds) in which the values will be collected from this


@@ -3356,6 +3381,19 @@ If a sensor disappears a notification is sent.
 If you have for example dual power supply and one of them is (un)plugged then
 a notification is sent.
 
 If you have for example dual power supply and one of them is (un)plugged then
 a notification is sent.
 

+=item B<SELEnabled> I<true>|I<false>
+
+If system event log (SEL) is enabled, plugin will listen for sensor threshold
+and discrete events. When event is received the notification is sent.
+Defaults to B<false>.
+
+=item B<SELClearEvent> I<true>|I<false>
+
+If SEL clear event is enabled, plugin will delete event from SEL list after
+it is received and successfully handled. In this case other tools that are
+subscribed for SEL events will receive an empty event.
+Defaults to B<false>.
+

 =back
 
 =head2 Plugin C<iptables>
 =back
 
 =head2 Plugin C<iptables>


@@ -5765,6 +5803,7 @@ plugin's documentation above for details.
       </Result>
     </Query>
     <Database "product_information">
       </Result>
     </Query>
     <Database "product_information">

+      #Plugin "warehouse"

       ConnectID "db01"
       Username "oracle"
       Password "secret"
       ConnectID "db01"
       Username "oracle"
       Password "secret"


@@ -5787,6 +5826,11 @@ values submitted to the daemon. Other than that, that name is not used.
 
 =over 4
 
 
 =over 4
 

+=item B<Plugin> I<Plugin>
+
+Use I<Plugin> as the plugin name when submitting query results from
+this B<Database>. Defaults to C<oracle>.
+

 =item B<ConnectID> I<ID>
 
 Defines the "database alias" or "service name" to connect to. Usually, these
 =item B<ConnectID> I<ID>
 
 Defines the "database alias" or "service name" to connect to. Usually, these


@@ -6140,6 +6184,7 @@ L<http://www.postgresql.org/docs/manuals/>.
     </Writer>
 
     <Database foo>
     </Writer>
 
     <Database foo>

+      Plugin "kingdom"

       Host "hostname"
       Port "5432"
       User "username"
       Host "hostname"
       Port "5432"
       User "username"


@@ -6461,6 +6506,11 @@ activating this option. The draw-back is, that data covering the specified
 amount of time will be lost, for example, if a single statement within the
 transaction fails or if the database server crashes.
 
 amount of time will be lost, for example, if a single statement within the
 transaction fails or if the database server crashes.
 

+=item B<Plugin> I<Plugin>
+
+Use I<Plugin> as the plugin name when submitting query results from
+this B<Database>. Defaults to C<postgresql>.
+

 =item B<Instance> I<name>
 
 Specify the plugin instance name that should be used instead of the database
 =item B<Instance> I<name>
 
 Specify the plugin instance name that should be used instead of the database


@@ -6725,6 +6775,7 @@ collected for these selected processes are:
  - number of processes
  - number of threads
  - number of open files (under Linux)
  - number of processes
  - number of threads
  - number of open files (under Linux)

+ - number of memory mapped files (under Linux)

  - io data (where available)
  - context switches (under Linux)
  - minor and major pagefaults.
  - io data (where available)
  - context switches (under Linux)
  - minor and major pagefaults.


@@ -6745,6 +6796,12 @@ slashes.
 
 Collect context switch of the process.
 
 
 Collect context switch of the process.
 

+=item B<CollectMemoryMaps> I<Boolean>
+
+Collect the number of memory mapped files of the process.
+The limit for this number is configured via F</proc/sys/vm/max_map_count> in
+the Linux kernel.
+

 =back
 
 =head2 Plugin C<protocols>
 =back
 
 =head2 Plugin C<protocols>


@@ -8381,6 +8438,7 @@ Synopsis:
      CollectManagement  false
      CollectSMF         false
      CollectVBE         false
      CollectManagement  false
      CollectSMF         false
      CollectVBE         false

+     CollectMSE         false

    </Instance>
  </Plugin>
 
    </Instance>
  </Plugin>
 


@@ -8456,11 +8514,9 @@ log messages which is flushed to disk when full. True by default.
 =item B<CollectSMA> B<true>|B<false>
 
 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
 =item B<CollectSMA> B<true>|B<false>
 
 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage

-component is Solaris specific.
-Note: SMA and SMF share counters, enable only the one used by the Varnish
-instance.
-Only available with Varnish 2.x. False by
-default.
+component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
+only the one used by the Varnish instance. Only available with Varnish 2.x.
+False by default.

 
 =item B<CollectSMS> B<true>|B<false>
 
 
 =item B<CollectSMS> B<true>|B<false>
 


@@ -8508,9 +8564,8 @@ Backend counters. Only available with Varnish 4.x. False by default.
 =item B<CollectSMF> B<true>|B<false>
 
 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
 =item B<CollectSMF> B<true>|B<false>
 
 file (memory mapped file) storage statistics. Only available with Varnish 4.x.

-Note: SMA and SMF share counters, enable only the one used by the Varnish
-instance.
-Used to be called SM in Varnish 2.x. False by default.
+Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
+instance. Used to be called SM in Varnish 2.x. False by default.

 
 =item B<CollectManagement> B<true>|B<false>
 
 
 =item B<CollectManagement> B<true>|B<false>
 


@@ -8524,6 +8579,13 @@ Lock counters. Only available with Varnish 4.x. False by default.
 
 Memory pool counters. Only available with Varnish 4.x. False by default.
 
 
 Memory pool counters. Only available with Varnish 4.x. False by default.
 

+=item B<CollectMSE> B<true>|B<false>
+
+Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
+Varnish, replacing the traditional malloc and file storages. Only available
+with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
+one used by the Varnish instance. False by default.
+

 =back
 
 =head2 Plugin C<virt>
 =back
 
 =head2 Plugin C<virt>