Configuration Reference for RabbitMQ 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.connect.rabbitmq.RabbitMQSourceConnector

Connector-specific configuration properties are described below.

Note

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

Connection

rabbitmq.host

The RabbitMQ host to connect to. See ConnectionFactory.setHost(java.lang.String)

Type: string
Default: localhost
Importance: high

rabbitmq.password

The password to authenticate to RabbitMQ with. See ConnectionFactory.setPassword(java.lang.String)

Type: string
Default: guest
Importance: high

rabbitmq.username

The username to authenticate to RabbitMQ with. See ConnectionFactory.setUsername(java.lang.String)

Type: string
Default: guest
Importance: high

rabbitmq.virtual.host

The virtual host to use when connecting to the broker. See ConnectionFactory.setVirtualHost(java.lang.String)

Type: string
Default: /
Importance: high

rabbitmq.port

The RabbitMQ port to connect to. See ConnectionFactory.setPort(int)

Type: int
Default: 5672
Importance: medium

rabbitmq.automatic.recovery.enabled

Enables or disables automatic connection recovery. See ConnectionFactory.setAutomaticRecoveryEnabled(boolean)

Type: boolean
Default: true
Importance: low

rabbitmq.connection.timeout.ms

Connection TCP establishment timeout in milliseconds. zero for infinite. See ConnectionFactory.setConnectionTimeout(int)

Type: int
Default: 60000
Valid Values: [0,…]
Importance: low

rabbitmq.handshake.timeout.ms

The AMQP0-9-1 protocol handshake timeout, in milliseconds. See ConnectionFactory.setHandshakeTimeout(int)

Type: int
Default: 10000
Importance: low

rabbitmq.network.recovery.interval.ms

See ConnectionFactory.setNetworkRecoveryInterval(long)

Type: int
Default: 10000
Importance: low

rabbitmq.requested.channel.max

Initially requested maximum channel number. Zero for unlimited. See ConnectionFactory.setRequestedChannelMax(int)

Type: int
Default: 0
Importance: low

rabbitmq.requested.frame.max

Initially requested maximum frame size, in octets. Zero for unlimited. See ConnectionFactory.setRequestedFrameMax(int)

Type: int
Default: 0
Importance: low

rabbitmq.requested.heartbeat.seconds

Set the requested heartbeat timeout. Heartbeat frames will be sent at about 1/2 the timeout interval. If server heartbeat timeout is configured to a non-zero value, this method can only be used to lower the value; otherwise any value provided by the client will be used. See ConnectionFactory.setRequestedHeartbeat(int)

Type: int
Default: 60
Importance: low

rabbitmq.shutdown.timeout.ms

Set the shutdown timeout. This is the amount of time that Consumer implementations have to continue working through deliveries (and other Consumer callbacks) after the connection has closed but before the ConsumerWorkService is torn down. If consumers exceed this timeout then any remaining queued deliveries (and other Consumer callbacks, including the Consumer’s handleShutdownSignal() invocation) will be lost. See ConnectionFactory.setShutdownTimeout(int)

Type: int
Default: 10000
Importance: low

rabbitmq.topology.recovery.enabled

Enables or disables topology recovery. See ConnectionFactory.setTopologyRecoveryEnabled(boolean)

Type: boolean
Default: true
Importance: low

Security

rabbitmq.security.protocol

The security protocol to use when connecting to RabbitMQ. Values can be PLAINTEXT or SSL. If PLAINTEXT is passed, all configs prefixed by rabbitmq.https. will be ignored.

Type: string
Default: PLAINTEXT
Importance: high

rabbitmq.https.ssl.key.password

The password of the private key in the key store file.

Type: password
Default: null
Importance: high

rabbitmq.https.ssl.keystore.location

The location of the key store file.

Type: string
Default: null
Importance: high

rabbitmq.https.ssl.keystore.password

The password for the key store file.

Type: password
Default: null
Importance: high

rabbitmq.https.ssl.truststore.location

The location of the trust store file.

Type: string
Default: null
Importance: high

rabbitmq.https.ssl.truststore.password

The password for the trust store file.

Type: password
Default: null
Importance: high

rabbitmq.https.ssl.enabled.protocols

The list of protocols enabled for SSL connections.

Type: list
Default: TLSv1.2,TLSv1.1,TLSv1
Importance: medium

rabbitmq.https.ssl.keystore.type

The file format of the key store file.

Type: string
Default: JKS
Importance: medium

rabbitmq.https.ssl.protocol

The SSL protocol used to generate the SSLContext. Default setting is TLS, which is fine for most cases. Allowed values in recent JVMs are TLS, TLSv1.1 and TLSv1.2. SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities.

Type: string
Default: TLS
Importance: medium

rabbitmq.https.ssl.provider

The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.

Type: string
Default: null
Importance: medium

rabbitmq.https.ssl.truststore.type

The file format of the trust store file.

Type: string
Default: JKS
Importance: medium

rabbitmq.https.ssl.cipher.suites

A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default, all the available cipher suites are supported.

Type: list
Default: null
Importance: low

rabbitmq.https.ssl.endpoint.identification.algorithm

The endpoint identification algorithm to validate server hostname using server certificate.

Type: string
Default: https
Importance: low

rabbitmq.https.ssl.keymanager.algorithm

The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine.

Type: string
Default: SunX509
Importance: low

rabbitmq.https.ssl.secure.random.implementation

The SecureRandom PRNG implementation to use for SSL cryptography operations.

Type: string
Default: null
Importance: low

rabbitmq.https.ssl.trustmanager.algorithm

The algorithm used by the trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine.

Type: string
Default: PKIX
Importance: low

Source

kafka.topic

Apache Kafka® topic to write the messages to.

Type: string
Importance: high

rabbitmq.queue

Comma-separated list of one or multiple RabbitMQ queues to read from.

Type: list
Importance: high

backoff.time.ms

The number of milliseconds to wait when no records are returned from the RabbitMQ queue.

Type: int
Default: 100
Valid Values: [1,…]
Importance: medium

batch.size

The maximum number of records to return to Connect for each poll, if there are more than this number of records already available from RabbitMQ. This setting is independent from the general producer setting batch.size

Type: int
Default: 1024
Valid Values: [1,…]
Importance: medium

rabbitmq.prefetch.count

Maximum number of messages that the server will deliver, 0 if unlimited. See Channel.basicQos(int, boolean)

Type: int
Default: 0
Importance: medium

rabbitmq.prefetch.global

True if the settings should be applied to the entire channel rather than each consumer. See Channel.basicQos(int, boolean)

Type: boolean
Default: false
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.