Merge branch 'collectd-4.5'

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 9ce2ae9..55aa69b 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1019,12 +1019,12 @@ database when started and keeps the connection up as long as possible. When the
 connection is interrupted for whatever reason it will try to re-connect. The
 plugin will complaint loudly in case anything goes wrong.
 
 connection is interrupted for whatever reason it will try to re-connect. The
 plugin will complaint loudly in case anything goes wrong.
 

-This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
-C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
-F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
-C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
-in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
-I<5.2.4. Server Status Variables> for an explanation of these values.
+This plugin issues the MySQL C<SHOW STATUS> command and collects information
+about MySQL network traffic, executed statements, requests, the query cache
+and threads by evaluating the C<Bytes_{received,sent}>, C<Com_*>,
+C<Handler_*>, C<Qcache_*> and C<Threads_*> return values. Please refer to the
+B<MySQL reference manual>, I<5.1.6. Server Status Variables> for an
+explanation of these values.

 
 Use the following options to configure the plugin:
 
 
 Use the following options to configure the plugin:
 


@@ -1036,7 +1036,9 @@ Hostname of the database server. Defaults to B<localhost>.
 
 =item B<User> I<Username>
 
 
 =item B<User> I<Username>
 

-Username to use when connecting to the database.
+Username to use when connecting to the database. The user does not have to be
+granted any privileges (which is synonym to granting the C<USAGE> privilege).
+Any existing MySQL user will do.

 
 =item B<Password> I<Password>
 
 
 =item B<Password> I<Password>
 


@@ -1824,6 +1826,15 @@ collected for these selected processes are size of the resident segment size
 (RSS), user- and system-time used, number of processes and number of threads,
 and minor and major pagefaults.
 
 (RSS), user- and system-time used, number of processes and number of threads,
 and minor and major pagefaults.
 

+=item B<ProcessMatch> I<name> I<regex>
+
+Similar to the B<Process> option this allows to select more detailed
+statistics of processes matching the specified I<regex> (see L<regex(7)> for
+details). The statistics of all matching processes are summed up and
+dispatched to the daemon using the specified I<name> as an identifier. This
+allows to "group" several processes together. I<name> must not contain
+slashes.
+

 =back
 
 =head2 Plugin C<rrdcached>
 =back
 
 =head2 Plugin C<rrdcached>


@@ -2041,16 +2052,16 @@ user using (extended) regular expressions, as described in L<regex(7)>.
     <File "/var/log/exim4/mainlog">
       Instance "exim"
       <Match>
     <File "/var/log/exim4/mainlog">
       Instance "exim"
       <Match>

-       Regex "S=([1-9][0-9]*)"
-       DSType "CounterAdd"
-       Type "ipt_bytes"
-       Instance "total"
+        Regex "S=([1-9][0-9]*)"
+        DSType "CounterAdd"
+        Type "ipt_bytes"
+        Instance "total"

       </Match>
       <Match>
       </Match>
       <Match>

-       Regex "\\<R=local_user\\>"
-       DSType "CounterInc"
-       Type "counter"
-       Instance "local_user"
+        Regex "\\<R=local_user\\>"
+        DSType "CounterInc"
+        Type "counter"
+        Instance "local_user"

       </Match>
     </File>
   </Plugin>
       </Match>
     </File>
   </Plugin>


@@ -2381,7 +2392,7 @@ information.
      <Plugin "memory">
        <Type "memory">
          Instance "cached"
      <Plugin "memory">
        <Type "memory">
          Instance "cached"

-        WarningMin 100000000
+         WarningMin 100000000

        </Type>
      </Plugin>
    </Host>
        </Type>
      </Plugin>
    </Host>


@@ -2623,10 +2634,31 @@ plugins to be loaded:
 
 =over 4
 
 
 =over 4
 

+=item B<return>
+
+Signals the "return" condition. This causes the current chain to stop
+processing the value and returns control to the calling chain. The calling
+chain will continue processing targets and rules just after the B<jump> target
+(see below). This is very similar to the B<RETURN> target of iptables, see
+L<iptables(8)>.
+
+This target does not have any options.
+
+Example:
+
+ Target "return"
+

 =item B<stop>
 
 =item B<stop>
 

-Does nothing except returning with the stop condition, causing processing of
-the current chain to be aborted.
+Signals the "stop" condition, causing processing of the value to be aborted
+immediately. This is similar to the B<DROP> target of iptables, see
+L<iptables(8)>.
+
+This target does not have any options.
+
+Example:
+
+ Target "stop"

 
 =item B<write>
 
 
 =item B<write>
 


@@ -2641,10 +2673,6 @@ Available options:
 Name of the write plugin to which the data should be sent. This option may be
 given multiple times to send the data to more than one write plugin.
 
 Name of the write plugin to which the data should be sent. This option may be
 given multiple times to send the data to more than one write plugin.
 

