Adding fhcount plugin

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index d9721ce..11bc7fa 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -98,7 +98,6 @@ Options inside a B<LoadPlugin> block can override default settings and
 influence the way plugins are loaded, e.g.:
 
  <LoadPlugin perl>
-   Globals true
    Interval 60
  </LoadPlugin>
 
@@ -2265,6 +2264,27 @@ expected from them. This is documented in great detail in L<collectd-exec(5)>.
 
 =back
 
+=head2 Plugin C<fhcount>
+
+The C<fhcount> plugin provides statistics about used, unused and total number of
+file handles.
+
+The I<fhcount plugin> provides the following configuration options:
+
+=over 4
+
+=item B<ValuesAbsolute> B<true>|B<false>
+
+Enables or disables reporting of file handles usage in absolute numbers,
+e.g. file handles used. Defaults to B<true>.
+
+=item B<ValuesPercentage> B<false>|B<true>
+
+Enables or disables reporting of file handles usage in percentages, e.g.
+percent of file handles used. Defaults to B<false>.
+
+=back
+
 =head2 Plugin C<filecount>
 
 The C<filecount> plugin counts the number of files in a certain directory (and
@@ -5133,6 +5153,13 @@ 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.
 
+=item B<Instance> I<name>
+
+Specify the plugin instance name that should be used instead of the database
+name (which is the default, if this option has not been specified). This
+allows to query multiple databases of the same name on the same host (e.g.
+when running multiple database server versions in parallel).
+
 =item B<Host> I<hostname>
 
 Specify the hostname or IP of the PostgreSQL server to connect to. If the
@@ -5567,7 +5594,7 @@ that numerical port numbers must be given as a string, too.
 
 Use I<Password> to authenticate when connecting to I<Redis>.
 
-=item B<Timeout> I<Timeout in miliseconds>
+=item B<Timeout> I<Milliseconds>
 
 The B<Timeout> option set the socket timeout for node response. Since the Redis
 read function is blocking, you should keep this value as low as possible. Keep
@@ -7095,7 +7122,7 @@ Hostname or address to connect to. Defaults to C<localhost>.
 
 Service name or port number to connect to. Defaults to C<27017>.
 
-=item B<Timeout> I<Timeout>
+=item B<Timeout> I<Milliseconds>
 
 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
 Setting this option to zero means no timeout, which is the default.
@@ -7399,7 +7426,7 @@ The B<Port> option is the TCP port on which the Redis instance accepts
 connections. Either a service name of a port number may be given. Please note
 that numerical port numbers must be given as a string, too.
 
-=item B<Timeout> I<Timeout in miliseconds>
+=item B<Timeout> I<Milliseconds>
 
 The B<Timeout> option sets the socket connection timeout, in milliseconds.
 
@@ -7531,10 +7558,11 @@ attribute for each metric being sent out to I<Riemann>.
 
 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
-a local I<sensu> client using a TCP socket. At the moment, write_sensu plugin
-does not send over a collectd_host parameter so it not possible to use
-one collectd instance as a gateway for other collectd: each collectd host
-must write to its own sensu client.
+a local I<Sensu> client using a TCP socket.
+
+At the moment, the I<write_sensu plugin> does not send over a collectd_host
+parameter so it is not possible to use one collectd instance as a gateway for
+others. Each collectd host must pair with one I<Sensu> client.
 
 Synopsis:
 
@@ -7562,7 +7590,7 @@ The following options are understood by the I<write_sensu plugin>:
 
 The plugin's configuration consists of one or more B<Node> blocks. Each block
 is given a unique I<Name> and specifies one connection to an instance of
-I<Sensu>. Indise the B<Node> block, the following per-connection options are
+I<Sensu>. Inside the B<Node> block, the following per-connection options are
 understood:
 
 =over 4
@@ -7580,9 +7608,9 @@ Service name or port number to connect to. Defaults to C<3030>.
 If set to B<true> (the default), convert counter values to rates. If set to
 B<false> counter values are stored as is, i.e. as an increasing integer number.
 
-This will be reflected in the C<collectd_data_source_type> tag: If B<StoreRates> is enabled,
-converted values will have "rate" appended to the data source type, e.g.
-C<collectd_data_source_type:derive:rate>.
+This will be reflected in the C<collectd_data_source_type> tag: If
+B<StoreRates> is enabled, converted values will have "rate" appended to the
+data source type, e.g.  C<collectd_data_source_type:derive:rate>.
 
 =item B<AlwaysAppendDS> B<false>|B<true>
 
@@ -7593,12 +7621,12 @@ only done when there is more than one DS.
 
 =item B<Notifications> B<false>|B<true>
 
-If set to B<true>, create sensu events for notifications. This is B<false>
+If set to B<true>, create I<Sensu> events for notifications. This is B<false>
 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
 
 =item B<Metrics> B<false>|B<true>
 
-If set to B<true>, create sensu events for metrics. This is B<false>
+If set to B<true>, create I<Sensu> events for metrics. This is B<false>
 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
 
 
@@ -7613,8 +7641,8 @@ several of them, one per line. Defaults to no handler.
 
 =item B<NotificationHandler> I<String>
 
-Add a handler that will be set when notifications are sent to I<Sensu>. You can add
-several of them, one per line. Defaults to no handler.
+Add a handler that will be set when notifications are sent to I<Sensu>. You can
+add several of them, one per line. Defaults to no handler.
 
 =item B<EventServicePrefix> I<String>