MQTT Source Connector for Confluent Cloud¶

注釈

If you are installing the connector locally for Confluent Platform, see MQTT Source Connector for Confluent Platform.

フルマネージド型 Kafka Connect MQTT Source Connector は MQTT ブローカーに接続し、指定されたトピックをサブスクライブして、これらのトピックからデータを Apache Kafka® にストリーミングします。

機能¶

MQTT Source Connector には、以下の機能があります。

トピックの自動作成: このコネクターでは Kafka トピックを自動的に作成できます。
複数のタスク: このコネクターは複数のタスクをサポートしています。タスクが多いほどパフォーマンスが向上する可能性があります。
SSL のサポート: 双方向 SSL をサポートします。

詳しくは、Confluent Cloud コネクターの制限事項を参照してください。

Confluent Cloud API for Connect の詳細と使用例については、「Confluent Cloud API for Connect」セクションを参照してください。

クイックスタート¶

このクイックスタートを使用して、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 を有効にしておく必要があります。詳細については、「環境の制限」を参照してください。
ネットワークに関する考慮事項については、「ネットワークアクセス」を参照してください。静的なエグレス IP を使用する方法については、「静的なエグレス IP アドレス」を参照してください。

Kafka クラスターの認証情報。次のいずれかの方法で認証情報を指定できます。
- 既存のサービスアカウントのリソース ID を入力する。
- コネクター用の Confluent Cloud サービスアカウントを作成する。サービスアカウントのドキュメントで、必要な ACL エントリを確認してください。一部のコネクターには固有の ACL 要件があります。
- Confluent Cloud の API キーとシークレットを作成する。キーとシークレットを作成するには、confluent api-key create を使用するか、コネクターのセットアップ時に Cloud Console で直接 API キーとシークレットを自動生成します。

Confluent Cloud Console の使用¶

ステップ 1: Confluent Cloud クラスターを起動します。¶

インストール手順については、「Confluent Cloud を使用した Apache Kafka のクイックスタート」を参照してください。

ステップ 2: コネクターを追加します。¶

左のナビゲーションメニューの Data integration をクリックし、Connectors をクリックします。クラスター内に既にコネクターがある場合は、+ Add connector をクリックします。

ステップ 3: コネクターを選択します。¶

MQTT Source コネクターアイコンをクリックします。

ステップ 4: 接続をセットアップします。¶

以下を実行して、Continue をクリックします。

注釈

すべての前提条件を満たしていることを確認してください。
アスタリスク（ * ）は必須項目であることを示しています。

