id: io-influxdb-sink title: InfluxDB sink connector sidebar_label: InfluxDB sink connector

The InfluxDB sink connector pulls messages from Pulsar topics and persists the messages to InfluxDB.

Configuration

The configuration of the InfluxDB sink connector has the following properties.

Property

NameTypeRequiredDefaultDescription
influxdbUrlStringtrue" " (empty string)The URL of the InfluxDB instance.
usernameStringfalse" " (empty string)The username used to authenticate to InfluxDB.
passwordStringfalse" " (empty string)The password used to authenticate to InfluxDB.
databaseStringtrue" " (empty string)The InfluxDB to which write messages.
consistencyLevelStringfalseONEThe consistency level for writing data to InfluxDB.

Below are the available options:ALL
ANY
ONE
QUORUM
logLevelStringfalseNONEThe log level for InfluxDB request and response.

Below are the available options:NONE
BASIC
HEADERS
FULL
retentionPolicyStringfalseautogenThe retention policy for InfluxDB.
gzipEnablebooleanfalsefalseWhether to enable gzip or not.
batchTimeMslongfalse1000LThe InfluxDB operation time in milliseconds.
batchSizeintfalse200The batch size of writing to InfluxDB.

Example

Before using the InfluxDB sink connector, you need to create a configuration file through one of the following methods.

  • JSON

    {
        "influxdbUrl": "http://localhost:8086",
        "database": "test_db",
        "consistencyLevel": "ONE",
        "logLevel": "NONE",
        "retentionPolicy": "autogen",
        "gzipEnable": false,
        "batchTimeMs": 1000,
        "batchSize": 100
    }
    
  • YAML

    {
        influxdbUrl: "http://localhost:8086"
        database: "test_db"
        consistencyLevel": "ONE"
        logLevel: "NONE"
        retentionPolicy: "autogen"
        gzipEnable: false
        batchTimeMs: 1000
        batchSize: 100
    }