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 them 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 flush functions
  96
  97 This type of function is used to flush internal caches of plugins. It is
  98 usually triggered by the user only. Any plugin which caches data before
  99 writing it to disk should provide this kind of callback function.
 100
 101 =item log functions
 102
 103 This type of function is used to pass messages of plugins or the daemon itself
 104 to the user.
 105
 106 =item notification function
 107
 108 This type of function is used to act upon notifications. In general, a
 109 notification is a status message that may be associated with a data instance.
 110 Usually, a notification is generated by the daemon if a configured threshold
 111 has been exceeded (see the section "THRESHOLD CONFIGURATION" in
 112 L<collectd.conf(5)> for more details), but any plugin may dispatch
 113 notifications as well.
 114
 115 =item shutdown functions
 116
 117 This type of function is called once before the daemon shuts down. It should
 118 be used to clean up the plugin (e.g. close sockets, ...).
 119
 120 =back
 121
 122 Any function (except log functions) may set the B<$@> variable to describe
 123 errors in more detail. The message will be passed on to the user using
 124 collectd's logging mechanism.
 125
 126 See the documentation of the B<plugin_register> method in the section
 127 "METHODS" below for the number and types of arguments passed to each
 128 B<callback function>. This section also explains how to register B<callback
 129 functions> with collectd.
 130
 131 To enable a plugin, copy it to a place where Perl can find it (i.E<nbsp>e. a
 132 directory listed in the B<@INC> array) just as any other Perl plugin and add
 133 an appropriate B<LoadPlugin> option to the configuration file. After
 134 restarting collectd you're done.
 135
 136 =head1 DATA TYPES
 137
 138 The following complex types are used to pass values between the Perl plugin
 139 and collectd:
 140
 141 =over 4
 142
 143 =item Data-Set
 144
 145 A data-set is a list of one or more data-sources. Each data-source defines a
 146 name, type, min- and max-value and the data-set wraps them up into one
 147 structure. The general layout looks like this:
 148
 149   [{
 150     name => 'data_source_name',
 151     type => DS_TYPE_COUNTER || DS_TYPE_GAUGE,
 152     min  => value || undef,
 153     max  => value || undef
 154   }, ...]
 155
 156 =item Value-List
 157
 158 A value-list is one structure which features an array of values and fields to
 159 identify the values, i.E<nbsp>e. time and host, plugin name and
 160 plugin-instance as well as a type and type-instance. Since the "type" is not
 161 included in the value-list but is passed as an extra argument, the general
 162 layout looks like this:
 163
 164   {
 165     values => [123, 0.5],
 166     time   => time (),
 167     host   => $hostname_g,
 168     plugin => 'myplugin',
 169     type   => 'myplugin',
 170     plugin_instance => '',
 171     type_instance   => ''
 172   }
 173
 174 =item Notification
 175
 176 A notification is one structure defining the severity, time and message of the
 177 status message as well as an identification of a data instance:
 178
 179   {
 180     severity => NOTIF_FAILURE || NOTIF_WARNING || NOTIF_OKAY,
 181     time     => time (),
 182     message  => 'status message',
 183     host     => $hostname_g,
 184     plugin   => 'myplugin',
 185     type     => 'mytype',
 186     plugin_instance => '',
 187     type_instance   => ''
 188   }
 189
 190 =back
 191
 192 =head1 METHODS
 193
 194 The following functions provide the C-interface to Perl-modules. They are
 195 exported by the ":plugin" export tag (see the section "EXPORTS" below).
 196
 197 =over 4
 198
 199 =item B<plugin_register> (I<type>, I<name>, I<data>)
 200
 201 Registers a callback-function or data-set.
 202
 203 I<type> can be one of:
 204
 205 =over 4
 206
 207 =item TYPE_INIT
 208
 209 =item TYPE_READ
 210
 211 =item TYPE_WRITE
 212
 213 =item TYPE_FLUSH
 214
 215 =item TYPE_LOG
 216
 217 =item TYPE_NOTIF
 218
 219 =item TYPE_SHUTDOWN
 220
 221 =item TYPE_DATASET
 222
 223 =back
 224
 225 I<name> is the name of the callback-function or the type of the data-set,
 226 depending on the value of I<type>. (Please note that the type of the data-set
 227 is the value passed as I<name> here and has nothing to do with the I<type>
 228 argument which simply tells B<plugin_register> what is being registered.)
 229
 230 The last argument, I<data>, is either a function name or an array-reference.
 231 If I<type> is B<TYPE_DATASET>, then the I<data> argument must be an
 232 array-reference which points to an array of hashes. Each hash describes one
 233 data-set. For the exact layout see B<Data-Set> above. Please note that
 234 there is a large number of predefined data-sets available in the B<types.db>
 235 file which are automatically registered with collectd - see L<types.db(5)> for
 236 a description of the format of this file.
 237
 238 If the I<type> argument is any of the other types (B<TYPE_INIT>, B<TYPE_READ>,
 239 ...) then I<data> is expected to be a function name. If the name is not
 240 prefixed with the plugin's package name collectd will add it automatically.
 241 The interface slightly differs from the C interface (which expects a function
 242 pointer instead) because Perl does not support to share references to
 243 subroutines between threads.
 244
 245 These functions are called in the various stages of the daemon (see the
 246 section "WRITING YOUR OWN PLUGINS" above) and are passed the following
 247 arguments:
 248
 249 =over 4
 250
 251 =item TYPE_INIT
 252
 253 =item TYPE_READ
 254
 255 =item TYPE_SHUTDOWN
 256
 257 No arguments are passed.
 258
 259 =item TYPE_WRITE
 260
 261 The arguments passed are I<type>, I<data-set>, and I<value-list>. I<type> is a
 262 string. For the layout of I<data-set> and I<value-list> see above.
 263
 264 =item TYPE_FLUSH
 265
 266 The arguments passed are I<timeout> and I<identifier>. I<timeout> indicates
 267 that only data older than I<timeout> seconds is to be flushed. I<identifier>
 268 specifies which values are to be flushed.
 269
 270 =item TYPE_LOG
 271
 272 The arguments are I<log-level> and I<message>. The log level is small for
 273 important messages and high for less important messages. The least important
 274 level is B<LOG_DEBUG>, the most important level is B<LOG_ERR>. In between there
 275 are (from least to most important): B<LOG_INFO>, B<LOG_NOTICE>, and
 276 B<LOG_WARNING>. I<message> is simply a string B<without> a newline at the end.
 277
 278 =item TYPE_NOTIF
 279
 280 The only argument passed is I<notification>. See above for the layout of this
 281 data type.
 282
 283 =back
 284
 285 =item B<plugin_unregister> (I<type>, I<plugin>)
 286
 287 Removes a callback or data-set from collectd's internal list of
 288 functionsE<nbsp>/ datasets.
 289
 290 =item B<plugin_dispatch_values> (I<value-list>)
 291
 292 Submits a I<value-list> to the daemon. If the data-set identified by
 293 I<value-list>->{I<type>}
 294 is found (and the number of values matches the number of data-sources) then the
 295 type, data-set and value-list is passed to all write-callbacks that are
 296 registered with the daemon.
 297
 298 B<Note>: Prior to version 4.4 of collectd, the data-set type used to be passed
 299 as the first argument to B<plugin_register>. This syntax is still supported
 300 for backwards compatibility but has been deprecated and will be removed in
 301 some future version of collectd.
 302
 303 =item B<plugin_flush> ([B<timeout> => I<timeout>][, B<plugins> => I<...>][,
 304 B<identifiers> => I<...>])
 305
 306 Flush one or more plugins. I<timeout> and the specified I<identifiers> are
 307 passed on to the registered flush-callbacks. If omitted, the timeout defaults
 308 to C<-1>. The identifier defaults to the undefined value. If the I<plugins>
 309 argument has been specified, only named plugins will be flushed. The value of
 310 the B<plugins> and B<identifiers> arguments may either be a string or a
 311 reference to an array of strings.
 312
 313 =item B<plugin_flush_one> (I<timeout>, I<plugin>)
 314
 315 This is identical to using "plugin_flush (timeout =E<gt> I<timeout>, plugins
 316 =E<gt> I<plugin>".
 317
 318 B<Note>: Starting with version 4.5 of collectd, B<plugin_flush_one> has been
 319 deprecated and will be removed in some future version of collectd. Use
 320 B<plugin_flush> instead.
 321
 322 =item B<plugin_flush_all> (I<timeout>)
 323
 324 This is identical to using "plugin_flush (timeout =E<gt> I<timeout>)".
 325
 326 B<Note>: Starting with version 4.5 of collectd, B<plugin_flush_all> has been
 327 deprecated and will be removed in some future version of collectd. Use
 328 B<plugin_flush> instead.
 329
 330 =item B<plugin_dispatch_notification> (I<notification>)
 331
 332 Submits a I<notification> to the daemon which will then pass it to all
 333 notification-callbacks that are registered.
 334
 335 =item B<plugin_log> (I<log-level>, I<message>)
 336
 337 Submits a I<message> of level I<log-level> to collectd's logging mechanism.
 338 The message is passed to all log-callbacks that are registered with collectd.
 339
 340 =item B<ERROR>, B<WARNING>, B<NOTICE>, B<INFO>, B<DEBUG> (I<message>)
 341
 342 Wrappers around B<plugin_log>, using B<LOG_ERR>, B<LOG_WARNING>,
 343 B<LOG_NOTICE>, B<LOG_INFO> and B<LOG_DEBUG> respectively as I<log-level>.
 344
 345 =back
 346
 347 =head1 GLOBAL VARIABLES
 348
 349 =over 4
 350
 351 =item B<$hostname_g>
 352
 353 As the name suggests this variable keeps the hostname of the system collectd
 354 is running on. The value might be influenced by the B<Hostname> or
 355 B<FQDNLookup> configuration options (see L<collectd.conf(5)> for details).
 356
 357 =item B<$interval_g>
 358
 359 This variable keeps the interval in seconds in which the read functions are
 360 queried (see the B<Interval> configuration option).
 361
 362 =back
 363
 364 Any changes to these variables will be globally visible in collectd.
 365
 366 =head1 EXPORTS
 367
 368 By default no symbols are exported. However, the following export tags are
 369 available (B<:all> will export all of them):
 370
 371 =over 4
 372
 373 =item B<:plugin>
 374
 375 =over 4
 376
 377 =item B<plugin_register> ()
 378
 379 =item B<plugin_unregister> ()
 380
 381 =item B<plugin_dispatch_values> ()
 382
 383 =item B<plugin_flush> ()
 384
 385 =item B<plugin_flush_one> ()
 386
 387 =item B<plugin_flush_all> ()
 388
 389 =item B<plugin_dispatch_notification> ()
 390
 391 =item B<plugin_log> ()
 392
 393 =back
 394
 395 =item B<:types>
 396
 397 =over 4
 398
 399 =item B<TYPE_INIT>
 400
 401 =item B<TYPE_READ>
 402
 403 =item B<TYPE_WRITE>
 404
 405 =item B<TYPE_FLUSH>
 406
 407 =item B<TYPE_SHUTDOWN>
 408
 409 =item B<TYPE_LOG>
 410
 411 =back
 412
 413 =item B<:ds_types>
 414
 415 =over 4
 416
 417 =item B<DS_TYPE_COUNTER>
 418
 419 =item B<DS_TYPE_GAUGE>
 420
 421 =back
 422
 423 =item B<:log>
 424
 425 =over 4
 426
 427 =item B<ERROR> ()
 428
 429 =item B<WARNING> ()
 430
 431 =item B<NOTICE> ()
 432
 433 =item B<INFO> ()
 434
 435 =item B<DEBUG> ()
 436
 437 =item B<LOG_ERR>
 438
 439 =item B<LOG_WARNING>
 440
 441 =item B<LOG_NOTICE>
 442
 443 =item B<LOG_INFO>
 444
 445 =item B<LOG_DEBUG>
 446
 447 =back
 448
 449 =item B<:notif>
 450
 451 =over 4
 452
 453 =item B<NOTIF_FAILURE>
 454
 455 =item B<NOTIF_WARNING>
 456
 457 =item B<NOTIF_OKAY>
 458
 459 =back
 460
 461 =item B<:globals>
 462
 463 =over 4
 464
 465 =item B<$hostname_g>
 466
 467 =item B<$interval_g>
 468
 469 =back
 470
 471 =back
 472
 473 =head1 EXAMPLES
 474
 475 Any Perl plugin will start similar to:
 476
 477   package Collectd::Plugins::FooBar;
 478
 479   use strict;
 480   use warnings;
 481
 482   use Collectd qw( :all );
 483
 484 A very simple read function will look like:
 485
 486   sub foobar_read
 487   {
 488     my $vl = { plugin => 'foobar' };
 489     $vl->{'values'} = [ rand(42) ];
 490     plugin_dispatch_values ('gauge', $vl);
 491     return 1;
 492   }
 493
 494 A very simple write function will look like:
 495
 496   sub foobar_write
 497   {
 498     my ($type, $ds, $vl) = @_;
 499     for (my $i = 0; $i < scalar (@$ds); ++$i) {
 500       print "$vl->{'plugin'} ($vl->{'type'}): $vl->{'values'}->[$i]\n";
 501     }
 502     return 1;
 503   }
 504
 505 To register those functions with collectd:
 506
 507   plugin_register (TYPE_READ, "foobar", "foobar_read");
 508   plugin_register (TYPE_WRITE, "foobar", "foobar_write");
 509
 510 See the section "DATA TYPES" above for a complete documentation of the data
 511 types used by the read and write functions.
 512
 513 =head1 NOTES
 514
 515 =over 4
 516
 517 =item
 518
 519 Please feel free to send in new plugins to collectd's mailinglist at
 520 E<lt>collectdE<nbsp>atE<nbsp>verplant.orgE<gt> for review and, possibly,
 521 inclusion in the main distribution. In the latter case, we will take care of
 522 keeping the plugin up to date and adapting it to new versions of collectd.
 523
 524 Before submitting your plugin, please take a look at
 525 L<http://collectd.org/dev-info.shtml>.
 526
 527 =back
 528
 529 =head1 CAVEATS
 530
 531 =over 4
 532
 533 =item
 534
 535 collectd is heavily multi-threaded. Each collectd thread accessing the perl
 536 plugin will be mapped to a Perl interpreter thread (see L<threads(3perl)>).
 537 Any such thread will be created and destroyed transparently and on-the-fly.
 538
 539 Hence, any plugin has to be thread-safe if it provides several entry points
 540 from collectd (i.E<nbsp>e. if it registers more than one callback or if a
 541 registered callback may be called more than once in parallel). Please note
 542 that no data is shared between threads by default. You have to use the
 543 B<threads::shared> module to do so.
 544
 545 =item
 546
 547 Each function name registered with collectd has to be available before the
 548 first thread has been created (i.E<nbsp>e. basically at compile time). This
 549 basically means that hacks (yes, I really consider this to be a hack) like
 550 C<*foo = \&bar; plugin_register (TYPE_READ, "plugin", "foo");> most likely
 551 will not work. This is due to the fact that the symbol table is not shared
 552 across different threads.
 553
 554 =item
 555
 556 Each plugin is usually only loaded once and kept in memory for performance
 557 reasons. Therefore, END blocks are only executed once when collectd shuts
 558 down. You should not rely on END blocks anyway - use B<shutdown functions>
 559 instead.
 560
 561 =item
 562
 563 The perl plugin exports the internal API of collectd which is considered
 564 unstable and subject to change at any time. We try hard to not break backwards
 565 compatibility in the Perl API during the life cycle of one major release.
 566 However, this cannot be guaranteed at all times. Watch out for warnings
 567 dispatched by the perl plugin after upgrades.
 568
 569 =back
 570
 571 =head1 KNOWN BUGS
 572
 573 =over 4
 574
 575 =item
 576
 577 Currently, it is not possible to flush a single Perl plugin only. You can
 578 either flush all Perl plugins or none at all and you have to use C<perl> as
 579 plugin name when doing so.
 580
 581 =back
 582
 583 =head1 SEE ALSO
 584
 585 L<collectd(1)>,
 586 L<collectd.conf(5)>,
 587 L<collectd-exec(5)>,
 588 L<types.db(5)>,
 589 L<perl(1)>,
 590 L<threads(3perl)>,
 591 L<threads::shared(3perl)>,
 592 L<perldebug(1)>
 593
 594 =head1 AUTHOR
 595
 596 The C<perl plugin> has been written by Sebastian Harl
 597 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
 598
 599 This manpage has been written by Florian Forster
 600 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt> and Sebastian Harl
 601 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
 602
 603 =cut
 604