X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=48b75bc82f9cfa6a32e263c950dc108bbd67c915;hb=04b395325b152a5ddf424d1a750f455a2f8229fb;hp=a8831b92af91de222bae35b4b85acacd6f25017f;hpb=eeb86d2d88b08cfc2f0701ca9b7a77d6731c7b94;p=collectd.git

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index a8831b92..48b75bc8 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1083,6 +1083,65 @@ and all other interrupts are collected.
 
 =back
 
+=head2 Plugin C<java>
+
+Synopsis:
+
+ <Plugin "java">
+   JVMArg "-verbose:jni"
+   JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
+   LoadPlugin "org.collectd.java.Foobar"
+   <Plugin "org.collectd.java.Foobar">
+     # To be parsed by the plugin
+   </Plugin>
+ </Plugin>
+
+Available config options:
+
+=over 4
+
+=item B<JVMArg> I<Argument>
+
+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.
+
+=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> ()
+
+=item *
+
+public int B<Read> ()
+
+=item *
+
+public int B<Write> (org.collectd.protocol.ValueList vl)
+
+=item *
+
+public int B<Shutdown> ()
+
+=back
+
+=item B<Plugin> I<JavaClass>
+
+The entrie block is passed to the Java plugin as an
+I<org.collectd.api.OConfigItem> object.
+
+=back
+
 =head2 Plugin C<libvirt>
 
 This plugin allows CPU, disk and network load to be collected for virtualized
@@ -2486,6 +2545,10 @@ table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
 of a table - see its documentation for more details. This option is mandatory.
 
+A horizontal tab, newline and carriage return may be specified by C<\\t>,
+C<\\n> and C<\\r> respectively. Please note that the double backslashes are
+required because of collectd's config parsing.
+
 =back
 
 The following options are available inside a B<Result> block: