Merge branch 'ff/gmond'

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 48b75bc..8dd53ca 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -454,7 +454,7 @@ finance page and dispatch the value to collectd.
       <Match>
         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
         DSType "GaugeAverage"
       <Match>
         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
         DSType "GaugeAverage"

-       # Note: `stock_value' is not a standard type.
+        # Note: `stock_value' is not a standard type.

         Type "stock_value"
         Instance "AMD"
       </Match>
         Type "stock_value"
         Instance "AMD"
       </Match>


@@ -606,6 +606,9 @@ like this:
 use a more strict database server, you may have to select from a dummy table or
 something.)
 
 use a more strict database server, you may have to select from a dummy table or
 something.)
 

+Please note that some databases, for example B<Oracle>, will fail if you
+include a semicolon at the end of the statement.
+

 =item B<MinVersion> I<Version>
 
 =item B<MaxVersion> I<Value>
 =item B<MinVersion> I<Version>
 
 =item B<MaxVersion> I<Value>


@@ -959,6 +962,88 @@ Controls whether or not to recurse into subdirectories. Enabled by default.
 
 =back
 
 
 =back
 

+=head2 Plugin C<gmond>
+
+The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
+statistics collection daemon of Ganglia. Mappings for the standard "metrics"
+are built-in, custom mappings may be added via B<Metric> blocks, see below.
+
+Synopsis:
+
+ <Plugin "gmond">
+   MCReceiveFrom "239.2.11.71" "8649"
+   <Metric "swap_total">
+     Type "swap"
+     TypeInstance "total"
+     DataSource "value"
+   </Metric>
+   <Metric "swap_free">
+     Type "swap"
+     TypeInstance "free"
+     DataSource "value"
+   </Metric>
+ </Plugin>
+
+The following metrics are built-in:
+
+=over 4
+
+=item *
+
+load_one, load_five, load_fifteen
+
+=item *
+
+cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
+
+=item *
+
+mem_free, mem_shared, mem_buffers, mem_cached, mem_total
+
+=item *
+
+bytes_in, bytes_out
+
+=item *
+
+pkts_in, pkts_out
+
+=back
+
+Available configuration options:
+
+=over 4
+
+=item B<MCReceiveFrom> I<MCGroup> [I<Port>]
+
+Sets sets the multicast group and UDP port to which to subscribe.
+
+Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
+
+=item E<lt>B<Metric> I<Name>E<gt>
+
+These blocks add a new metric conversion to the internal table. I<Name>, the
+string argument to the B<Metric> block, is the metric name as used by Ganglia.
+
+=over 4
+
+=item B<Type> I<Type>
+
+Type to map this metric to. Required.
+
+=item B<TypeInstance> I<Instance>
+
+Type-instance to use. Optional.
+
+=item B<DataSource> I<Name>
+
+Data source to map this metric to. If the configured type has exactly one data
+source, this is optional. Otherwise the option is required.
+
+=back
+
+=back
+

 =head2 Plugin C<hddtemp>
 
 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
 =head2 Plugin C<hddtemp>
 
 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),


@@ -1085,6 +1170,11 @@ and all other interrupts are collected.
 
 =head2 Plugin C<java>
 
 
 =head2 Plugin C<java>
 

+The I<Java> plugin makes it possible to write extensions for collectd in Java.
+This section only discusses the syntax and semantic of the configuration
+options. For more in-depth information on the I<Java> plugin, please read
+L<collectd-java(5)>.
+

 Synopsis:
 
  <Plugin "java">
 Synopsis:
 
  <Plugin "java">


@@ -1096,7 +1186,7 @@ Synopsis:
    </Plugin>
  </Plugin>
 
    </Plugin>
  </Plugin>
 

-Available config options:
+Available configuration options:

 
 =over 4
 
 
 =over 4
 


@@ -1106,40 +1196,32 @@ Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
 exactly the way the arguments to the I<java> binary on the command line work.
 Execute C<javaE<nbsp>--help> for details.
 
 exactly the way the arguments to the I<java> binary on the command line work.
 Execute C<javaE<nbsp>--help> for details.
 

-=item B<LoadPlugin> I<JavaClass>
-
-Instantiates a new I<JavaClass> object. The following methods of this class are
-used when available:
-
-=over 4
-
-=item *
-
-public int B<Config> (org.collectd.api.OConfigItem ci)
-
-=item *
-
-public int B<Init> ()
+Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
+any other options! When another option is found, the JVM will be started and
+later options will have to be ignored!

 
 

