filecount: Controls whether or not to include only regular files in the count (#2483)

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index b392baa..c92e3fd 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1624,6 +1624,7 @@ finance page and dispatch the value to collectd.
 
   <Plugin curl>
     <Page "stock_quotes">
 
   <Plugin curl>
     <Page "stock_quotes">

+      Plugin "quotes"

       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
       User "foo"
       Password "bar"
       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
       User "foo"
       Password "bar"


@@ -1655,6 +1656,11 @@ The following options are valid within B<Page> blocks:
 
 =over 4
 
 
 =over 4
 

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

 =item B<URL> I<URL>
 
 URL of the web site to retrieve. Since a regular expression will be used to
 =item B<URL> I<URL>
 
 URL of the web site to retrieve. Since a regular expression will be used to


@@ -1815,6 +1821,11 @@ The following options are valid within B<URL> blocks:
 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 C<curl_json>.
+

 =item B<Instance> I<Instance>
 
 Sets the plugin instance to I<Instance>.
 =item B<Instance> I<Instance>
 
 Sets the plugin instance to I<Instance>.


@@ -1877,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"


@@ -1890,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>


@@ -1915,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>
 


@@ -1989,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> ...]
 


@@ -2000,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
 


@@ -2030,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"


@@ -2211,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


@@ -2798,6 +2834,11 @@ Controls whether or not to include "hidden" files and directories in the count.
 "Hidden" files and directories are those, whose name begins with a dot.
 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
 
 "Hidden" files and directories are those, whose name begins with a dot.
 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
 

+=item B<RegularOnly> I<true>|I<false>
+
+Controls whether or not to include only regular files in the count.
+Defaults to I<true>, i.e. by default non regular files are ignored.
+

 =item B<FilesSizeType> I<Type>
 
 Sets the type used to dispatch files combined size. Empty value ("") disables
 =item B<FilesSizeType> I<Type>
 
 Sets the type used to dispatch files combined size. Empty value ("") disables


@@ -3315,8 +3356,43 @@ This option is only available on Solaris.
 
 =head2 Plugin C<ipmi>
 
 
 =head2 Plugin C<ipmi>
 

+The B<ipmi plugin> allows to monitor server platform status using the Intelligent
+Platform Management Interface (IPMI). Local and remote interfaces are supported.
+
+The plugin configuration consists of one or more B<Instance> blocks which
+specify one I<ipmi> connection each. Each block requires one unique string
+argument as the instance name. If instances are not configured, an instance with
+the default option values will be created.
+
+For backwards compatibility, any option other than B<Instance> block will trigger
+legacy config handling and it will be treated as an option within B<Instance>
+block. This support will go away in the next major version of Collectd.
+
+Within the B<Instance> blocks, the following options are allowed:
+

 =over 4
 
 =over 4
 

+=item B<Address> I<Address>
+
+Hostname or IP to connect to. If not specified, plugin will try to connect to
+local management controller (BMC).
+
+=item B<Username> I<Username>
+
+=item B<Password> I<Password>
+
+The username and the password to use for the connection to remote BMC.
+
+=item B<AuthType> I<MD5>|I<rmcp+>
+
+Forces the authentication type to use for the connection to remote BMC.
+By default most secure type is seleted.
+
+=item B<Host> I<Hostname>
+
+Sets the B<host> field of dispatched values. Defaults to the global hostname
+setting.
+

 =item B<Sensor> I<Sensor>
 
 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
 =item B<Sensor> I<Sensor>
 
 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.


@@ -3345,6 +3421,24 @@ 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<NotifyIPMIConnectionState> I<true>|I<false>
+
+If a IPMI connection state changes after initialization time of a minute
+a notification is sent. Defaults to B<false>.
+
+=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>


@@ -3673,6 +3767,7 @@ Synopsis of the configuration:
    <Page "plugin_instance">
      Server "localhost"
      Key "page_key"
    <Page "plugin_instance">
      Server "localhost"
      Key "page_key"

+     Plugin "plugin_name"

      <Match>
        Regex "(\\d+) bytes sent"
        DSType CounterAdd
      <Match>
        Regex "(\\d+) bytes sent"
        DSType CounterAdd


@@ -3700,6 +3795,11 @@ B<Page> block.
 
 When connected to the memcached server, asks for the page I<Key>.
 
 
 When connected to the memcached server, asks for the page I<Key>.
 

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

 =item E<lt>B<Match>E<gt>
 
 Match blocks define which strings to look for and how matches substrings are
 =item E<lt>B<Match>E<gt>
 
 Match blocks define which strings to look for and how matches substrings are


@@ -5748,6 +5848,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"


@@ -5770,6 +5871,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


@@ -5825,7 +5931,7 @@ The address of the OVS DB server JSON-RPC interface used by the plugin. To
 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
 option. See L<ovsdb-server(1)> for more details. The option may be either
 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
 option. See L<ovsdb-server(1)> for more details. The option may be either
 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string

