src/Makefile.am: Fix "make dist" to include utils_threshold.h

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 0a6820c148b4aaa14671e44ae5bee884f683cfb0..2720e83448530a5bacb4bf1fc61d402e18f2fb42 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -386,8 +386,11 @@ if your virtualization setup is static you might consider increasing
 this.
 
 =item B<Domain> I<name>
+
 =item B<BlockDevice> I<name:dev>
+
 =item B<InterfaceDevice> I<name:dev>
+
 =item B<IgnoreSelected> I<true>|I<false>
 
 Select which domains and devices are monitored.
@@ -413,6 +416,26 @@ Example:
 Ignore all I<hdb> devices on any domain, but other block devices
 (eg. I<hda>) will be monitored.
 
+=item B<HostnameFormat> I<name|uuid|hostname|...>
+
+When libvirtstats logs data, it sets the collectd I<host> field in the
+data according to this setting.
+
+The default is I<name> which means to use the guest name from the
+hypervisor.
+
+I<uuid> means use the guest's UUID.  This is useful if you want to
+track the same guest across migrations.
+
+I<hostname> means to use the global I<Hostname> setting, which is
+probably not useful on its own because all guests will appear to have
+the same name.
+
+You can also specify combinations of these fields.  For example
+I<name uuid>
+means to concatenate the guest name and UUID (with a literal
+colon character between, thus I<"foo:1234-1234-1234-1234">).
+
 =back
 
 =head2 Plugin C<logfile>
@@ -929,6 +952,35 @@ L<chmod(1)>. Defaults to B<0770>.
 
 =back
 
+=head2 Plugin C<uuid>
+
+This plugin, if loaded, causes the Hostname to be taken from the
+machine's UUID.  The UUID is a universally unique designation for the
+machine, usually taken from the machine's BIOS.  This is most useful
+if the machine is running in a virtual environment such as Xen, in
+which case the UUID is preserved across shutdowns and migration.
+
+The following methods are used to find the machine's UUID, in order:
+
+Check I</etc/uuid> (or I<UUIDFile>).
+
+Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>)
+if present.
+
+Check for UUID from C<dmidecode> / SMBIOS.
+
+Check for UUID from Xen hypervisor.
+
+If no UUID can be found then the hostname is not modified.
+
+=over 4
+
+=item B<UUIDFile> I<Path>
+
+Take the UUID from the given file (default I</etc/uuid>).
+
+=back
+
 =head2 Plugin C<vserver>
 
 This plugin doesn't have any options. B<VServer> support is only available for