X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-lua.pod;h=7a25655088283188e2dc4cce260ac91018c91467;hb=7e942ee673692b1b08dff8a4ad842f6cd628b376;hp=62dd850ede31f4060f13ad32c774b5e40229ad97;hpb=ba420266281dac4ee5c1db44299db9594fb5b15a;p=collectd.git diff --git a/src/collectd-lua.pod b/src/collectd-lua.pod index 62dd850e..7a256550 100644 --- a/src/collectd-lua.pod +++ b/src/collectd-lua.pod @@ -12,7 +12,7 @@ =head1 NAME -collectd-lua - Documentation of Collectd's C +collectd-lua - Documentation of collectd's C =head1 SYNOPSIS @@ -26,9 +26,9 @@ collectd-lua - Documentation of Collectd's C =head1 DESCRIPTION -The C 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 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 (see L) and provides a lot more functionality, too. @@ -56,11 +56,11 @@ If B is not specified, this needs to be an absolute path. =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 which call the appropriate B 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 are implemented in the Lua plugin (all of them are optional): @@ -69,8 +69,8 @@ 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 configuration option of Collectd). Usually -it will call B to dispatch the values to Collectd +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 does not return 0 the plugin will be skipped for an increasing amount of time until it returns normally again. @@ -86,6 +86,8 @@ once for every value that was dispatched by any plugin. The following functions are provided to Lua modules: +=over 4 + =item register_read(callback) The callback will be called without arguments.