Skip to content

InfluxDB Sink

The sink will write the result into a InfluxDB V2.X .


Connection properties:

Property nameOptionalDescription
addrtrueThe addr of the InfluxDB
tokenfalseThe token of access InfluxDB
orgfalseThe InfluxDB organization
bucketfalseThe InfluxDB bucket
certificationPathtrueThe certification path. It can be an absolute path, or a relative path. If it is an relative path, then the base path is where you executing the kuiperd command. For example, if you run bin/kuiperd from /var/kuiper, then the base path is /var/kuiper; If you run ./kuiperd from /var/kuiper/bin, then the base path is /var/kuiper/bin.
privateKeyPathtrueThe private key path. It can be either absolute path, or relative path, which is similar to use of certificationPath.
rootCaPathtrueThe location of root ca path. It can be an absolute path, or a relative path, which is similar to use of certificationPath.
tlsMinVersiontrueSpecifies the minimum version of the TLS protocol that will be negotiated with the client. Accept values are tls1.0, tls1.1, tls1.2 and tls1.3. Default: tls1.2.
renegotiationSupporttrueDetermines how and when the client handles server-initiated renegotiation requests. Support never, once or freely options. Default: never.
insecureSkipVerifytrueIf InsecureSkipVerify is true, TLS accepts any certificate presented by the server and any host name in that certificate. In this mode, TLS is susceptible to man-in-the-middle attacks. The default value is false. The configuration item can only be used with TLS connections.

Write options:

Property nameOptionalDescription
measurementfalseThe measurement of the InfluxDb (like table name)
tagstrueThe tags to write, the format is like {"tag1":"value1"}. The value can be dataTemplate format, like {"tag1":"{{.temperature}}"}
fieldstrueThe fields to write, the format is like ["field1", "field2"]. If fields is not set, all fields selected in the SQL will all written to InfluxDB.
precisiontrueThe precision of the timestamp. Support ns, us, ms, s. Default: ms.
tsFieldNametrueThe field name of the timestamp. If set, the written timestamp will use the value of the field. For example, if the data has {"ts": 1888888888} and the tsFieldName is set to ts, then the value 1888888888 will be used when written to InfluxDB. Make sure the value is formatted according to the precision. If not set, the current timestamp will be used.
useLineProtocoltrueUse line protocol format or not. Default is false. If line protocol is set, the dataTemplate must format to the line protocol format.

Other common sink properties including batch settings are supported. Please refer to the sink common properties for more information.

Sample usage

Below is a sample for selecting temperature greater than 50 degree and write into influxDB.

  "id": "influx",
  "sql": "SELECT * from demo_stream where temperature > 50",
  "actions": [
      "log": {},
        "addr": "",
        "token": "test_token",
        "org": "admin",
        "measurement": "test",
        "bucket": "bucketName",
        "tags": "{\"tag1\":\"value1\"}",
        "fields": ["humidity", "temperature", "pressure"]