X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-perl.pod;h=02563066de232a0c013859b482b8328a1a5f4301;hb=4371ef7f98f6f51ea3df34d5e26e175d6b44a328;hp=ee05e002d4fea57996ed5cf6543c38d166a35c13;hpb=21b429b6b5ecd2f9820d9a2516c12577a0e59d19;p=collectd.git diff --git a/src/collectd-perl.pod b/src/collectd-perl.pod index ee05e002..02563066 100644 --- a/src/collectd-perl.pod +++ b/src/collectd-perl.pod @@ -1,12 +1,12 @@ +=encoding UTF-8 + =head1 NAME collectd-perl - Documentation of collectd's C =head1 SYNOPSIS - - Globals true - + LoadPlugin perl # ... IncludeDir "/path/to/perl/plugins" @@ -27,12 +27,6 @@ for collectd in Perl. This is a lot more efficient than executing a Perl-script every time you want to read a value with the C (see L) and provides a lot more functionality, too. -When loading the C, the B option should be enabled. -Else, the perl plugin will fail to load any Perl modules implemented in C, -which includes, amongst many others, the B module used by the plugin -itself. See the documentation of the B option in L -for details. - =head1 CONFIGURATION =over 4 @@ -711,7 +705,7 @@ types used by the read, write and match functions. =over 4 -=item +=item * Please feel free to send in new plugins to collectd's mailing list at EcollectdEatEverplant.orgE for review and, possibly, @@ -727,7 +721,7 @@ L. =over 4 -=item +=item * collectd is heavily multi-threaded. Each collectd thread accessing the perl plugin will be mapped to a Perl interpreter thread (see L). @@ -739,7 +733,7 @@ registered callback may be called more than once in parallel). Please note that no data is shared between threads by default. You have to use the B module to do so. -=item +=item * Each function name registered with collectd has to be available before the first thread has been created (i.Ee. basically at compile time). This @@ -748,14 +742,14 @@ C<*foo = \&bar; plugin_register (TYPE_READ, "plugin", "foo");> most likely will not work. This is due to the fact that the symbol table is not shared across different threads. -=item +=item * Each plugin is usually only loaded once and kept in memory for performance reasons. Therefore, END blocks are only executed once when collectd shuts down. You should not rely on END blocks anyway - use B instead. -=item +=item * The perl plugin exports the internal API of collectd which is considered unstable and subject to change at any time. We try hard to not break backwards @@ -769,7 +763,7 @@ dispatched by the perl plugin after upgrades. =over 4 -=item +=item * Currently, it is not possible to flush a single Perl plugin only. You can either flush all Perl plugins or none at all and you have to use C as