![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 99eb08b)
raw | patch | inline | side by side (parent: 99eb08b)
| author | Marc Fournier <marc.fournier@camptocamp.com> | |
| Tue, 14 Jun 2016 05:38:30 +0000 (07:38 +0200) | ||
| committer | Marc Fournier <marc.fournier@camptocamp.com> | |
| Tue, 14 Jun 2016 05:38:30 +0000 (07:38 +0200) |
diff --git a/src/collectd-email.pod b/src/collectd-email.pod
index 6f58542784d51a206c685eedee1eed488cd3b101..6a07b886786c8bb857f4b698a2477ad815a0b09d 100644 (file)
--- a/src/collectd-email.pod
+++ b/src/collectd-email.pod
=over 4
-=item
+=item *
E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
If C<size> is less than or equal to zero, C<size> is ignored.
-=item
+=item *
Spam score:
s:<value>
-=item
+=item *
Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...):
diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod
index 57e5b6e2e43a8ab2bb8b126dbbcd79565be2a5de..074bbbdca4c58bc9acd123c05bbf76cc1bb7ab63 100644 (file)
--- a/src/collectd-exec.pod
+++ b/src/collectd-exec.pod
=over 4
-=item
+=item *
The user, the binary is executed as, may not have root privileges, i.E<nbsp>e.
must have an UID that is non-zero. This is for your own good.
-=item
+=item *
Early versions of the plugin did not use a command but treated all lines as if
they were arguments to the I<PUTVAL> command. When the I<PUTNOTIF> command was
diff --git a/src/collectd-perl.pod b/src/collectd-perl.pod
index d4137bb751cc9259a3af4e07d0a69eb384dedf53..02563066de232a0c013859b482b8328a1a5f4301 100644 (file)
--- a/src/collectd-perl.pod
+++ b/src/collectd-perl.pod
=over 4
-=item
+=item *
Please feel free to send in new plugins to collectd's mailing list at
E<lt>collectdE<nbsp>atE<nbsp>verplant.orgE<gt> for review and, possibly,
=over 4
-=item
+=item *
collectd is heavily multi-threaded. Each collectd thread accessing the perl
plugin will be mapped to a Perl interpreter thread (see L<threads(3perl)>).
that no data is shared between threads by default. You have to use the
B<threads::shared> module to do so.
-=item
+=item *
Each function name registered with collectd has to be available before the
first thread has been created (i.E<nbsp>e. basically at compile time). This
will not work. This is due to the fact that the symbol table is not shared
across different threads.
-=item
+=item *
Each plugin is usually only loaded once and kept in memory for performance
reasons. Therefore, END blocks are only executed once when collectd shuts
down. You should not rely on END blocks anyway - use B<shutdown functions>
instead.
-=item
+=item *
The perl plugin exports the internal API of collectd which is considered
unstable and subject to change at any time. We try hard to not break backwards
=over 4
-=item
+=item *
Currently, it is not possible to flush a single Perl plugin only. You can
either flush all Perl plugins or none at all and you have to use C<perl> as
index b382424b7b0392180219156d18de144f58043b60..8564ae77e8c0210d9e47ac373743b54ee8c8ffff 100644 (file)
--- a/src/collectd-python.pod
+++ b/src/collectd-python.pod
=over 4
-=item
+=item *
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,
To quit collectd send I<EOF> (press I<Ctrl+D> at the beginning of a new line).
-=item
+=item *
B<3.> collectd handles I<SIGCHLD>. This means that Python won't be able to
determine the return code of spawned processes with system(), popen() and
=over 4
-=item
+=item *
I<callback> is a callable object that will be called every time the event is
triggered.
-=item
+=item *
I<data> is an optional object that will be passed back to the callback function
every time it is called. If you omit this parameter no object is passed back to
your callback, not even None.
-=item
+=item *
I<name> is an optional identifier for this callback. The default name is
B<python>.I<module>. I<module> is taken from the B<__module__> attribute of
want to register the same callback multiple times in the same module you need to
specify a name here. Otherwise it's safe to ignore this parameter.
-=item
+=item *
I<identifier> is the full identifier assigned to this callback.
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<flush>(I<plugin[, timeout][, 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
=over 4
-=item
+=item *
Please feel free to send in new plugins to collectd's mailing list at
E<lt>collectdE<nbsp>atE<nbsp>verplant.orgE<gt> for review and, possibly,
=over 4
-=item
+=item *
collectd is heavily multi-threaded. Each collectd thread accessing the Python
plugin will be mapped to a Python interpreter thread. Any such thread will be
from collectd (i.E<nbsp>e. if it registers more than one callback or if a
registered callback may be called more than once in parallel).
-=item
+=item *
The Python thread module is initialized just before calling the init callbacks.
This means you must not use Python's threading module prior to this point. This
includes all config and possibly other callback as well.
-=item
+=item *
The python plugin exports the internal API of collectd which is considered
unstable and subject to change at any time. We try hard to not break backwards
=over 4
-=item
+=item *
Not all aspects of the collectd API are accessible from Python. This includes
but is not limited to filters and data sets.
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 499634c5d5af888006b4848a63123221f18046c7..f85c7e799291354756f04ce53c022cfd386fb147 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
=over 4
-=item
+=item *
The I<Type> cannot be left unspecified, because it is not reasonable to add
apples to oranges. Also, the internal lookup structure won't work if you try
to group by type.
-=item
+=item *
There must be at least one unspecified, ungrouped field. Otherwise nothing
will be aggregated.
=over 4
-=item
+=item *
foo.example.com/cpu-even-average/cpu-idle
-=item
+=item *
foo.example.com/cpu-even-average/cpu-system
-=item
+=item *
foo.example.com/cpu-even-average/cpu-user
-=item
+=item *
...
Sets the plugin instance to I<Instance>.
=item B<User> I<Name>
+
=item B<Password> I<Password>
+
=item B<VerifyPeer> B<true>|B<false>
+
=item B<VerifyHost> B<true>|B<false>
+
=item B<CACert> I<file>
+
=item B<Header> I<Header>
+
=item B<Post> I<Body>
These options behave exactly equivalent to the appropriate options of the
=over 4
-=item
+=item *
Check I</etc/uuid> (or I<UUIDFile>).
-=item
+=item *
Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
present.
-=item
+=item *
Check for UUID from C<dmidecode> / SMBIOS.
-=item
+=item *
Check for UUID from Xen hypervisor.
diff --git a/src/collectd.pod b/src/collectd.pod
index 2f7b9f707439c795fcf85acfaede29ec39821a2e..8ea47ec81496716699d504e0115fdb6986cacb4c 100644 (file)
--- a/src/collectd.pod
+++ b/src/collectd.pod
=over 4
-=item
+=item *
Input plugins are queried periodically. They somehow acquire the current value
of whatever they where designed to work with and submit these values back to
reads the current cpu-counters of time spent in the various modes (user,
system, nice, ...) and dispatches these counters to the daemon.
-=item
+=item *
Output plugins get the dispatched values from the daemon and does something
with them. Common applications are writing to RRD-files, CSV-files or sending