summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: b9ebf85)
raw | patch | inline | side by side (parent: b9ebf85)
author | Sven Trenkel <collectd@semidefinite.de> | |
Thu, 23 Oct 2014 19:01:13 +0000 (19:01 +0000) | ||
committer | Sven Trenkel <collectd@semidefinite.de> | |
Thu, 23 Oct 2014 19:01:13 +0000 (19:01 +0000) |
src/collectd-python.pod | patch | blob | history |
index 6645614ce02cf3beda14c7644556cce550ba291c..fc5376ed05743ae17dfdf3b7eaa5452330ae07a2 100644 (file)
--- a/src/collectd-python.pod
+++ b/src/collectd-python.pod
The callback will be called without arguments.
-=item register_read(callback[, interval][, data][, name]) -> identifier
+=item register_read(callback[, interval][, data][, name]) -> I<identifier>
This function takes an additional parameter: I<interval>. It specifies the
time between calls to the callback function.
or a callback function. The identifier will be constructed in the same way as
for the register functions.
-=item B<flush>(I<plugin[, I<timeout>][, I<identifier>]) -> None
+=item B<get_dataset>(I<name>) -> I<definition>
+
+Returns the definition of a dataset specified by I<name>. I<definition> is a list
+of tuples, each representing one data source. Each tuple has 4 values:
+
+=over 4
+
+=item name
+
+A string, the name of the data source.
+
+=item type
+
+A string that is equal to either of the variables B<DS_TYPE_COUNTER>,
+B<DS_TYPE_GAUGE>, B<DS_TYPE_DERIVE> or B<DS_TYPE_ABSOLUTE>.
+
+=item min
+
+A float or None, the minimum value.
+
+=item max
+
+A float or None, the maximum value.
+
+=back
+
+=item B<flush>(I<plugin>[, I<timeout>][, I<identifier>]) -> None
Flush one or all plugins. I<timeout> and the specified I<identifiers> are
passed on to the registered flush-callbacks. If omitted, the timeout defaults