feat(output plugin): Add new output plugin to support Apache IoTDB

docs/LICENSE_OF_DEPENDENCIES.md

@@ -36,6 +36,7 @@ following works:
 - github.com/antchfx/xmlquery [MIT License](https://github.com/antchfx/xmlquery/blob/master/LICENSE)
 - github.com/antchfx/xpath [MIT License](https://github.com/antchfx/xpath/blob/master/LICENSE)
 - github.com/apache/arrow/go/arrow [Apache License 2.0](https://github.com/apache/arrow/blob/master/LICENSE.txt)
+- github.com/apache/iotdb-client-go [Apache License 2.0](https://github.com/apache/iotdb-client-go/blob/main/LICENSE)
 - github.com/apache/thrift [Apache License 2.0](https://github.com/apache/thrift/blob/master/LICENSE)
 - github.com/aristanetworks/glog [Apache License 2.0](https://github.com/aristanetworks/glog/blob/master/LICENSE)
 - github.com/aristanetworks/goarista [Apache License 2.0](https://github.com/aristanetworks/goarista/blob/master/COPYING)

go.mod

@@ -20,7 +20,7 @@ require (
 	github.com/Shopify/sarama v1.34.1
 	github.com/aerospike/aerospike-client-go/v5 v5.7.0
 	github.com/alecthomas/units v0.0.0-20210208195552-ff826a37aa15
-	github.com/aliyun/alibaba-cloud-sdk-go v1.61.1529
+	github.com/aliyun/alibaba-cloud-sdk-go v1.61.1695
 	github.com/amir/raidman v0.0.0-20170415203553-1ccc43bfb9c9
 	github.com/antchfx/jsonquery v1.1.5
 	github.com/antchfx/xmlquery v1.3.9
@@ -134,7 +134,7 @@ require (
 	github.com/sirupsen/logrus v1.8.1
 	github.com/sleepinggenius2/gosmi v0.4.4
 	github.com/snowflakedb/gosnowflake v1.6.2
-	github.com/stretchr/testify v1.7.4
+	github.com/stretchr/testify v1.8.0
 	github.com/tbrandon/mbserver v0.0.0-20170611213546-993e1772cc62
 	github.com/testcontainers/testcontainers-go v0.12.0
 	github.com/tidwall/gjson v1.14.1
@@ -202,6 +202,7 @@ require (
 	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
 	github.com/alecthomas/participle v0.4.1 // indirect
 	github.com/apache/arrow/go/arrow v0.0.0-20211006091945-a69884db78f4 // indirect
+	github.com/apache/iotdb-client-go v0.12.2-0.20220722111104-cd17da295b46
 	github.com/aristanetworks/glog v0.0.0-20191112221043-67e8567f59f3 // indirect
 	github.com/armon/go-metrics v0.3.3 // indirect
 	github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.4.2 // indirect

go.sum

@@ -275,8 +275,8 @@ github.com/alexflint/go-filemutex v0.0.0-20171022225611-72bdc8eae2ae/go.mod h1:C
 github.com/alexkohler/prealloc v1.0.0/go.mod h1:VetnK3dIgFBBKmg0YnD9F9x6Icjd+9cvfHR56wJVlKE=
 github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a/go.mod h1:SGnFV6hVsYE877CKEZ6tDNTjaSXYUk6QqoIK6PrAtcc=
 github.com/alicebob/miniredis v2.5.0+incompatible/go.mod h1:8HZjEj4yU0dwhYHky+DxYx+6BMjkBbe5ONFIF1MXffk=
-github.com/aliyun/alibaba-cloud-sdk-go v1.61.1529 h1:qAt5MZ3Ukwx/JMAiaagQhNQMBZLcmJbnweBoK3EeHxI=
-github.com/aliyun/alibaba-cloud-sdk-go v1.61.1529/go.mod h1:RcDobYh8k5VP6TNybz9m++gL3ijVI5wueVr0EM10VsU=
+github.com/aliyun/alibaba-cloud-sdk-go v1.61.1695 h1:ISpCPksXFyDOLO/8OQAdO6pKkC31NKldG6q+lPxM/ao=
+github.com/aliyun/alibaba-cloud-sdk-go v1.61.1695/go.mod h1:RcDobYh8k5VP6TNybz9m++gL3ijVI5wueVr0EM10VsU=
 github.com/amir/raidman v0.0.0-20170415203553-1ccc43bfb9c9 h1:FXrPTd8Rdlc94dKccl7KPmdmIbVh/OjelJ8/vgMRzcQ=
 github.com/amir/raidman v0.0.0-20170415203553-1ccc43bfb9c9/go.mod h1:eliMa/PW+RDr2QLWRmLH1R1ZA4RInpmvOzDDXtaIZkc=
 github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883/go.mod h1:rCTlJbsFo29Kk6CurOXKm700vrz8f0KW0JNfpkRJY/8=
@@ -297,6 +297,8 @@ github.com/apache/arrow/go/arrow v0.0.0-20191024131854-af6fa24be0db/go.mod h1:VT
 github.com/apache/arrow/go/arrow v0.0.0-20210818145353-234c94e4ce64/go.mod h1:2qMFB56yOP3KzkB3PbYZ4AlUFg3a88F67TIx5lB/WwY=
 github.com/apache/arrow/go/arrow v0.0.0-20211006091945-a69884db78f4 h1:nPUln5QTzhftSpmld3xcXw/GOJ3z1E8fR8tUrrc0YWk=
 github.com/apache/arrow/go/arrow v0.0.0-20211006091945-a69884db78f4/go.mod h1:Q7yQnSMnLvcXlZ8RV+jwz/6y1rQTqbX6C82SndT52Zs=
+github.com/apache/iotdb-client-go v0.12.2-0.20220722111104-cd17da295b46 h1:28HyUQcr8ZCyCAatR0gkf9PuLr52U2T+66tx5Th0nxI=
+github.com/apache/iotdb-client-go v0.12.2-0.20220722111104-cd17da295b46/go.mod h1:1z89VPGCUGHGqxkPW8p2Haq6WJwrRBKZN+WOjDBiQQM=
 github.com/apache/thrift v0.12.0/go.mod h1:cp2SuWMxlEZw2r+iP2GNCdIi4C1qmUzdZFSVb+bacwQ=
 github.com/apache/thrift v0.13.0/go.mod h1:cp2SuWMxlEZw2r+iP2GNCdIi4C1qmUzdZFSVb+bacwQ=
 github.com/apache/thrift v0.14.1/go.mod h1:cp2SuWMxlEZw2r+iP2GNCdIi4C1qmUzdZFSVb+bacwQ=
@@ -2234,8 +2236,8 @@ github.com/stretchr/testify v1.6.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.4 h1:wZRexSlwd7ZXfKINDLsO4r7WBt3gTKONc6K/VesHvHM=
-github.com/stretchr/testify v1.7.4/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw=
 github.com/syndtr/gocapability v0.0.0-20170704070218-db04d3cc01c8/go.mod h1:hkRG7XYTFWNJGYcbNJQlaLq0fg1yr4J4t/NcTQtrfww=
 github.com/syndtr/gocapability v0.0.0-20180916011248-d98352740cb2/go.mod h1:hkRG7XYTFWNJGYcbNJQlaLq0fg1yr4J4t/NcTQtrfww=

plugins/outputs/all/all.go

@@ -28,6 +28,7 @@ import (
 	_ "github.com/influxdata/telegraf/plugins/outputs/influxdb"
 	_ "github.com/influxdata/telegraf/plugins/outputs/influxdb_v2"
 	_ "github.com/influxdata/telegraf/plugins/outputs/instrumental"
+	_ "github.com/influxdata/telegraf/plugins/outputs/iotdb"
 	_ "github.com/influxdata/telegraf/plugins/outputs/kafka"
 	_ "github.com/influxdata/telegraf/plugins/outputs/kinesis"
 	_ "github.com/influxdata/telegraf/plugins/outputs/librato"

plugins/outputs/iotdb/README.md

@@ -0,0 +1,146 @@
+# IoTDB Output Plugin
+
+We provide readme and sample configuration file in different languages.
+Please Choose a friendly one here:
+[English](./README.md) | [中文](./README_ZH.md)
+
+The IoTDB output plugin saves Telegraf metric data to an IoTDB backend.
+This plugin uses Apache IoTDB client for Golang to support session connection
+and data insertion. For metrics sampled, this pulgin converts them into records
+and inserts them into databases.
+
+## Apache IoTDB
+
+Apache IoTDB (Database for Internet of Things) is an IoT native database with
+high performance for data management and analysis, deployable on the edge and
+the cloud. Due to its light-weight architecture, high performance and rich
+feature set together with its deep integration with Apache Hadoop, Spark and
+Flink, Apache IoTDB can meet the requirements of massive data storage,
+high-speed data ingestion and complex data analysis in the IoT industrial
+fields.
+
+Apache IoTDB website: <https://iotdb.apache.org>
+Apache IoTDB Github: <https://github.com/apache/iotdb>
+
+## Apache IoTDB Client for Golang
+
+There is an Apache IoTDB Client for Golang, using native Golang API to
+inserting, deleting, modifying records.
+
+Apache IoTDB Golang Client Github: <https://github.com/apache/iotdb>
+
+## Getting started
+
+Before using this plugin, please configure the IP address, port number,
+user name, password and other information of the database server,
+as well as some data type conversion, time unit and other configurations.
+
+There is a sample configuration: [English Configuration](./sample.conf).
+And there is one in Chinese:  [中文配置样例](./sample_zh.conf).
+The configuration is also provided at the end of this readme.
+
+## Please pay attention to these points
+
+1. IoTDB (version 0.13.x or older) **DO NOT support unsigned integer**.
+There are three available options of converting uint64, which are specified by
+parameter `convertUint64To`.
+
+   - `ToInt64`, default option. If an unsigned integer is greater than
+   `math.MaxInt64`, save it as `int64`; else save `math.MaxInt64`
+   (9223372036854775807).
+   - `ForceToInt64`, force converting an unsigned integer to a`int64`,no mater
+   what the value it is. This option may lead to exception if the value is
+   greater than `int64`.
+   - `Text`force converting an unsigned integer to a string, no mater what the
+   value it is.
+
+2. IoTDB supports a variety of time precision, but no matter what precision,
+timestamp is stored in `Int64`, so users need to specify the unit of timestamp.
+Default unit is `nanosecond`.
+
+3. Till now, IoTDB can not support Tag indexing well. To see current process
+method, please refer to [InfluxDB-Protocol Adapter](
+   https://iotdb.apache.org/UserGuide/Master/API/InfluxDB-Protocol.html).
+There are two available options of converting tags, which are specified by
+parameter `treateTagsAs`:
+
+   - `Measurements`. Treat Tags as measurements. For each Key:Value in Tag,
+   convert them into Measurement, Value, DataType, which are supported in IoTDB.
+   - `DeviceID_subtree`, default option. Treat Tags as part of device id. Tags
+   is subtree of 'Name'.
+
+   For example, there is a metric:
+
+   `Name="root.sg.device", Tags={tag1="private", tag2="working"}, Fields={s1=100, s2="hello"}`
+
+   - `Measurements`, result: `root.sg.device, s1=100, s2="hello", tag1="private", tag2="working"`
+   - `DeviceID_subtree`, result: `root.sg.device.private.working, s1=100, s2="hello"`
+
+## Testing
+
+**Please prepare running database before testing**.
+Target address is`localhost:6667` by default, which can be edit in
+`iotdb_test.go`. `test_host` is the target ip address of database server.
+
+Testing contains: network connection, error correction, datatype conversion,
+data writing.
+
+## Configuration
+
+```toml @sample.conf
+# Save metrics to an IoTDB Database
+[[outputs.iotdb]]
+  ## Configuration of IoTDB server
+  ## host is the IP address of the IoTDB server
+  ## port is a string descirbing the port of the IoTDB service, default port is 6667
+  host = "127.0.0.1"
+  port = "6667"
+
+  ## Configuration of authentication
+  ## The defualt user is 'root', and the defualt password is also 'root'
+  user = "root"
+  password = "root"
+
+  ## Configuration of session
+  ## - timeout is in milliseconds(ms). This is the timeout for calling 'Session.Open'
+  ##   The value type of 'timeout' should be int. 0 means no timeout. 
+  ##   Negative values will be treated as 0.
+  timeout = 5000
+
+  ## Configuration of type conversion for 64-bits unsigned int
+  ## IoTDB DO NOT support unsigned int (version 13.x). 
+  ## For uint32, this plugin will convert it into int64.
+  ## But if the specific type of an unsigned int is uint64, overflow may take place. 
+  ## So user should choose an available option of converting uint64 below.
+  ## 
+  ## This plugin supports 3 different available conversions of UInt64: 
+  ## - "ForceToInt64": no mater what the value it is, force covert it into int64.
+  ## - "ToInt64"(default): if an unsigned int is less than MAXINT64, covert it into int64; 
+  ##                       else save MAXINT64 instaed. math.MaxInt64 = 9223372036854775807
+  ## - "Text": no matter what value it is, convert it into a string, which is called TEXT in IoTDB.
+  convertUint64To = "ToInt64"
+
+  ## Configuration of TimeStamp
+  ## TimeStamp is always saved in 64bits int. timeStampUnit specifies the unit of timestamp. 
+  ## Available value:
+  ## "second", "millisecond", "microsecond", "nanosecond"(defualt)
+  timeStampUnit = "nanosecond"
+
+  ## Configuration of dealing with Tags
+  ## Tag is not fully supported by IoTDB, but an instead method is provided here:
+  ##     https://iotdb.apache.org/zh/UserGuide/Master/API/InfluxDB-Protocol.html
+  ## 
+  ## This pugin provide two available methods to deal with Tags:
+  ## - "Measurements": Treat Tags as measurements. For each Key:Value in Tag, convert them 
+  ##                            into Measurement, Value, DataType, which are supported in IoTDB.
+  ## - "DeviceID_subtree"(default): Treat Tags as part of device id. Tags is subtree of 'Name'.
+  ##
+  ## For Example, a metric:
+  ##      Name="root.sg.device", Tags={tag1="private", tag2="working"}, Fields={s1=100, s2="hello"}
+  ## - Records in "Measurements" method:
+  ##      root.sg.device, s1=100, s2="hello", tag1="private", tag2="working"
+  ## - Records in "DeviceID_subtree" method:
+  ##      root.sg.device.private.working, s1=100, s2="hello"
+  treateTagsAs = "DeviceID_subtree"
+
+```