-format. Defaults to B<'localhost'>.
+format. Defaults to C<localhost>.

 
 =item B<Port> I<service>
 
 
 =item B<Port> I<service>
 


@@ -5891,7 +5997,7 @@ The address of the OVS DB server JSON-RPC interface used by the plugin. To
 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
 option. See L<ovsdb-server(1)> for more details. The option may be either
 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
 option. See L<ovsdb-server(1)> for more details. The option may be either
 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string

-format. Defaults to B<'localhost'>.
+format. Defaults to C<localhost>.

 
 =item B<Port> I<service>
 
 
 =item B<Port> I<service>
 


@@ -6123,6 +6229,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"


@@ -6444,6 +6551,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


@@ -7710,6 +7822,7 @@ user using (extended) regular expressions, as described in L<regex(7)>.
 
   <Plugin "tail">
     <File "/var/log/exim4/mainlog">
 
   <Plugin "tail">
     <File "/var/log/exim4/mainlog">

+      Plugin "mail"

       Instance "exim"
       Interval 60
       <Match>
       Instance "exim"
       Interval 60
       <Match>


@@ -7742,11 +7855,13 @@ The config consists of one or more B<File> blocks, each of which configures one
 logfile to parse. Within each B<File> block, there are one or more B<Match>
 blocks, which configure a regular expression to search for.
 
 logfile to parse. Within each B<File> block, there are one or more B<Match>
 blocks, which configure a regular expression to search for.
 

-The B<Instance> option in the B<File> block may be used to set the plugin
-instance. So in the above example the plugin name C<tail-foo> would be used.
-This plugin instance is for all B<Match> blocks that B<follow> it, until the
-next B<Instance> option. This way you can extract several plugin instances from
-one logfile, handy when parsing syslog and the like.
+The B<Plugin> and B<Instance> options in the B<File> block may be used to set
+the plugin name and instance respectively. So in the above example the plugin name
+C<mail-exim> would be used.
+
+These options are applied for all B<Match> blocks that B<follow> it, until the
+next B<Plugin> or B<Instance> option. This way you can extract several plugin
+instances from one logfile, handy when parsing syslog and the like.

 
 The B<Interval> option allows you to define the length of time between reads. If
 this is not set, the default Interval will be used.
 
 The B<Interval> option allows you to define the length of time between reads. If
 this is not set, the default Interval will be used.


@@ -7934,7 +8049,8 @@ B<Synopsis:>
        Index 1
    </Metric>
    <File "/var/log/snort/snort.stats">
        Index 1
    </Metric>
    <File "/var/log/snort/snort.stats">

-       Instance "snort-eth0"
+       Plugin "snortstats"
+       Instance "eth0"

        Interval 600
        Collect "snort-dropped"
    </File>
        Interval 600
        Collect "snort-dropped"
    </File>


@@ -7986,6 +8102,11 @@ I<File> block but there can be multiple if you have multiple CSV files.
 
 =over 4
 
 
 =over 4
 

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

 =item B<Instance> I<PluginInstance>
 
 Sets the I<plugin instance> used when dispatching the values.
 =item B<Instance> I<PluginInstance>
 
 Sets the I<plugin instance> used when dispatching the values.


@@ -8362,6 +8483,7 @@ Synopsis:
      CollectManagement  false
      CollectSMF         false
      CollectVBE         false
      CollectManagement  false
      CollectSMF         false
      CollectVBE         false

+     CollectMSE         false

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


@@ -8437,11 +8559,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>
 


@@ -8489,9 +8609,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>
 


@@ -8505,6 +8624,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>


@@ -9149,6 +9275,12 @@ Sets the Cassandra ttl for the data points.
 
 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
 
 
 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
 

+=item B<Prefix> I<String>
+
+Only available for the KAIROSDB output format.
+
+Sets the metrics prefix I<string>. Defaults to I<collectd>.
+

 =item B<Metrics> B<true>|B<false>
 
 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
 =item B<Metrics> B<true>|B<false>
 
 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.


@@ -9330,6 +9462,7 @@ Synopsis:
         Prefix "collectd/"
         Database 1
         MaxSetSize -1
         Prefix "collectd/"
         Database 1
         MaxSetSize -1

+        MaxSetDuration -1

         StoreRates true
     </Node>
   </Plugin>
         StoreRates true
     </Node>
   </Plugin>


@@ -9392,6 +9525,12 @@ to C<0>.
 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
 hold. Negative values for I<Items> sets no limit, which is the default behavior.
 
 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
 hold. Negative values for I<Items> sets no limit, which is the default behavior.
 

+=item B<MaxSetDuration> I<Seconds>
+
+The B<MaxSetDuration> option limits the duration of items that the
+I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
+is the default behavior.
+

 =item B<StoreRates> B<true>|B<false>
 
 If set to B<true> (the default), convert counter values to rates. If set to
 =item B<StoreRates> B<true>|B<false>
 
 If set to B<true> (the default), convert counter values to rates. If set to