TIBCO Sink Connector 構成プロパティ¶

このコネクターを使用するには、connector.class 構成プロパティでこのコネクタークラスの名前を指定します。

connector.class=io.confluent.connect.jms.TibcoSinkConnector

コネクター固有の構成プロパティについて、以降で説明します。

TIBCO 接続¶

tibco.url

TIBCO EMS ブローカーの URLです。

型: string
重要度: 高

tibco.username

TIBCO EMS に接続する際に使用するユーザー名です。

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

tibco.password

TIBCO EMS に接続する際に使用するパスワードです。

型: password
デフォルト: [hidden]
重要度: 中

JMS¶

jms.destination.name

メッセージの書き込み先である JMS 送信先の名前です。

型: string
重要度: 高

jms.destination.type

JMS 送信先のタイプです。

型: string
デフォルト: queue
指定可能な値: [queue, topic]
重要度: 高

jms.forward.kafka.key

有効にすると、Kafka レコードキーが文字列に変換され、JMS メッセージの JMSCorrelationID プロパティとして転送されます。

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

jms.forward.kafka.metadata

有効にすると、Kafka レコードのメタデータは JMS メッセージのプロパティに転送されます。レコードのトピック、パーティション、オフセットが含まれます。トピック名は KAFKA_TOPIC という名前の String プロパティ、パーティション値は KAFKA_PARTITION という名前の Int プロパティ、オフセット値は KAFKA_OFFSET という名前の Long プロパティとしてそれぞれ適用されます。

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

jms.forward.kafka.headers

有効にすると、Kafka レコードのヘッダーは、JMS メッセージに String プロパティとして追加されます。

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

jms.connection.max.retries

JMS ブローカーへの接続は、複数の理由により失敗する場合があります。これは、JMS ブローカーへの接続をタスクが試行できる最大回数を指定します。

型: int
デフォルト: 150
指定可能な値: [0,…]
重要度: 低

jms.connection.backoff.ms

この構成パラメーターは、JMS ブローカーへの接続の失敗後に再接続を試行するまでに待機する時間をミリ秒単位で指定します。0 以下の値は、まったく遅延がないことを表します。

型: int
デフォルト: 2000
重要度: 低

JMS フォーマッター¶

jms.message.format

JMS メッセージ値のフォーマットです。

型: string
デフォルト: string
指定可能な値: [string, avro, json, bytes] のいずれか
重要度: 高
依存関係 : jms.message.format.schemas.cache.config、jms.message.format.connect.meta.data、jms.message.format.enhanced.avro.schema.support、jms.message.format.schemas.cache.size、jms.message.format.schemas.enable

character.encoding

メッセージの書き込み時に使用する文字エンコーディングです。

型: string
デフォルト: UTF-8
指定可能な値: [ISO-8859-1, UTF-8, UTF-16, UTF-16LE, UTF-16BE, US-ASCII] のいずれか
重要度: 低

Avro フォーマッター¶

jms.message.format.schemas.cache.config

変換されたスキーマキャッシュのサイズです。

型: int
デフォルト: 128
指定可能な値: [0,…,2048]
重要度: 中

jms.message.format.connect.meta.data

Connect コンバーターの有効化と無効化を切り替えて、メタデータを出力スキーマに追加するかどうかを指定します。

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

jms.message.format.enhanced.avro.schema.support

Avro スキーマの高度なサポートの有効化と無効化を切り替えます。高度なサポートには、列挙型のシンボルの保持とパッケージ名の認識が含まれます。

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

JSON フォーマッター¶

jms.message.format.schemas.cache.size

JSON フォーマッターでキャッシュできる最大スキーマ数です。

型: int
デフォルト: 128
指定可能な値: [0,…,2048]
重要度: 中

jms.message.format.schemas.enable

シリアル化された値とキーのそれぞれにスキーマを含めます。

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

JMS MessageProducer¶

jms.producer.time.to.live.ms

JMS ブローカーに送信されるメッセージの Time To Live（TTL）をミリ秒単位で指定します。

型: long
デフォルト: 0
指定可能な値: [0,…,99999999900]
重要度: 低

jms.producer.delivery.mode

PERSISTENT デリバリーモード（デフォルト）は、JMS プロバイダーが失敗した場合に転送中のメッセージが紛失しないよう、十分な対処をするように JMS プロバイダーに指示します。NON_PERSISTENT デリバリーモードでは、JMS プロバイダーは、メッセージを保管したり、プロバイダーが失敗した場合にメッセージが紛失しないことを保証したりする必要はありません。PERSISTENT デリバリーモードを使用するコネクターは、NON_PERSISTENT デリバリーモードで実行する場合と比較して全体のスループットが低くなります。ただし、NON_PERSISTENT デリバリーモードは PERSISTENT デリバリーモードと同等のデリバリーの保証は提供しません。

