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