RabbitMQ Source Connector for Confluent Cloud¶

注釈

Confluent Platform 用にコネクターをローカルにインストールする場合は、「RabbitMQ Source Connector for Confluent Platform」を参照してください。

フルマネージド型の RabbitMQ Source Connector は、AMQP プロトコルを使用して RabbitMQ サーバーと通信します。RabbitMQ Source Connector では、1 つまたは複数の RabbitMQ キューからデータが読み取られ、Apache Kafka® のトピックに保存されます。

機能¶

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

少なくとも 1 回のデリバリー: レコードが Kafka のトピックに少なくとも 1 回は配信されることが保証されます。
複数のタスクのサポート: 1 つまたは複数のタスクの実行をサポートしています。タスクが多いほどパフォーマンスが向上する可能性があります。

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

制限¶

以下の情報を確認してください。

1 つ以上の Single Message Transforms（SMT）を使用する場合は、「SMT の制限」を参照してください。
Confluent Cloud Schema Registry を使用する場合は、「スキーマレジストリ Enabled Environments」を参照してください。

クイックスタート¶

このクイックスタートを使用して、Confluent Cloud RabbitMQ Source Connector の利用を開始することができます。このクイックスタートでは、コネクターを選択し、RabbitMQ のキューからデータを読み取って Apache Kafka® トピックに保存するようにコネクターを構成する方法について説明します。

前提条件

アマゾンウェブサービス（ AWS ）、Microsoft Azure （ Azure ）、または Google Cloud Platform （ GCP ）上の Confluent Cloud クラスターへのアクセスを許可されていること。
RabbitMQ ホストサーバー、キュー、およびホストのセキュリティ情報へのアクセスが許可されていること。
コネクターを起動する前に、トピックが 1 つ以上存在している必要があります。
Confluent CLI がインストールされ、クラスター用に構成されていること。「Confluent CLI のインストール」を参照してください。
スキーマレジストリベースのフォーマット（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 キーとシークレットを自動生成します。

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

注釈

このソースコネクターで使用される output.data.format 構成はありません。このコネクターのデフォルトの値が ByteArrayConverter、デフォルトのキーが StringConverter であるためです。このコネクターで、他のコンバーターは使用できません。

Confluent Cloud Console の使用¶

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

インストール手順については、「Quick Start for Confluent Cloud」を参照してください。

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

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

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

Click the RabbitMQ Source connector card.

Step 4: Enter the connector details.¶

注釈

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

At the Add RabbitMQ Source Connector screen, complete the following:

Select the topic you want to send data to from the Topics list. To create a new topic, click +Add new topic.

connection details に、接続の詳細情報を追加します。
- RabbitMQ host: 接続先 RabbitMQ ホストサーバーのアドレス。例: 192.168.1.99。RabbitMQ のユーザー名とパスワードを追加します。
- RabbitMQ username: Username to autheniticate to RabbitMQ.
- RabbitMQ password: Password to autheniticate to RabbitMQ.
- RabbitMQ virtual host: RabbitMQ で作成された仮想ホストの名前。
- RabbitMQ port: RabbitMQ port to connect to. This should be set in accordance with chosen Security protocol.
- Security protocol: The security protocol to use when connecting to RabbitMQ.
Click Continue.