コネクターの名前を入力します。
Kafka Cluster credentials で Kafka クラスターの認証情報の指定方法を選択します。サービスアカウントのリソース ID を選択するか、API キーとシークレットを入力できます（または、Cloud Console でこれらを生成します）。
データの送信先とする Kafka トピック名（1 つまたは複数）を入力します。
broker connection details に、MQTT ブローカー接続の詳細情報を追加します。
- list of server URIs （MQTT ブローカー URI のリスト）を追加します。<PROTOCOL>//:URI というフォーマットを使用する必要があります。サポートされるプロトコルは、TCP、SSL、WS、および WSS です。TLS 接続の場合は、認証情報を追加で指定し、キーストアファイルとトラストストアファイルをアップロードする必要があります。
- MQTT ブローカーで匿名モードがサポートされていない場合は、ブローカーに接続するためにコネクターで使用されるユーザー名とパスワードを入力する必要があります。
セキュアな接続のために、必要な Keystore ファイルおよび Truststore ファイルとパスワードを追加します。キーストアについては、保存されているクライアント証明書のパスワードも追加する必要があります。
session connection details に、セッションの接続に関する詳細を追加します。
- Clean Session?: クライアントとサーバーのステートを再起動および再接続後に引き継ぐ必要があるかどうかを設定します。クライアントとサーバーが再接続したときに未受信のメッセージを受信するには、MQTT サービス品質（QOS）プロパティを少なくとも 1 または 2 に設定する必要があります。詳細については、このマニュアルページの「Quality of Service」を参照してください。
- Connection Timeout: MQTT ブローカーに接続するときに待機する時間の長さ（秒）。デフォルトは 30 秒です。
- Connection Keepalive: メッセージの送受信の最長間隔（秒）を定義します。入力された期間中にデータ関連のメッセージがない場合、ブローカーによる確認のために非常に小さな ping メッセージがクライアントから送信されます。デフォルト値は 60 秒です。
- Max Retry Time: コネクターが MQTT ブローカーへの接続のバックオフと再試行にかける最大時間（ミリ秒）。デフォルト値は 30000 ミリ秒（30 秒）です。
- MQTT Topics: サブスクライブする 1 つ以上のブローカートピック。
- MQTT QOS: デフォルト値は 0 です。これは、確認なくメッセージが 1 回配信されることを意味します。クライアントとサーバーが再接続したときに未受信のメッセージを受信するには、QOS プロパティを少なくとも 1 または 2 に設定する必要があります。詳細については、このマニュアルページの「Quality of Service」を参照してください。
このコネクターで使用するタスクの数を入力します。このコネクターは複数のタスクに対応しています。タスクが多いほどパフォーマンスが向上する可能性があります。
Transforms and Predicates: SMT 追加の詳細については、Single Message Transforms（SMT）のドキュメントを参照してください。このコネクターでサポートされていない SMT のリストについては、「サポートされない変換」を参照してください。

See 構成プロパティ for all property values and definitions.

ステップ 5: コネクターを起動します。¶

実行中の構成をプレビューして、接続の詳細情報を確認します。プロパティの構成に問題がないことが確認できたら、Launch をクリックします。

ちなみに

コネクターの出力のプレビューについては、「コネクターのデータプレビュー」を参照してください。

ステップ 6: コネクターのステータスを確認します。¶

コネクターのステータスが Provisioning から Running に変わります。ステータスが変わるまで数分かかる場合があります。

ステップ 7: Kafka トピックを確認します。¶

コネクターが実行中になったら、メッセージが 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>`__」を参照してください。

ステップ 1: 使用可能なコネクターをリスト表示します。¶

以下のコマンドを入力して、使用可能なコネクターをリスト表示します。

confluent connect plugin list

ステップ 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 のリストについては、「サポートされない変換」を参照してください。

See 構成プロパティ for all property values and definitions.

ステップ 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」セクションを参照してください。

構成プロパティ¶

Use the following configuration properties with this connector.

How should we connect to your data?¶

name

Sets a name for your connector.

型: 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.

型: string
Default: KAFKA_API_KEY
Valid Values: SERVICE_ACCOUNT, KAFKA_API_KEY
Importance: high

kafka.api.key

型: password
Importance: high

kafka.service.account.id

The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.

型: string
Importance: high

kafka.api.secret

型: password
Importance: high

Which topic do you want to send data to?¶

kafka.topic

Identifies the topic name to write the data to.

型: 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.

型: string
Importance: high

mqtt.password

Password to connect with, or blank if a password is not required.

型: password
デフォルト: [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.

型: password
デフォルト: [hidden]
Importance: low

mqtt.ssl.key.store.password

Java キーストアファイルを開くために使用されるパスワード。

型: password
デフォルト: [hidden]
Importance: medium

mqtt.ssl.key.password

Java キーストアに格納されるクライアント証明書のパスワード。

型: password
デフォルト: [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.

型: password
デフォルト: [hidden]
Importance: medium

mqtt.ssl.trust.store.password

Java トラストストアファイルを開くために使用されるパスワード。

型: password
デフォルト: [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

接続のタイムアウト値（秒）を設定します。

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
指定可能な値: [1、…]
Importance: high

次のステップ¶

参考

フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。