Configuration Reference for InfluxDB Source Connector for Confluent Platform¶

To use this connector, specify the name of the connector class in the connector.class configuration property.

connector.class=io.confluent.influxdb.source.InfluxdbSourceConnector

Connector-specific configuration properties are described below.

Note

These are properties for the self-managed connector. If you are using Confluent Cloud, see InfluxDB Source Connector for Confluent Cloud.

InfluxDB¶

influxdb.url

Fully qualified InfluxDB API URL used for establishing connection.

Type: string
Valid Values: Fully qualified HTTP URL
Importance: high

influxdb.username

InfluxDB username on whose behalf database connection has to be established.

Type: string
Default: null
Importance: medium

influxdb.password

The InfluxDB user’s password used for establishing database connection.

Type: password
Default: [hidden]
Importance: medium

topic.prefix

Prefix that should be prepended to measurement names to determine the name of the Apache Kafka® topic to publish data to, in case of custom query, it should be the full name of the Kafka topic.

Type: string
Default: “”
Importance: low

topic.mapper

Configuration to decide how to map topics. Supported options are :

db: Topic name is Topic Prefix + Database name. All of the records from the same database go into the same topic.
measurement or series: Topic name is Topic Prefix + Measurement name. All of the records from the same measurement go into the same topic.

Type: string
Default: db
Valid Values: [db, measurement, series]
Importance: low

influxdb.db

The InfluxDB database name from which records have to be read and publish data to configured Kafka topic.

Type: string
Importance: high

Mode¶

mode

The mode in which measurements in InfluxDB has to be polled. Supported modes are :

bulk: performs a bulk load of the entire measurement to desired Kafka topic, each time it is polled.
timestamp: uses the timestamp to detect newly created rows and writes them to the desired Kafka topic.

Type: string
Default: timestamp
Valid Values: [timestamp, bulk]
Importance: medium

Query¶

query

If specified, this query is executed and resulting records are pushed to the desired Kafka topic. Use this setting if you need to select a subset of fields or tags, perform aggregations, or filter data.

In case of mode=bulk, the connector will run the query as-is each time it polls.

If you use mode=timestamp, the connector will use appropriate timestamp value from the offsets if it exists to fetch new records each time it polls. If there are no offsets, the connector starts fetching data from the timestamp 1970-01-01T00:00:00.000Z.

Type: string
Default: null
Importance: low

batch.size

Maximum number of points to include in a single batch when polling for new data. This setting can be used to limit the amount of data buffered internally in the connector.

Type: int
Default: 5000
Importance: low

timestamp.delay.interval.ms

After a row with a certain timestamp appears, this is the amount of time the connector waits to include it in the result. You can add a delay to allow transactions with an earlier timestamp to complete. The first execution fetches all available records (starting at timestamp 0) until the current time minus the delay. Each subsequent execution retrieves data from the last time you fetched until the current time minus the delay.

Type: long
Default: 0
Importance: high

Retries¶

max.retries

The maximum number of times to retry on errors before failing the task.

Type: int
Default: 10
Valid Values: [0,…]
Importance: medium

retry.backoff.ms

Backoff time duration to wait before retrying (in milliseconds).

Type: int
Default: 1000
Valid Values: [0,…]
Importance: medium

WhiteList and BlackList¶

influxdb.measurement.whitelist

