TSDR Boron User Guide check in. 63/41263/6
authoryuling_c <yulingchen54@gmail.com>
Mon, 4 Jul 2016 06:56:25 +0000 (23:56 -0700)
committerColin Dixon <colin@colindixon.com>
Tue, 5 Jul 2016 16:28:48 +0000 (12:28 -0400)
Change-Id: I6164aad0e9c9adcef6deb821b0fa86ee54b7c134
Signed-off-by: yuling_c <yulingchen54@gmail.com>
manuals/user-guide/src/main/asciidoc/tsdr/tsdr-user-guide.adoc

index 34653d8669199674e658dc9a9ffa155fa766a647..1914b0bc60883d2a932d1af0f904fa65c1c25d3e 100644 (file)
@@ -154,6 +154,9 @@ The following is the list of supported TSDR data collectors with the associated
 
   feature:install odl-tsdr-netflow-statistics-collector
 
+* sFlow Data Collector
+  feature:install odl-tsdr-sflow-statistics-colletor
+
 * Syslog Data Collector
 
   feature:install odl-tsdr-syslog-collector
@@ -244,7 +247,7 @@ TSDR provides two REST APIs for querying data stored in TSDR data stores.
 
 The following is an example curl command for querying metric data from TSDR data store:
 
-curl -G -v -H "Accept: application/json" -H "Content-Type: application/json" "http://localhost:8181/tsdr/metrics/query" --data-urlencode "tsdrkey=[NID=][DC=FLOWSTATS][MN=][RK=]" --data-urlencode "from=0" --data-urlencode "until=240000000"|more
+curl -G -v -H "Accept: application/json" -H "Content-Type: application/json" "http://localhost:8181/tsdr/metrics/query" --data-urlencode "tsdrkey=[NID=][DC=FLOWSTATS][MN=][RK=]" --data-urlencode "from=0" --data-urlencode "until=240000000000"|more
 
 * Query of TSDR Log type of data
 ** URL:http://localhost:8181/tsdr/logs/query
@@ -262,7 +265,7 @@ curl -G -v -H "Accept: application/json" -H "Content-Type: application/json" "ht
 
 The following is an example curl command for querying log type of data from TSDR data store:
 
-curl -G -v -H "Accept: application/json" -H "Content-Type: application/json" "http://localhost:8181/tsdr/logs/query" --data-urlencode "tsdrkey=[NID=][DC=NETFLOW][RK=]" --data-urlencode "from=0" --data-urlencode "until=240000000"|more
+curl -G -v -H "Accept: application/json" -H "Content-Type: application/json" "http://localhost:8181/tsdr/logs/query" --data-urlencode "tsdrkey=[NID=][DC=NETFLOW][RK=]" --data-urlencode "from=0" --data-urlencode "until=240000000000"|more
 
 === Grafana integration with TSDR
 
@@ -360,3 +363,32 @@ TSDR gets the data from a variety of sources, which can be secured in different
 
 ** Syslog Security
 *** Syslog, which cannot be configured with security so we recommend making sure it flows only over a secured management network.
+
+=== Support multiple data stores simultaneously at runtime
+
+TSDR supports running multiple data stores simultaneously at runtim. For example, it is possible to configure TSDR to push log type of data into Cassandra data store, while pushing metrics type of data into HBase.
+
+When you install one TSDR data store from karaf console, such as using feature:install odl-tsdr-hsqldb, a properties file will be generated under <Karaf-distribution-directory>/etc/. For example, when you install hsqldb, a file called tsdr-persistence-hsqldb.properties is generated under that directory. 
+
+By default, all the types of data are supported in the data store. For example, the default content of tsdr-persistence-hsqldb.properties is as follows:
+
+ metric-persistency=true
+ log-persistency=true
+ binary-persistency=true
+
+When the user would like to use different data stores to support different types of data, he/she could enable or disable a particular type of data persistence in the data stores by configuring the properties file accordingly.
+
+For example, if the user would like to store the log type of data in HBase, and store the metric and binary type of data in Cassandra, he/she needs to install both hbase and cassandra data stores from Karaf console. Then the user needs to modify the properties file under <Karaf-distribution-directory>/etc as follows:
+
+* tsdr-persistence-hbase.properties
+
+ metric-persistency=false
+ log-persistency=true
+ binary-persistency=true
+
+
+* tsdr-persistence-cassandra.properties
+
+ metric-psersistency=true
+ log-persistency=false
+ binary-persistency=false