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 =item B<org.collectd.api.Notification>
  65
  66 Corresponds to C<notification_t>, defined in F<src/plugin.h>.
  67
  68 =back
  69
  70 In the remainder of this document, we'll use the short form of these names, for
  71 example B<ValueList>. In order to be able to use these abbreviated names, you
  72 need to B<import> the classes.
  73
  74 The API functions that are available from Java are implemented as I<static>
  75 functions of the B<org.collectd.api.Collectd> class.
  76 See L<"CALLING API FUNCTIONS"> below for details.
  77
  78 =head1 REGISTERING CALLBACKS
  79
  80 When starting up, collectd creates an object of each configured class. The
  81 constructor of this class should then register "callbacks" with the daemon,
  82 using the appropriate static functions in B<Collectd>,
  83 see L<"CALLING API FUNCTIONS"> below. To register a callback, the object being
  84 passed to one of the register functions must implement an appropriate
  85 interface, which are all in the B<org.collectd.api> namespace.
  86
  87 A constructor may register any number of these callbacks, even none. An object
  88 without callback methods is never actively called by collectd, but may still
  89 call the exported API functions. One could, for example, start a new thread in
  90 the constructor and dispatch (submit to the daemon) values asynchronously,
  91 whenever one is available.
  92
  93 Each callback method is now explained in more detail:
  94
  95 =head2 config callback
  96
  97 Interface: B<org.collectd.api.CollectdConfigInterface>
  98
  99 Signature: I<int> B<config> (I<OConfigItem> ci)
 100
 101 This method is passed a B<OConfigItem> object, if both, method and
 102 configuration, are available. B<OConfigItem> is the root of a tree representing
 103 the configuration for this plugin. The root itself is the representation of the
 104 B<E<lt>PluginE<nbsp>/E<gt>> block, so in next to all cases the children of the
 105 root are the first interesting objects.
 106
 107 To signal success, this method has to return zero. Anything else will be
 108 considered an error condition and the plugin will be disabled entirely.
 109
 110 =head2 init callback
 111
 112 Interface: B<org.collectd.api.CollectdInitInterface>
 113
 114 Signature: I<int> B<init> ()
 115
 116 This method is called after the configuration has been handled. It is
 117 supposed to set up the plugin. e.E<nbsp>g. start threads, open connections, or
 118 check if can do anything useful at all.
 119
 120 To signal success, this method has to return zero. Anything else will be
 121 considered an error condition and the plugin will be disabled entirely.
 122
 123 =head2 read callback
 124
 125 Interface: B<org.collectd.api.CollectdReadInterface>
 126
 127 Signature: I<int> B<read> ()
 128
 129 This method is called periodically and is supposed to gather statistics in
 130 whatever fashion. These statistics are represented as a B<ValueList> object and
 131 sent to the daemon using B<dispatchValues>, see L<"CALLING API FUNCTIONS">
 132 below.
 133
 134 To signal success, this method has to return zero. Anything else will be
 135 considered an error condition and cause an appropriate message to be logged.
 136 Currently, returning non-zero does not have any other effects. In particular,
 137 Java "read"-methods are not suspended for increasing intervals like C
 138 "read"-functions.
 139
 140 =head2 write callback
 141
 142 Interface: B<org.collectd.api.CollectdWriteInterface>
 143
 144 Signature: I<int> B<write> (I<ValueList> vl)
 145
 146 This method is called whenever a value is dispatched to the daemon. The
 147 corresponding C "write"-functions are passed a C<data_set_t>, so they can
 148 decide which values are absolute values (gauge) and which are counter values.
 149 To get the corresponding C<ListE<lt>DataSourceE<gt>>, call the B<getDataSource>
 150 method of the B<ValueList> object.
 151
 152 To signal success, this method has to return zero. Anything else will be
 153 considered an error condition and cause an appropriate message to be logged.
 154
 155 =head2 flush callback
 156
 157 Interface: B<org.collectd.api.CollectdFlushInterface>
 158
 159 Signature: I<int> B<flush> (I<int> timeout, I<String> identifier)
 160
 161 This method is called when the daemon received a flush command. This can either
 162 be done using the C<USR1> signal (see L<collectd(1)>) or using the I<unixsock>
 163 plugin (see L<collectd-unixsock(5)>).
 164
 165 If I<timeout> is greater than zero, only values older than this number of
 166 seconds should be flushed. To signal that all values should be flushed
 167 regardless of age, this argument is set to a negative number.
 168
 169 The I<identifier> specifies which value should be flushed. If it is not
 170 possible to flush one specific value, flush all values. To signal that all
 171 values should be flushed, this argument is set to I<null>.
 172
 173 To signal success, this method has to return zero. Anything else will be
 174 considered an error condition and cause an appropriate message to be logged.
 175
 176 =head2 shutdown callback
 177
 178 Interface: B<org.collectd.api.CollectdShutdownInterface>
 179
 180 Signature: I<int> B<shutdown> ()
 181
 182 This method is called when the daemon is shutting down. You should not rely on
 183 the destructor to clean up behind the object but use this function instead.
 184
 185 To signal success, this method has to return zero. Anything else will be
 186 considered an error condition and cause an appropriate message to be logged.
 187
 188 =head2 log callback
 189
 190 Interface: B<org.collectd.api.CollectdLogInterface>
 191
 192 Signature: I<void> B<log> (I<int> severity, I<String> message)
 193
 194 This callback can be used to receive log messages from the daemon.
 195
 196 The argument I<severity> is one of:
 197
 198 =over 4
 199
 200 =item *
 201
 202 org.collectd.api.Collectd.LOG_ERR
 203
 204 =item *
 205
 206 org.collectd.api.Collectd.LOG_WARNING
 207
 208 =item *
 209
 210 org.collectd.api.Collectd.LOG_NOTICE
 211
 212 =item *
 213
 214 org.collectd.api.Collectd.LOG_INFO
 215
 216 =item *
 217
 218 org.collectd.api.Collectd.LOG_DEBUG
 219
 220 =back
 221
 222 The function does not return any value.
 223
 224 =head2 notification callback
 225
 226 Interface: B<org.collectd.api.CollectdNotificationInterface>
 227
 228 Signature: I<int> B<notification> (I<Notification> n)
 229
 230 This callback can be used to receive notifications from the daemon.
 231
 232 To signal success, this method has to return zero. Anything else will be
 233 considered an error condition and cause an appropriate message to be logged.
 234
 235 =head2 Example
 236
 237 This short example demonstrates how to register a read callback with the
 238 daemon:
 239
 240   import org.collectd.api.Collectd;
 241   import org.collectd.api.ValueList;
 242
 243   import org.collectd.api.CollectdReadInterface;
 244
 245   public class Foobar implements CollectdReadInterface
 246   {
 247     public Foobar ()
 248     {
 249       Collectd.registerRead ("Foobar", this);
 250     }
 251
 252     public int read ()
 253     {
 254       ValueList vl;
 255
 256       /* Do something... */
 257
 258       Collectd.dispatchValues (vl);
 259     }
 260   }
 261
 262 =head1 CALLING API FUNCTIONS
 263
 264 All collectd API functions that are available to Java plugins are implemented
 265 as I<publicE<nbsp>static> functions of the B<org.collectd.api.Collectd> class.
 266 This makes calling these functions pretty straight forward.
 267
 268 The following are the currently exported functions. For information on the
 269 interfaces used, please see L<"REGISTERING CALLBACKS"> above.
 270
 271 =head2 registerConfig
 272
 273 Signature: I<int> B<registerConfig> (I<String> name,
 274 I<CollectdConfigInterface> object);
 275
 276 Registers the B<config> function of I<object> with the daemon.
 277
 278 Returns zero upon success and non-zero when an error occurred.
 279
 280 =head2 registerInit
 281
 282 Signature: I<int> B<registerInit> (I<String> name,
 283 I<CollectdInitInterface> object);
 284
 285 Registers the B<init> function of I<object> with the daemon.
 286
 287 Returns zero upon success and non-zero when an error occurred.
 288
 289 =head2 registerRead
 290
 291 Signature: I<int> B<registerRead> (I<String> name,
 292 I<CollectdReadInterface> object)
 293
 294 Registers the B<read> function of I<object> with the daemon.
 295
 296 Returns zero upon success and non-zero when an error occurred.
 297
 298 =head2 registerWrite
 299
 300 Signature: I<int> B<registerWrite> (I<String> name,
 301 I<CollectdWriteInterface> object)
 302
 303 Registers the B<write> function of I<object> with the daemon.
 304
 305 Returns zero upon success and non-zero when an error occurred.
 306
 307 =head2 registerFlush
 308
 309 Signature: I<int> B<registerFlush> (I<String> name,
 310 I<CollectdFlushInterface> object)
 311
 312 Registers the B<flush> function of I<object> with the daemon.
 313
 314 Returns zero upon success and non-zero when an error occurred.
 315
 316 =head2 registerShutdown
 317
 318 Signature: I<int> B<registerShutdown> (I<String> name,
 319 I<CollectdShutdownInterface> object);
 320
 321 Registers the B<shutdown> function of I<object> with the daemon.
 322
 323 Returns zero upon success and non-zero when an error occurred.
 324
 325 =head2 registerLog
 326
 327 Signature: I<int> B<registerLog> (I<String> name,
 328 I<CollectdLogInterface> object);
 329
 330 Registers the B<log> function of I<object> with the daemon.
 331
 332 Returns zero upon success and non-zero when an error occurred.
 333
 334 =head2 registerNotification
 335
 336 Signature: I<int> B<registerNotification> (I<String> name,
 337 I<CollectdNotificationInterface> object);
 338
 339 Registers the B<notification> function of I<object> with the daemon.
 340
 341 Returns zero upon success and non-zero when an error occurred.
 342
 343 =head2 dispatchValues
 344
 345 Signature: I<int> B<dispatchValues> (I<ValueList>)
 346
 347 Passes the values represented by the B<ValueList> object to the
 348 C<plugin_dispatch_values> function of the daemon. The "data set" (or list of
 349 "data sources") associated with the object are ignored, because
 350 C<plugin_dispatch_values> will automatically lookup the required data set. It
 351 is therefore absolutely okay to leave this blank.
 352
 353 Returns zero upon success or non-zero upon failure.
 354
 355 =head2 getDS
 356
 357 Signature: I<DataSet> B<getDS> (I<String>)
 358
 359 Returns the approrpate I<type> or B<null> if the type is not defined.
 360
 361 =head2 logError
 362
 363 Signature: I<void> B<logError> (I<String>)
 364
 365 Sends a log message with severity B<ERROR> to the daemon.
 366
 367 =head2 logWarning
 368
 369 Signature: I<void> B<logWarning> (I<String>)
 370
 371 Sends a log message with severity B<WARNING> to the daemon.
 372
 373 =head2 logNotice
 374
 375 Signature: I<void> B<logNotice> (I<String>)
 376
 377 Sends a log message with severity B<NOTICE> to the daemon.
 378
 379 =head2 logInfo
 380
 381 Signature: I<void> B<logInfo> (I<String>)
 382
 383 Sends a log message with severity B<INFO> to the daemon.
 384
 385 =head2 logDebug
 386
 387 Signature: I<void> B<logDebug> (I<String>)
 388
 389 Sends a log message with severity B<DEBUG> to the daemon.
 390
 391 =head1 SEE ALSO
 392
 393 L<collectd(1)>,
 394 L<collectd.conf(5)>,
 395 L<collectd-perl(5)>,
 396 L<types.db(5)>
 397
 398 =head1 AUTHOR
 399
 400 Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>
 401