Code

Document interpolation and DeleteMetaData.
authorIgor Peshansky <igorpeshansky@github.com>
Thu, 8 Sep 2016 16:26:00 +0000 (12:26 -0400)
committerIgor Peshansky <igorpeshansky@github.com>
Fri, 9 Sep 2016 16:42:00 +0000 (12:42 -0400)
src/collectd.conf.pod

index 0fa74d54bbe515d49aef330fd2adb20d9ef2a831..127d51861fc8de719285bd5224b33425c29f80ab 100644 (file)
@@ -9419,9 +9419,37 @@ Available options:
 
 =item B<MetaData> I<String> I<String>
 
-Set the appropriate field to the given string. The strings for plugin instance
-and type instance may be empty, the strings for host and plugin may not be
-empty. It's currently not possible to set the type of a value this way.
+Set the appropriate field to the given string. The strings for plugin instance,
+type instance, and meta data may be empty, the strings for host and plugin may
+not be empty. It's currently not possible to set the type of a value this way.
+
+The following placeholders will be replaced by an appropriate value:
+
+=over 4
+
+=item B<%{host}>
+
+=item B<%{plugin}>
+
+=item B<%{plugin_instance}>
+
+=item B<%{type}>
+
+=item B<%{type_instance}>
+
+These placeholders are replaced by the identifier field of the same name.
+
+=item B<%{meta:>I<name>B<}>
+
+These placeholders are replaced by the meta data value with the given name.
+
+=back
+
+Please note that these placeholders are B<case sensitive>!
+
+=item B<DeleteMetaData> I<String>
+
+Delete the named meta data field.
 
 =back