X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-python.pod;h=ada1ff55fa32d52551c81306da878936e7956f14;hb=ad0a12907bf80b4f0deec217b8379dd08c490dbc;hp=773a6cd4b7919b1d950794c63b49dc401e43a4c1;hpb=f7b05ebf3311b4c6cb5289f1f7cd8ee02918ef92;p=collectd.git diff --git a/src/collectd-python.pod b/src/collectd-python.pod index 773a6cd4..ada1ff55 100644 --- a/src/collectd-python.pod +++ b/src/collectd-python.pod @@ -37,7 +37,7 @@ for collectd in Python. This is a lot more efficient than executing a Python-script every time you want to read a value with the C (see L) and provides a lot more functionality, too. -The minimum required Python version is I<2.3>. +The minimum required Python version is I<2.6>. =head1 CONFIGURATION @@ -94,11 +94,12 @@ way of entering your commands. The daemonized collectd won't do that. =item * -B<2.> collectd will block I. Pressing I will usually cause +B<2.> Python will be handling I. Pressing I will usually cause collectd to shut down. This would be problematic in an interactive session, -therefore this signal will be blocked. You can still use it to interrupt -syscalls like sleep and pause but it won't generate a I -exception either. +therefore Python will be handling it in interactive sessions. This allows you +to use I to interrupt Python code without killing collectd. This also +means you can catch I exceptions which does not work during +normal operation. To quit collectd send I (press I at the beginning of a new line). @@ -474,7 +475,7 @@ Methods defined here: =over 4 -=item B([type][, values][, plugin_instance][, type_instance][, plugin][, host][, time][, interval]) -> None. Dispatch a value list. +=item B([type][, message][, plugin_instance][, type_instance][, plugin][, host][, time][, severity]) -> None. Dispatch a notification. Dispatch this instance to the collectd process. The object has members for each of the possible arguments for this method. For a detailed explanation of these @@ -658,6 +659,8 @@ Any Python module will start similar to: A very simple read function might look like: + import random + def read(data=None): vl = collectd.Values(type='gauge') vl.plugin='python.spam' @@ -671,28 +674,12 @@ A very simple write function might look like: To register those functions with collectd: - collectd.register_read(read); - collectd.register_write(write); + collectd.register_read(read) + collectd.register_write(write) See the section L<"CLASSES"> above for a complete documentation of the data types used by the read, write and match functions. -=head1 NOTES - -=over 4 - -=item * - -Please feel free to send in new plugins to collectd's mailing list at -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. - -Before submitting your plugin, please take a look at -L. - -=back - =head1 CAVEATS =over 4