src/collectd-java.pod

   1 =head1 NAME
   2
   3 collectd-java - Documentation of collectd's "java plugin"
   4
   5 =head1 SYNOPSIS
   6
   7  LoadPlugin "java"
   8  <Plugin "java">
   9    JVMArg "-verbose:jni"
  10    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
  11
  12    LoadPlugin "org.collectd.java.Foobar"
  13    <Plugin "org.collectd.java.Foobar">
  14      # To be parsed by the plugin
  15    </Plugin>
  16  </Plugin>
  17
  18 =head1 DESCRIPTION
  19
  20 The I<Java> plugin embeds a I<Java Virtual Machine> (JVM) into I<collectd> and
  21 provides a Java interface to part of collectd's API. This makes it possible to
  22 write additions to the daemon in Java.
  23
  24 This plugin is similar in nature to, but shares no code with, the I<Perl>
  25 plugin by Sebastian Harl, see L<collectd-perl(5)> for details.
  26
  27 =head1 CONFIGURATION
  28
  29 A short outline of this plugin's configuration can be seen in L<"SYNOPSIS">
  30 above. For a complete list of all configuration options and their semantics
  31 please read L<collectd.conf(5)/Plugin C<java>>.
  32
  33 =head1 OVERVIEW
  34
  35 When writing additions for collectd in Java, the underlying C base is mostly
  36 hidden from you. All complex data types are converted to their Java counterparts
  37 before they're passed to your functions. These Java classes reside in the
  38 I<org.collectd.api> namespace.
  39
  40 The available classes are:
  41
  42 =over 4
  43
  44 =item B<org.collectd.api.OConfigValue>
  45
  46 Corresponds to C<oconfig_value_t>, defined in F<src/liboconfig/oconfig.h>.
  47
  48 =item B<org.collectd.api.OConfigItem>
  49
  50 Corresponds to C<oconfig_item_t>, defined in F<src/liboconfig/oconfig.h>.
  51
  52 =item B<org.collectd.api.DataSource>
  53
  54 Corresponds to C<data_source_t>, defined in F<src/plugin.h>.
  55
  56 =item B<org.collectd.api.DataSet>
  57
  58 Corresponds to C<data_set_t>, defined in F<src/plugin.h>.
  59
  60 =item B<org.collectd.api.ValueList>
  61
  62 Corresponds to C<value_list_t>, defined in F<src/plugin.h>.
  63
  64 =back
  65
  66 In the remainder of this document, we'll use the short form of these names, for
  67 example B<ValueList>. In order to be able to use these abbreviated names, you
  68 need to B<import> the classes.
  69
  70 The API functions that are available from Java are implemented as I<static>
  71 functions of the B<org.collectd.api.CollectdAPI> class.
  72 See L<"CALLING API FUNCTIONS"> below for details.
  73
  74 =head1 REGISTERING CALLBACKS
  75
  76 When starting up, collectd creates an object of each configured class. The
  77 constructor of this class should then register "callbacks" with the daemon,
  78 using the appropriate static functions in B<CollectdAPI>,
  79 see L<"CALLING API FUNCTIONS"> below. To register a callback, the object being
  80 passed to one of the register functions must implement an appropriate
  81 interface, which are all in the B<org.collectd.api> namespace.
  82
  83 A constructor may register any number of these callbacks, even none. An object
  84 without callback methods is never actively called by collectd, but may still
  85 call the exported API functions. One could, for example, start a new thread in
  86 the constructor and dispatch (submit to the daemon) values asynchronously,
  87 whenever one is available.
  88
  89 Each callback method is now explained in more detail:
  90
  91 =head2 config callback
  92
  93 Interface: B<org.collectd.api.CollectdConfigInterface>
  94
  95 Signature: I<int> B<config> (I<OConfigItem>)
  96
  97 This method is passed a B<OConfigItem> object, if both, method and
  98 configuration, are available. B<OConfigItem> is the root of a tree representing
  99 the configuration for this plugin. The root itself is the representation of the
 100 B<E<lt>PluginE<nbsp>/E<gt>> block, so in next to all cases the children of the
 101 root are the first interesting objects.
 102
 103 To signal success, this method has to return zero. Anything else will be
 104 considered an error condition and the plugin will be disabled entirely.
 105
 106 =head2 init callback
 107
 108 Interface: B<org.collectd.api.CollectdInitInterface>
 109
 110 Signature: I<int> B<init> ()
 111
 112 This method is called after the configuration has been handled. It is
 113 supposed to set up the plugin. e.E<nbsp>g. start threads, open connections, or
 114 check if can do anything useful at all.
 115
 116 To signal success, this method has to return zero. Anything else will be
 117 considered an error condition and the plugin will be disabled entirely.
 118
 119 =head2 read callback
 120
 121 Interface: B<org.collectd.api.CollectdReadInterface>
 122
 123 Signature: I<int> B<read> ()
 124
 125 This method is called periodically and is supposed to gather statistics in
 126 whatever fashion. These statistics are represented as a B<ValueList> object and
 127 sent to the daemon using B<dispatchValues>, see L<"CALLING API FUNCTIONS">
 128 below.
 129
 130 To signal success, this method has to return zero. Anything else will be
 131 considered an error condition and cause an appropriate message to be logged.
 132 Currently, returning non-zero does not have any other effects. In particular,
 133 Java "read"-methods are not suspended for increasing intervals like C
 134 "read"-functions.
 135
 136 =head2 write callback
 137
 138 Interface: B<org.collectd.api.CollectdWriteInterface>
 139
 140 Signature: I<int> B<write> (I<ValueList>)
 141
 142 This method is called whenever a value is dispatched to the daemon. The
 143 corresponding C "write"-functions are passed a C<data_set_t>, so they can
 144 decide which values are absolute values (gauge) and which are counter values.
 145 To get the corresponding C<ListE<lt>DataSourceE<gt>>, call the B<getDataSource>
 146 method of the B<ValueList> object.
 147
 148 To signal success, this method has to return zero. Anything else will be
 149 considered an error condition and cause an appropriate message to be logged.
 150
 151 =head2 shutdown callback
 152
 153 Interface: B<org.collectd.api.CollectdShutdownInterface>
 154
 155 Signature: I<int> B<shutdown> ()
 156
 157 This method is called when the daemon is shutting down. You should not rely on
 158 the destructor to clean up behind the object but use this function instead.
 159
 160 To signal success, this method has to return zero. Anything else will be
 161 considered an error condition and cause an appropriate message to be logged.
 162
 163 =head2 Example
 164
 165 This short example demonstrates how to register a read callback with the
 166 daemon:
 167
 168   import org.collectd.api.CollectdAPI;
 169   import org.collectd.api.ValueList;
 170
 171   import org.collectd.api.CollectdReadInterface;
 172
 173   public class Foobar implements CollectdReadInterface
 174   {
 175     public Foobar ()
 176     {
 177       CollectdAPI.registerRead ("Foobar", this);
 178     }
 179
 180     public int read ()
 181     {
 182       ValueList vl;
 183
 184       /* Do something... */
 185
 186       CollectdAPI.dispatchValues (vl);
 187     }
 188   }
 189
 190 =head1 CALLING API FUNCTIONS
 191
 192 All collectd API functions that are available to Java plugins are implemented
 193 as I<publicE<nbsp>static> functions of the B<org.collectd.api.CollectdAPI>
 194 class. This makes calling these functions pretty straight forward.
 195
 196 The currently exported functions are:
 197
 198 =head2 registerRead
 199
 200 Signature: I<int> B<registerRead> (I<String> name,
 201 I<CollectdReadInterface> object)
 202
 203 Registers the B<read> function of I<object> with the daemon.
 204 For a description of the B<CollectdReadInterface> interface, see
 205 L<"REGISTERING CALLBACKS"> above.
 206
 207 Returns zero upon success and non-zero when an error occurred.
 208
 209 =head2 registerWrite
 210
 211 Signature: I<int> B<registerWrite> (I<String> name,
 212 I<CollectdWriteInterface> object)
 213
 214 Registers the B<write> function of I<object> with the daemon.
 215 For a description of the B<CollectdWriteInterface> interface, see
 216 L<"REGISTERING CALLBACKS"> above.
 217
 218 Returns zero upon success and non-zero when an error occurred.
 219
 220 =head2 dispatchValues
 221
 222 Signature: I<int> B<dispatchValues> (I<ValueList>)
 223
 224 Passes the values represented by the B<ValueList> object to the
 225 C<plugin_dispatch_values> function of the daemon. The "data set" (or list of
 226 "data sources") associated with the object are ignored, because
 227 C<plugin_dispatch_values> will automatically lookup the required data set. It
 228 is therefore absolutely okay to leave this blank.
 229
 230 Returns zero upon success or non-zero upon failure.
 231
 232 =head2 getDS
 233
 234 Signature: I<DataSet> B<getDS> (I<String>)
 235
 236 Returns the approrpate I<type> or B<null> if the type is not defined.
 237
 238 =head1 SEE ALSO
 239
 240 L<collectd(1)>,
 241 L<collectd.conf(5)>,
 242 L<collectd-perl(5)>,
 243 L<types.db(5)>
 244
 245 =head1 AUTHOR
 246
 247 Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>
 248