Comma-separated list of measurements to include in copying. If specified, influxdb.measurement.blacklist` cannot be set. If left empty, all measurements will be included.

Type: string
Default: “”
Importance: medium

influxdb.measurement.blacklist

Comma-separated list of measurements to exclude from copying. If specified, influxdb.measurement.whitelist cannot be set.

Type: string
Default: “”
Importance: medium

Auto topic creation¶

For more information about Auto topic creation, see Configuring Auto Topic Creation for Source Connectors.

Configuration properties accept regular expressions (regex) that are defined as Java regex.

topic.creation.groups

A list of group aliases that are used to define per-group topic configurations for matching topics. A default group always exists and matches all topics.

Type: List of String types
Default: empty
Possible Values: The values of this property refer to any additional groups. A default group is always defined for topic configurations.

topic.creation.$alias.replication.factor

The replication factor for new topics created by the connector. This value must not be larger than the number of brokers in the Kafka cluster. If this value is larger than the number of Kafka brokers, an error occurs when the connector attempts to create a topic. This is a required property for the default group. This property is optional for any other group defined in topic.creation.groups. Other groups use the Kafka broker default value.

Type: int
Default: n/a
Possible Values: >= 1 for a specific valid value or -1 to use the Kafka broker’s default value.

topic.creation.$alias.partitions

The number of topic partitions created by this connector. This is a required property for the default group. This property is optional for any other group defined in topic.creation.groups. Other groups use the Kafka broker default value.

Type: int
Default: n/a
Possible Values: >= 1 for a specific valid value or -1 to use the Kafka broker’s default value.

topic.creation.$alias.include

A list of strings that represent regular expressions that match topic names. This list is used to include topics with matching values, and apply this group’s specific configuration to the matching topics. $alias applies to any group defined in topic.creation.groups. This property does not apply to the default group.

Type: List of String types
Default: empty
Possible Values: Comma-separated list of exact topic names or regular expressions.

topic.creation.$alias.exclude

A list of strings representing regular expressions that match topic names. This list is used to exclude topics with matching values from getting the group’s specfic configuration. $alias applies to any group defined in topic.creation.groups. This property does not apply to the default group. Note that exclusion rules override any inclusion rules for topics.

Type: List of String types
Default: empty
Possible Values: Comma-separated list of exact topic names or regular expressions.

topic.creation.$alias.${kafkaTopicSpecificConfigName}

Any of the Changing Broker Configurations Dynamically for the version of the Kafka broker where the records will be written. The broker’s topic-level configuration value is used if the configuration is not specified for the rule. $alias applies to the default group as well as any group defined in topic.creation.groups.

Type: property values
Default: Kafka broker value

Confluent Platform license¶

confluent.topic.bootstrap.servers

A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the form <code>host1:port1,host2:port2,…</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).

Type: list
Importance: high

confluent.topic

Name of the Kafka topic used for Confluent Platform configuration, including licensing information.

Type: string
Default: _confluent-command
Importance: low

confluent.topic.replication.factor

The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).

Type: int
Default: 3
Importance: low

Confluent license properties¶

You can put license-related properties in the connector configuration, or starting with Confluent Platform version 6.0, you can put license-related properties in the Connect worker configuration instead of in each connector configuration.

This connector is proprietary and requires a license. The license information is stored in the _confluent-command topic. If the broker requires SSL for connections, you must include the security-related confluent.topic.* properties as described below.

confluent.license

Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for confluent.license. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.

If you are a subscriber, contact Confluent Support for more information.

Type: string
Default: “”
Valid Values: Confluent Platform license
Importance: high

confluent.topic.ssl.truststore.location

The location of the trust store file.

Type: string
Default: null
Importance: high

confluent.topic.ssl.truststore.password

The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.

Type: password
Default: null
Importance: high

confluent.topic.ssl.keystore.location

The location of the key store file. This is optional for client and can be used for two-way authentication for client.

Type: string
Default: null
Importance: high

confluent.topic.ssl.keystore.password

The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.

Type: password
Default: null
Importance: high

confluent.topic.ssl.key.password

The password of the private key in the key store file. This is optional for client.

Type: password
Default: null
Importance: high

confluent.topic.security.protocol

Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

Type: string
Default: “PLAINTEXT”
Importance: medium

License topic configuration¶

A Confluent enterprise license is stored in the _confluent-command topic. This topic is created by default and contains the license that corresponds to the license key supplied through the confluent.license property. No public keys are stored in Kafka topics.

The following describes how the default _confluent-command topic is generated under different scenarios:

A 30-day trial license is automatically generated for the _confluent command topic if you do not add the confluent.license property or leave this property empty (for example, confluent.license=).
Adding a valid license key (for example, confluent.license=<valid-license-key>) adds a valid license in the _confluent-command topic.

Here is an example of the minimal properties for development and testing.

You can change the name of the _confluent-command topic using the confluent.topic property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server.

confluent.topic=foo_confluent-command
confluent.topic.bootstrap.servers=localhost:9092

The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with confluent.topic..

License topic ACLs¶

The _confluent-command topic contains the license that corresponds to the license key supplied through the confluent.license property. It is created by default. Connectors that access this topic require the following ACLs configured:

CREATE and DESCRIBE on the resource cluster, if the connector needs to create the topic.
DESCRIBE, READ, and WRITE on the _confluent-command topic.

Important

You can also use DESCRIBE and READ without WRITE to restrict access to read-only for license topic ACLs. If a topic exists, the LicenseManager will not try to create the topic.

You can provide access either individually for each principal that will use the license or use a wildcard entry to allow all clients. The following examples show commands that you can use to configure ACLs for the resource cluster and _confluent-command topic.

Set a CREATE and DESCRIBE ACL on the resource cluster:

kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation CREATE --operation DESCRIBE --cluster

Set a DESCRIBE, READ, and WRITE ACL on the _confluent-command topic:

kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command

Override Default Configuration Properties¶

You can override the replication factor using confluent.topic.replication.factor. For example, when using a Kafka cluster as a destination with less than three brokers (for development and testing) you should set the confluent.topic.replication.factor property to 1.

You can override producer-specific properties by using the producer.override.* prefix (for source connectors) and consumer-specific properties by using the consumer.override.* prefix (for sink connectors).

You can use the defaults or customize the other properties as well. For example, the confluent.topic.client.id property defaults to the name of the connector with -licensing suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix.

You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.