X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=src%2Fcollectd-python.pod;h=6645614ce02cf3beda14c7644556cce550ba291c;hp=06ed11938e00a0cf46bbf949d3d14c3903b292bd;hb=633c3966f770e4d46651a2fe219a18d8a9907a9f;hpb=3709e1d89fba561ae035bd541e354f904213e830 diff --git a/src/collectd-python.pod b/src/collectd-python.pod index 06ed1193..6645614c 100644 --- a/src/collectd-python.pod +++ b/src/collectd-python.pod @@ -8,6 +8,8 @@ # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. +=encoding UTF-8 + =head1 NAME collectd-python - Documentation of collectd's C @@ -174,7 +176,7 @@ example. The following types of B are known to collectd =item configuration functions -This type of functions is called during configuration if an appropriate +These are called during configuration if an appropriate B block has been encountered. It is called once for each B block which matches the name of the callback as provided with the B method - see below. @@ -184,14 +186,14 @@ threading functions here! =item init functions -This type of functions is called once after loading the module and before any +These are called once after loading the module and before any calls to the read and write functions. It should be used to initialize the internal state of the plugin (e.Eg. open sockets, ...). This is the earliest point where you may use threads. =item read functions -This type of function is used to collect the actual data. It is called once +These are used to collect the actual data. It is called once per interval (see the B configuration option of collectd). Usually it will call B to dispatch the values to collectd which will pass them on to all registered B. If this function @@ -200,23 +202,23 @@ amount of time until it returns normally again. =item write functions -This type of function is used to write the dispatched values. It is called +These are used to write the dispatched values. It is called once for every value that was dispatched by any plugin. =item flush functions -This type of function is used to flush internal caches of plugins. It is +These are used to flush internal caches of plugins. It is usually triggered by the user only. Any plugin which caches data before writing it to disk should provide this kind of callback function. =item log functions -This type of function is used to pass messages of plugins or the daemon itself +These are used to pass messages of plugins or the daemon itself to the user. =item notification function -This type of function is used to act upon notifications. In general, a +These are used to act upon notifications. In general, a notification is a status message that may be associated with a data instance. Usually, a notification is generated by the daemon if a configured threshold has been exceeded (see the section "THRESHOLD CONFIGURATION" in @@ -534,9 +536,12 @@ your callback, not even None. I is an optional identifier for this callback. The default name is B.I. I is taken from the B<__module__> attribute of your callback function. Every callback needs a unique identifier, so if you -want to register the same callback multiple time in the same module you need to -specify a name here. Otherwise it's save to ignore this parameter I -is the full identifier assigned to this callback. +want to register the same callback multiple times in the same module you need to +specify a name here. Otherwise it's safe to ignore this parameter. + +=item + +I is the full identifier assigned to this callback. =back @@ -658,7 +663,7 @@ types used by the read, write and match functions. =item Please feel free to send in new plugins to collectd's mailing list at -EcollectdEatEverplant.orgE for review and, possibly, +EcollectdEatEcollectd.orgE for review and, possibly, inclusion in the main distribution. In the latter case, we will take care of keeping the plugin up to date and adapting it to new versions of collectd. @@ -725,7 +730,7 @@ Sven Trenkel EcollectdEatEsemidefinite.deE. This manpage has been written by Sven Trenkel EcollectdEatEsemidefinite.deE. It is based on the L manual page by -Florian Forster EoctoEatEverplant.orgE and +Florian Forster EoctoEatEcollectd.orgE and Sebastian Harl EshEatEtokkee.orgE. =cut