ActiveMQ Source Connector for Confluent Cloud¶

注釈

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

Kafka Connect ActiveMQ Source Connector for Confluent Cloud は ActiveMQ ブローカーからメッセージを読み取り、そのメッセージを Apache Kafka® トピックに書き込みます。

機能¶

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

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

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

制限¶

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

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

クイックスタート¶

このクイックスタートを使用して、Confluent Cloud ActiveMQ Source Connector の利用を開始することができます。

前提条件

アマゾンウェブサービス（ AWS ）、Microsoft Azure （ Azure ）、または Google Cloud Platform （ GCP ）上の Confluent Cloud クラスターへのアクセスを許可されていること。
ActiveMQ メッセージブローカーへのアクセス。
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 キーとシークレットを自動生成します。

Confluent Cloud Console を使用する場合¶

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

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

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

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

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

Click the ActiveMQ Source connector card.

Step 4: Enter the connector details.¶

注釈

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

At the Add ActiveMQ 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.

Enter the ActiveMQ connection ans session details:
- ActiveMQ URL: The URL of the ActiveMQ broke. An ActiveMQ broker URL is similar to tcp://<remotehost>:61616.
- ActiveMQ Username: The username to use when connecting to ActiveMQ.
- ActiveMQ Password: The password to use when connecting to ActiveMQ.
Click Continue.

Select the output record value format (data going to the Kafka topic): AVRO, JSON, JSON_SR (JSON Schema), or PROTOBUF. Schema Registry must be enabled to use a スキーマレジストリ-based format (for example, Avro, JSON Schema, or Protobuf). See スキーマレジストリ Enabled Environments for additional information.
Enter the Destination Name: The name of the JMS destination (queue or topic) to read from.
Enter the Destination Type: The type of JMS destination, which is either queue or topic.
Show advanced configurations
- Batch Size: コネクターが Kafka に書き込む前にブローカーから読み取ることができる最大レコード数。コネクターのタスクは Kafka で受領確認が行われるまでこれらのレコードを保持するので、この設定はメモリー使用量に影響を及ぼす可能性があります。1 から 2048 までの値を指定できます。
- Unacknowledged Messages Limit: Kafka がメッセージの受領確認を行う前に、ブローカーから受け取り Kafka に書き込むことができる（コネクターのタスクあたりの）最大メッセージ数。これは、コネクターのタスクが失敗して再起動された場合、タスクが Kafka に重複して作成する可能性のある JMS メッセージの最大数です。通常、Batch Size より大きい値に設定します。Batch Size の値より小さい値を入力すると、バッチのサイズがここで使用されている値に制限されます。
- Maximum time to wait...: タスクがバッチを構築するために費やせる最大時間（単位: ミリ秒）。この時間に達すると、バッチは閉じられ Kafka に送信されます。指定されたバッチのサイズよりメッセージの数が少なくても、バッチは Kafka に送信されます。これにより、JMS のキューまたはトピックのスループットが低い場合に、コネクターのラグを制限できます。デフォルトは 60000 ミリ秒（60 秒）です。
- Character Encoding: メッセージを受け取る際に使用する文字エンコーディング。デフォルトは UTF-8 です。
- Durable Subscription: Whether the connector task subscription to the JMS topic is durable or not.
- Subscription Name: JMS サブスクリプションの名前。永続サブスクリプションには必須です。このオプションは JMS トピックにのみ適用されます。
- Message Selector: 送信先のメッセージに適用する必要がある JMS メッセージセレクター。
- 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 connect plugin describe ActiveMQSource

出力例:

Following are the required configs:
connector.class: ActiveMQSource
name
kafka.auth.mode
kafka.api.key
kafka.api.secret
kafka.topic
output.data.format
activemq.url
activemq.username
activemq.password
jms.destination.name
tasks.max

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

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

