6.17.1 Kafkaアダプタ実行環境プロパティファイル
- 〈この項の構成〉
(1) 形式
［message.level={0｜10｜20}］
［methodtrace.level={1｜2｜3｜4｜5}］
［methodtracefile.num=メソッドトレースの出力面数］
［methodtracefile.size=メソッドトレースの出力サイズ］
［datatrace.level={0｜10｜20}］
［datatracefile.num=データトレースの出力面数］
［datatracefile.size=データトレースの出力サイズ］
［exptracefile.num=例外ログの出力面数］
［exptracefile.size=例外ログの出力サイズ］
producer.bootstrap.servers=Kafkaクラスタへの初期接続を確立するために使用するホスト/ポート
［producer.buffer.memory=レコードをバッファリングするために使用できるメモリの合計バイト数］
［producer.receive.buffer.bytes=TCP受信ソケットバッファのサイズ］
［producer.send.buffer.bytes=TCP送信ソケットバッファのサイズ］
［producer.security.protocol={PLAINTEXT｜SSL}］
［producer.ssl.key.password=キーストアファイル内の秘密鍵のパスワード］
［producer.ssl.keystore.key=キーストアファイルの秘密キー］
［producer.ssl.keystore.location=キーストアファイルの格納場所］
［producer.ssl.keystore.password=キーストアファイルのストアパスワード］
［producer.ssl.truststore.location=トラストストアファイルの格納場所］
［producer.ssl.truststore.password=トラストストアファイルのパスワード］
［producer.ssl.enabled.protocols=SSL接続が有効になっているプロトコルのリスト］
［producer.ssl.keystore.type=キーストアファイルのファイル形式］
［producer.ssl.protocol=SSLコンテキストの生成に使用されるSSLプロトコル］
［producer.ssl.provider=SSL接続に使用されるセキュリティプロバイダの名前］
［producer.ssl.truststore.type=トラストストアファイルのファイル形式］
(2) 機能
Kafkaアダプタごとの構成情報を設定します。
(a) ファイルの種類
Kafkaアダプタ実行環境プロパティファイルは，次に示す2種類があります。
-
Kafkaアダプタ実行環境プロパティファイル
有効範囲：特定のKafkaアダプタ
-
Kafkaアダプタ実行環境共通プロパティファイル
有効範囲：すべてのKafkaアダプタ
作成手順については「6.17.2 Kafkaアダプタ実行環境共通プロパティファイル」を参照してください。
これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。
また，1つのマシンに複数のHCSCサーバをセットアップした場合，Kafkaアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。
同じ内容が要求電文，Kafkaアダプタ実行環境プロパティファイル，Kafkaアダプタ実行環境共通プロパティファイルの間で複数設定された場合，次の表でより優先度の高いものが適用されます。
|
指定個所 |
重複時の優先度 |
|---|---|
|
Kafkaアダプタ実行環境プロパティファイル （HCSCサーバ単位の指定：あり） |
高 |
|
Kafkaアダプタ実行環境共通プロパティファイル （HCSCサーバ単位の指定：あり） |
｜ |
|
Kafkaアダプタ実行環境プロパティファイル （HCSCサーバ単位の指定：なし） |
｜ |
|
Kafkaアダプタ実行環境共通プロパティファイル （HCSCサーバ単位の指定：なし） |
低 |
(b) 作成手順
Kafkaアダプタ実行環境プロパティファイルは次の手順で作成してください。Kafkaアダプタ実行環境共通プロパティファイルの作成手順は，「6.17.2 Kafkaアダプタ実行環境共通プロパティファイル」を参照してください。
-
次のテンプレートファイルを基に，Kafkaアダプタ実行環境プロパティファイルを定義します。
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\Kafka\config\templates\serviceid.properties
-
編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納してください。
- 全HCSCサーバ共通の定義の場合
-
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\Kafka\config
- 特定のHCSCサーバ用の定義の場合
-
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\Kafka\config\<HCSCサーバ名>
サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。
サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。
(3) 設定できるプロパティ
(a) メッセージログ関連
message.level={0｜10｜20} 〜<<10>>
メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。
|
情報種別 |
出力レベル |
||
|---|---|---|---|
|
0 |
10 |
20 |
|
|
エラー情報 |
○ |
○ |
○ |
|
警告情報 |
△ |
○ |
○ |
|
インフォメーション |
△ |
△ |
○ |
- （凡例）
-
○：出力されます。
△：重要なメッセージログだけ出力されます。
(b) メソッドトレース関連
methodtrace.level={1｜2｜3｜4｜5} 〜<<3>>
メソッドトレースの出力レベルを指定します。出力情報と出力レベルを次の表に示します。
|
情報種別 |
出力レベル |
||||
|---|---|---|---|---|---|
|
1 |
2 |
3 |
4 |
5 |
|
|
メソッド内のエラー |
○ |
○ |
○ |
○ |
○ |
|
外部から呼び出されるメソッド情報およびファイル入出力メソッドの開始・終了情報 |
× |
○ |
○ |
○ |
○ |
|
ほかのHCSCコンポーネントから参照するpublicメソッドの開始・終了情報 |
× |
× |
○ |
○ |
○ |
|
ほかのHCSCコンポーネントから参照しない内部メソッド（public以外のメソッド）の開始・終了情報 |
× |
× |
× |
○ |
○ |
|
デバッグ情報 |
× |
× |
× |
× |
○ |
- （凡例）
-
○：出力されます。
×：出力されません。
methodtracefile.num=メソッドトレースの出力面数 〜＜数字＞((1−16))<<8>>
Kafkaアダプタが取得するメソッドトレース情報の出力ファイル面数を指定します。
methodtracefile.size=メソッドトレースの出力サイズ 〜＜数字＞((4096−2147483647))<<4194304>>
Kafkaアダプタが取得するメソッドトレース情報の出力ファイルサイズをバイト単位で指定します。
(c) データトレース関連
datatrace.level={0｜10｜20} 〜<<0>>
データトレースの出力レベルを指定します。出力情報と出力レベルを次の表に示します。
|
情報種別 |
出力レベル |
||
|---|---|---|---|
|
0 |
10 |
20 |
|
|
メッセージ送信成功 |
× |
× |
○ |
|
メッセージ送信失敗 |
× |
○ |
○ |
- （凡例）
-
○：出力されます。
×：出力されません。
datatracefile.num=データトレースの出力面数 〜＜数字＞((1−16))<<8>>
Kafkaアダプタが取得するデータトレース情報の出力ファイル面数を指定します。
datatracefile.size=データトレースの出力サイズ 〜＜数字＞((4096−2147483647))<<67108864>>
Kafkaアダプタが取得するデータトレース情報の出力ファイルサイズをバイト単位で指定します。
(d) 例外ログ関連
exptracefile.num=例外ログの出力面数 〜＜数字＞((1−16))<<8>>
Kafkaアダプタが取得する例外ログの出力ファイル面数を指定します。
exptracefile.size=例外ログの出力サイズ 〜＜数字＞((4096−2147483647))<<4194304>>
Kafkaアダプタが取得する例外ログの出力ファイルサイズをバイト単位で指定します。
(e) サーバ情報
producer.bootstrap.servers=Kafkaクラスタへの初期接続を確立するために使用するホスト/ポート
Kafkaクラスタへの初期接続を確立するために使用するホスト/ポートを指定します。指定は省略できません。
指定した値は，Kafkaサーバへのメッセージ送信に使用されるProducer APIのプロパティ「bootstrap.servers」に設定されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
(f) データサイズ制限
producer.buffer.memory=レコードをバッファリングするために使用できるメモリの合計バイト数 〜<<33554432>>
レコードをバッファリングするために使用できるメモリの合計バイト数を指定します。
指定した値は，Kafkaサーバへのメッセージ送信に使用されるProducer APIのプロパティ「buffer.memory」に設定されます。設定できる値の範囲などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.receive.buffer.bytes=TCP受信ソケットバッファのサイズ 〜<<32768>>
TCP受信ソケットバッファのサイズを指定します。
指定した値は，Kafkaサーバへのメッセージ送信に使用されるProducer APIのプロパティ「receive.buffer.bytes」に設定されます。設定できる値の範囲などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.send.buffer.bytes=TCP送信ソケットバッファのサイズ 〜<<131072>>
TCP送信ソケットバッファのサイズを指定します。
指定した値は，Kafkaサーバへのメッセージ送信に使用されるProducer APIのプロパティ「send.buffer.bytes」に設定されます。設定できる値の範囲などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
(g) セキュリティ情報
producer.security.protocol={PLAINTEXT｜SSL} 〜<<PLAINTEXT>>
Brokerとの通信に使用されるプロトコルを指定します。
-
PLAINTEXT
Brokerとの通信用のプロトコルにPLAINTEXTを使用します。
-
SSL
Brokerとの通信用のプロトコルにSSLを使用します。
指定した値はProducer APIのプロパティ「security.protocol」に設定され，Kafkaサーバへのメッセージ送信に使用されます。詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.key.password=キーストアファイル内の秘密鍵のパスワード 〜<<null>>
キーストアファイル内の秘密鍵のパスワードを指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。
指定した値はProducer APIのプロパティ「ssl.key.password」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.keystore.key=キーストアファイルの秘密キー 〜<<null>>
キーストアファイルの秘密キーを指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。
指定した値はProducer APIのプロパティ「ssl.keystore.key」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.keystore.location=キーストアファイルの格納場所 〜<<null>>
キーストアファイルの格納場所を指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。
指定した値はProducer APIのプロパティ「ssl.keystore.location」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.keystore.password=キーストアファイルのストアパスワード 〜<<null>>
キーストアファイルのストアパスワードを指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。
指定した値はProducer APIのプロパティ「ssl.keystore.password」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.truststore.location=トラストストアファイルの格納場所 〜<<null>>
トラストストアファイルの格納場所を指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。
指定した値はProducer APIのプロパティ「ssl.truststore.location」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.truststore.password=トラストストアファイルのパスワード 〜<<null>>
トラストストアファイルのパスワードを指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。
指定した値はProducer APIのプロパティ「ssl.truststore.password」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.enabled.protocols=SSL接続が有効になっているプロトコルのリスト 〜<<TLSv1.2,TLSv1.3>>
SSL接続が有効になっているプロトコルのリストを指定します。
指定した値はProducer APIのプロパティ「ssl.enabled.protocols」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.keystore.type=キーストアファイルのファイル形式 〜<<JKS>>
キーストアファイルのファイル形式を指定します。
指定した値はProducer APIのプロパティ「ssl.keystore.type」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.protocol=SSLコンテキストの生成に使用されるSSLプロトコル 〜<<TLSv1.3>>
SSLコンテキストの生成に使用されるSSLプロトコルを指定します。
指定した値はProducer APIのプロパティ「ssl.protocol」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.provider=SSL接続に使用されるセキュリティプロバイダの名前 〜<<null>>
SSL接続に使用されるセキュリティプロバイダの名前を指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。
指定した値はProducer APIのプロパティ「ssl.provider」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。
producer.ssl.truststore.type=トラストストアファイルのファイル形式 〜<<JKS>>
トラストストアファイルのファイル形式を指定します。
指定した値はProducer APIのプロパティ「ssl.truststore.type」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。