You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by GitBox <gi...@apache.org> on 2022/10/31 09:34:03 UTC

[GitHub] [incubator-seatunnel] EricJoy2048 commented on a diff in pull request #3174: [Feature][Connector-V2] influxdb sink connector

EricJoy2048 commented on code in PR #3174:
URL: https://github.com/apache/incubator-seatunnel/pull/3174#discussion_r1009206447


##########
docs/en/connector-v2/sink/InfluxDB.md:
##########
@@ -0,0 +1,98 @@
+# InfluxDB
+
+> InfluxDB sink connector
+
+## Description
+
+Write data to InfluxDB.
+
+## Key features
+
+- [ ] [exactly-once](../../concept/connector-v2-features.md)
+- [ ] [schema projection](../../concept/connector-v2-features.md)
+
+## Options
+
+| name                        | type     | required | default value                 |
+|-----------------------------|----------|----------|-------------------------------|
+| url                         | string   | yes      | -                             |
+| database                    | string   | yes      |                               |
+| measurement                 | string   | yes      |                               |
+| username                    | string   | no       | -                             |
+| password                    | string   | no       | -                             |
+| key_time                    | string   | yes      | processing time               |
+| key_tags                    | array    | no       | exclude `field` & `key_time`  |
+| batch_size                  | int      | no       | 1024                          |
+| batch_interval_ms           | int      | no       | -                             |
+| max_retries                 | int      | no       | -                             |
+| retry_backoff_multiplier_ms | int      | no       | -                             |
+| connect_timeout_ms          | long     | no       | 15000                         |
+
+### url
+the url to connect to influxDB e.g.
+``` 
+http://influxdb-host:8086
+```
+
+### database [string]
+
+The name of `influxDB` database
+
+### measurement [string]
+
+The name of `influxDB` measurement
+
+### username [string]
+
+`influxDB` user username
+
+### password [string]
+
+`influxDB` user password
+
+### key_time [string]
+
+Specify field-name of the `influxDB` measurement timestamp in SeaTunnelRow. If not specified, use processing-time as timestamp
+
+### key_tags [array]
+
+Specify field-name of the `influxDB` measurement tags in SeaTunnelRow.
+If not specified, include all fields with `influxDB` measurement field
+
+### batch_size [int]
+
+For batch writing, when the number of buffers reaches the number of `batch_size` or the time reaches `batch_interval_ms`, the data will be flushed into the influxDB
+
+### batch_interval_ms [int]
+
+For batch writing, when the number of buffers reaches the number of `batch_size` or the time reaches `batch_interval_ms`, the data will be flushed into the influxDB
+
+### max_retries [int]
+
+The number of retries to flush failed
+
+### retry_backoff_multiplier_ms [int]
+
+Using as a multiplier for generating the next delay for backoff
+
+### max_retry_backoff_ms [int]
+
+The amount of time to wait before attempting to retry a request to `influxDB`
+
+### connect_timeout_ms [long]
+the timeout for connecting to InfluxDB, in milliseconds 
+
+## Examples
+```hocon
+sink {
+    InfluxDB {
+        url = "http://influxdb-host:8086"
+        database = "test"
+        measurement = "sink"
+        key_time = "time"
+        key_tags = ["label"]
+        batch_size = 1
+    }
+}
+
+```

Review Comment:
   Please add `changed log` reference https://github.com/apache/incubator-seatunnel/blob/dev/docs/en/connector-v2/source/SftpFile.md



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org