{
  "connector.class": "ActiveMQSource",
  "name": "ActiveMQSource_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",
  "output.data.format" : "AVRO",
  "activemq.url" : "tcp://<remotehost>:61616",
  "activemq.username" : "<username>",
  "activemq.password" : "<password>",
  "jms.destination.name" : "<JMS-queue-or-topic-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": データの送信先とする Kafka トピックの名前（複数の場合は、コンマ区切りのトピック名）。
"output.data.format": オプションは AVRO、JSON、JSON_SR、PROTOBUF です。スキーマレジストリベースのフォーマット（Avro、JSON_SR（JSON スキーマ）、Protobuf など）を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」を参照してください。
"activemq.url": ActiveMQ ブローカーの URL。ActiveMQ のブローカー URL は tcp://<remotehost>:61616 のような形式です。
"jms.destination.name": 読み取り元の JMS 送信先の queue または topic の名前。
"tasks.max": このコネクターで使用するタスクの数を入力します。このコネクターは複数のタスクに対応しています。タスクが多いほどパフォーマンスが向上する可能性があります。

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

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

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

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

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

例:

confluent connect create --config activemq-source.json

出力例:

Created connector ActiveMQSource_0 lcc-ix4dl

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

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

confluent connect plugin list

出力例:

ID          |    Name             | Status  |  Type
+-----------+---------------------+---------+-------+
lcc-ix4dl   | ActiveMQSource_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.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
重要度: 高

出力メッセージ（Output messages）¶

output.data.format

Kafka 出力レコード値のフォーマットを設定します。指定可能なエントリは、AVRO、JSON_SR、PROTOBUF、または JSON です。スキーマベースのメッセージフォーマット（AVRO、JSON_SR、PROTOBUF など）を使用する場合は、Confluent Cloud Schema Registry を構成しておく必要がある点に注意してください

型: string
重要度: 高

ActiveMQ 接続（ActiveMQ Connection）¶

activemq.url

ActiveMQ ブローカーの URL。

型: string
重要度: 高

activemq.username

ActiveMQ に接続する際に使用するユーザー名。

型: string
重要度: 高

activemq.password

ActiveMQ に接続する際に使用するパスワード。

型: password
重要度: 高

ActiveMQ セッション（ActiveMQ Session）¶

jms.destination.name

読み取り元である JMS 送信先（キューまたはトピック）の名前です。

型: string
重要度: 高

jms.destination.type

JMS 送信先のタイプであり、queue または topic のいずれかです。

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

batch.size

コネクターのタスクが、Kafka に書き込む前に JMS ブローカーから読み取ることができる最大レコード数。タスクは Kafka で受領確認が行われるまでこれらのレコードを保持するので、この設定はメモリー使用量に影響を及ぼす可能性があります。

型: int
指定可能な値: [1、…、2048]
重要度: 中

max.pending.messages

タスクが JMS セッション/メッセージの受領確認を行う前に、JMS ブローカーから受け取って Kafka に生成できる、タスクごとの最大メッセージ数。タスクが失敗して再起動された場合、これが、タスクが Kafka に重複して作成する可能性のある JMS メッセージの最大数になります。これは通常、batch.size より大きい値に設定します。batch.size より小さい値に設定すると、バッチのサイズが制限されます。

型: int
重要度: 中

max.poll.duration

各タスクでバッチのビルドにかけることができる最長時間。割り当てられた時間内に十分な数のメッセージが読み取られなかった場合、バッチは閉じられ、Kafka に送信されます。これにより、JMS キュー/トピックのスループットが低い場合に、コネクターのラグを制限できます。

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

character.encoding

メッセージの受信時に使用する文字エンコーディング。

型: string
デフォルト: UTF-8
重要度: 中

jms.subscription.durable

JMS トピックへのコネクタータスクのサブスクリプションを永続的にするかどうかを指定します。永続サブスクリプションにするためには、jms.subscription.name でサブスクリプション名が設定されている必要があります。

型: boolean
デフォルト: false
重要度: 中

jms.subscription.name

JMS サブスクリプションの名前。永続サブスクリプション（jms.subscription.durable = true）でのみサポートされ、対象となるのは JMS トピックのみです。

型: string
重要度: 中

jms.message.selector

送信先のメッセージに適用する必要があるメッセージセレクター。

型: string
重要度: 中

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

tasks.max

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

次のステップ¶

参考

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