重要
このページの日本語コンテンツは古くなっている可能性があります。最新の英語版コンテンツをご覧になるには、こちらをクリックしてください。
MQTT Source Connector for Confluent Cloud¶
注釈
Confluent Platform 用のコネクターをローカルにインストールする場合は、「MQTT Source Connector for Confluent Platform」を参照してください。
フルマネージド型 Kafka Connect MQTT Source Connector は MQTT ブローカーに接続し、指定されたトピックをサブスクライブして、これらのトピックからデータを Apache Kafka® にストリーミングします。
機能¶
MQTT Source Connector には、以下の機能があります。
- トピックの自動作成: このコネクターでは Kafka トピックを自動的に作成できます。
- 複数のタスク: このコネクターは複数のタスクをサポートしています。タスクが多いほどパフォーマンスが向上する可能性があります。
- SSL のサポート: 双方向 SSL をサポートします。
Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。
制限¶
以下の情報を確認してください。
- コネクターの制限事項については、MQTT Source Connector の制限事項を参照してください。
- 1 つ以上の Single Message Transforms（SMT）を使用する場合は、「SMT の制限」を参照してください。
- Confluent Cloud Schema Registry を使用する場合は、「スキーマレジストリ Enabled Environments」を参照してください。
クイックスタート¶
このクイックスタートを使用して、Confluent Cloud MQTT Source Connector の利用を開始することができます。クイックスタートでは、コネクターを MQTT ブローカーに接続し、指定されたトピックをサブスクライブして、データを Apache Kafka® にストリーミングする方法を示します。
- 前提条件
- アマゾンウェブサービス （ AWS ）、Microsoft Azure （ Azure ）、または Google Cloud Platform （ GCP ）上の Confluent Cloud クラスターへのアクセスを許可されていること。
- MQTT ブローカーへのアクセス。
- Confluent CLI がインストールされ、クラスター用に構成されていること。「Confluent CLI のインストール」を参照してください。
- このコネクターでは Kafka トピックが自動的に作成されます。トピックを手動で作成することもできます。
- スキーマレジストリ ベースのフォーマット（Avro、JSON_SR（JSON スキーマ）、Protobuf など）を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」を参照してください。
- ネットワークに関する考慮事項については、「Networking and DNS Considerations」を参照してください。静的なエグレス IP を使用する方法については、「静的なエグレス IP アドレス」を参照してください。
- Kafka クラスターの認証情報。次のいずれかの方法で認証情報を指定できます。
- 既存の サービスアカウント のリソース ID を入力する。
- コネクター用の Confluent Cloud サービスアカウント を作成する。サービスアカウントのドキュメント で、必要な ACL エントリを確認してください。一部のコネクターには固有の ACL 要件があります。
- Confluent Cloud の API キーとシークレットを作成する。キーとシークレットを作成するには、confluent api-key create を使用するか、コネクターのセットアップ時に Cloud Console で直接 API キーとシークレットを自動生成します。
Confluent Cloud Console の使用¶
ステップ 1: Confluent Cloud クラスターを起動します。¶
インストール手順については、「Quick Start for Confluent Cloud」を参照してください。
ステップ 2: コネクターを追加します。¶
左のナビゲーションメニューの Data integration をクリックし、Connectors をクリックします。クラスター内に既にコネクターがある場合は、+ Add connector をクリックします。
Step 4: Enter the connector details.¶
注釈
- すべての 前提条件 を満たしていることを確認してください。
- アスタリスク（ * ）は必須項目であることを示しています。
At the Add MQTT Source Connector screen, complete the following:
- Select the way you want to provide Kafka Cluster credentials. You can
choose one of the following options:
- Global Access: Allows your connector to access everything you have access to. With global access, connector access will be linked to your account. This option is not recommended for production.
- Granular access: Limits the access for your connector. You will be able to manage connector access through a service account. This option is recommended for production.
- Use an existing API key: Allows you to enter an API key and secret part you have stored. You can enter an API key and secret (or generate these in the Cloud Console).
- Click Continue.
- Enter the MQTT connection details:
- List of Server URIs: 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. - Username: The username the connector will use to connect to the host.
- MQTT Topics: MQTT topics to subscribe to.
- Password: Password to connect with.
- SSL Keystore: The key store containing server certificate.
- Keystore Password: Password used to open the Java KeyStore file.
- Key Password: Password for the client certificate contained in the Java KeyStore.
- SSL Truststore: The trust store containing server CA certificate.
- Truststore Password: Password used to open the Java TrustStore file.
- List of Server URIs: The URI of the MQTT broker. This must be
given in the format
- Click Continue.
Set the following configuration:
- MQTT QOS: The MQTT QOS level to subscribe to. Valid values are 0, 1, and 2.
Show advanced configurations
Clean Session?: Select whether the client and server should remember state across restarts and reconnects.
Connection Timeout: Sets the connection timeout value in seconds.
Connection Keepalive: Defines the maximum time interval in seconds between messages sent or received.
Max Retry Time: The maximum amount of time in milliseconds (ms) the connector will spend backing off and retrying failed operations (connecting to the MQTT broker and publishing records).
Transforms and Predicates: See the Single Message Transforms (SMT) documentation for details.
Click Continue
Based on the number of topic partitions you select, you will be provided with a recommended number of tasks.
- To change the number of tasks, use the Range Slider to select the desired number of tasks.
- Click Continue.
Verify the connection details by previewing the running configuration.
ちなみに
コネクターの出力のプレビューについては、「コネクターのデータプレビュー」を参照してください。
Once you've validated that the properties are configured to your satisfaction, click Launch.
The status for the connector should go from Provisioning to Running.
Step 5: Check the Kafka topic.¶
コネクターが実行中になったら、メッセージが Kafka トピックに取り込まれていることを確認します。
Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。
参考
フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。
Confluent CLI の使用¶
以下の手順に従うと、Confluent CLI を使用してコネクターをセットアップし、実行できます。
注釈
- すべての 前提条件 を満たしていることを確認してください。
- コマンド例では Confluent CLI バージョン 2 を使用しています。詳細については、「Confluent CLI v2 への移行 <https://docs.confluent.io/confluent-cli/current/migrate.html#cli-migrate>`__」を参照してください。
ステップ 2: コネクターの必須の構成プロパティを表示します。¶
以下のコマンドを実行して、コネクターの必須プロパティを表示します。
confluent connect plugin describe <connector-catalog-name>
例:
confluent connect plugin describe MqttSource
出力例:
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
ステップ 3: コネクターの構成ファイルを作成します。¶
コネクター構成プロパティを含む JSON ファイルを作成します。以下の例は、コネクターの必須プロパティを示しています。
{
"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"
}
以下のプロパティ定義に注意してください。
"name": 新しいコネクターの名前を設定します。"connector.class": コネクターのプラグイン名を指定します。
"kafka.auth.mode": 使用するコネクターの認証モードを指定します。オプションはSERVICE_ACCOUNTまたはKAFKA_API_KEY（デフォルト）です。API キーとシークレットを使用するには、構成プロパティkafka.api.keyとkafka.api.secretを構成例（前述）のように指定します。サービスアカウント を使用するには、プロパティkafka.service.account.id=<service-account-resource-ID>に リソース ID を指定します。使用できるサービスアカウントのリソース ID のリストを表示するには、次のコマンドを使用します。confluent iam service-account list
例:
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": データの送信先とする Kafka トピックの名前（複数の場合は、コンマ区切りのトピック名）。指定しなかった場合、デフォルトのトピック名mqttが作成されます。"mqtt.server.uri": MQTT ブローカーの URI。<PROTOCOL>//:URIというフォーマットを使用する必要があります。サポートされるプロトコルは、TCP、SSL、WS、および WSS です。TLS 接続の場合は、認証情報を追加で指定し、キーストアファイルとトラストストアファイルをアップロードする必要があります。これらのプロパティの値と定義については、MQTT Source の構成プロパティ を参照してください。注釈
MQTT ブローカーで匿名モードがサポートされていない場合は、次の 2 つのプロパティを追加する必要があります。
"mqtt.username":"<mqtt_broker_username>""mqtt.password":"<user_password>"
"mqtt.topics": サブスクライブするブローカートピック（または、コンマで区切った複数のブローカートピック）。"tasks.max": このコネクターで使用する タスク の数を入力します。このコネクターは複数のタスクに対応しています。タスクが多いほどパフォーマンスが向上する可能性があります。
Single Message Transforms: SMT 追加の詳細については、Single Message Transforms（SMT） のドキュメントを参照してください。このコネクターでサポートされていない SMT のリストについては、「サポートされない変換」を参照してください。
すべてのプロパティの値と定義については、「構成プロパティ」を参照してください。
ステップ 4: プロパティファイルを読み込み、コネクターを作成します。¶
以下のコマンドを入力して、構成を読み込み、コネクターを起動します。
confluent connect create --config <file-name>.json
例:
confluent connect create --config mqtt-source.json
出力例:
Created connector MqttSource_0 lcc-ix4dl
ステップ 5: コネクターのステータスを確認します。¶
以下のコマンドを入力して、コネクターのステータスを確認します。
confluent connect plugin list
出力例:
ID | Name | Status | Type
+-----------+-----------------+---------+-------+
lcc-ix4dl | MqttSource_0 | RUNNING | source
ステップ 6: ブローカーで結果を確認します。¶
コネクターが実行中になったら、メッセージが Kafka トピックに取り込まれていることを確認します。
Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。
構成プロパティ¶
このコネクターでは、以下のコネクター構成プロパティを使用します。
データへの接続方法（How should we connect to your data?）¶
nameコネクターの名前を設定します。
- 型: string
- 指定可能な値: 最大 64 文字の文字列
- 重要度: 高
Kafka クラスターの認証情報（Kafka Cluster credentials）¶
kafka.auth.modeKafka の認証モード。KAFKA_API_KEY または SERVICE_ACCOUNT を指定できます。デフォルトは KAFKA_API_KEY モードです。
- 型: string
- デフォルト: KAFKA_API_KEY
- 指定可能な値: KAFKA_API_KEY、SERVICE_ACCOUNT
- 重要度: 高
kafka.api.key- 型: password
- 重要度: 高
kafka.service.account.idKafka クラスターとの通信用の API キーを生成するために使用されるサービスアカウント。
- 型: string
- 重要度: 高
kafka.api.secret- 型: password
- 重要度: 高
データの送信先トピック（Which topic do you want to send data to?）¶
kafka.topicデータの書き込み先トピック名を指定します。
- 型: string
- 重要度: 高
MQTT ブローカーへの接続方法（How should we connect to MQTT Broker?）¶
mqtt.server.uriMQTT ブローカーの URI。<PROTOCOL>//:URI というフォーマットで指定する必要があります。サポートされるプロトコルは、tcp、ssl、ws、および wss です。TLS を使用する接続については、キーストアとトラストストアを指定する必要があることに注意してください。
- 型: list
- 重要度: 高
mqtt.username接続に使用するユーザー名、またはユーザー名が必須でない場合は空白にします。
- 型: string
- 重要度: 高
mqtt.password接続に使用するパスワード、またはパスワードが必須でない場合は空白にします。
- 型: password
- デフォルト: [hidden]
- 重要度: 高
MQTT へのセキュアな接続（MQTT secure connection）¶
mqtt.ssl.key.store.fileサーバーでの認証に使用されるプライベートキーを含む Java キーストアファイルの場所。
- 型: password
- デフォルト: [hidden]
- 重要度: 低
mqtt.ssl.key.store.passwordJava キーストアファイルを開くために使用されるパスワード。
- 型: password
- デフォルト: [hidden]
- 重要度: 中
mqtt.ssl.key.passwordJava キーストアに格納されるクライアント証明書のパスワード。
- 型: password
- デフォルト: [hidden]
- 重要度: 高
mqtt.ssl.trust.store.fileサーバーとの SSL 接続の検証に要求される証明書が含まれる Java トラストストアファイルの場所。
- 型: password
- デフォルト: [hidden]
- 重要度: 中
mqtt.ssl.trust.store.passwordJava トラストストアファイルを開くために使用されるパスワード。
- 型: password
- デフォルト: [hidden]
- 重要度: 中
接続の詳細（Connection Details）¶
mqtt.clean.session.enabledクライアントとサーバーのステートを再起動および再接続後に引き継ぐ必要があるかどうかを設定します。再接続後に未受信のメッセージを受信するには、QOS を 1 以上に設定する必要があります。
- 型: boolean
- デフォルト: false
- 重要度: 中
mqtt.connect.timeout.seconds接続のタイムアウト値（秒）を設定します。
- 型: int
- デフォルト: 30
- 重要度: 中
mqtt.keepalive.interval.secondsこの値は、秒単位で、メッセージの送受信の最長間隔を定義します。指定の期間中にデータ関連のメッセージがない場合、クライアントから非常に小さな ping メッセージが送信され、サーバーから確認応答が返されます。
- 型: int
- デフォルト: 60
- 重要度: 中
max.retry.time.ms失敗した操作（MQTT ブローカーとの接続およびレコードのパブリッシュ）に対してコネクターがバックオフおよび再試行に費やす最大時間（ミリ秒）。
- 型: int
- デフォルト: 30000（30 秒）
- 重要度: 中
mqtt.topicsサブスクライブ先の MQTT トピック。
- 型: list
- 重要度: 高
mqtt.qosサブスクライブ先の MQTT QOS レベル。指定可能な値は、0、1、2 です。
- 型: int
- デフォルト: 0
- 重要度: 低
このコネクターのタスク数（Number of tasks for this connector）¶
tasks.max- 型: int
- 指定可能な値: [1、…]
- 重要度: 高
次のステップ¶
参考
フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。