3 collectd-perl - Documentation of collectd's C<perl plugin>
10 IncludeDir "/path/to/perl/plugins"
11 BaseName "Collectd::Plugin"
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.
32 =item B<LoadPlugin> I<Plugin>
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.
38 =item B<BaseName> I<Name>
40 Prepends I<Name>B<::> to all plugin names loaded after this option. This is
41 provided for convenience to keep plugin names short.
43 =item E<lt>B<Plugin> I<Name>E<gt> block
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.
50 The I<name> identifies the callback. It is used literally and independent of
51 the B<BaseName> setting.
53 =item B<EnableDebugger> I<Package>[=I<option>,...]
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.
62 See L<perldebug> for detailed documentation about debugging Perl.
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.
68 =item B<IncludeDir> I<Dir>
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.
76 =head1 WRITING YOUR OWN PLUGINS
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):
88 =item configuration functions
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.
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.
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.
111 =item write functions
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>.
116 =item flush functions
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.
124 This type of function is used to pass messages of plugins or the daemon itself
127 =item notification function
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.
136 =item shutdown functions
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, ...).
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.
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.
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.
159 The following complex types are used to pass values between the Perl plugin
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.
173 values => [ val1, val2, ... ],
174 children => [ { ... }, { ... }, ... ]
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:
184 name => 'data_source_name',
185 type => DS_TYPE_COUNTER || DS_TYPE_GAUGE,
186 min => value || undef,
187 max => value || undef
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:
199 values => [123, 0.5],
202 plugin => 'myplugin',
204 plugin_instance => '',
210 A notification is one structure defining the severity, time and message of the
211 status message as well as an identification of a data instance:
214 severity => NOTIF_FAILURE || NOTIF_WARNING || NOTIF_OKAY,
216 message => 'status message',
218 plugin => 'myplugin',
220 plugin_instance => '',
228 The following functions provide the C-interface to Perl-modules. They are
229 exported by the ":plugin" export tag (see the section "EXPORTS" below).
233 =item B<plugin_register> (I<type>, I<name>, I<data>)
235 Registers a callback-function or data-set.
237 I<type> can be one of:
261 I<name> is the name of the callback-function or the type of the data-set,
262 depending on the value of I<type>. (Please note that the type of the data-set
263 is the value passed as I<name> here and has nothing to do with the I<type>
264 argument which simply tells B<plugin_register> what is being registered.)
266 The last argument, I<data>, is either a function name or an array-reference.
267 If I<type> is B<TYPE_DATASET>, then the I<data> argument must be an
268 array-reference which points to an array of hashes. Each hash describes one
269 data-set. For the exact layout see B<Data-Set> above. Please note that
270 there is a large number of predefined data-sets available in the B<types.db>
271 file which are automatically registered with collectd - see L<types.db(5)> for
272 a description of the format of this file.
274 If the I<type> argument is any of the other types (B<TYPE_INIT>, B<TYPE_READ>,
275 ...) then I<data> is expected to be a function name. If the name is not
276 prefixed with the plugin's package name collectd will add it automatically.
277 The interface slightly differs from the C interface (which expects a function
278 pointer instead) because Perl does not support to share references to
279 subroutines between threads.
281 These functions are called in the various stages of the daemon (see the
282 section "WRITING YOUR OWN PLUGINS" above) and are passed the following
289 The only argument passed is I<config-item>. See above for the layout of this
298 No arguments are passed.
302 The arguments passed are I<type>, I<data-set>, and I<value-list>. I<type> is a
303 string. For the layout of I<data-set> and I<value-list> see above.
307 The arguments passed are I<timeout> and I<identifier>. I<timeout> indicates
308 that only data older than I<timeout> seconds is to be flushed. I<identifier>
309 specifies which values are to be flushed.
313 The arguments are I<log-level> and I<message>. The log level is small for
314 important messages and high for less important messages. The least important
315 level is B<LOG_DEBUG>, the most important level is B<LOG_ERR>. In between there
316 are (from least to most important): B<LOG_INFO>, B<LOG_NOTICE>, and
317 B<LOG_WARNING>. I<message> is simply a string B<without> a newline at the end.
321 The only argument passed is I<notification>. See above for the layout of this
326 =item B<plugin_unregister> (I<type>, I<plugin>)
328 Removes a callback or data-set from collectd's internal list of
329 functionsE<nbsp>/ datasets.
331 =item B<plugin_dispatch_values> (I<value-list>)
333 Submits a I<value-list> to the daemon. If the data-set identified by
334 I<value-list>->{I<type>}
335 is found (and the number of values matches the number of data-sources) then the
336 type, data-set and value-list is passed to all write-callbacks that are
337 registered with the daemon.
339 B<Note>: Prior to version 4.4 of collectd, the data-set type used to be passed
340 as the first argument to B<plugin_register>. This syntax is still supported
341 for backwards compatibility but has been deprecated and will be removed in
342 some future version of collectd.
344 =item B<plugin_write> ([B<plugins> => I<...>][, B<datasets> => I<...>],
345 B<valuelists> => I<...>)
347 Calls the write function of the given I<plugins> with the provided I<data
348 sets> and I<value lists>. In contrast to B<plugin_dispatch_values>, it does
349 not update collectd's internal cache and bypasses the filter mechanism (see
350 L<collectd.conf(5)> for details). If the B<plugins> argument has been omitted,
351 the values will be dispatched to all registered write plugins. If the
352 B<datasets> argument has been omitted, the required data sets are looked up
353 according to the C<type> member in the appropriate value list. The value of
354 all three arguments may either be a single scalar or a reference to an array.
355 If the B<datasets> argument has been specified, the number of data sets has to
356 equal the number of specified value lists.
358 =item B<plugin_flush> ([B<timeout> => I<timeout>][, B<plugins> => I<...>][,
359 B<identifiers> => I<...>])
361 Flush one or more plugins. I<timeout> and the specified I<identifiers> are
362 passed on to the registered flush-callbacks. If omitted, the timeout defaults
363 to C<-1>. The identifier defaults to the undefined value. If the B<plugins>
364 argument has been specified, only named plugins will be flushed. The value of
365 the B<plugins> and B<identifiers> arguments may either be a string or a
366 reference to an array of strings.
368 =item B<plugin_flush_one> (I<timeout>, I<plugin>)
370 This is identical to using "plugin_flush (timeout =E<gt> I<timeout>, plugins
373 B<Note>: Starting with version 4.5 of collectd, B<plugin_flush_one> has been
374 deprecated and will be removed in some future version of collectd. Use
375 B<plugin_flush> instead.
377 =item B<plugin_flush_all> (I<timeout>)
379 This is identical to using "plugin_flush (timeout =E<gt> I<timeout>)".
381 B<Note>: Starting with version 4.5 of collectd, B<plugin_flush_all> has been
382 deprecated and will be removed in some future version of collectd. Use
383 B<plugin_flush> instead.
385 =item B<plugin_dispatch_notification> (I<notification>)
387 Submits a I<notification> to the daemon which will then pass it to all
388 notification-callbacks that are registered.
390 =item B<plugin_log> (I<log-level>, I<message>)
392 Submits a I<message> of level I<log-level> to collectd's logging mechanism.
393 The message is passed to all log-callbacks that are registered with collectd.
395 =item B<ERROR>, B<WARNING>, B<NOTICE>, B<INFO>, B<DEBUG> (I<message>)
397 Wrappers around B<plugin_log>, using B<LOG_ERR>, B<LOG_WARNING>,
398 B<LOG_NOTICE>, B<LOG_INFO> and B<LOG_DEBUG> respectively as I<log-level>.
402 =head1 GLOBAL VARIABLES
408 As the name suggests this variable keeps the hostname of the system collectd
409 is running on. The value might be influenced by the B<Hostname> or
410 B<FQDNLookup> configuration options (see L<collectd.conf(5)> for details).
414 This variable keeps the interval in seconds in which the read functions are
415 queried (see the B<Interval> configuration option).
419 Any changes to these variables will be globally visible in collectd.
423 By default no symbols are exported. However, the following export tags are
424 available (B<:all> will export all of them):
432 =item B<plugin_register> ()
434 =item B<plugin_unregister> ()
436 =item B<plugin_dispatch_values> ()
438 =item B<plugin_flush> ()
440 =item B<plugin_flush_one> ()
442 =item B<plugin_flush_all> ()
444 =item B<plugin_dispatch_notification> ()
446 =item B<plugin_log> ()
464 =item B<TYPE_SHUTDOWN>
468 =item B<TYPE_DATASET>
476 =item B<DS_TYPE_COUNTER>
478 =item B<DS_TYPE_GAUGE>
512 =item B<NOTIF_FAILURE>
514 =item B<NOTIF_WARNING>
534 Any Perl plugin will start similar to:
536 package Collectd::Plugins::FooBar;
541 use Collectd qw( :all );
543 A very simple read function will look like:
547 my $vl = { plugin => 'foobar' };
548 $vl->{'values'} = [ rand(42) ];
549 plugin_dispatch_values ('gauge', $vl);
553 A very simple write function will look like:
557 my ($type, $ds, $vl) = @_;
558 for (my $i = 0; $i < scalar (@$ds); ++$i) {
559 print "$vl->{'plugin'} ($vl->{'type'}): $vl->{'values'}->[$i]\n";
564 To register those functions with collectd:
566 plugin_register (TYPE_READ, "foobar", "foobar_read");
567 plugin_register (TYPE_WRITE, "foobar", "foobar_write");
569 See the section "DATA TYPES" above for a complete documentation of the data
570 types used by the read and write functions.
578 Please feel free to send in new plugins to collectd's mailinglist at
579 E<lt>collectdE<nbsp>atE<nbsp>verplant.orgE<gt> for review and, possibly,
580 inclusion in the main distribution. In the latter case, we will take care of
581 keeping the plugin up to date and adapting it to new versions of collectd.
583 Before submitting your plugin, please take a look at
584 L<http://collectd.org/dev-info.shtml>.
594 collectd is heavily multi-threaded. Each collectd thread accessing the perl
595 plugin will be mapped to a Perl interpreter thread (see L<threads(3perl)>).
596 Any such thread will be created and destroyed transparently and on-the-fly.
598 Hence, any plugin has to be thread-safe if it provides several entry points
599 from collectd (i.E<nbsp>e. if it registers more than one callback or if a
600 registered callback may be called more than once in parallel). Please note
601 that no data is shared between threads by default. You have to use the
602 B<threads::shared> module to do so.
606 Each function name registered with collectd has to be available before the
607 first thread has been created (i.E<nbsp>e. basically at compile time). This
608 basically means that hacks (yes, I really consider this to be a hack) like
609 C<*foo = \&bar; plugin_register (TYPE_READ, "plugin", "foo");> most likely
610 will not work. This is due to the fact that the symbol table is not shared
611 across different threads.
615 Each plugin is usually only loaded once and kept in memory for performance
616 reasons. Therefore, END blocks are only executed once when collectd shuts
617 down. You should not rely on END blocks anyway - use B<shutdown functions>
622 The perl plugin exports the internal API of collectd which is considered
623 unstable and subject to change at any time. We try hard to not break backwards
624 compatibility in the Perl API during the life cycle of one major release.
625 However, this cannot be guaranteed at all times. Watch out for warnings
626 dispatched by the perl plugin after upgrades.
636 Currently, it is not possible to flush a single Perl plugin only. You can
637 either flush all Perl plugins or none at all and you have to use C<perl> as
638 plugin name when doing so.
650 L<threads::shared(3perl)>,
655 The C<perl plugin> has been written by Sebastian Harl
656 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
658 This manpage has been written by Florian Forster
659 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt> and Sebastian Harl
660 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.