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 || DS_TYPE_DERIVE || DS_TYPE_ABSOLUTE,
 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 =item Match-Proc
 229
 230 A match-proc is one structure storing the callbacks of a "match" of the filter
 231 chain infrastructure. The general layout looks like this:
 232
 233   {
 234     create  => 'my_create',
 235     destroy => 'my_destroy',
 236     match   => 'my_match'
 237   }
 238
 239 =item Target-Proc
 240
 241 A target-proc is one structure storing the callbacks of a "target" of the
 242 filter chain infrastructure. The general layout looks like this:
 243
 244   {
 245     create  => 'my_create',
 246     destroy => 'my_destroy',
 247     invoke  => 'my_invoke'
 248   }
 249
 250 =back
 251
 252 =head1 METHODS
 253
 254 The following functions provide the C-interface to Perl-modules. They are
 255 exported by the ":plugin" export tag (see the section "EXPORTS" below).
 256
 257 =over 4
 258
 259 =item B<plugin_register> (I<type>, I<name>, I<data>)
 260
 261 Registers a callback-function or data-set.
 262
 263 I<type> can be one of:
 264
 265 =over 4
 266
 267 =item TYPE_CONFIG
 268
 269 =item TYPE_INIT
 270
 271 =item TYPE_READ
 272
 273 =item TYPE_WRITE
 274
 275 =item TYPE_FLUSH
 276
 277 =item TYPE_LOG
 278
 279 =item TYPE_NOTIF
 280
 281 =item TYPE_SHUTDOWN
 282
 283 =item TYPE_DATASET
 284
 285 =back
 286
 287 I<name> is the name of the callback-function or the type of the data-set,
 288 depending on the value of I<type>. (Please note that the type of the data-set
 289 is the value passed as I<name> here and has nothing to do with the I<type>
 290 argument which simply tells B<plugin_register> what is being registered.)
 291
 292 The last argument, I<data>, is either a function name or an array-reference.
 293 If I<type> is B<TYPE_DATASET>, then the I<data> argument must be an
 294 array-reference which points to an array of hashes. Each hash describes one
 295 data-set. For the exact layout see B<Data-Set> above. Please note that
 296 there is a large number of predefined data-sets available in the B<types.db>
 297 file which are automatically registered with collectd - see L<types.db(5)> for
 298 a description of the format of this file.
 299
 300 B<Note>: Using B<plugin_register> to register a data-set is deprecated. Add
 301 the new type to a custom L<types.db(5)> file instead. This functionality might
 302 be removed in a future version of collectd.
 303
 304 If the I<type> argument is any of the other types (B<TYPE_INIT>, B<TYPE_READ>,
 305 ...) then I<data> is expected to be a function name. If the name is not
 306 prefixed with the plugin's package name collectd will add it automatically.
 307 The interface slightly differs from the C interface (which expects a function
 308 pointer instead) because Perl does not support to share references to
 309 subroutines between threads.
 310
 311 These functions are called in the various stages of the daemon (see the
 312 section "WRITING YOUR OWN PLUGINS" above) and are passed the following
 313 arguments:
 314
 315 =over 4
 316
 317 =item TYPE_CONFIG
 318
 319 The only argument passed is I<config-item>. See above for the layout of this
 320 data type.
 321
 322 =item TYPE_INIT
 323
 324 =item TYPE_READ
 325
 326 =item TYPE_SHUTDOWN
 327
 328 No arguments are passed.
 329
 330 =item TYPE_WRITE
 331
 332 The arguments passed are I<type>, I<data-set>, and I<value-list>. I<type> is a
 333 string. For the layout of I<data-set> and I<value-list> see above.
 334
 335 =item TYPE_FLUSH
 336
 337 The arguments passed are I<timeout> and I<identifier>. I<timeout> indicates
 338 that only data older than I<timeout> seconds is to be flushed. I<identifier>
 339 specifies which values are to be flushed.
 340
 341 =item TYPE_LOG
 342
 343 The arguments are I<log-level> and I<message>. The log level is small for
 344 important messages and high for less important messages. The least important
 345 level is B<LOG_DEBUG>, the most important level is B<LOG_ERR>. In between there
 346 are (from least to most important): B<LOG_INFO>, B<LOG_NOTICE>, and
 347 B<LOG_WARNING>. I<message> is simply a string B<without> a newline at the end.
 348
 349 =item TYPE_NOTIF
 350
 351 The only argument passed is I<notification>. See above for the layout of this
 352 data type.
 353
 354 =back
 355
 356 =item B<plugin_unregister> (I<type>, I<plugin>)
 357
 358 Removes a callback or data-set from collectd's internal list of
 359 functionsE<nbsp>/ datasets.
 360
 361 =item B<plugin_dispatch_values> (I<value-list>)
 362
 363 Submits a I<value-list> to the daemon. If the data-set identified by
 364 I<value-list>->{I<type>}
 365 is found (and the number of values matches the number of data-sources) then the
 366 type, data-set and value-list is passed to all write-callbacks that are
 367 registered with the daemon.
 368
 369 B<Note>: Prior to version 4.4 of collectd, the data-set type used to be passed
 370 as the first argument to B<plugin_register>. This syntax is still supported
 371 for backwards compatibility but has been deprecated and will be removed in
 372 some future version of collectd.
 373
 374 =item B<plugin_write> ([B<plugins> => I<...>][, B<datasets> => I<...>],
 375 B<valuelists> => I<...>)
 376
 377 Calls the write function of the given I<plugins> with the provided I<data
 378 sets> and I<value lists>. In contrast to B<plugin_dispatch_values>, it does
 379 not update collectd's internal cache and bypasses the filter mechanism (see
 380 L<collectd.conf(5)> for details). If the B<plugins> argument has been omitted,
 381 the values will be dispatched to all registered write plugins. If the
 382 B<datasets> argument has been omitted, the required data sets are looked up
 383 according to the C<type> member in the appropriate value list. The value of
 384 all three arguments may either be a single scalar or a reference to an array.
 385 If the B<datasets> argument has been specified, the number of data sets has to
 386 equal the number of specified value lists.
 387
 388 =item B<plugin_flush> ([B<timeout> => I<timeout>][, B<plugins> => I<...>][,
 389 B<identifiers> => I<...>])
 390
 391 Flush one or more plugins. I<timeout> and the specified I<identifiers> are
 392 passed on to the registered flush-callbacks. If omitted, the timeout defaults
 393 to C<-1>. The identifier defaults to the undefined value. If the B<plugins>
 394 argument has been specified, only named plugins will be flushed. The value of
 395 the B<plugins> and B<identifiers> arguments may either be a string or a
 396 reference to an array of strings.
 397
 398 =item B<plugin_flush_one> (I<timeout>, I<plugin>)
 399
 400 This is identical to using "plugin_flush (timeout =E<gt> I<timeout>, plugins
 401 =E<gt> I<plugin>".
 402
 403 B<Note>: Starting with version 4.5 of collectd, B<plugin_flush_one> has been
 404 deprecated and will be removed in some future version of collectd. Use
 405 B<plugin_flush> instead.
 406
 407 =item B<plugin_flush_all> (I<timeout>)
 408
 409 This is identical to using "plugin_flush (timeout =E<gt> I<timeout>)".
 410
 411 B<Note>: Starting with version 4.5 of collectd, B<plugin_flush_all> has been
 412 deprecated and will be removed in some future version of collectd. Use
 413 B<plugin_flush> instead.
 414
 415 =item B<plugin_dispatch_notification> (I<notification>)
 416
 417 Submits a I<notification> to the daemon which will then pass it to all
 418 notification-callbacks that are registered.
 419
 420 =item B<plugin_log> (I<log-level>, I<message>)
 421
 422 Submits a I<message> of level I<log-level> to collectd's logging mechanism.
 423 The message is passed to all log-callbacks that are registered with collectd.
 424
 425 =item B<ERROR>, B<WARNING>, B<NOTICE>, B<INFO>, B<DEBUG> (I<message>)
 426
 427 Wrappers around B<plugin_log>, using B<LOG_ERR>, B<LOG_WARNING>,
 428 B<LOG_NOTICE>, B<LOG_INFO> and B<LOG_DEBUG> respectively as I<log-level>.
 429
 430 =back
 431
 432 The following function provides the filter chain C-interface to Perl-modules.
 433 It is exported by the ":filter_chain" export tag (see the section "EXPORTS"
 434 below).
 435
 436 =over 4
 437
 438 =item B<fc_register> (I<type>, I<name>, I<proc>)
 439
 440 Registers filter chain callbacks with collectd.
 441
 442 I<type> may be any of:
 443
 444 =over 4
 445
 446 =item FC_MATCH
 447
 448 =item FC_TARGET
 449
 450 =back
 451
 452 I<name> is the name of the match or target. By this name, the callbacks are
 453 identified in the configuration file when specifying a B<Match> or B<Target>
 454 block (see L<collectd.conf(5)> for details).
 455
 456 I<proc> is a hash reference. The hash includes up to three callbacks: an
 457 optional constructor (B<create>) and destructor (B<destroy>) and a mandatory
 458 B<match> or B<invoke> callback. B<match> is called whenever processing an
 459 appropriate match, while B<invoke> is called whenever processing an
 460 appropriate target (see the section "FILTER CONFIGURATION" in
 461 L<collectd.conf(5)> for details). Just like any other callbacks, filter chain
 462 callbacks are identified by the function name rather than a function pointer
 463 because Perl does not support to share references to subroutines between
 464 threads. The following arguments are passed to the callbacks:
 465
 466 =over 4
 467
 468 =item create
 469
 470 The arguments passed are I<config-item> and I<user-data>. See above for the
 471 layout of the config-item data-type. I<user-data> is a reference to a scalar
 472 value that may be used to store any information specific to this particular
 473 instance. The daemon does not care about this information at all. It's for the
 474 plugin's use only.
 475
 476 =item destroy
 477
 478 The only argument passed is I<user-data> which is a reference to the user data
 479 initialized in the B<create> callback. This callback may be used to cleanup
 480 instance-specific information and settings.
 481
 482 =item match, invoke
 483
 484 The arguments passed are I<data-set>, I<value-list>, I<meta> and I<user-data>.
 485 See above for the layout of the data-set and value-list data-types. I<meta> is
 486 a pointer to an array of meta information, just like the B<meta> member of the
 487 notification data-type (see above). I<user-data> is a reference to the user
 488 data initialized in the B<create> callback.
 489
 490 =back
 491
 492 =back
 493
 494 =head1 GLOBAL VARIABLES
 495
 496 =over 4
 497
 498 =item B<$hostname_g>
 499
 500 As the name suggests this variable keeps the hostname of the system collectd
 501 is running on. The value might be influenced by the B<Hostname> or
 502 B<FQDNLookup> configuration options (see L<collectd.conf(5)> for details).
 503
 504 =item B<$interval_g>
 505
 506 This variable keeps the interval in seconds in which the read functions are
 507 queried (see the B<Interval> configuration option).
 508
 509 =back
 510
 511 Any changes to these variables will be globally visible in collectd.
 512
 513 =head1 EXPORTS
 514
 515 By default no symbols are exported. However, the following export tags are
 516 available (B<:all> will export all of them):
 517
 518 =over 4
 519
 520 =item B<:plugin>
 521
 522 =over 4
 523
 524 =item B<plugin_register> ()
 525
 526 =item B<plugin_unregister> ()
 527
 528 =item B<plugin_dispatch_values> ()
 529
 530 =item B<plugin_flush> ()
 531
 532 =item B<plugin_flush_one> ()
 533
 534 =item B<plugin_flush_all> ()
 535
 536 =item B<plugin_dispatch_notification> ()
 537
 538 =item B<plugin_log> ()
 539
 540 =back
 541
 542 =item B<:types>
 543
 544 =over 4
 545
 546 =item B<TYPE_CONFIG>
 547
 548 =item B<TYPE_INIT>
 549
 550 =item B<TYPE_READ>
 551
 552 =item B<TYPE_WRITE>
 553
 554 =item B<TYPE_FLUSH>
 555
 556 =item B<TYPE_SHUTDOWN>
 557
 558 =item B<TYPE_LOG>
 559
 560 =item B<TYPE_DATASET>
 561
 562 =back
 563
 564 =item B<:ds_types>
 565
 566 =over 4
 567
 568 =item B<DS_TYPE_COUNTER>
 569
 570 =item B<DS_TYPE_GAUGE>
 571
 572 =item B<DS_TYPE_DERIVE>
 573
 574 =item B<DS_TYPE_ABSOLUTE>
 575
 576 =back
 577
 578 =item B<:log>
 579
 580 =over 4
 581
 582 =item B<ERROR> ()
 583
 584 =item B<WARNING> ()
 585
 586 =item B<NOTICE> ()
 587
 588 =item B<INFO> ()
 589
 590 =item B<DEBUG> ()
 591
 592 =item B<LOG_ERR>
 593
 594 =item B<LOG_WARNING>
 595
 596 =item B<LOG_NOTICE>
 597
 598 =item B<LOG_INFO>
 599
 600 =item B<LOG_DEBUG>
 601
 602 =back
 603
 604 =item B<:filter_chain>
 605
 606 =over 4
 607
 608 =item B<fc_register>
 609
 610 =item B<FC_MATCH_NO_MATCH>
 611
 612 =item B<FC_MATCH_MATCHES>
 613
 614 =item B<FC_TARGET_CONTINUE>
 615
 616 =item B<FC_TARGET_STOP>
 617
 618 =item B<FC_TARGET_RETURN>
 619
 620 =back
 621
 622 =item B<:fc_types>
 623
 624 =over 4
 625
 626 =item B<FC_MATCH>
 627
 628 =item B<FC_TARGET>
 629
 630 =back
 631
 632 =item B<:notif>
 633
 634 =over 4
 635
 636 =item B<NOTIF_FAILURE>
 637
 638 =item B<NOTIF_WARNING>
 639
 640 =item B<NOTIF_OKAY>
 641
 642 =back
 643
 644 =item B<:globals>
 645
 646 =over 4
 647
 648 =item B<$hostname_g>
 649
 650 =item B<$interval_g>
 651
 652 =back
 653
 654 =back
 655
 656 =head1 EXAMPLES
 657
 658 Any Perl plugin will start similar to:
 659
 660   package Collectd::Plugins::FooBar;
 661
 662   use strict;
 663   use warnings;
 664
 665   use Collectd qw( :all );
 666
 667 A very simple read function might look like:
 668
 669   sub foobar_read
 670   {
 671     my $vl = { plugin => 'foobar' };
 672     $vl->{'values'} = [ rand(42) ];
 673     plugin_dispatch_values ('gauge', $vl);
 674     return 1;
 675   }
 676
 677 A very simple write function might look like:
 678
 679   sub foobar_write
 680   {
 681     my ($type, $ds, $vl) = @_;
 682     for (my $i = 0; $i < scalar (@$ds); ++$i) {
 683       print "$vl->{'plugin'} ($vl->{'type'}): $vl->{'values'}->[$i]\n";
 684     }
 685     return 1;
 686   }
 687
 688 A very simple match callback might look like:
 689
 690   sub foobar_match
 691   {
 692     my ($ds, $vl, $meta, $user_data) = @_;
 693     if (matches($ds, $vl)) {
 694       return FC_MATCH_MATCHES;
 695     } else {
 696       return FC_MATCH_NO_MATCH;
 697     }
 698   }
 699
 700 To register those functions with collectd:
 701
 702   plugin_register (TYPE_READ, "foobar", "foobar_read");
 703   plugin_register (TYPE_WRITE, "foobar", "foobar_write");
 704
 705   fc_register (FC_MATCH, "foobar", "foobar_match");
 706
 707 See the section "DATA TYPES" above for a complete documentation of the data
 708 types used by the read, write and match functions.
 709
 710 =head1 NOTES
 711
 712 =over 4
 713
 714 =item
 715
 716 Please feel free to send in new plugins to collectd's mailinglist at
 717 E<lt>collectdE<nbsp>atE<nbsp>verplant.orgE<gt> for review and, possibly,
 718 inclusion in the main distribution. In the latter case, we will take care of
 719 keeping the plugin up to date and adapting it to new versions of collectd.
 720
 721 Before submitting your plugin, please take a look at
 722 L<http://collectd.org/dev-info.shtml>.
 723
 724 =back
 725
 726 =head1 CAVEATS
 727
 728 =over 4
 729
 730 =item
 731
 732 collectd is heavily multi-threaded. Each collectd thread accessing the perl
 733 plugin will be mapped to a Perl interpreter thread (see L<threads(3perl)>).
 734 Any such thread will be created and destroyed transparently and on-the-fly.
 735
 736 Hence, any plugin has to be thread-safe if it provides several entry points
 737 from collectd (i.E<nbsp>e. if it registers more than one callback or if a
 738 registered callback may be called more than once in parallel). Please note
 739 that no data is shared between threads by default. You have to use the
 740 B<threads::shared> module to do so.
 741
 742 =item
 743
 744 Each function name registered with collectd has to be available before the
 745 first thread has been created (i.E<nbsp>e. basically at compile time). This
 746 basically means that hacks (yes, I really consider this to be a hack) like
 747 C<*foo = \&bar; plugin_register (TYPE_READ, "plugin", "foo");> most likely
 748 will not work. This is due to the fact that the symbol table is not shared
 749 across different threads.
 750
 751 =item
 752
 753 Each plugin is usually only loaded once and kept in memory for performance
 754 reasons. Therefore, END blocks are only executed once when collectd shuts
 755 down. You should not rely on END blocks anyway - use B<shutdown functions>
 756 instead.
 757
 758 =item
 759
 760 The perl plugin exports the internal API of collectd which is considered
 761 unstable and subject to change at any time. We try hard to not break backwards
 762 compatibility in the Perl API during the life cycle of one major release.
 763 However, this cannot be guaranteed at all times. Watch out for warnings
 764 dispatched by the perl plugin after upgrades.
 765
 766 =back
 767
 768 =head1 KNOWN BUGS
 769
 770 =over 4
 771
 772 =item
 773
 774 Currently, it is not possible to flush a single Perl plugin only. You can
 775 either flush all Perl plugins or none at all and you have to use C<perl> as
 776 plugin name when doing so.
 777
 778 =back
 779
 780 =head1 SEE ALSO
 781
 782 L<collectd(1)>,
 783 L<collectd.conf(5)>,
 784 L<collectd-exec(5)>,
 785 L<types.db(5)>,
 786 L<perl(1)>,
 787 L<threads(3perl)>,
 788 L<threads::shared(3perl)>,
 789 L<perldebug(1)>
 790
 791 =head1 AUTHOR
 792
 793 The C<perl plugin> has been written by Sebastian Harl
 794 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
 795
 796 This manpage has been written by Florian Forster
 797 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt> and Sebastian Harl
 798 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
 799
 800 =cut
 801