ActiveMQ Source Connector for Confluent Cloud¶

注釈

If you are installing the connector locally for Confluent Platform, see 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 のコネクターの制限事項を参照してください。

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

クイックスタート¶

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

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

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

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

注釈

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

コネクターの名前を入力します。
Kafka Cluster credentials で Kafka クラスターの認証情報の指定方法を選択します。サービスアカウントのリソース ID を選択するか、API キーとシークレットを入力できます（または、Cloud Console でこれらを生成します）。
データの送信先とする Kafka トピック名（1 つまたは複数）を選択します。
Output Kafka record value で Kafka 出力レコード値のフォーマットを選択します。AVRO、JSON、JSON_SR、PROTOBUF のいずれかを選択できます。スキーマレジストリベースのフォーマット（Avro、JSON_SR（JSON スキーマ）、Protobuf など）を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「環境の制限」を参照してください。
ActiveMQ connection に ActiveMQ の接続の詳細を追加します。ActiveMQ のブローカー URL は tcp://<remotehost>:61616 のような形式です。61616 はデフォルトの ActiveMQ ポートです。
ActiveMQ Session に ActiveMQ セッションの詳細を追加します。
- Destination Name: コネクターの読み取り元である JMS 送信先のキューまたはトピックの名前。
- Destination Type: JMS 送信先のタイプ。queue または topic を選択します。このプロパティのデフォルトは topic です。
- 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: コネクターのタスクによる JMS トピックのサブスクリプションが永続的であるかどうか。永続サブスクリプションにするためには Subscription Name が必要です。デフォルトは false です。
- Subscription Name: JMS サブスクリプションの名前。永続サブスクリプションには必須です。このオプションは JMS トピックにのみ適用されます。
- Message Selector: 送信先のメッセージに適用する必要がある JMS メッセージセレクター。
このコネクターで使用するタスクの数を入力します。このコネクターは複数のタスクに対応しています。タスクが多いほどパフォーマンスが向上する可能性があります。
Transforms and Predicates: 詳細については、Single Message Transforms（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 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 を有効にしておく必要があります。詳細については、「環境の制限」を参照してください。
"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）のドキュメントを参照してください。

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

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

構成プロパティ¶

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
重要度: 高

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
重要度: 高

kafka.api.key

型: password
重要度: 高

kafka.service.account.id

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

型: string
重要度: 高

kafka.api.secret

型: password
重要度: 高

Which topic do you want to send data to?¶

kafka.topic

Identifies the topic name to write the data to.

型: string
重要度: 高

Output messages¶

output.data.format

Sets the output Kafka record value format. Valid entries are AVRO, JSON_SR, PROTOBUF, or JSON. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF

型: string
重要度: 高

ActiveMQ Connection¶

activemq.url

ActiveMQ ブローカーの URL。

型: string
重要度: 高

activemq.username

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

型: string
重要度: 高

activemq.password

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

型: password
重要度: 高

ActiveMQ Session¶

jms.destination.name

The name of the JMS destination (queue or topic) to read from.

型: string
重要度: 高

jms.destination.type

The type of JMS destination, which is either queue or topic.

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

batch.size

The maximum number of records that a connector task may read from the JMS broker before writing to Kafka. The task holds these records until they are acknowledged in Kafka, so this may affect memory usage.

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

max.pending.messages

The maximum number of messages per task that can be received from JMS brokers and produced to Kafka before the task acknowledges the JMS session/messages. If the task fails and is restarted, this is the maximum number of JMS messages the task may duplicate in Kafka. This is typically set larger than batch.size. A smaller value than batch.size limits the size of the batches.

型: int
重要度: 中

max.poll.duration

The maximum amount of time each task can build a batch. The batch is closed and sent to Kafka if not enough messages are read during the time allotted. This helps limit connector lag when the JMS queue/topic has a lower throughput.

型: int
デフォルト: 60000
Valid Values: [1,...,120000]
重要度: 中

character.encoding

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

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

jms.subscription.durable

Whether the subscription of the connector tasks to a JMS topic is durable or not. Durable subscriptions require a subscription name to be set via jms.subscription.name.

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

jms.subscription.name

The name of the JMS subscription. Supported only in durable subscriptions (jms.subscription.durable = true) and is applicable only to JMS topics.

型: string
重要度: 中

jms.message.selector

The message selector that should be applied to messages in the destination.

型: string
重要度: 中

Number of tasks for this connector¶

tasks.max

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

次のステップ¶

参考

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