summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: bc58fd4)
raw | patch | inline | side by side (parent: bc58fd4)
author | Ruben Kerkhof <ruben@rubenkerkhof.com> | |
Sun, 14 Aug 2016 11:58:14 +0000 (13:58 +0200) | ||
committer | Ruben Kerkhof <ruben@rubenkerkhof.com> | |
Sun, 14 Aug 2016 11:58:14 +0000 (13:58 +0200) |
src/collectd-lua.pod | patch | blob | history |
diff --git a/src/collectd-lua.pod b/src/collectd-lua.pod
index 62dd850ede31f4060f13ad32c774b5e40229ad97..2f18f60fa2a813c9b2020563c8b1ce0b783134f7 100644 (file)
--- a/src/collectd-lua.pod
+++ b/src/collectd-lua.pod
=head1 NAME
-collectd-lua - Documentation of Collectd's C<Lua plugin>
+collectd-lua - Documentation of collectd's C<Lua plugin>
=head1 SYNOPSIS
=head1 DESCRIPTION
-The C<Lua plugin> embeds a Lua interpreter into Collectd and provides an
-interface to Collectd's plugin system. This makes it possible to write plugins
-for Collectd in Lua. This is a lot more efficient than executing a
+The C<Lua plugin> embeds a Lua interpreter into collectd and provides an
+interface to collectd's plugin system. This makes it possible to write plugins
+for collectd in Lua. This is a lot more efficient than executing a
Lua script every time you want to read a value with the C<exec plugin> (see
L<collectd-exec(5)>) and provides a lot more functionality, too.
=head1 WRITING YOUR OWN PLUGINS
-Writing your own plugins is quite simple. Collectd manages plugins by means of
+Writing your own plugins is quite simple. collectd manages plugins by means of
B<dispatch functions> which call the appropriate B<callback functions>
registered by the plugins. Any plugin basically consists of the implementation
of these callback functions and initializing code which registers the
-functions with Collectd. See the section "EXAMPLES" below for a really basic
+functions with collectd. See the section "EXAMPLES" below for a really basic
example. The following types of B<callback functions> are implemented in the
Lua plugin (all of them are optional):
=item read functions
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<collectd.dispatch_values> to dispatch the values to Collectd
+per interval (see the B<Interval> configuration option of collectd). Usually
+it will call B<collectd.dispatch_values> to dispatch the values to collectd
which will pass them on to all registered B<write functions>. If this function
does not return 0 the plugin will be skipped for an increasing
amount of time until it returns normally again.