src/collectd-perl.pod

   1 =head1 NAME
   2
   3 collectd-perl - Documentation of collectd's C<perl plugin>
   4
   5 =head1 SYNOPSIS
   6
   7   LoadPlugin perl
   8   # ...
   9   <Plugin perl>
  10     IncludeDir "/path/to/perl/plugins"
  11     BaseName "Collectd::Plugin"
  12     EnableDebugger ""
  13     LoadPlugin "FooBar"
  14   </Plugin>
  15
  16 =head1 DESCRIPTION
  17
  18 The C<perl plugin> embeds a Perl-interpreter into collectd and provides an
  19 interface to collectd's plugin system. This makes it possible to write plugins
  20 for collectd in Perl. This is a lot more efficient than executing a
  21 Perl-script every time you want to read a value with the C<exec plugin> (see
  22 L<collectd-exec(5)>) and provides a lot more functionality, too.
  23
  24 =head1 CONFIGURATION
  25
  26 =over 4
  27
  28 =item B<LoadPlugin> I<Plugin>
  29
  30 Loads the Perl plugin I<Plugin>. This does basically the same as B<use> would
  31 do in a Perl program. As a side effect, the first occurrence of this option
  32 causes the Perl-interpreter to be initialized.
  33
  34 =item B<BaseName> I<Name>
  35
  36 Prepends I<Name>B<::> to all plugin names loaded after this option. This is
  37 provided for convenience to keep plugin names short.
  38
  39 =item B<EnableDebugger> I<Package>[=I<option>,...]
  40
  41 Run collectd under the control of the Perl source debugger. If I<Package> is
  42 not the empty string, control is passed to the debugging, profiling, or
  43 tracing module installed as Devel::I<Package>. A comma-separated list of
  44 options may be specified after the "=" character. Please note that you may not
  45 leave out the I<Package> option even if you specify B<"">. This is the same as
  46 using the B<-d:Package> command line option.
  47
  48 See L<perldebug> for detailed documentation about debugging Perl.
  49
  50 This option does not prevent collectd from daemonizing, so you should start
  51 collectd with the B<-f> command line option. Else you will not be able to use
  52 the command line driven interface of the debugger.
  53
  54 =item B<IncludeDir> I<Dir>
  55
  56 Adds I<Dir> to the B<@INC> array. This is the same as using the B<-IDir>
  57 command line option or B<use lib Dir> in the source code. Please note that it
  58 only has effect on plugins loaded after this option.
  59
  60 =back
  61
  62 =head1 WRITING YOUR OWN PLUGINS
  63
  64 Writing your own plugins is quite simple. collectd manages plugins by means of
  65 B<dispatch functions> which call the appropriate B<callback functions>
  66 registered by the plugins. Any plugin basically consists of the implementation
  67 of these callback functions and initializing code which registers the
  68 functions with collectd. See the section "EXAMPLES" below for a really basic
  69 example. The following types of B<callback functions> are known to collectd
  70 (all of these are optional):
  71
  72 =over 4
  73
  74 =item init functions
  75
  76 This type of functions is called once after loading the module and before any
  77 calls to the read and write functions. It should be used to initialize the
  78 internal state of the plugin (e.E<nbsp>g. open sockets, ...). If the return
  79 value evaluates to B<false>, the plugin will be disabled.
  80
  81 =item read functions
  82
  83 This type of function is used to collect the actual data. It is called once
  84 per interval (see the B<Interval> configuration option of collectd). Usually
  85 it will call B<plugin_dispatch_values> to dispatch the values to collectd
  86 which will pass them on to all registered B<write functions>. If the return
  87 value evaluates to B<false> the plugin will be skipped for an increasing
  88 amount of time until it returns B<true> again.
  89
  90 =item write functions
  91
  92 This type of function is used to write the dispatched values. It is called
  93 once for each call to B<plugin_dispatch_values>.
  94
  95 =item log functions
  96
  97 This type of function is used to pass messages of plugins or the daemon itself
  98 to the user.
  99
 100 =item notification function
 101
 102 This type of function is used to act upon notifications. In general, a
 103 notification is a status message that may be associated with a data instance.
 104 Usually, a notification is generated by the daemon if a configured threshold
 105 has been exceeded (see the section "THRESHOLD CONFIGURATION" in
 106 L<collectd.conf(5)> for more details), but any plugin may dispatch
 107 notifications as well.
 108
 109 =item shutdown functions
 110
 111 This type of function is called once before the daemon shuts down. It should
 112 be used to clean up the plugin (e.g. close sockets, ...).
 113
 114 =back
 115
 116 Any function (except log functions) may set the B<$@> variable to describe
 117 errors in more detail. The message will be passed on to the user using
 118 collectd's logging mechanism.
 119
 120 See the documentation of the B<plugin_register> method in the section
 121 "METHODS" below for the number and types of arguments passed to each
 122 B<callback function>. This section also explains how to register B<callback
 123 functions> with collectd.
 124
 125 To enable a plugin, copy it to a place where Perl can find it (i.E<nbsp>e. a
 126 directory listed in the B<@INC> array) just as any other Perl plugin and add
 127 an appropriate B<LoadPlugin> option to the configuration file. After
 128 restarting collectd you're done.
 129
 130 =head1 DATA TYPES
 131
 132 The following complex types are used to pass values between the Perl plugin
 133 and collectd:
 134
 135 =over 4
 136
 137 =item Data-Set
 138
 139 A data-set is a list of one or more data-sources. Each data-source defines a
 140 name, type, min- and max-value and the data-set wraps them up into one
 141 structure. The general layout looks like this:
 142
 143   [{
 144     name => 'data_source_name',
 145     type => DS_TYPE_COUNTER || DS_TYPE_GAUGE,
 146     min  => value || undef,
 147     max  => value || undef
 148   }, ...]
 149
 150 =item Value-List
 151
 152 A value-list is one structure which features an array of values and fields to
 153 identify the values, i.E<nbsp>e. time and host, plugin name and
 154 plugin-instance as well as a type and type-instance. Since the "type" is not
 155 included in the value-list but is passed as an extra argument, the general
 156 layout looks like this:
 157
 158   {
 159     values => [123, 0.5],
 160     time   => time (),
 161     host   => $hostname_g,
 162     plugin => 'myplugin',
 163     type   => 'myplugin',
 164     plugin_instance => '',
 165     type_instance   => ''
 166   }
 167
 168 =item Notification
 169
 170 A notification is one structure defining the severity, time and message of the
 171 status message as well as an identification of a data instance:
 172
 173   {
 174     severity => NOTIF_FAILURE || NOTIF_WARNING || NOTIF_OKAY,
 175     time     => time (),
 176     message  => 'status message',
 177     host     => $hostname_g,
 178     plugin   => 'myplugin',
 179     type     => 'mytype',
 180     plugin_instance => '',
 181     type_instance   => ''
 182   }
 183
 184 =back
 185
 186 =head1 METHODS
 187
 188 The following functions provide the C-interface to Perl-modules. They are
 189 exported by the ":plugin" export tag (see the section "EXPORTS" below).
 190
 191 =over 4
 192
 193 =item B<plugin_register> (I<type>, I<name>, I<data>)
 194
 195 Registers a callback-function or data-set.
 196
 197 I<type> can be one of:
 198
 199 =over 4
 200
 201 =item TYPE_INIT
 202
 203 =item TYPE_READ
 204
 205 =item TYPE_WRITE
 206
 207 =item TYPE_LOG
 208
 209 =item TYPE_NOTIF
 210
 211 =item TYPE_SHUTDOWN
 212
 213 =item TYPE_DATASET
 214
 215 =back
 216
 217 I<name> is the name of the callback-function or the type of the data-set,
 218 depending on the value of I<type>. (Please note that the type of the data-set
 219 is the value passed as I<name> here and has nothing to do with the I<type>
 220 argument which simply tells B<plugin_register> what is being registered.)
 221
 222 The last argument, I<data>, is either a function name or an array-reference.
 223 If I<type> is B<TYPE_DATASET>, then the I<data> argument must be an
 224 array-reference which points to an array of hashes. Each hash describes one
 225 data-set. For the exact layout see B<Data-Set> above. Please note that
 226 there is a large number of predefined data-sets available in the B<types.db>
 227 file which are automatically registered with collectd - see L<types.db(5)> for
 228 a description of the format of this file.
 229
 230 If the I<type> argument is any of the other types (B<TYPE_INIT>, B<TYPE_READ>,
 231 ...) then I<data> is expected to be a function name. If the name is not
 232 prefixed with the plugin's package name collectd will add it automatically.
 233 The interface slightly differs from the C interface (which expects a function
 234 pointer instead) because Perl does not support to share references to
 235 subroutines between threads.
 236
 237 These functions are called in the various stages of the daemon (see the
 238 section "WRITING YOUR OWN PLUGINS" above) and are passed the following
 239 arguments:
 240
 241 =over 4
 242
 243 =item TYPE_INIT
 244
 245 =item TYPE_READ
 246
 247 =item TYPE_SHUTDOWN
 248
 249 No arguments are passed
 250
 251 =item TYPE_WRITE
 252
 253 The arguments passed are I<type>, I<data-set>, and I<value-list>. I<type> is a
 254 string. For the layout of I<data-set> and I<value-list> see above.
 255
 256 =item TYPE_LOG
 257
 258 The arguments are I<log-level> and I<message>. The log level is small for
 259 important messages and high for less important messages. The least important
 260 level is B<LOG_DEBUG>, the most important level is B<LOG_ERR>. In between there
 261 are (from least to most important): B<LOG_INFO>, B<LOG_NOTICE>, and
 262 B<LOG_WARNING>. I<message> is simply a string B<without> a newline at the end.
 263
 264 =item TYPE_NOTIF
 265
 266 The only argument passed is I<notification>. See above for the layout of this
 267 data type.
 268
 269 =back
 270
 271 =item B<plugin_unregister> (I<type>, I<plugin>)
 272
 273 Removes a callback or data-set from collectd's internal list of
 274 functionsE<nbsp>/ datasets.
 275
 276 =item B<plugin_dispatch_values> (I<value-list>)
 277
 278 Submits a I<value-list> to the daemon. If the data-set identified by
 279 I<value-list>->{I<type>}
 280 is found (and the number of values matches the number of data-sources) then the
 281 type, data-set and value-list is passed to all write-callbacks that are
 282 registered with the daemon.
 283
 284 B<Note>: Prior to version 4.4 of collectd, the data-set type used to be passed
 285 as the first argument to B<plugin_register>. This syntax is still supported
 286 for backwards compatibility but has been deprecated and will be removed in
 287 some future version of collectd.
 288
 289 =item B<plugin_dispatch_notification> (I<notification>)
 290
 291 Submits a I<notification> to the daemon which will then pass it to all
 292 notification-callbacks that are registered.
 293
 294 =item B<plugin_log> (I<log-level>, I<message>)
 295
 296 Submits a I<message> of level I<log-level> to collectd's logging mechanism.
 297 The message is passed to all log-callbacks that are registered with collectd.
 298
 299 =item B<ERROR>, B<WARNING>, B<NOTICE>, B<INFO>, B<DEBUG> (I<message>)
 300
 301 Wrappers around B<plugin_log>, using B<LOG_ERR>, B<LOG_WARNING>,
 302 B<LOG_NOTICE>, B<LOG_INFO> and B<LOG_DEBUG> respectively as I<log-level>.
 303
 304 =back
 305
 306 =head1 GLOBAL VARIABLES
 307
 308 =over 4
 309
 310 =item B<$hostname_g>
 311
 312 As the name suggests this variable keeps the hostname of the system collectd
 313 is running on. The value might be influenced by the B<Hostname> or
 314 B<FQDNLookup> configuration options (see L<collectd.conf(5)> for details).
 315
 316 =item B<$interval_g>
 317
 318 This variable keeps the interval in seconds in which the read functions are
 319 queried (see the B<Interval> configuration option).
 320
 321 =back
 322
 323 Any changes to these variables will be globally visible in collectd.
 324
 325 =head1 EXPORTS
 326
 327 By default no symbols are exported. However, the following export tags are
 328 available (B<:all> will export all of them):
 329
 330 =over 4
 331
 332 =item B<:plugin>
 333
 334 =over 4
 335
 336 =item B<plugin_register> ()
 337
 338 =item B<plugin_unregister> ()
 339
 340 =item B<plugin_dispatch_values> ()
 341
 342 =item B<plugin_dispatch_notification> ()
 343
 344 =item B<plugin_log> ()
 345
 346 =back
 347
 348 =item B<:types>
 349
 350 =over 4
 351
 352 =item B<TYPE_INIT>
 353
 354 =item B<TYPE_READ>
 355
 356 =item B<TYPE_WRITE>
 357
 358 =item B<TYPE_SHUTDOWN>
 359
 360 =item B<TYPE_LOG>
 361
 362 =back
 363
 364 =item B<:ds_types>
 365
 366 =over 4
 367
 368 =item B<DS_TYPE_COUNTER>
 369
 370 =item B<DS_TYPE_GAUGE>
 371
 372 =back
 373
 374 =item B<:log>
 375
 376 =over 4
 377
 378 =item B<ERROR> ()
 379
 380 =item B<WARNING> ()
 381
 382 =item B<NOTICE> ()
 383
 384 =item B<INFO> ()
 385
 386 =item B<DEBUG> ()
 387
 388 =item B<LOG_ERR>
 389
 390 =item B<LOG_WARNING>
 391
 392 =item B<LOG_NOTICE>
 393
 394 =item B<LOG_INFO>
 395
 396 =item B<LOG_DEBUG>
 397
 398 =back
 399
 400 =item B<:notif>
 401
 402 =over 4
 403
 404 =item B<NOTIF_FAILURE>
 405
 406 =item B<NOTIF_WARNING>
 407
 408 =item B<NOTIF_OKAY>
 409
 410 =back
 411
 412 =item B<:globals>
 413
 414 =over 4
 415
 416 =item B<$hostname_g>
 417
 418 =item B<$interval_g>
 419
 420 =back
 421
 422 =back
 423
 424 =head1 EXAMPLES
 425
 426 Any Perl plugin will start similar to:
 427
 428   package Collectd::Plugins::FooBar;
 429
 430   use strict;
 431   use warnings;
 432
 433   use Collectd qw( :all );
 434
 435 A very simple read function will look like:
 436
 437   sub foobar_read
 438   {
 439     my $vl = { plugin => 'foobar' };
 440     $vl->{'values'} = [ rand(42) ];
 441     plugin_dispatch_values ('gauge', $vl);
 442     return 1;
 443   }
 444
 445 A very simple write function will look like:
 446
 447   sub foobar_write
 448   {
 449     my ($type, $ds, $vl) = @_;
 450     for (my $i = 0; $i < scalar (@$ds); ++$i) {
 451       print "$vl->{'plugin'} ($vl->{'type'}): $vl->{'values'}->[$i]\n";
 452     }
 453     return 1;
 454   }
 455
 456 To register those functions with collectd:
 457
 458   plugin_register (TYPE_READ, "foobar", "foobar_read");
 459   plugin_register (TYPE_WRITE, "foobar", "foobar_write");
 460
 461 See the section "DATA TYPES" above for a complete documentation of the data
 462 types used by the read and write functions.
 463
 464 =head1 NOTES
 465
 466 =over 4
 467
 468 =item
 469
 470 Please feel free to send in new plugins to collectd's mailinglist at
 471 E<lt>collectdE<nbsp>atE<nbsp>verplant.orgE<gt> for review and, possibly,
 472 inclusion in the main distribution. In the latter case, we will take care of
 473 keeping the plugin up to date and adapting it to new versions of collectd.
 474
 475 Before submitting your plugin, please take a look at
 476 L<http://collectd.org/dev-info.shtml>.
 477
 478 =back
 479
 480 =head1 CAVEATS
 481
 482 =over 4
 483
 484 =item
 485
 486 collectd is heavily multi-threaded. Each collectd thread accessing the perl
 487 plugin will be mapped to a Perl interpreter thread (see L<threads(3perl)>).
 488 Any such thread will be created and destroyed transparently and on-the-fly.
 489
 490 Hence, any plugin has to be thread-safe if it provides several entry points
 491 from collectd (i.E<nbsp>e. if it registers more than one callback or if a
 492 registered callback may be called more than once in parallel). Please note
 493 that no data is shared between threads by default. You have to use the
 494 B<threads::shared> module to do so.
 495
 496 =item
 497
 498 Each function name registered with collectd has to be available before the
 499 first thread has been created (i.E<nbsp>e. basically at compile time). This
 500 basically means that hacks (yes, I really consider this to be a hack) like
 501 C<*foo = \&bar; plugin_register (TYPE_READ, "plugin", "foo");> most likely
 502 will not work. This is due to the fact that the symbol table is not shared
 503 across different threads.
 504
 505 =item
 506
 507 Each plugin is usually only loaded once and kept in memory for performance
 508 reasons. Therefore, END blocks are only executed once when collectd shuts
 509 down. You should not rely on END blocks anyway - use B<shutdown functions>
 510 instead.
 511
 512 =back
 513
 514 =head1 SEE ALSO
 515
 516 L<collectd(1)>,
 517 L<collectd.conf(5)>,
 518 L<collectd-exec(5)>,
 519 L<types.db(5)>,
 520 L<perl(1)>,
 521 L<threads(3perl)>,
 522 L<threads::shared(3perl)>,
 523 L<perldebug(1)>
 524
 525 =head1 AUTHOR
 526
 527 The C<perl plugin> has been written by Sebastian Harl
 528 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
 529
 530 This manpage has been written by Florian Forster
 531 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt> and Sebastian Harl
 532 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
 533
 534 =cut
 535