From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Tue, 15 Apr 2008 14:57:46 +0000 (+0200)
Subject: collectd.conf(5): Document the `DataSource' option.
X-Git-Tag: collectd-4.4.0~33
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=d07f285d446bdb5abbb6294ef592c890f7515200;p=collectd.git

collectd.conf(5): Document the `DataSource' option.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 40c31581..781e2738 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1361,6 +1361,7 @@ information.
      Instance "eth0"
      <Type "if_octets">
        FailureMax 10000000
+       DataSource "rx"
      </Type>
    </Plugin>
 
@@ -1411,6 +1412,19 @@ infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
 be created. If the value is less than B<WarningMin> but greater than (or equal
 to) B<FailureMin> a B<WARNING> notification will be created.
 
+=item B<DataSource> I<DSName>
+
+Some data sets have more than one "data source". Interesting examples are the
+C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
+the C<disk_ops> data set, which holds C<read> and C<write> operations. The
+system load data set, C<load>, even has three data sources: C<shortterm>,
+C<midterm>, and C<longterm>.
+
+Normally, all data sources are checked against a configured threshold. If this
+is undesirable, or if you want to specify different limits for each data
+source, you can use the B<DataSource> option to have a threshold apply only to
+one data source.
+
 =item B<Invert> B<true>|B<false>
 
 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.