Code

Bump version to 5.0.5; Update ChangeLog.
[collectd.git] / src / collectd-perl.pod
1 =head1 NAME
3 collectd-perl - Documentation of collectd's C<perl plugin>
5 =head1 SYNOPSIS
7   <LoadPlugin perl>
8     Globals true
9   </LoadPlugin>
10   # ...
11   <Plugin perl>
12     IncludeDir "/path/to/perl/plugins"
13     BaseName "Collectd::Plugins"
14     EnableDebugger ""
15     LoadPlugin "FooBar"
17     <Plugin FooBar>
18       Foo "Bar"
19     </Plugin>
20   </Plugin>
22 =head1 DESCRIPTION
24 The C<perl plugin> embeds a Perl-interpreter into collectd and provides an
25 interface to collectd's plugin system. This makes it possible to write plugins
26 for collectd in Perl. This is a lot more efficient than executing a
27 Perl-script every time you want to read a value with the C<exec plugin> (see
28 L<collectd-exec(5)>) and provides a lot more functionality, too.
30 When loading the C<perl plugin>, the B<Globals> option should be enabled.
31 Else, the perl plugin will fail to load any Perl modules implemented in C,
32 which includes, amongst many others, the B<threads> module used by the plugin
33 itself. See the documentation of the B<Globals> option in L<collectd.conf(5)>
34 for details.
36 =head1 CONFIGURATION
38 =over 4
40 =item B<LoadPlugin> I<Plugin>
42 Loads the Perl plugin I<Plugin>. This does basically the same as B<use> would
43 do in a Perl program. As a side effect, the first occurrence of this option
44 causes the Perl-interpreter to be initialized.
46 =item B<BaseName> I<Name>
48 Prepends I<Name>B<::> to all plugin names loaded after this option. This is
49 provided for convenience to keep plugin names short. All Perl-based plugins
50 provided with the I<collectd> distributions reside in the C<Collectd::Plugins>
51 namespace.
53 =item E<lt>B<Plugin> I<Name>E<gt> block
55 This block may be used to pass on configuration settings to a Perl plugin. The
56 configuration is converted into a config-item data type which is passed to the
57 registered configuration callback. See below for details about the config-item
58 data type and how to register callbacks.
60 The I<name> identifies the callback. It is used literally and independent of
61 the B<BaseName> setting.
63 =item B<EnableDebugger> I<Package>[=I<option>,...]
65 Run collectd under the control of the Perl source debugger. If I<Package> is
66 not the empty string, control is passed to the debugging, profiling, or
67 tracing module installed as Devel::I<Package>. A comma-separated list of
68 options may be specified after the "=" character. Please note that you may not
69 leave out the I<Package> option even if you specify B<"">. This is the same as
70 using the B<-d:Package> command line option.
72 See L<perldebug> for detailed documentation about debugging Perl.
74 This option does not prevent collectd from daemonizing, so you should start
75 collectd with the B<-f> command line option. Else you will not be able to use
76 the command line driven interface of the debugger.
78 =item B<IncludeDir> I<Dir>
80 Adds I<Dir> to the B<@INC> array. This is the same as using the B<-IDir>
81 command line option or B<use lib Dir> in the source code. Please note that it
82 only has effect on plugins loaded after this option.
84 =back
86 =head1 WRITING YOUR OWN PLUGINS
88 Writing your own plugins is quite simple. collectd manages plugins by means of
89 B<dispatch functions> which call the appropriate B<callback functions>
90 registered by the plugins. Any plugin basically consists of the implementation
91 of these callback functions and initializing code which registers the
92 functions with collectd. See the section "EXAMPLES" below for a really basic
93 example. The following types of B<callback functions> are known to collectd
94 (all of them are optional):
96 =over 4
98 =item configuration functions
100 This type of functions is called during configuration if an appropriate
101 B<Plugin> block has been encountered. It is called once for each B<Plugin>
102 block which matches the name of the callback as provided with the
103 B<plugin_register> method - see below.
105 =item init functions
107 This type of functions is called once after loading the module and before any
108 calls to the read and write functions. It should be used to initialize the
109 internal state of the plugin (e.E<nbsp>g. open sockets, ...). If the return
110 value evaluates to B<false>, the plugin will be disabled.
112 =item read functions
114 This type of function is used to collect the actual data. It is called once
115 per interval (see the B<Interval> configuration option of collectd). Usually
116 it will call B<plugin_dispatch_values> to dispatch the values to collectd
117 which will pass them on to all registered B<write functions>. If the return
118 value evaluates to B<false> the plugin will be skipped for an increasing
119 amount of time until it returns B<true> again.
121 =item write functions
123 This type of function is used to write the dispatched values. It is called
124 once for each call to B<plugin_dispatch_values>.
126 =item flush functions
128 This type of function is used to flush internal caches of plugins. It is
129 usually triggered by the user only. Any plugin which caches data before
130 writing it to disk should provide this kind of callback function.
132 =item log functions
134 This type of function is used to pass messages of plugins or the daemon itself
135 to the user.
137 =item notification function
139 This type of function is used to act upon notifications. In general, a
140 notification is a status message that may be associated with a data instance.
141 Usually, a notification is generated by the daemon if a configured threshold
142 has been exceeded (see the section "THRESHOLD CONFIGURATION" in
143 L<collectd.conf(5)> for more details), but any plugin may dispatch
144 notifications as well.
146 =item shutdown functions
148 This type of function is called once before the daemon shuts down. It should
149 be used to clean up the plugin (e.g. close sockets, ...).
151 =back
153 Any function (except log functions) may set the B<$@> variable to describe
154 errors in more detail. The message will be passed on to the user using
155 collectd's logging mechanism.
157 See the documentation of the B<plugin_register> method in the section
158 "METHODS" below for the number and types of arguments passed to each
159 B<callback function>. This section also explains how to register B<callback
160 functions> with collectd.
162 To enable a plugin, copy it to a place where Perl can find it (i.E<nbsp>e. a
163 directory listed in the B<@INC> array) just as any other Perl plugin and add
164 an appropriate B<LoadPlugin> option to the configuration file. After
165 restarting collectd you're done.
167 =head1 DATA TYPES
169 The following complex types are used to pass values between the Perl plugin
170 and collectd:
172 =over 4
174 =item Config-Item
176 A config-item is one structure which keeps the information provided in the
177 configuration file. The array of children keeps one entry for each
178 configuration option. Each such entry is another config-item structure, which
179 may nest further if nested blocks are used.
181   {
182     key      => key,
183     values   => [ val1, val2, ... ],
184     children => [ { ... }, { ... }, ... ]
185   }
187 =item Data-Set
189 A data-set is a list of one or more data-sources. Each data-source defines a
190 name, type, min- and max-value and the data-set wraps them up into one
191 structure. The general layout looks like this:
193   [{
194     name => 'data_source_name',
195     type => DS_TYPE_COUNTER || DS_TYPE_GAUGE || DS_TYPE_DERIVE || DS_TYPE_ABSOLUTE,
196     min  => value || undef,
197     max  => value || undef
198   }, ...]
200 =item Value-List
202 A value-list is one structure which features an array of values and fields to
203 identify the values, i.E<nbsp>e. time and host, plugin name and
204 plugin-instance as well as a type and type-instance. Since the "type" is not
205 included in the value-list but is passed as an extra argument, the general
206 layout looks like this:
208   {
209     values => [123, 0.5],
210     time   => time (),
211     interval => $interval_g,
212     host   => $hostname_g,
213     plugin => 'myplugin',
214     type   => 'myplugin',
215     plugin_instance => '',
216     type_instance   => ''
217   }
219 =item Notification
221 A notification is one structure defining the severity, time and message of the
222 status message as well as an identification of a data instance. Also, it
223 includes an optional list of user-defined meta information represented as
224 (name, value) pairs:
226   {
227     severity => NOTIF_FAILURE || NOTIF_WARNING || NOTIF_OKAY,
228     time     => time (),
229     message  => 'status message',
230     host     => $hostname_g,
231     plugin   => 'myplugin',
232     type     => 'mytype',
233     plugin_instance => '',
234     type_instance   => '',
235     meta     => [ { name => <name>, value => <value> }, ... ]
236   }
238 =item Match-Proc
240 A match-proc is one structure storing the callbacks of a "match" of the filter
241 chain infrastructure. The general layout looks like this:
243   {
244     create  => 'my_create',
245     destroy => 'my_destroy',
246     match   => 'my_match'
247   }
249 =item Target-Proc
251 A target-proc is one structure storing the callbacks of a "target" of the
252 filter chain infrastructure. The general layout looks like this:
254   {
255     create  => 'my_create',
256     destroy => 'my_destroy',
257     invoke  => 'my_invoke'
258   }
260 =back
262 =head1 METHODS
264 The following functions provide the C-interface to Perl-modules. They are
265 exported by the ":plugin" export tag (see the section "EXPORTS" below).
267 =over 4
269 =item B<plugin_register> (I<type>, I<name>, I<data>)
271 Registers a callback-function or data-set.
273 I<type> can be one of:
275 =over 4
277 =item TYPE_CONFIG
279 =item TYPE_INIT
281 =item TYPE_READ
283 =item TYPE_WRITE
285 =item TYPE_FLUSH
287 =item TYPE_LOG
289 =item TYPE_NOTIF
291 =item TYPE_SHUTDOWN
293 =item TYPE_DATASET
295 =back
297 I<name> is the name of the callback-function or the type of the data-set,
298 depending on the value of I<type>. (Please note that the type of the data-set
299 is the value passed as I<name> here and has nothing to do with the I<type>
300 argument which simply tells B<plugin_register> what is being registered.)
302 The last argument, I<data>, is either a function name or an array-reference.
303 If I<type> is B<TYPE_DATASET>, then the I<data> argument must be an
304 array-reference which points to an array of hashes. Each hash describes one
305 data-set. For the exact layout see B<Data-Set> above. Please note that
306 there is a large number of predefined data-sets available in the B<types.db>
307 file which are automatically registered with collectd - see L<types.db(5)> for
308 a description of the format of this file.
310 B<Note>: Using B<plugin_register> to register a data-set is deprecated. Add
311 the new type to a custom L<types.db(5)> file instead. This functionality might
312 be removed in a future version of collectd.
314 If the I<type> argument is any of the other types (B<TYPE_INIT>, B<TYPE_READ>,
315 ...) then I<data> is expected to be a function name. If the name is not
316 prefixed with the plugin's package name collectd will add it automatically.
317 The interface slightly differs from the C interface (which expects a function
318 pointer instead) because Perl does not support to share references to
319 subroutines between threads.
321 These functions are called in the various stages of the daemon (see the
322 section "WRITING YOUR OWN PLUGINS" above) and are passed the following
323 arguments:
325 =over 4
327 =item TYPE_CONFIG
329 The only argument passed is I<config-item>. See above for the layout of this
330 data type.
332 =item TYPE_INIT
334 =item TYPE_READ
336 =item TYPE_SHUTDOWN
338 No arguments are passed.
340 =item TYPE_WRITE
342 The arguments passed are I<type>, I<data-set>, and I<value-list>. I<type> is a
343 string. For the layout of I<data-set> and I<value-list> see above.
345 =item TYPE_FLUSH
347 The arguments passed are I<timeout> and I<identifier>. I<timeout> indicates
348 that only data older than I<timeout> seconds is to be flushed. I<identifier>
349 specifies which values are to be flushed.
351 =item TYPE_LOG
353 The arguments are I<log-level> and I<message>. The log level is small for
354 important messages and high for less important messages. The least important
355 level is B<LOG_DEBUG>, the most important level is B<LOG_ERR>. In between there
356 are (from least to most important): B<LOG_INFO>, B<LOG_NOTICE>, and
357 B<LOG_WARNING>. I<message> is simply a string B<without> a newline at the end.
359 =item TYPE_NOTIF
361 The only argument passed is I<notification>. See above for the layout of this
362 data type.
364 =back
366 =item B<plugin_unregister> (I<type>, I<plugin>)
368 Removes a callback or data-set from collectd's internal list of
369 functionsE<nbsp>/ datasets.
371 =item B<plugin_dispatch_values> (I<value-list>)
373 Submits a I<value-list> to the daemon. If the data-set identified by
374 I<value-list>->{I<type>}
375 is found (and the number of values matches the number of data-sources) then the
376 type, data-set and value-list is passed to all write-callbacks that are
377 registered with the daemon.
379 =item B<plugin_write> ([B<plugins> => I<...>][, B<datasets> => I<...>],
380 B<valuelists> => I<...>)
382 Calls the write function of the given I<plugins> with the provided I<data
383 sets> and I<value lists>. In contrast to B<plugin_dispatch_values>, it does
384 not update collectd's internal cache and bypasses the filter mechanism (see
385 L<collectd.conf(5)> for details). If the B<plugins> argument has been omitted,
386 the values will be dispatched to all registered write plugins. If the
387 B<datasets> argument has been omitted, the required data sets are looked up
388 according to the C<type> member in the appropriate value list. The value of
389 all three arguments may either be a single scalar or a reference to an array.
390 If the B<datasets> argument has been specified, the number of data sets has to
391 equal the number of specified value lists.
393 =item B<plugin_flush> ([B<timeout> => I<timeout>][, B<plugins> => I<...>][,
394 B<identifiers> => I<...>])
396 Flush one or more plugins. I<timeout> and the specified I<identifiers> are
397 passed on to the registered flush-callbacks. If omitted, the timeout defaults
398 to C<-1>. The identifier defaults to the undefined value. If the B<plugins>
399 argument has been specified, only named plugins will be flushed. The value of
400 the B<plugins> and B<identifiers> arguments may either be a string or a
401 reference to an array of strings.
403 =item B<plugin_dispatch_notification> (I<notification>)
405 Submits a I<notification> to the daemon which will then pass it to all
406 notification-callbacks that are registered.
408 =item B<plugin_log> (I<log-level>, I<message>)
410 Submits a I<message> of level I<log-level> to collectd's logging mechanism.
411 The message is passed to all log-callbacks that are registered with collectd.
413 =item B<ERROR>, B<WARNING>, B<NOTICE>, B<INFO>, B<DEBUG> (I<message>)
415 Wrappers around B<plugin_log>, using B<LOG_ERR>, B<LOG_WARNING>,
416 B<LOG_NOTICE>, B<LOG_INFO> and B<LOG_DEBUG> respectively as I<log-level>.
418 =back
420 The following function provides the filter chain C-interface to Perl-modules.
421 It is exported by the ":filter_chain" export tag (see the section "EXPORTS"
422 below).
424 =over 4
426 =item B<fc_register> (I<type>, I<name>, I<proc>)
428 Registers filter chain callbacks with collectd.
430 I<type> may be any of:
432 =over 4
434 =item FC_MATCH
436 =item FC_TARGET
438 =back
440 I<name> is the name of the match or target. By this name, the callbacks are
441 identified in the configuration file when specifying a B<Match> or B<Target>
442 block (see L<collectd.conf(5)> for details).
444 I<proc> is a hash reference. The hash includes up to three callbacks: an
445 optional constructor (B<create>) and destructor (B<destroy>) and a mandatory
446 B<match> or B<invoke> callback. B<match> is called whenever processing an
447 appropriate match, while B<invoke> is called whenever processing an
448 appropriate target (see the section "FILTER CONFIGURATION" in
449 L<collectd.conf(5)> for details). Just like any other callbacks, filter chain
450 callbacks are identified by the function name rather than a function pointer
451 because Perl does not support to share references to subroutines between
452 threads. The following arguments are passed to the callbacks:
454 =over 4
456 =item create
458 The arguments passed are I<config-item> and I<user-data>. See above for the
459 layout of the config-item data-type. I<user-data> is a reference to a scalar
460 value that may be used to store any information specific to this particular
461 instance. The daemon does not care about this information at all. It's for the
462 plugin's use only.
464 =item destroy
466 The only argument passed is I<user-data> which is a reference to the user data
467 initialized in the B<create> callback. This callback may be used to cleanup
468 instance-specific information and settings.
470 =item match, invoke
472 The arguments passed are I<data-set>, I<value-list>, I<meta> and I<user-data>.
473 See above for the layout of the data-set and value-list data-types. I<meta> is
474 a pointer to an array of meta information, just like the B<meta> member of the
475 notification data-type (see above). I<user-data> is a reference to the user
476 data initialized in the B<create> callback.
478 =back
480 =back
482 =head1 GLOBAL VARIABLES
484 =over 4
486 =item B<$hostname_g>
488 As the name suggests this variable keeps the hostname of the system collectd
489 is running on. The value might be influenced by the B<Hostname> or
490 B<FQDNLookup> configuration options (see L<collectd.conf(5)> for details).
492 =item B<$interval_g>
494 This variable keeps the interval in seconds in which the read functions are
495 queried (see the B<Interval> configuration option).
497 =back
499 Any changes to these variables will be globally visible in collectd.
501 =head1 EXPORTS
503 By default no symbols are exported. However, the following export tags are
504 available (B<:all> will export all of them):
506 =over 4
508 =item B<:plugin>
510 =over 4
512 =item B<plugin_register> ()
514 =item B<plugin_unregister> ()
516 =item B<plugin_dispatch_values> ()
518 =item B<plugin_flush> ()
520 =item B<plugin_flush_one> ()
522 =item B<plugin_flush_all> ()
524 =item B<plugin_dispatch_notification> ()
526 =item B<plugin_log> ()
528 =back
530 =item B<:types>
532 =over 4
534 =item B<TYPE_CONFIG>
536 =item B<TYPE_INIT>
538 =item B<TYPE_READ>
540 =item B<TYPE_WRITE>
542 =item B<TYPE_FLUSH>
544 =item B<TYPE_SHUTDOWN>
546 =item B<TYPE_LOG>
548 =item B<TYPE_DATASET>
550 =back
552 =item B<:ds_types>
554 =over 4
556 =item B<DS_TYPE_COUNTER>
558 =item B<DS_TYPE_GAUGE>
560 =item B<DS_TYPE_DERIVE>
562 =item B<DS_TYPE_ABSOLUTE>
564 =back
566 =item B<:log>
568 =over 4
570 =item B<ERROR> ()
572 =item B<WARNING> ()
574 =item B<NOTICE> ()
576 =item B<INFO> ()
578 =item B<DEBUG> ()
580 =item B<LOG_ERR>
582 =item B<LOG_WARNING>
584 =item B<LOG_NOTICE>
586 =item B<LOG_INFO>
588 =item B<LOG_DEBUG>
590 =back
592 =item B<:filter_chain>
594 =over 4
596 =item B<fc_register>
598 =item B<FC_MATCH_NO_MATCH>
600 =item B<FC_MATCH_MATCHES>
602 =item B<FC_TARGET_CONTINUE>
604 =item B<FC_TARGET_STOP>
606 =item B<FC_TARGET_RETURN>
608 =back
610 =item B<:fc_types>
612 =over 4
614 =item B<FC_MATCH>
616 =item B<FC_TARGET>
618 =back
620 =item B<:notif>
622 =over 4
624 =item B<NOTIF_FAILURE>
626 =item B<NOTIF_WARNING>
628 =item B<NOTIF_OKAY>
630 =back
632 =item B<:globals>
634 =over 4
636 =item B<$hostname_g>
638 =item B<$interval_g>
640 =back
642 =back
644 =head1 EXAMPLES
646 Any Perl plugin will start similar to:
648   package Collectd::Plugins::FooBar;
650   use strict;
651   use warnings;
653   use Collectd qw( :all );
655 A very simple read function might look like:
657   sub foobar_read
658   {
659     my $vl = { plugin => 'foobar', type => 'gauge' };
660     $vl->{'values'} = [ rand(42) ];
661     plugin_dispatch_values ($vl);
662     return 1;
663   }
665 A very simple write function might look like:
667   sub foobar_write
668   {
669     my ($type, $ds, $vl) = @_;
670     for (my $i = 0; $i < scalar (@$ds); ++$i) {
671       print "$vl->{'plugin'} ($vl->{'type'}): $vl->{'values'}->[$i]\n";
672     }
673     return 1;
674   }
676 A very simple match callback might look like:
678   sub foobar_match
679   {
680     my ($ds, $vl, $meta, $user_data) = @_;
681     if (matches($ds, $vl)) {
682       return FC_MATCH_MATCHES;
683     } else {
684       return FC_MATCH_NO_MATCH;
685     }
686   }
688 To register those functions with collectd:
690   plugin_register (TYPE_READ, "foobar", "foobar_read");
691   plugin_register (TYPE_WRITE, "foobar", "foobar_write");
693   fc_register (FC_MATCH, "foobar", "foobar_match");
695 See the section "DATA TYPES" above for a complete documentation of the data
696 types used by the read, write and match functions.
698 =head1 NOTES
700 =over 4
702 =item
704 Please feel free to send in new plugins to collectd's mailing list at
705 E<lt>collectdE<nbsp>atE<nbsp>verplant.orgE<gt> for review and, possibly,
706 inclusion in the main distribution. In the latter case, we will take care of
707 keeping the plugin up to date and adapting it to new versions of collectd.
709 Before submitting your plugin, please take a look at
710 L<http://collectd.org/dev-info.shtml>.
712 =back
714 =head1 CAVEATS
716 =over 4
718 =item
720 collectd is heavily multi-threaded. Each collectd thread accessing the perl
721 plugin will be mapped to a Perl interpreter thread (see L<threads(3perl)>).
722 Any such thread will be created and destroyed transparently and on-the-fly.
724 Hence, any plugin has to be thread-safe if it provides several entry points
725 from collectd (i.E<nbsp>e. if it registers more than one callback or if a
726 registered callback may be called more than once in parallel). Please note
727 that no data is shared between threads by default. You have to use the
728 B<threads::shared> module to do so.
730 =item
732 Each function name registered with collectd has to be available before the
733 first thread has been created (i.E<nbsp>e. basically at compile time). This
734 basically means that hacks (yes, I really consider this to be a hack) like
735 C<*foo = \&bar; plugin_register (TYPE_READ, "plugin", "foo");> most likely
736 will not work. This is due to the fact that the symbol table is not shared
737 across different threads.
739 =item
741 Each plugin is usually only loaded once and kept in memory for performance
742 reasons. Therefore, END blocks are only executed once when collectd shuts
743 down. You should not rely on END blocks anyway - use B<shutdown functions>
744 instead.
746 =item
748 The perl plugin exports the internal API of collectd which is considered
749 unstable and subject to change at any time. We try hard to not break backwards
750 compatibility in the Perl API during the life cycle of one major release.
751 However, this cannot be guaranteed at all times. Watch out for warnings
752 dispatched by the perl plugin after upgrades.
754 =back
756 =head1 KNOWN BUGS
758 =over 4
760 =item
762 Currently, it is not possible to flush a single Perl plugin only. You can
763 either flush all Perl plugins or none at all and you have to use C<perl> as
764 plugin name when doing so.
766 =back
768 =head1 SEE ALSO
770 L<collectd(1)>,
771 L<collectd.conf(5)>,
772 L<collectd-exec(5)>,
773 L<types.db(5)>,
774 L<perl(1)>,
775 L<threads(3perl)>,
776 L<threads::shared(3perl)>,
777 L<perldebug(1)>
779 =head1 AUTHOR
781 The C<perl plugin> has been written by Sebastian Harl
782 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
784 This manpage has been written by Florian Forster
785 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt> and Sebastian Harl
786 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
788 =cut