型: string
デフォルト: persistent
指定可能な値: [non_persistent, persistent] のいずれか
重要度: 低

jms.producer.disable.message.id

メッセージ ID を無効にするかどうかを指定します。メッセージ ID は作成に負荷がかかるうえにメッセージサイズが増えるので、一部の JMS プロバイダーは、アプリケーションでメッセージ ID が使用されていないことがヒントを介して伝えられた場合に、メッセージのオーバーヘッドを最適化できるようになっています。JMS メッセージのプロデューサーは、メッセージ ID を無効にするヒントを提供します。コネクターがメッセージ ID を無効にするようにプロデューサーを設定すると、そのコネクターは、生成するメッセージについてメッセージ ID の値に依存しないことを示します。これらのメッセージは、メッセージ ID が null に設定されているか、ヒントが無視される場合はメッセージ ID が通常の一意の値に設定されている必要があります。メッセージ ID はデフォルトで有効に設定されています。

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

jms.producer.disable.message.timestamp

メッセージのタイムスタンプを無効にするかどうかを指定します。タイムスタンプは、作成に負荷がかかるうえにメッセージサイズが増えるので、一部の JMS プロバイダーは、アプリケーションでタイムスタンプが使用されていないことがヒントを介して伝えられた場合に、メッセージのオーバーヘッドを最適化できるようになっています。JMS メッセージのプロデューサーは、タイムスタンプを無効にするヒントを提供します。コネクターがタイムスタンプを無効にするようにプロデューサーを設定すると、そのコネクターは、生成するメッセージについてタイムスタンプの値に依存しないことを示します。これらのメッセージは、タイムスタンプが null に設定されているか、ヒントが無視される場合はタイムスタンプが通常の一意の値に設定されている必要があります。メッセージのタイムスタンプはデフォルトで有効に設定されています。

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

Confluent Platform ライセンス¶

confluent.topic.bootstrap.servers

ライセンス供与に使用される Kafka クラスターとの初期接続を確立するために使用するホストとポートのペアのリストです。初期接続で、クラスター内のすべてのサーバーが検出されます。このリストは、host1:port1,host2:port2,… という形式にする必要があります。これらのサーバーは、初期接続ですべてのクラスターメンバーシップを検出するためにのみ使用されます。これは動的に変わる可能性があるので、このリストにすべてのサーバーセットを含める必要はありません（ただし、サーバーの障害に備えて、複数指定しておくこともできます）。

型: list
重要度: 高

confluent.topic

Confluent Platform の構成（ライセンス情報など）で使用される Kafka のトピックの名前。

型: string
デフォルト: _confluent-command
重要度: 低

confluent.topic.replication.factor

Confluent Platform の構成（ライセンス情報など）で使用される Kafka のトピックのレプリケーション係数。これは、トピックがまだ存在しない場合にのみ使用されます。デフォルトの 3 は、本稼働環境での使用に適しています。ブローカー数が 3 未満の開発環境で使用する場合は、そのブローカー数をこのプロパティに設定する必要があります（多くの場合、1 です）。

型: int
デフォルト: 3
重要度: 低

Confluent ライセンスのプロパティ¶

ちなみに

コネクターの構成にライセンス関連のプロパティを含めることができますが、Confluent Platform バージョン 6.0 以降では、各コネクターの構成ではなく、Connect ワーカーの構成にライセンス関連のプロパティを構成できるように変わりました。

注釈

このコネクターはプロプライエタリであり、ライセンスが必要です。ライセンス情報は、_confluent-command トピックに保管されています。ブローカーが SSL 接続を必要とする場合は、以下で説明するセキュリティ関連の confluent.topic.* プロパティを含める必要があります。

confluent.license

Confluent では、各契約者にエンタープライズライセンスキーを発行します。ライセンスキーはテキストであるため、コピーアンドペーストで confluent.license の値として使用できます。試用ライセンスでは、コネクターを 30 日間使用できます。開発者ライセンスでは、ブローカーが 1 つの開発環境で、コネクターを無期限に使用できます。

既にご契約されている場合は、詳細について Confluent サポートにお問い合わせください。

型: string
デフォルト: ""
指定可能な値: Confluent Platform ライセンス
重要度: 高

confluent.topic.ssl.truststore.location

トラストストアファイルの場所。

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

confluent.topic.ssl.truststore.password

