Github user HeartSaVioR commented on a diff in the pull request:
https://github.com/apache/storm/pull/1484#discussion_r66918897
--- Diff: external/storm-opentsdb/README.md ---
@@ -0,0 +1,73 @@
+# Storm OpenTSDB Bolt and TridentState
+
+OpenTSDB offers a scalable and highly available storage for time series
data. It consists of a
+Time Series Daemon (TSD) servers along with command line utilities. Each
TSD connects to the
+configured HBase cluster to push/query the data.
+
+Time series data point consists of:
+ - a metric name.
+ - a UNIX timestamp (seconds or millisecinds since Epoch).
+ - a value (64 bit integer or single-precision floating point value).
+ - a set of tags (key-value pairs) that describe the time series the point
belongs to.
+
+Storm bolt and trident state creates the above time series data from a
tuple based on the given `TupleMetricPointMapper`
+
+This module provides core Storm and Trident bolt implementations for
writing data to OpenTSDB.
+
+## Examples
+
+### Core Bolt
+Below example describes the usage of core colt viz
`org.apache.stom.opentsdb.bolt.OpenTsdbBolt`
+
+```java
+
+ OpenTsdbClient.Builder builder =
OpenTsdbClient.newBuilder(openTsdbUrl).sync(30_000).returnDetails();
+ final OpenTsdbBolt openTsdbBolt = new OpenTsdbBolt(builder,
Collections.singletonList(TupleOpenTsdbDatapointMapper.DEFAULT_MAPPER));
+ openTsdbBolt.withBatchSize(10).withFlushInterval(2000);
+ topologyBuilder.setBolt("opentsdb",
openTsdbBolt).shuffleGrouping("metric-gen");
+
+```
+
+
+### Trident Bolt
--- End diff --
Bolt -> State
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
