From ccfed46ff2b8b8857a328e134bed369772a46d6d Mon Sep 17 00:00:00 2001
From: Kevin Bowling <kevin.bowling@kev009.com>
Date: Wed, 13 Aug 2014 01:25:57 -0700
Subject: [PATCH] [METRICS-383] Add documentation for write_tsdb

---
 README                |  4 ++++
 src/collectd.conf.in  |  2 ++
 src/collectd.conf.pod | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 59 insertions(+)

diff --git a/README b/README
index 60de1edd..cd581425 100644
--- a/README
+++ b/README
@@ -411,6 +411,10 @@ Features
       can be configured to avoid logging send errors (especially useful when
       using UDP).
 
+    - write_tsdb
+      Sends data OpenTSDB, a scalable no master, no shared state time series
+      database.
+
     - write_http
       Sends the values collected by collectd to a web-server using HTTP POST
       requests. The transmitted data is either in a form understood by the
diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 00d44497..18a74c65 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -1249,6 +1249,8 @@
 #		Host "localhost"
 #		Port "4242"
 #		HostTags "status=production"
+#		StoreRates false
+#		AlwaysAppendDS false
 #	</Node>
 #</Plugin>
 
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 3acf0f89..acd0cbbe 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -6518,6 +6518,59 @@ more than one DS.
 
 =back
 
+=head2 Plugin C<write_tsdb>
+
+The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
+time series database. The plugin connects to a I<TSD>, a masterless, no shared
+state daemon that ingests metrics and stores them in HBase. The plugin uses
+I<TCP> over the "line based" protocol with a default port 4242. The data will
+be sent in blocks of at most 1428 bytes to minimize the number of network
+packets.
+
+Synopsis:
+
+ <Plugin write_tsdb>
+   <Node "example">
+     Host "tsd-1.my.domain"
+     Port "4242"
+     HostTags "status=production"
+   </Node>
+ </Plugin>
+
+The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
+blocks. Inside the B<Node> blocks, the following options are recognized:
+
+=over 4
+
+=item B<Host> I<Address>
+
+Hostname or address to connect to. Defaults to C<localhost>.
+
+=item B<Port> I<Service>
+
+Service name or port number to connect to. Defaults to C<4242>.
+
+
+=item B<HostTags> I<String>
+
+When set, I<HostTags> is added to the end of the metric. It is intended to be
+used for name=value pairs that the TSD will tag the metric with. Dots and
+whitespace are I<not> escaped in this string.
+
+=item B<StoreRates> B<false>|B<true>
+
+If set to B<true>, convert counter values to rates. If set to B<false>
+(the default) counter values are stored as is, as an increasing
+integer number.
+
+=item B<AlwaysAppendDS> B<false>|B<true>
+
+If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
+identifier. If set to B<false> (the default), this is only done when there is
+more than one DS.
+
+=back
+
 =head2 Plugin C<write_mongodb>
 
 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
-- 
2.11.0