-=item *
-
-public int B<Read> ()
-
-=item *
-
-public int B<Write> (org.collectd.protocol.ValueList vl)
+=item B<LoadPlugin> I<JavaClass>

 
 

-=item *
+Instantiates a new I<JavaClass> object. The constructor of this object very
+likely then registers one or more callback methods with the server.

 
 

-public int B<Shutdown> ()
+See L<collectd-java(5)> for details.

 
 

-=back
+When the first such option is found, the virtual machine (JVM) is created. This
+means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
+B<LoadPlugin> options!

 
 

-=item B<Plugin> I<JavaClass>
+=item B<Plugin> I<Name>

 
 

-The entrie block is passed to the Java plugin as an
+The entire block is passed to the Java plugin as an

 I<org.collectd.api.OConfigItem> object.
 
 I<org.collectd.api.OConfigItem> object.
 

+For this to work, the plugin has to register a configuration callback first,
+see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
+must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
+depends on the (Java) plugin registering the callback and is completely
+independent from the I<JavaClass> argument passed to B<LoadPlugin>.
+

 =back
 
 =head2 Plugin C<libvirt>
 =back
 
 =head2 Plugin C<libvirt>


@@ -1797,6 +1879,13 @@ to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
 
 =head2 Plugin C<ping>
 
 
 =head2 Plugin C<ping>
 

+The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
+configured hosts periodically and measures the network latency. Whenever the
+C<read> function of the plugin is called, it submits the average latency, the
+standard deviation and the drop rate for each host.
+
+Available configuration options:
+

 =over 4
 
 =item B<Host> I<IP-address>
 =over 4
 
 =item B<Host> I<IP-address>


@@ -1804,6 +1893,26 @@ to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
 Host to ping periodically. This option may be repeated several times to ping
 multiple hosts.
 
 Host to ping periodically. This option may be repeated several times to ping
 multiple hosts.
 

+=item B<Interval> I<Seconds>
+
+Sets the interval in which to send ICMP echo packets to the configured hosts.
+This is B<not> the interval in which statistics are queries from the plugin but
+the interval in which the hosts are "pinged". Therefore, the setting here
+should be smaller than or equal to the global B<Interval> setting. Fractional
+times, such as "1.24" are allowed.
+
+Default: B<1.0>
+
+=item B<Timeout> I<Seconds>
+
+Time to wait for a response from the host to which an ICMP packet had been
+sent. If a reply was not received after I<Seconds> seconds, the host is assumed
+to be down or the packet to be dropped. This setting must be smaller than the
+B<Interval> setting above for the plugin to work correctly. Fractional
+arguments are accepted.
+
+Default: B<0.9>
+

 =item B<TTL> I<0-255>
 
 Sets the Time-To-Live of generated ICMP packets.
 =item B<TTL> I<0-255>
 
 Sets the Time-To-Live of generated ICMP packets.


@@ -2290,6 +2399,39 @@ slashes.
 
 =back
 
 
 =back
 

+=head2 Plugin C<protocols>
+
+Collects a lot of information about various network protocols, such as I<IP>,
+I<TCP>, I<UDP>, etc.
+
+Available configuration options:
+
+=over 4
+
+=item B<Value> I<Selector>
+
+Selects whether or not to select a specific value. The string being matched is
+of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
+plugin instance and I<ValueName> will be used as type instance. An example of
+the string being used would be C<Tcp:RetransSegs>.
+
+You can use regular expressions to match a large number of values with just one
+configuration option. To select all "extended" I<TCP> values, you could use the
+following statement:
+
+  Value "/^TcpExt:/"
+
+Whether only matched values are selected or all matched values are ignored
+depends on the B<IgnoreSelected>. By default, only matched values are selected.
+If no value is configured at all, all values will be selected.
+
+=item B<IgnoreSelected> B<true>|B<false>
+
+If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
+matching values will be ignored.
+
+=back
+

 =head2 Plugin C<rrdcached>
 
 The C<rrdcached> plugin uses the RRDTool accelerator daemon, L<rrdcached(1)>,
 =head2 Plugin C<rrdcached>
 
 The C<rrdcached> plugin uses the RRDTool accelerator daemon, L<rrdcached(1)>,