MQTT Source Connector for Confluent Cloud¶
Note
If you are installing the connector locally for Confluent Platform, see MQTT Source Connector for Confluent Platform.
The fully-managed Kafka Connect MQTT Source connector attaches to an MQTT broker, subscribes to specified topics, and streams data from these topics into Apache Kafka®.
Features¶
The MQTT Source connector provides the following features:
- Topics created automatically: The connector can automatically create the Kafka topic.
- Multiple tasks: The connector supports multiple tasks. More tasks may improve performance.
- SSL support: Supports two-way SSL.
For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.
Limitations¶
Be sure to review the following information.
- For connector limitations, see MQTT Source Connector limitations.
- If you plan to use one or more Single Message Transforms (SMTs), see SMT Limitations.
- If you plan to use Confluent Cloud Schema Registry, see Environment Limitations.
Quick Start¶
Use this quick start to get up and running with the Confluent Cloud MQTT source connector. The quick start shows how to attach the connector to an MQTT broker, subscribe to the specified topics, and stream data into Apache Kafka®.
- Prerequisites
- Authorized access to a Confluent Cloud cluster on Amazon Web Services (AWS), Microsoft Azure (Azure), or Google Cloud Platform (GCP).
- Access to an MQTT broker.
- The Confluent CLI installed and configured for the cluster. See Install the Confluent CLI.
- The connector automatically creates Kafka topics. You can manually create topic
- Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). See Environment Limitations for additional information.
- For networking considerations, see Networking and DNS Considerations. To use static egress IPs, see Static Egress IP Addresses.
- Kafka cluster credentials. The following lists the different ways you can provide credentials.
- Enter an existing service account resource ID.
- Create a Confluent Cloud service account for the connector. Make sure to review the ACL entries required in the service account documentation. Some connectors have specific ACL requirements.
- Create a Confluent Cloud API key and secret. To create a key and secret, you can use confluent api-key create or you can autogenerate the API key and secret directly in the Cloud Console when setting up the connector.
Using the Confluent Cloud Console¶
Step 1: Launch your Confluent Cloud cluster.¶
See the Quick Start for Apache Kafka using Confluent Cloud for installation instructions.
Step 2: Add a connector.¶
In the left navigation menu, click Data integration, and then click Connectors. If you already have connectors in your cluster, click + Add connector.
Step 4: Set up the connection.¶
Complete the following and click Continue.
Note
- Make sure you have all your prerequisites completed.
- An asterisk ( * ) designates a required entry.
- Enter a connector name.
- Select the way you want to provide Kafka Cluster credentials. You can either select a service account resource ID or you can enter an API key and secret (or generate these in the Cloud Console).
- Enter the Kafka topic name (or topic names) where you want data sent.
- Add the MQTT broker connection details.
- Add the list of server URIs: The MQTT broker URI. Must be in the format
<PROTOCOL>//:URI
. The supported protocols are TCP, SSL, WS, and WSS. For TLS connections you must additionally provide credentials and upload Keystore and Truststore files. - If the MQTT broker does not support anonymous mode, you must enter a username and password that the connector uses to attach to the broker.
- Add the list of server URIs: The MQTT broker URI. Must be in the format
- For secure connections, add the required Keystore and Truststore files and passwords. For Keystores, you must also add the password for the stored client certificate.
- Add the session connection details:
- Clean Session?: Sets whether the client and server should remember their state after restarts and reconnects. For unreceived messages to be received when the client and server reconnecting, the MQTT Quality of Service (QOS) property must be set to at least
1
or2
. For more information, see Quality of Service in this man page. - Connection Timeout: The amount of time to wait in seconds when connecting to the MQTT broker. The default is 30 seconds.
- Connection Keepalive: Defines the maximum time interval between messages sent or received (in seconds). In the absence of a data-related message during the time period entered, the client sends a very small ping message for the broker to acknowledge. The default value is 60 seconds.
- Max Retry Time: The maximum time in milliseconds (ms) the connector spends backing off and retrying a connection to the MQTT broker. The default value is 30000 ms (30 seconds).
- MQTT Topics: One or more broker topics to subscribe to.
- MQTT QOS: The default value is
0
which means the message gets delivered once, with no confirmation. The QOS property must be set to at least1
or2
for unreceived messages to be received when the client and server reconnect. For more information, see Quality of Service in this man page.
- Clean Session?: Sets whether the client and server should remember their state after restarts and reconnects. For unreceived messages to be received when the client and server reconnecting, the MQTT Quality of Service (QOS) property must be set to at least
- Enter the number of tasks in use by the connector. The connector supports multiple tasks. More tasks may improve performance.
- Transforms and Predicates: See the Single Message Transforms (SMT) documentation for details about adding SMTs. See Unsupported transformations for a list of SMTs that are not supported with this connector.
See Configuration Properties for all property values and definitions.
Step 5: Launch the connector.¶
Verify the connection details by previewing the running configuration. Once you’ve validated that the properties are configured to your satisfaction, click Launch.
Tip
For information about previewing your connector output, see Connector Data Previews.
Step 6: Check the connector status.¶
The status for the connector should go from Provisioning to Running. It may take a few minutes.
Step 7: Check the Kafka topic.¶
After the connector is running, verify that messages are populating your Kafka topic.
For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.
See also
For an example that shows fully-managed Confluent Cloud connectors in action with Confluent Cloud ksqlDB, see the Cloud ETL Demo. This example also shows how to use Confluent CLI to manage your resources in Confluent Cloud.
Using the Confluent CLI¶
Complete the following steps to set up and run the connector using the Confluent CLI.
Note
- Make sure you have all your prerequisites completed.
- The example commands use Confluent CLI version 2. For more information see, Confluent CLI v2.
Step 1: List the available connectors.¶
Enter the following command to list available connectors:
confluent connect plugin list
Step 2: Show the required connector configuration properties.¶
Enter the following command to show the required connector properties:
confluent connect plugin describe <connector-catalog-name>
For example:
confluent connect plugin describe MqttSource
Example output:
Following are the required configs:
connector.class: MqttSource
name
kafka.auth.mode
kafka.api.key
kafka.api.secret
kafka.topic
mqtt.server.uri
mqtt.topics
tasks.max
Step 3: Create the connector configuration file.¶
Create a JSON file that contains the connector configuration properties. The following example shows the required connector properties.
{
"connector.class": "MqttSource",
"name": "MqttSource_0",
"kafka.auth.mode": "KAFKA_API_KEY",
"kafka.api.key": "<my-kafka-api-key>",
"kafka.api.secret": "<my-kafka-api-secret>",
"kafka.topic" : "data_topic_0",
"mqtt.server.uri" : "tcp://192.0.0.1:1881",
"mqtt.topics" : "broker_topic_0",
"tasks.max" : "1"
}
Note the following property definitions:
"name"
: Sets a name for your new connector."connector.class"
: Identifies the connector plugin name.
"kafka.auth.mode"
: Identifies the connector authentication mode you want to use. There are two options:SERVICE_ACCOUNT
orKAFKA_API_KEY
(the default). To use an API key and secret, specify the configuration propertieskafka.api.key
andkafka.api.secret
, as shown in the example configuration (above). To use a service account, specify the Resource ID in the propertykafka.service.account.id=<service-account-resource-ID>
. To list the available service account resource IDs, use the following command:confluent iam service-account list
For example:
confluent iam service-account list Id | Resource ID | Name | Description +---------+-------------+-------------------+------------------- 123456 | sa-l1r23m | sa-1 | Service account 1 789101 | sa-l4d56p | sa-2 | Service account 2
"kafka.topic"
: The Kafka topic name (or comma-separated topic names) where you want data sent. If not used, the default topic name created ismqtt
."mqtt.server.uri"
: The MQTT broker URI. Must be in the format<PROTOCOL>//:URI
. The supported protocols are TCP, SSL, WS, and WSS. For TLS connections you must additionally provide credentials and upload Keystore and Truststore files. See the MQTT Source configuration properties for these property values and definitions.Note
If the MQTT broker does not support anonymous mode, you must add the following two additional properties:
"mqtt.username"
:"<mqtt_broker_username>"
"mqtt.password"
:"<user_password>"
"mqtt.topics"
: The broker topic (or comma-separated broker topics) to subscribe to."tasks.max"
: Enter the number of tasks in use by the connector. The connector supports multiple tasks. More tasks may improve performance.
Single Message Transforms: See the Single Message Transforms (SMT) documentation for details about adding SMTs. See Unsupported transformations for a list of SMTs that are not supported with this connector.
See Configuration Properties for all property values and definitions.
Step 4: Load the properties file and create the connector.¶
Enter the following command to load the configuration and start the connector:
confluent connect create --config <file-name>.json
For example:
confluent connect create --config mqtt-source.json
Example output:
Created connector MqttSource_0 lcc-ix4dl
Step 5: Check the connector status.¶
Enter the following command to check the connector status:
confluent connect plugin list
Example output:
ID | Name | Status | Type
+-----------+-----------------+---------+-------+
lcc-ix4dl | MqttSource_0 | RUNNING | source
Step 6: Check the results on the broker.¶
After the connector is running, verify that messages are populating your Kafka topic.
For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.
Configuration Properties¶
Use the following configuration properties with this connector.
How should we connect to your data?¶
name
Sets a name for your connector.
- Type: string
- Valid Values: A string at most 64 characters long
- Importance: high
Kafka Cluster credentials¶
kafka.auth.mode
Kafka Authentication mode. It can be one of KAFKA_API_KEY or SERVICE_ACCOUNT. It defaults to KAFKA_API_KEY mode.
- Type: string
- Default: KAFKA_API_KEY
- Valid Values: KAFKA_API_KEY, SERVICE_ACCOUNT
- Importance: high
kafka.api.key
- Type: password
- Importance: high
kafka.service.account.id
The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.
- Type: string
- Importance: high
kafka.api.secret
- Type: password
- Importance: high
Which topic do you want to send data to?¶
kafka.topic
Identifies the topic name to write the data to.
- Type: string
- Importance: high
How should we connect to MQTT Broker?¶
mqtt.server.uri
The URI of the MQTT broker. This must be given in the format <PROTOCOL>//:URI. The supported protocols are tcp, ssl, ws, wss. Note that for a connection that uses TLS, you must provide the required key stores and trust stores.
- Type: list
- Importance: high
mqtt.username
Username to connect with, or blank if a username is not required.
- Type: string
- Importance: high
mqtt.password
Password to connect with, or blank if a password is not required.
- Type: password
- Default: [hidden]
- Importance: high
MQTT secure connection¶
mqtt.ssl.key.store.file
The location of the Java KeyStore file containing the private key to use for authenticating with the server.
- Type: password
- Default: [hidden]
- Importance: low
mqtt.ssl.key.store.password
Password used to open the Java KeyStore file.
- Type: password
- Default: [hidden]
- Importance: medium
mqtt.ssl.key.password
Password for the client certificate contained in the Java KeyStore.
- Type: password
- Default: [hidden]
- Importance: high
mqtt.ssl.trust.store.file
The location of the Java TrustStore file containing the certificates required to validate the SSL connection to the server.
- Type: password
- Default: [hidden]
- Importance: medium
mqtt.ssl.trust.store.password
Password used to open the Java TrustStore file.
- Type: password
- Default: [hidden]
- Importance: medium
Connection Details¶
mqtt.clean.session.enabled
Sets whether the client and server should remember state across restarts and reconnects. Note that for unreceived messages to be received after reconnect you should set the QOS to 1 or above.
- Type: boolean
- Default: false
- Importance: medium
mqtt.connect.timeout.seconds
Sets the connection timeout value in seconds.
- Type: int
- Default: 30
- Importance: medium
mqtt.keepalive.interval.seconds
This value, measured in seconds, defines the maximum time interval between messages sent or received. In the absence of a data-related message during the time period, the client sends a very small “ping” message, which the server will acknowledge.
- Type: int
- Default: 60
- Importance: medium
max.retry.time.ms
The maximum time in milliseconds (ms) the connector will spend backing off and retrying failed operations (connecting to the MQTT broker and publishing records).
- Type: int
- Default: 30000 (30 seconds)
- Importance: medium
mqtt.topics
The MQTT topics to subscribe to.
- Type: list
- Importance: high
mqtt.qos
The MQTT QOS level to subscribe to. Valid values are 0, 1 and 2.
- Type: int
- Default: 0
- Importance: low
Number of tasks for this connector¶
tasks.max
- Type: int
- Valid Values: [1,…]
- Importance: high
Next Steps¶
See also
For an example that shows fully-managed Confluent Cloud connectors in action with Confluent Cloud ksqlDB, see the Cloud ETL Demo. This example also shows how to use Confluent CLI to manage your resources in Confluent Cloud.