From: Florian Forster <octo@collectd.org>
Date: Fri, 16 Sep 2016 08:50:34 +0000 (+0200)
Subject: Merge branch 'pr/1918'
X-Git-Tag: collectd-5.7.0~77
X-Git-Url: https://git.octo.it/?a=commitdiff_plain;h=6f4f918d4d5e70c75471632254ecb9c55fd8d62f;hp=-c;p=collectd.git

Merge branch 'pr/1918'
---

6f4f918d4d5e70c75471632254ecb9c55fd8d62f
diff --combined src/collectd.conf.pod
index f2443599,20d8c6b6..9d4b7918
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@@ -241,12 -241,6 +241,12 @@@ Path to the plugins (shared objects) o
  Set one or more files that contain the data-set descriptions. See
  L<types.db(5)> for a description of the format of this file.
  
 +If this option is not specified, a default file is read. If you need to define
 +custom types in addition to the types defined in the default file, you need to
 +explicitly load both. In other words, if the B<TypesDB> option is encountered
 +the default behavior is disabled and if you need the default types you have to
 +also explicitly load them.
 +
  =item B<Interval> I<Seconds>
  
  Configures the interval in which to query the read plugins. Obviously smaller
@@@ -2836,35 -2830,20 +2836,35 @@@ options (default is enabled)
  
  =over 4
  
 -=item B<ReportPerNodeHP> I<true>|I<false>
 +=item B<ReportPerNodeHP> B<true>|B<false>
  
  If enabled, information will be collected from the hugepage
  counters in "/sys/devices/system/node/*/hugepages".
  This is used to check the per-node hugepage statistics on
  a NUMA system.
  
 -=item B<ReportRootHP> I<true>|I<false>
 +=item B<ReportRootHP> B<true>|B<false>
  
  If enabled, information will be collected from the hugepage
  counters in "/sys/kernel/mm/hugepages".
  This can be used on both NUMA and non-NUMA systems to check
  the overall hugepage statistics.
  
 +=item B<ValuesPages> B<true>|B<false>
 +
 +Whether to report hugepages metrics in number of pages.
 +Defaults to B<true>.
 +
 +=item B<ValuesBytes> B<false>|B<true>
 +
 +Whether to report hugepages metrics in bytes.
 +Defaults to B<false>.
 +
 +=item B<ValuesPercentage> B<false>|B<true>
 +
 +Whether to report hugepages metrics as percentage.
 +Defaults to B<false>.
 +
  =back
  
  =head2 Plugin C<interface>
@@@ -5747,7 -5726,7 +5747,7 @@@ values are made available through thos
  
  =item B<$1>
  
- The timestamp of the queried value as a floating point number.
+ The timestamp of the queried value as an RFC 3339-formatted local time.
  
  =item B<$2>
  
@@@ -7839,32 -7818,6 +7839,32 @@@ If set to B<true>, append the name of t
  identifier. If set to B<false> (the default), this is only done when there is
  more than one DS.
  
 +=item B<DropDuplicateFields> B<false>|B<true>
 +
 +If set to B<true>, detect and remove duplicate components in Graphite metric
 +names. For example, the metric name  C<host.load.load.shortterm> will
 +be shortened to C<host.load.shortterm>.
 +
 +=back
 +
 +=head2 Plugin C<write_log>
 +
 +The C<write_log> plugin writes metrics as INFO log messages.
 +
 +This plugin supports two output formats: I<Graphite> and I<JSON>.
 +
 +Synopsis:
 +
 + <Plugin write_log>
 +   Format Graphite
 + </Plugin>
 +
 +=over 4
 +
 +=item B<Format> I<Format>
 +
 +The output format to use. Can be one of C<Graphite> or C<JSON>.
 +
  =back
  
  =head2 Plugin C<write_tsdb>
@@@ -9140,8 -9093,6 +9140,8 @@@ Available options
  
  =item B<TypeInstance> I<Regex>
  
 +=item B<MetaData> I<String> I<Regex>
 +
  Match values where the given regular expressions match the various fields of
  the identifier of a value. If multiple regular expressions are given, B<all>
  regexen must match for a value to match.
@@@ -9430,10 -9381,6 +9430,10 @@@ Available options
  
  =item B<TypeInstance> I<Regex> I<Replacement>
  
 +=item B<MetaData> I<String> I<Regex> I<Replacement>
 +
 +=item B<DeleteMetaData> I<String> I<Regex>
 +
  Match the appropriate field with the given regular expression I<Regex>. If the
  regular expression matches, that part that matches is replaced with
  I<Replacement>. If multiple places of the input buffer match a given regular
@@@ -9472,37 -9419,9 +9472,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