Add the following RabbitMQ details:
- RabbitMQ queue(s): RabbitMQ ` キューの名前 <https://www.rabbitmq.com/queues.html#names>`__。読み取る複数の RabbitMQ キューを指定できます。
Show advanced configurations
- RabbitMQ batch size: コネクターがバッチで処理して Kafka トピックに返すレコードの最大数。デフォルトのプロパティ値は 1024 件です。
- RabbitMQ backoff time (in milliseconds): RabbitMQ キューからレコードが返されない場合に待機する時間の長さ（ミリ秒）。デフォルトのプロパティ値は 100 ミリ秒です。
- Transforms and Predicates: 詳細については、Single Message Transforms（SMT）のドキュメントを参照してください。
すべてのプロパティの値と定義については、「構成プロパティ」を参照してください。
Click Continue.

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>`__」を参照してください。

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

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

confluent connect plugin list

ステップ 2: コネクターの必須の構成プロパティを表示します。¶

以下のコマンドを実行して、コネクターの必須プロパティを表示します。

confluent connect plugin describe <connector-catalog-name>

例:

confluent plugin describe RabbitMQSource

出力例:

Following are the required configs:
connector.class: RabbitMQSource
name
kafka.api.key
kafka.api.secret
kafka.topic
rabbitmq.host
rabbitmq.username
rabbitmq.password
rabbitmq.queue
tasks.max

ステップ 3: コネクターの構成ファイルを作成します。¶

コネクター構成プロパティを含む JSON ファイルを作成します。以下の例は、コネクターの必須プロパティを示しています。

{
    "connector.class": "RabbitMQSource",
    "name": "RabbitMQSource_0",
    "kafka.auth.mode": "KAFKA_API_KEY",
    "kafka.api.key": "<my-kafka-api-key>",
    "kafka.api.secret" : "<my-kafka-api-secret>",
    "kafka.topic" : "topic_0"
    "rabbitmq.host" : "192.168.1.99",
    "rabbitmq.username" : "<username>",
    "rabbitmq.password": "<password>",
    "rabbitmq.queue": "<queue-name>",
    "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": データの送信先とするトピック名を入力します。コネクターを起動する前に、トピックが 1 つ以上存在している必要があります。
"rabbitmq....": RabbitMQ 認証とキューの詳細を入力します。コンマ区切りのリストを使用して、読み取る複数の rabbitmq.queue 名を指定できます。
"tasks.max": このコネクターで使用するタスクの数を入力します。コネクターは、1 つまたは複数のタスクの実行をサポートしています。タスクが多いほどパフォーマンスが向上する可能性があります。

Single Message Transforms: CLI を使用した SMT の追加の詳細については、Single Message Transforms（SMT）のドキュメントを参照してください。

すべてのプロパティの値と定義については、「構成プロパティ」を参照してください。

ステップ 4: プロパティファイルを読み込み、コネクターを作成します。¶

以下のコマンドを入力して、構成を読み込み、コネクターを起動します。

confluent connect create --config <file-name>.json

例:

confluent connect create --config rabbitmq-source.json

出力例:

Created connector RabbitMQSourceConnector_0 lcc-ix4dl

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

以下のコマンドを入力して、コネクターのステータスを確認します。

confluent connect plugin list

出力例:

ID          |            Name           | Status  |  Type
+-----------+---------------------------+---------+-------+
lcc-ix4dl   | RabbitMQSourceConnector_0 | RUNNING | source

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

コネクターが実行中になったら、メッセージが 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.mode

Kafka の認証モード。KAFKA_API_KEY または SERVICE_ACCOUNT を指定できます。デフォルトは KAFKA_API_KEY モードです。

型: string
デフォルト: KAFKA_API_KEY
指定可能な値: KAFKA_API_KEY、SERVICE_ACCOUNT
重要度: 高

kafka.api.key

型: password
重要度: 高

kafka.service.account.id

Kafka クラスターとの通信用の API キーを生成するために使用されるサービスアカウント。

型: string
重要度: 高

kafka.api.secret

型: password
重要度: 高

データの送信先トピック（Which topic do you want to send data to?）¶

kafka.topic

データの書き込み先トピック名を指定します。

型: string
重要度: 高

RabbitMQ への接続方法（How should we connect to RabbitMQ?）¶

rabbitmq.host

接続先の RabbitMQ ホスト。

型: string
重要度: 高

rabbitmq.username

RabbitMQ での認証に使用するユーザー名。

型: string
重要度: 高

rabbitmq.password

RabbitMQ での認証に使用するパスワード。

型: password
重要度: 高

rabbitmq.virtual.host

RabbitMQ ブローカーへの接続時に使用する仮想ホスト。

型: string
デフォルト: /
重要度: 高

rabbitmq.port

接続先の RabbitMQ ポート。これは、選択したセキュリティプロトコルに従って設定する必要があります。

型: int
デフォルト: 5672
指定可能な値: [0,...]
重要度: 高

RabbitMQ の詳細情報（RabbitMQ details）¶

rabbitmq.queue

読み取り元の RabbitMQ キュー。

型: list
重要度: 高

batch.size

RabbitMQ から入手できるレコードがこの数より既に多い場合に、1 回のポーリングで Connect に返すレコードの最大数。

型: int
デフォルト: 1024
指定可能な値: [1,...]
重要度: 中

backoff.time.ms

RabbitMQ キューからレコードが返されない場合に待機する時間（ミリ秒）。

型: int
デフォルト: 100
指定可能な値: [1,...]
重要度: 中

セキュリティ（Security）¶

rabbitmq.security.protocol

RabbitMQ との接続に使用するセキュリティプロトコル。指定可能な値は、PLAINTEXT と SSL です。

型: string
デフォルト: PLAINTEXT
重要度: 高

rabbitmq.https.ssl.key.password

キーストアファイル内のプライベートキーのパスワード。クライアントでは省略可能です。

型: password
重要度: 高

rabbitmq.https.ssl.keystorefile

サーバー証明書が含まれるキーストア。SSL を使用する場合にのみ必要です。

型: password
重要度: 高

rabbitmq.https.ssl.keystore.password

キーストアファイルのストアパスワード。クライアントでは省略可能です。キーストアが構成されている場合にのみ必要です。

型: password
重要度: 高

rabbitmq.https.ssl.keystore.type

キーストアファイルのファイルフォーマット。クライアントでは省略可能です。

型: string
デフォルト: JKS
重要度: 中

rabbitmq.https.ssl.truststorefile

サーバー CA 証明書情報が含まれるトラストストア。SSL を使用する場合にのみ必要です。

型: password
重要度: 高

rabbitmq.https.ssl.truststore.password

トラストストアファイルのパスワード。パスワードが設定されていなくても、構成されたトラストストアファイルを使用できますが、整合性チェックが無効になります。トラストストアのパスワードは PEM 形式ではサポートされていません。

型: password
重要度: 高

rabbitmq.https.ssl.truststore.type

トラストストアファイルのファイルフォーマットです。

型: string
デフォルト: JKS
重要度: 中

このコネクターのタスク数（Number of tasks for this connector）¶

tasks.max

型: int
指定可能な値: [1,...]
重要度: 高

次のステップ¶

参考

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