battery plugin: Fix a typo.
[collectd.git] / 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,
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     host   => $hostname_g,
202     plugin => 'myplugin',
203     type   => 'myplugin',
204     plugin_instance => '',
205     type_instance   => ''
206   }
207
208 =item Notification
209
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:
212
213   {
214     severity => NOTIF_FAILURE || NOTIF_WARNING || NOTIF_OKAY,
215     time     => time (),
216     message  => 'status message',
217     host     => $hostname_g,
218     plugin   => 'myplugin',
219     type     => 'mytype',
220     plugin_instance => '',
221     type_instance   => ''
222   }
223
224 =back
225
226 =head1 METHODS
227
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).
230
231 =over 4
232
233 =item B<plugin_register> (I<type>, I<name>, I<data>)
234
235 Registers a callback-function or data-set.
236
237 I<type> can be one of:
238
239 =over 4
240
241 =item TYPE_CONFIG
242
243 =item TYPE_INIT
244
245 =item TYPE_READ
246
247 =item TYPE_WRITE
248
249 =item TYPE_FLUSH
250
251 =item TYPE_LOG
252
253 =item TYPE_NOTIF
254
255 =item TYPE_SHUTDOWN
256
257 =item TYPE_DATASET
258
259 =back
260
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.)
265
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.
273
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.
280
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
283 arguments:
284
285 =over 4
286
287 =item TYPE_CONFIG
288
289 The only argument passed is I<config-item>. See above for the layout of this
290 data type.
291
292 =item TYPE_INIT
293
294 =item TYPE_READ
295
296 =item TYPE_SHUTDOWN
297
298 No arguments are passed.
299
300 =item TYPE_WRITE
301
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.
304
305 =item TYPE_FLUSH
306
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.
310
311 =item TYPE_LOG
312
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.
318
319 =item TYPE_NOTIF
320
321 The only argument passed is I<notification>. See above for the layout of this
322 data type.
323
324 =back
325
326 =item B<plugin_unregister> (I<type>, I<plugin>)
327
328 Removes a callback or data-set from collectd's internal list of
329 functionsE<nbsp>/ datasets.
330
331 =item B<plugin_dispatch_values> (I<value-list>)
332
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.
338
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.
343
344 =item B<plugin_flush> ([B<timeout> => I<timeout>][, B<plugins> => I<...>][,
345 B<identifiers> => I<...>])
346
347 Flush one or more plugins. I<timeout> and the specified I<identifiers> are
348 passed on to the registered flush-callbacks. If omitted, the timeout defaults
349 to C<-1>. The identifier defaults to the undefined value. If the I<plugins>
350 argument has been specified, only named plugins will be flushed. The value of
351 the B<plugins> and B<identifiers> arguments may either be a string or a
352 reference to an array of strings.
353
354 =item B<plugin_flush_one> (I<timeout>, I<plugin>)
355
356 This is identical to using "plugin_flush (timeout =E<gt> I<timeout>, plugins
357 =E<gt> I<plugin>".
358
359 B<Note>: Starting with version 4.5 of collectd, B<plugin_flush_one> has been
360 deprecated and will be removed in some future version of collectd. Use
361 B<plugin_flush> instead.
362
363 =item B<plugin_flush_all> (I<timeout>)
364
365 This is identical to using "plugin_flush (timeout =E<gt> I<timeout>)".
366
367 B<Note>: Starting with version 4.5 of collectd, B<plugin_flush_all> has been
368 deprecated and will be removed in some future version of collectd. Use
369 B<plugin_flush> instead.
370
371 =item B<plugin_dispatch_notification> (I<notification>)
372
373 Submits a I<notification> to the daemon which will then pass it to all
374 notification-callbacks that are registered.
375
376 =item B<plugin_log> (I<log-level>, I<message>)
377
378 Submits a I<message> of level I<log-level> to collectd's logging mechanism.
379 The message is passed to all log-callbacks that are registered with collectd.
380
381 =item B<ERROR>, B<WARNING>, B<NOTICE>, B<INFO>, B<DEBUG> (I<message>)
382
383 Wrappers around B<plugin_log>, using B<LOG_ERR>, B<LOG_WARNING>,
384 B<LOG_NOTICE>, B<LOG_INFO> and B<LOG_DEBUG> respectively as I<log-level>.
385
386 =back
387
388 =head1 GLOBAL VARIABLES
389
390 =over 4
391
392 =item B<$hostname_g>
393
394 As the name suggests this variable keeps the hostname of the system collectd
395 is running on. The value might be influenced by the B<Hostname> or
396 B<FQDNLookup> configuration options (see L<collectd.conf(5)> for details).
397
398 =item B<$interval_g>
399
400 This variable keeps the interval in seconds in which the read functions are
401 queried (see the B<Interval> configuration option).
402
403 =back
404
405 Any changes to these variables will be globally visible in collectd.
406
407 =head1 EXPORTS
408
409 By default no symbols are exported. However, the following export tags are
410 available (B<:all> will export all of them):
411
412 =over 4
413
414 =item B<:plugin>
415
416 =over 4
417
418 =item B<plugin_register> ()
419
420 =item B<plugin_unregister> ()
421
422 =item B<plugin_dispatch_values> ()
423
424 =item B<plugin_flush> ()
425
426 =item B<plugin_flush_one> ()
427
428 =item B<plugin_flush_all> ()
429
430 =item B<plugin_dispatch_notification> ()
431
432 =item B<plugin_log> ()
433
434 =back
435
436 =item B<:types>
437
438 =over 4
439
440 =item B<TYPE_CONFIG>
441
442 =item B<TYPE_INIT>
443
444 =item B<TYPE_READ>
445
446 =item B<TYPE_WRITE>
447
448 =item B<TYPE_FLUSH>
449
450 =item B<TYPE_SHUTDOWN>
451
452 =item B<TYPE_LOG>
453
454 =item B<TYPE_DATASET>
455
456 =back
457
458 =item B<:ds_types>
459
460 =over 4
461
462 =item B<DS_TYPE_COUNTER>
463
464 =item B<DS_TYPE_GAUGE>
465
466 =back
467
468 =item B<:log>
469
470 =over 4
471
472 =item B<ERROR> ()
473
474 =item B<WARNING> ()
475
476 =item B<NOTICE> ()
477
478 =item B<INFO> ()
479
480 =item B<DEBUG> ()
481
482 =item B<LOG_ERR>
483
484 =item B<LOG_WARNING>
485
486 =item B<LOG_NOTICE>
487
488 =item B<LOG_INFO>
489
490 =item B<LOG_DEBUG>
491
492 =back
493
494 =item B<:notif>
495
496 =over 4
497
498 =item B<NOTIF_FAILURE>
499
500 =item B<NOTIF_WARNING>
501
502 =item B<NOTIF_OKAY>
503
504 =back
505
506 =item B<:globals>
507
508 =over 4
509
510 =item B<$hostname_g>
511
512 =item B<$interval_g>
513
514 =back
515
516 =back
517
518 =head1 EXAMPLES
519
520 Any Perl plugin will start similar to:
521
522   package Collectd::Plugins::FooBar;
523
524   use strict;
525   use warnings;
526
527   use Collectd qw( :all );
528
529 A very simple read function will look like:
530
531   sub foobar_read
532   {
533     my $vl = { plugin => 'foobar' };
534     $vl->{'values'} = [ rand(42) ];
535     plugin_dispatch_values ('gauge', $vl);
536     return 1;
537   }
538
539 A very simple write function will look like:
540
541   sub foobar_write
542   {
543     my ($type, $ds, $vl) = @_;
544     for (my $i = 0; $i < scalar (@$ds); ++$i) {
545       print "$vl->{'plugin'} ($vl->{'type'}): $vl->{'values'}->[$i]\n";
546     }
547     return 1;
548   }
549
550 To register those functions with collectd:
551
552   plugin_register (TYPE_READ, "foobar", "foobar_read");
553   plugin_register (TYPE_WRITE, "foobar", "foobar_write");
554
555 See the section "DATA TYPES" above for a complete documentation of the data
556 types used by the read and write functions.
557
558 =head1 NOTES
559
560 =over 4
561
562 =item
563
564 Please feel free to send in new plugins to collectd's mailinglist at
565 E<lt>collectdE<nbsp>atE<nbsp>verplant.orgE<gt> for review and, possibly,
566 inclusion in the main distribution. In the latter case, we will take care of
567 keeping the plugin up to date and adapting it to new versions of collectd.
568
569 Before submitting your plugin, please take a look at
570 L<http://collectd.org/dev-info.shtml>.
571
572 =back
573
574 =head1 CAVEATS
575
576 =over 4
577
578 =item
579
580 collectd is heavily multi-threaded. Each collectd thread accessing the perl
581 plugin will be mapped to a Perl interpreter thread (see L<threads(3perl)>).
582 Any such thread will be created and destroyed transparently and on-the-fly.
583
584 Hence, any plugin has to be thread-safe if it provides several entry points
585 from collectd (i.E<nbsp>e. if it registers more than one callback or if a
586 registered callback may be called more than once in parallel). Please note
587 that no data is shared between threads by default. You have to use the
588 B<threads::shared> module to do so.
589
590 =item
591
592 Each function name registered with collectd has to be available before the
593 first thread has been created (i.E<nbsp>e. basically at compile time). This
594 basically means that hacks (yes, I really consider this to be a hack) like
595 C<*foo = \&bar; plugin_register (TYPE_READ, "plugin", "foo");> most likely
596 will not work. This is due to the fact that the symbol table is not shared
597 across different threads.
598
599 =item
600
601 Each plugin is usually only loaded once and kept in memory for performance
602 reasons. Therefore, END blocks are only executed once when collectd shuts
603 down. You should not rely on END blocks anyway - use B<shutdown functions>
604 instead.
605
606 =item
607
608 The perl plugin exports the internal API of collectd which is considered
609 unstable and subject to change at any time. We try hard to not break backwards
610 compatibility in the Perl API during the life cycle of one major release.
611 However, this cannot be guaranteed at all times. Watch out for warnings
612 dispatched by the perl plugin after upgrades.
613
614 =back
615
616 =head1 KNOWN BUGS
617
618 =over 4
619
620 =item
621
622 Currently, it is not possible to flush a single Perl plugin only. You can
623 either flush all Perl plugins or none at all and you have to use C<perl> as
624 plugin name when doing so.
625
626 =back
627
628 =head1 SEE ALSO
629
630 L<collectd(1)>,
631 L<collectd.conf(5)>,
632 L<collectd-exec(5)>,
633 L<types.db(5)>,
634 L<perl(1)>,
635 L<threads(3perl)>,
636 L<threads::shared(3perl)>,
637 L<perldebug(1)>
638
639 =head1 AUTHOR
640
641 The C<perl plugin> has been written by Sebastian Harl
642 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
643
644 This manpage has been written by Florian Forster
645 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt> and Sebastian Harl
646 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
647
648 =cut
649