summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 3709e1d)
raw | patch | inline | side by side (parent: 3709e1d)
author | Idan Kamara <idankk86@gmail.com> | |
Wed, 24 Oct 2012 09:30:28 +0000 (11:30 +0200) | ||
committer | Florian Forster <octo@collectd.org> | |
Sat, 10 Nov 2012 08:02:07 +0000 (09:02 +0100) |
Signed-off-by: Florian Forster <octo@collectd.org>
src/collectd-python.pod | patch | blob | history |
index 06ed11938e00a0cf46bbf949d3d14c3903b292bd..ef2e6bd3c6f9a855d6d61a058f019a7a73de88de 100644 (file)
--- a/src/collectd-python.pod
+++ b/src/collectd-python.pod
=item configuration functions
-This type of functions is called during configuration if an appropriate
+These are called during configuration if an appropriate
B<Module> block has been encountered. It is called once for each B<Module>
block which matches the name of the callback as provided with the
B<register_config> method - see below.
=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.E<nbsp>g. 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<Interval> configuration option of collectd). Usually
it will call B<plugin_dispatch_values> to dispatch the values to collectd
which will pass them on to all registered B<write functions>. If this function
=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