トラストストアファイルのパスワードです。パスワードが設定されていなくてもトラストストアにアクセスできますが、整合性チェックが無効になります。

型: password
デフォルト: null
重要度: 高

confluent.topic.ssl.keystore.location

キーストアファイルの場所。クライアントでは省略可能です。クライアントの相互認証に使用できます。

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

confluent.topic.ssl.keystore.password

キーストアファイルのストアパスワードです。クライアントでは省略可能です。ssl.keystore.location を構成した場合にのみ必要となります。

型: password
デフォルト: null
重要度: 高

confluent.topic.ssl.key.password

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

型: password
デフォルト: null
重要度: 高

confluent.topic.security.protocol

ブローカーとの通信に使用されるプロトコル。指定可能な値は、PLAINTEXT、SSL、SASL_PLAINTEXT、SASL_SSL です。

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

ライセンストピックの構成¶

Confluent エンタープライズライセンスは、_confluent-command トピックに格納されます。このトピックは、デフォルトで作成され、confluent.license プロパティで指定されたライセンスキーに対応するライセンスが格納されます。

注釈

パブリックキーは Kafka のトピックには保管されません。

以下では、デフォルトの _confluent-command トピックがさまざまなシナリオでどのように生成されるかを説明します。

confluent.license プロパティを追加していない場合、またはこのプロパティを（ confluent.license= などで）空にした場合は、_confluent command トピックに、30 日間の試用ライセンスが自動的に生成されます。
有効なライセンスキーを（ confluent.license=<有効なライセンスキー> などで）追加すると、有効なライセンスが _confluent-command トピックに追加されます。

以下は、開発およびテストのための最小限のプロパティの例です。

_confluent-command トピックの名前は confluent.topic プロパティを使用して変更できます（たとえば、環境に厳格な命名規則がある場合など）。以下の例は、この変更と、構成される Kafka ブートストラップサーバーを示しています。

confluent.topic=foo_confluent-command
confluent.topic.bootstrap.servers=localhost:9092

上の例は、開発およびテストで使用できるブートストラップサーバーの必要最小限のプロパティを示しています。本稼働環境の場合は、プレフィックスとして confluent.topic. を付けて、通常のプロデューサー、コンシューマー、およびトピックの各構成プロパティをコネクターのプロパティに追加します。

ライセンストピックの ACL¶

_confluent-command トピックには、confluent.license プロパティで指定されたライセンスキーに対応するライセンスが格納されます。このトピックはデフォルトで作成されます。このトピックにアクセスするコネクターには、以下の ACL を構成する必要があります。

コネクターでトピックの作成が必要な場合は、リソースクラスターでの CREATE および DESCRIBE
_confluent-command トピックでの DESCRIBE、READ、および WRITE。

重要

You may also use DESCRIBE and READ without WRITE to restrict access to read-only for license topic ACLs. If a topic exists, the LicenseManager will not try to create the topic.

ライセンスを使用する各プリンシパルに個々にアクセス許可を付与することも、ワイルドカード入力を使用してすべてのクライアントを許可することもできます。以下の例は、リソースクラスターおよび _confluent-command トピックの ACL を構成するために使用できるコマンドを示しています。

リソースクラスターの CREATE および DESCRIBE の ACL を設定します。

kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation CREATE --operation DESCRIBE --cluster

_confluent-command トピックでの DESCRIBE、READ、および WRITE の ACL を設定します。

kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \
--add --allow-principal User:<principal> \
--operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command

デフォルトの構成プロパティのオーバーライド¶

confluent.topic.replication.factor を使用することにより、レプリケーション係数をオーバーライドできます。たとえば、（開発およびテスト用の）ブローカー数 3 未満の環境で送信先として Kafka クラスターを使用する場合、confluent.topic.replication.factor プロパティに 1 を設定する必要があります。

プロデューサー固有のプロパティは、confluent.topic.producer. プレフィックスを使用してオーバーライドできます。コンシューマー固有のプロパティは、confluent.topic.consumer. プレフィックスを使用してオーバーライドできます。

デフォルト値を使用することも、他のプロパティをカスタマイズすることもできます。たとえば、confluent.topic.client.id プロパティのデフォルトは、コネクターの名前に -licensing サフィックスを付けたものです。クライアント接続に SSL または SASL を必要とするブローカーの構成設定では、このプレフィックスを使用できます。

トピックのクリーンアップのポリシーはオーバーライドできません。トピックは、常にパーティションが単一で、圧縮されるからです。また、このプレフィックスを使用してシリアライザーおよびデシリアライザーを指定しないでください。追加しても無視されます。