-Example:
-
- Target "stop"
-

 =back
 
 If no plugin is explicitly specified, the values will be sent to all available
 =back
 
 If no plugin is explicitly specified, the values will be sent to all available


@@ -2661,6 +2689,8 @@ Example:
 Starts processing the rules of another chain. If the end of that chain is
 reached, or a stop condition is encountered, processing will continue right
 after the B<jump> target, i.E<nbsp>e. with the next target or the next rule.
 Starts processing the rules of another chain. If the end of that chain is
 reached, or a stop condition is encountered, processing will continue right
 after the B<jump> target, i.E<nbsp>e. with the next target or the next rule.

+This is similar to the B<-j> command line option of iptables, see
+L<iptables(8)>.

 
 Available options:
 
 
 Available options:
 


@@ -2680,6 +2710,114 @@ Example:
 
 =back
 
 
 =back
 

+=head2 Available matches
+
+=over 4
+
+=item B<regex>
+
+Matches a value using regular expressions.
+
+Available options:
+
+=over 4
+
+=item B<Host> I<Regex>
+
+=item B<Plugin> I<Regex>
+
+=item B<PluginInstance> I<Regex>
+
+=item B<Type> I<Regex>
+
+=item B<TypeInstance> I<Regex>
+
+Match values where the given regular expressions match the various fields of
+the identifier of a value. If multiple regular expressions are given, B<all>
+regexen must match for a value to match.
+
+=back
+
+Example:
+
+ <Match "regex">
+   Host "customer[0-9]+"
+   Plugin "^foobar$"
+ </Match>
+
+=item B<value>
+
+Matches the actual value of data sources against given minimumE<nbsp>/ maximum
+values. If a data-set consists of more than one data-source, all data-sources
+must match the specified ranges for a positive match.
+
+Available options:
+
+=over 4
+
+=item B<Min> I<Value>
+
+Sets the smallest value which still results in a match. If unset, behaves like
+negative infinity.
+
+=item B<Max> I<Value>
+
+Sets the largest value which still results in a match. If unset, behaves like
+positive infinity.
+
+=item B<Invert> B<true>|B<false>
+
+Inverts the selection. If the B<Min> and B<Max> settings result in a match,
+no-match is returned and vice versa.
+
+=back
+
+Either B<Min> or B<Max>, but not both, may be unset.
+
+Example:
+
+ # Match all values smaller than or equal to 100.
+ <Match "value">
+   Max 100
+ </Match>
+
+=back
+
+=head2 Available targets
+
+=over 4
+
+=item B<set>
+
+Sets part of the identifier of a value to a given string.
+
+Available options:
+
+=over 4
+
+=item B<Host> I<String>
+
+=item B<Plugin> I<String>
+
+=item B<PluginInstance> I<String>
+
+=item B<TypeInstance> I<String>
+
+Set the appropriate field to the given string. The strings for plugin instance
+and type instance may be empty, the strings for host and plugin may not be
+empty. It's currently not possible to set the type of a value this way.
+
+=back
+
+Example:
+
+ <Target "set">
+   PluginInstance "coretemp"
+   TypeInstance "core3"
+ </Target>
+
+=back
+

 =head2 Backwards compatibility
 
 If you use collectd with an old configuration, i.E<nbsp>e. one without a
 =head2 Backwards compatibility
 
 If you use collectd with an old configuration, i.E<nbsp>e. one without a


@@ -2696,6 +2834,21 @@ suggest to add the above snippet as default target to your main chain.
 
 TODO: Notifications will be implemented using chains, too. Describe that here!
 
 
 TODO: Notifications will be implemented using chains, too. Describe that here!
 

+=head2 Examples
+
+Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
+be an FQDN.
+
+ <Chain "main">
+   <Rule "no_fqdn">
+     <Match "regex">
+       Host "^[^\.]*$"
+     </Match>
+     Target "stop"
+   </Rule>
+   Target "write"
+ </Chain>
+

 =head1 SEE ALSO
 
 L<collectd(1)>,
 =head1 SEE ALSO
 
 L<collectd(1)>,


@@ -2704,10 +2857,12 @@ L<collectd-perl(5)>,
 L<collectd-unixsock(5)>,
 L<types.db(5)>,
 L<hddtemp(8)>,
 L<collectd-unixsock(5)>,
 L<types.db(5)>,
 L<hddtemp(8)>,

+L<iptables(8)>,

 L<kstat(3KSTAT)>,
 L<mbmon(1)>,
 L<pcre(3)>,
 L<psql(1)>,
 L<kstat(3KSTAT)>,
 L<mbmon(1)>,
 L<pcre(3)>,
 L<psql(1)>,

+L<regex(7)>,

 L<rrdtool(1)>,
 L<sensors(1)>
 
 L<rrdtool(1)>,
 L<sensors(1)>