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     plugin_instance => '',
 164     type_instance   => ''
 165   }
 166
 167 =item Notification
 168
 169 A notification is one structure defining the severity, time and message of the
 170 status message as well as an identification of a data instance:
 171
 172   {
 173     severity => NOTIF_FAILURE || NOTIF_WARNING || NOTIF_OKAY,
 174     time     => time (),
 175     message  => 'status message',
 176     host     => $hostname_g,
 177     plugin   => 'myplugin',
 178     type     => 'mytype',
 179     plugin_instance => '',
 180     type_instance   => ''
 181   }
 182
 183 =back
 184
 185 =head1 METHODS
 186
 187 The following functions provide the C-interface to Perl-modules. They are
 188 exported by the ":plugin" export tag (see the section "EXPORTS" below).
 189
 190 =over 4
 191
 192 =item B<plugin_register> (I<type>, I<name>, I<data>)
 193
 194 Registers a callback-function or data-set.
 195
 196 I<type> can be one of:
 197
 198 =over 4
 199
 200 =item TYPE_INIT
 201
 202 =item TYPE_READ
 203
 204 =item TYPE_WRITE
 205
 206 =item TYPE_LOG
 207
 208 =item TYPE_NOTIF
 209
 210 =item TYPE_SHUTDOWN
 211
 212 =item TYPE_DATASET
 213
 214 =back
 215
 216 I<name> is the name of the callback-function or the type of the data-set,
 217 depending on the value of I<type>. (Please note that the type of the data-set
 218 is the value passed as I<name> here and has nothing to do with the I<type>
 219 argument which simply tells B<plugin_register> what is being registered.)
 220
 221 The last argument, I<data>, is either a function name or an array-reference.
 222 If I<type> is B<TYPE_DATASET>, then the I<data> argument must be an
 223 array-reference which points to an array of hashes. Each hash describes one
 224 data-set. For the exact layout see B<Data-Set> above. Please note that
 225 there is a large number of predefined data-sets available in the B<types.db>
 226 file which are automatically registered with collectd - see L<types.db(5)> for
 227 a description of the format of this file.
 228
 229 If the I<type> argument is any of the other types (B<TYPE_INIT>, B<TYPE_READ>,
 230 ...) then I<data> is expected to be a function name. If the name is not
 231 prefixed with the plugin's package name collectd will add it automatically.
 232 The interface slightly differs from the C interface (which expects a function
 233 pointer instead) because Perl does not support to share references to
 234 subroutines between threads.
 235
 236 These functions are called in the various stages of the daemon (see the
 237 section "WRITING YOUR OWN PLUGINS" above) and are passed the following
 238 arguments:
 239
 240 =over 4
 241
 242 =item TYPE_INIT
 243
 244 =item TYPE_READ
 245
 246 =item TYPE_SHUTDOWN
 247
 248 No arguments are passed
 249
 250 =item TYPE_WRITE
 251
 252 The arguments passed are I<type>, I<data-set>, and I<value-list>. I<type> is a
 253 string. For the layout of I<data-set> and I<value-list> see above.
 254
 255 =item TYPE_LOG
 256
 257 The arguments are I<log-level> and I<message>. The log level is small for
 258 important messages and high for less important messages. The least important
 259 level is B<LOG_DEBUG>, the most important level is B<LOG_ERR>. In between there
 260 are (from least to most important): B<LOG_INFO>, B<LOG_NOTICE>, and
 261 B<LOG_WARNING>. I<message> is simply a string B<without> a newline at the end.
 262
 263 =item TYPE_NOTIF
 264
 265 The only argument passed is I<notification>. See above for the layout of this
 266 data type.
 267
 268 =back
 269
 270 =item B<plugin_unregister> (I<type>, I<plugin>)
 271
 272 Removes a callback or data-set from collectd's internal list of
 273 functionsE<nbsp>/ datasets.
 274
 275 =item B<plugin_dispatch_values> (I<type>, I<value-list>)
 276
 277 Submits a I<value-list> of type I<type> to the daemon. If the data-set I<type>
 278 is found (and the number of values matches the number of data-sources) then the
 279 type, data-set and value-list is passed to all write-callbacks that are
 280 registered with the daemon.
 281
 282 =item B<plugin_dispatch_notification> (I<notification>)
 283
 284 Submits a I<notification> to the daemon which will then pass it to all
 285 notification-callbacks that are registered.
 286
 287 =item B<plugin_log> (I<log-level>, I<message>)
 288
 289 Submits a I<message> of level I<log-level> to collectd's logging mechanism.
 290 The message is passed to all log-callbacks that are registered with collectd.
 291
 292 =item B<ERROR>, B<WARNING>, B<NOTICE>, B<INFO>, B<DEBUG> (I<message>)
 293
 294 Wrappers around B<plugin_log>, using B<LOG_ERR>, B<LOG_WARNING>,
 295 B<LOG_NOTICE>, B<LOG_INFO> and B<LOG_DEBUG> respectively as I<log-level>.
 296
 297 =back
 298
 299 =head1 GLOBAL VARIABLES
 300
 301 =over 4
 302
 303 =item B<$hostname_g>
 304
 305 As the name suggests this variable keeps the hostname of the system collectd
 306 is running on. The value might be influenced by the B<Hostname> or
 307 B<FQDNLookup> configuration options (see L<collectd.conf(5)> for details).
 308
 309 =item B<$interval_g>
 310
 311 This variable keeps the interval in seconds in which the read functions are
 312 queried (see the B<Interval> configuration option).
 313
 314 =back
 315
 316 Any changes to these variables will be globally visible in collectd.
 317
 318 =head1 EXPORTS
 319
 320 By default no symbols are exported. However, the following export tags are
 321 available (B<:all> will export all of them):
 322
 323 =over 4
 324
 325 =item B<:plugin>
 326
 327 =over 4
 328
 329 =item B<plugin_register> ()
 330
 331 =item B<plugin_unregister> ()
 332
 333 =item B<plugin_dispatch_values> ()
 334
 335 =item B<plugin_dispatch_notification> ()
 336
 337 =item B<plugin_log> ()
 338
 339 =back
 340
 341 =item B<:types>
 342
 343 =over 4
 344
 345 =item B<TYPE_INIT>
 346
 347 =item B<TYPE_READ>
 348
 349 =item B<TYPE_WRITE>
 350
 351 =item B<TYPE_SHUTDOWN>
 352
 353 =item B<TYPE_LOG>
 354
 355 =back
 356
 357 =item B<:ds_types>
 358
 359 =over 4
 360
 361 =item B<DS_TYPE_COUNTER>
 362
 363 =item B<DS_TYPE_GAUGE>
 364
 365 =back
 366
 367 =item B<:log>
 368
 369 =over 4
 370
 371 =item B<ERROR> ()
 372
 373 =item B<WARNING> ()
 374
 375 =item B<NOTICE> ()
 376
 377 =item B<INFO> ()
 378
 379 =item B<DEBUG> ()
 380
 381 =item B<LOG_ERR>
 382
 383 =item B<LOG_WARNING>
 384
 385 =item B<LOG_NOTICE>
 386
 387 =item B<LOG_INFO>
 388
 389 =item B<LOG_DEBUG>
 390
 391 =back
 392
 393 =item B<:notif>
 394
 395 =over 4
 396
 397 =item B<NOTIF_FAILURE>
 398
 399 =item B<NOTIF_WARNING>
 400
 401 =item B<NOTIF_OKAY>
 402
 403 =back
 404
 405 =item B<:globals>
 406
 407 =over 4
 408
 409 =item B<$hostname_g>
 410
 411 =item B<$interval_g>
 412
 413 =back
 414
 415 =back
 416
 417 =head1 EXAMPLES
 418
 419 Any Perl plugin will start similar to:
 420
 421   package Collectd::Plugins::FooBar;
 422
 423   use strict;
 424   use warnings;
 425
 426   use Collectd qw( :all );
 427
 428 A very simple read function will look like:
 429
 430   sub foobar_read
 431   {
 432     my $vl = { plugin => 'foobar' };
 433     $vl->{'values'} = [ rand(42) ];
 434     plugin_dispatch_values ('gauge', $vl);
 435     return 1;
 436   }
 437
 438 A very simple write function will look like:
 439
 440   sub foobar_write
 441   {
 442     my ($type, $ds, $vl) = @_;
 443     for (my $i = 0; $i < scalar (@$ds); ++$i) {
 444       print "$vl->{'plugin'} ($vl->{'type'}): $vl->{'values'}->[$i]\n";
 445     }
 446     return 1;
 447   }
 448
 449 To register those functions with collectd:
 450
 451   plugin_register (TYPE_READ, "foobar", "foobar_read");
 452   plugin_register (TYPE_WRITE, "foobar", "foobar_write");
 453
 454 See the section "DATA TYPES" above for a complete documentation of the data
 455 types used by the read and write functions.
 456
 457 =head1 NOTES
 458
 459 =over 4
 460
 461 =item
 462
 463 Please feel free to send in new plugins to collectd's mailinglist at
 464 E<lt>collectdE<nbsp>atE<nbsp>verplant.orgE<gt> for review and, possibly,
 465 inclusion in the main distribution. In the latter case, we will take care of
 466 keeping the plugin up to date and adapting it to new versions of collectd.
 467
 468 Before submitting your plugin, please take a look at
 469 L<http://collectd.org/dev-info.shtml>.
 470
 471 =back
 472
 473 =head1 CAVEATS
 474
 475 =over 4
 476
 477 =item
 478
 479 collectd is heavily multi-threaded. Each collectd thread accessing the perl
 480 plugin will be mapped to a Perl interpreter thread (see L<threads(3perl)>).
 481 Any such thread will be created and destroyed transparently and on-the-fly.
 482
 483 Hence, any plugin has to be thread-safe if it provides several entry points
 484 from collectd (i.E<nbsp>e. if it registers more than one callback or if a
 485 registered callback may be called more than once in parallel). Please note
 486 that no data is shared between threads by default. You have to use the
 487 B<threads::shared> module to do so.
 488
 489 =item
 490
 491 Each function name registered with collectd has to be available before the
 492 first thread has been created (i.E<nbsp>e. basically at compile time). This
 493 basically means that hacks (yes, I really consider this to be a hack) like
 494 C<*foo = \&bar; plugin_register (TYPE_READ, "plugin", "foo");> most likely
 495 will not work. This is due to the fact that the symbol table is not shared
 496 across different threads.
 497
 498 =item
 499
 500 Each plugin is usually only loaded once and kept in memory for performance
 501 reasons. Therefore, END blocks are only executed once when collectd shuts
 502 down. You should not rely on END blocks anyway - use B<shutdown functions>
 503 instead.
 504
 505 =back
 506
 507 =head1 SEE ALSO
 508
 509 L<collectd(1)>,
 510 L<collectd.conf(5)>,
 511 L<collectd-exec(5)>,
 512 L<types.db(5)>,
 513 L<perl(1)>,
 514 L<threads(3perl)>,
 515 L<threads::shared(3perl)>,
 516 L<perldebug(1)>
 517
 518 =head1 AUTHOR
 519
 520 The C<perl plugin> has been written by Sebastian Harl
 521 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
 522
 523 This manpage has been written by Florian Forster
 524 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt> and Sebastian Harl
 525 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
 526
 527 =cut
 528