Skip to content

Latest commit

 

History

History
59 lines (49 loc) · 8.35 KB

influx2.md

File metadata and controls

59 lines (49 loc) · 8.35 KB
Raw

InfluxDB Sink

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

Properties

Connection properties:

Property name Optional Description
addr true The addr of the InfluxDB
token false The token of access InfluxDB
org false The InfluxDB organization
bucket false The InfluxDB bucket
certificationPath true The 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.
privateKeyPath true The private key path. It can be either absolute path, or relative path, which is similar to use of certificationPath.
rootCaPath true The location of root ca path. It can be an absolute path, or a relative path, which is similar to use of certificationPath.
tlsMinVersion true Specifies 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.
renegotiationSupport true Determines how and when the client handles server-initiated renegotiation requests. Support never, once or freely options. Default: never.
insecureSkipVerify true If 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 name Optional Description
measurement false The measurement of the InfluxDb (like table name)
tags true The tags to write, the format is like {"tag1":"value1"}. The value can be dataTemplate format, like {"tag1":"{{.temperature}}"}
fields true The 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.
precision true The precision of the timestamp. Support ns, us, ms, s. Default: ms.
tsFieldName true The 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.
useLineProtocol true Use 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": {},
      "influx2":{
        "addr": "http://192.168.100.245:8086",
        "token": "test_token",
        "org": "admin",
        "measurement": "test",
        "bucket": "bucketName",
        "tags": "{\"tag1\":\"value1\"}",
        "fields": ["humidity", "temperature", "pressure"]
      }
    }
  ]
}