summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 50d491f)
raw | patch | inline | side by side (parent: 50d491f)
author | Florian Forster <octo@huhu.verplant.org> | |
Thu, 10 Dec 2009 11:11:34 +0000 (12:11 +0100) | ||
committer | Florian Forster <octo@huhu.verplant.org> | |
Thu, 10 Dec 2009 11:11:34 +0000 (12:11 +0100) |
src/collectd-python.pod | patch | blob | history |
index 9b990b9b322276e2f27e9941d75fc963cced3937..3620aee7f6879958675550c15bd01c37f5538430 100644 (file)
--- a/src/collectd-python.pod
+++ b/src/collectd-python.pod
B<1.> collectd will try to import the B<readline> module to give you a decent
way of entering your commands. The daemonized collectd won't do that.
B<1.> collectd will try to import the B<readline> module to give you a decent
way of entering your commands. The daemonized collectd won't do that.
-=item
+=item
B<2.> collectd will block I<SIGINT>. Pressing I<Ctrl+C> will usually cause
collectd to shut down. This would be problematic in an interactive session,
B<2.> collectd will block I<SIGINT>. Pressing I<Ctrl+C> will usually cause
collectd to shut down. This would be problematic in an interactive session,
@@ -217,17 +217,17 @@ It has no methods beyond the bare minimum and only exists for its data members.
Data descriptors defined here:
=over 4
Data descriptors defined here:
=over 4
-
+
=item parent
This represents the parent of this node. On the root node
of the config tree it will be None.
=item parent
This represents the parent of this node. On the root node
of the config tree it will be None.
-
+
=item key
This is the keyword of this item, i.e. the first word of any given line in the
config file. It will always be a string.
=item key
This is the keyword of this item, i.e. the first word of any given line in the
config file. It will always be a string.
-
+
=item values
This is a tuple (which might be empty) of all value, i.e. words following the
=item values
This is a tuple (which might be empty) of all value, i.e. words following the
Every item in this tuple will be either a string or a float or a boolean,
depending on the contents of the configuration file.
Every item in this tuple will be either a string or a float or a boolean,
depending on the contents of the configuration file.
-
+
=item children
This is a tuple of child nodes. For most nodes this will be empty. If this node
=item children
This is a tuple of child nodes. For most nodes this will be empty. If this node
=over 4
=item B<dispatch>([type][, values][, plugin_instance][, type_instance][, plugin][, host][, time][, interval]) -> None.
=over 4
=item B<dispatch>([type][, values][, plugin_instance][, type_instance][, plugin][, host][, time][, interval]) -> None.
-
+
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
parameters see the member of the same same.
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
parameters see the member of the same same.
source. This value has to be a positive integer, so you can't submit more than
one value per second. If this member is set to a non-positive value, the
default value as specified in the config file will be used (default: 10).
source. This value has to be a positive integer, so you can't submit more than
one value per second. If this member is set to a non-positive value, the
default value as specified in the config file will be used (default: 10).
-
+
If you submit values more often than the specified interval, the average will
be used. If you submit less values, your graphs will have gaps.
If you submit values more often than the specified interval, the average will
be used. If you submit less values, your graphs will have gaps.
=over 4
=item B<dispatch>([type][, values][, plugin_instance][, type_instance][, plugin][, host][, time][, interval]) -> None. Dispatch a value list.
=over 4
=item B<dispatch>([type][, values][, plugin_instance][, type_instance][, plugin][, host][, time][, interval]) -> None. Dispatch a value list.
-
+
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
parameters see the member of the same same.
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
parameters see the member of the same same.
-
+
If you do not submit a parameter the value saved in its member will be
submitted. If you do provide a parameter it will be used instead, without
altering the member.
If you do not submit a parameter the value saved in its member will be
submitted. If you do provide a parameter it will be used instead, without
altering the member.