MFT logger.properties ファイル

Managed File Transfer ロガーには、一連の構成プロパティーがあります。 これらのプロパティーを logger.properties ファイルで指定します。このファイルは、MQ_DATA_PATH/mqft/config/coordination_qmgr_name/loggers/logger_name ディレクトリーにあります。

IBM® WebSphere® MQ 7.5以降、ファイルまたはディレクトリーの場所を表す一部の Managed File Transfer プロパティーで環境変数を使用できるようになりました。 これにより、製品の一部の実行時に使用されるファイルまたはディレクトリーの場所を、環境の変更 (プロセスを実行しているユーザーなど) に合わせて変えることができます。 詳しくは、 MFT プロパティーでの環境変数の使用を参照してください。

[Windows]注: When you specify file paths on Windows, the backslash (\) separator character must appear as double backslashes (\\) (that is, escaped \). 代わりに、分離文字として単一スラッシュ文字 (/) を使用できます。 Oracleの Java プロパティー・ファイルでの文字エスケープについて詳しくは、 Properties クラスの場合は Javadocを参照してください。

MFT logger.properties ファイルには以下の値が含まれます。

バインディング・モード接続のプロパティー

表 1. logger.properties ファイルのバインディング・モードの接続プロパティー
プロパティー名 説明 デフォルト値
wmqfte.logger.type 使用しているロガー・タイプ (file または database)。 この値を FILEまたは DATABASEに設定します。 デフォルト値なし
wmqfte.max.transaction.messages トランザクションがコミットされる前にトランザクションで処理されるメッセージの最大数。 循環ロギング・モードでは、未完了データに使用可能な固定スペース量はキュー・マネージャーが持っています。 使用可能なスペースを使い尽くさないよう十分に低い値をこのプロパティーに設定するようにしてください。 50
wmqfte.max.transaction.time トランザクションのコミット間に経過する時間の最大長 (ミリ秒)。 5000
wmqfte.max.consecutive.reject 連続して (つまり、有効メッセージが出現することなく) リジェクト可能なメッセージの最大数。

この数値を超えると、ロガーは問題がメッセージ自体にあるのではなく構成にあると見なします。 例えば、使用しているすべてのエージェント名よりデータベース内のエージェント名列を狭く作ると、エージェントを参照しているすべてのメッセージがリジェクトされます。

50
wmqfte.reject.queue.name ロガーがメッセージを処理できない場合にロガーがメッセージを置くキューの名前。 データベース・ロガーがある場合は、このキューに書き込まれる可能性があるメッセージの詳細について、 MFT ロガーのエラー処理および拒否 を参照してください。 SYSTEM.FTE.LOG.RJCT。logger_name
wmqfte.command.queue.name ロガーがその動作を制御するコマンド・メッセージを読み取る際に、その読み取り元となるキューの名前。 SYSTEM.FTE.LOG.CMD。logger_name
wmqfte.queue.manager ロガーの接続先キュー・マネージャー。 このパラメーターは必須で、キュー・マネージャーへのバインディング・モード接続に必要となるものはこのパラメーターのみです。 (リモート・キュー・マネージャーに接続するためのプロパティーについては、 表 2を参照してください。) デフォルト値なし
wmqfte.message.source.type 以下のいずれかの値になります。
automatic subscription
デフォルト値。 ロガーは、SYSTEM.FTE/Log/# で定義される独自の永続的な管理対象サブスクリプションをキュー・マネージャー上に作成して使用します。 これは、ほとんどのシナリオで適切な値となります。
administrative subscription
自動サブスクリプションが適切でない場合は、別のサブスクリプションを (例えば、 IBM MQ Explorer、MQSC、または PCF を使用して) 定義し、ロガーにそのサブスクリプションを使用するように指示することができます。 例えば、この値を使用してログ・スペースを分割し、1 番目のロガーは A から H のエージェントを、2 番目のロガーは I から P のエージェントを、3 番目のロガーは Q から Z のエージェントを処理するようにします。
キュー
IBM MQ トポロジーが、ロガーのサブスクリプションの作成が不便であることを意味する場合は、代わりにキューを使用できます。 通常は調整キュー・マネージャー上の SYSTEM.FTE/Log/# へのサブスクリプションによって受信されるメッセージをキューが受信するように、 IBM MQ を構成します。
automatic subscription
wmqfte.message.source.name メッセージ送信元タイプが administrative subscription または queue である場合に使用するサブスクリプションまたはキューの名前。 このプロパティーは、送信元タイプが automatic subscription である場合は無視されます。 デフォルト値なし
wmqfte.database.credentials.file データベースに接続するためのユーザー名とパスワードを格納するファイル。

IBM WebSphere MQ 7.5以降の場合、このプロパティーの値に環境変数を含めることができます。

詳しくは、 MFT 資格情報ファイルのフォーマットを参照してください。

[z/OS]認証資格情報ファイルの作成については、 z/OS®での MQMFTCredentials.xml の構成を参照してください。

[AIX、Linux、Windows]このファイルの場所と許可については、 MQMFTCredentials.xmlの構成を参照してください。

[AIX、Linux、Windows] MFT および IBM MQ 接続認証 (connection authentication)も参照してください。

wmqfte.database.driver データベースの JDBC ドライバー・クラスの場所。 これは通常、JAR ファイルのパスおよびファイル名です。

[AIX]例えば、 AIX® システム上の Db2® 用のタイプ 2 ドライバーには、ファイル /opt/IBM/db2/V9.5/java/db2jcc.jarが必要です。

[Windows] Windows システムでは、パス分離文字をスラッシュ文字 (/) で指定します (例: C:/Program Files/IBM/SQLLIB/java/db2jcc.jar)。

[z/OS] z/OSの場合は、 db2jcc.jar ファイルの絶対パスを指定します。 例えば、wmqfte.database.driver=/db2/db2v10/jdbc/classes/db2jcc.jarなどです。

[z/OS] z/OS システムでは、以下のすべての JAR ファイルを参照する必要があります。
  • db2jcc.jar
  • db2jcc_license_cisuz.jar
  • db2jcc_javax.jar

データベース・ドライバーが複数の JAR ファイルで構成されている場合は (例えば、Db2 V9.1 にはドライバー JAR ファイルとライセンス JAR ファイルが必要です)、これらの JAR ファイルをすべてこのプロパティーに含めます。 複数のファイル名は、ご使用のプラットフォームのクラスパス分離文字、つまり、Windows システムの場合はセミコロン文字 (;)、他のプラットフォームの場合はコロン文字 (:) を使用して分離します。

デフォルト値なし
wmqfte.database.exclude .duplicate.metadata データベース・ロガー・スキーマ内の他の表にある情報を含むメタデータ表にエントリーを保管するかどうかを制御します。 この値を trueまたは falseに設定します。 これらのメタデータ・エントリーは、既存のデータと重複しており、データベース・ストレージ容量を無駄に占有することになるため、デフォルトでは保管されません。 同じデータが出現するプロパティー・エントリーおよび表は以下のとおりです。
  • com.ibm.wmqfte.SourceAgent TRANSFER_EVENT または CALL_REQUEST
  • com.ibm.wmqfte.DestinationAgent TRANSFER_EVENT
  • com.ibm.wmqfte.MqmdUser TRANSFER_EVENT または CALL_REQUEST
  • com.ibm.wmqfte.OriginatingUser TRANSFER_EVENT または CALL_REQUEST
  • com.ibm.wmqfte.OriginatingHost TRANSFER_EVENT または CALL_REQUEST
  • com.ibm.wmqfte.TransferId TRANSFER または CALL_REQUEST
  • com.ibm.wmqfte.JobName TRANSFER または CALL_REQUEST

このプロパティーの値を false に設定すると、これらのメタデータ・エントリーがメタデータ表に保管されます。

true
wmqfte.database.host

Db2 のみ:

IBM WebSphere MQ 7.5以降の場合は、Type 4 JDBC ドライバーを使用して接続するデータベース・サーバーのホスト名。 このプロパティーの値を指定する場合は、wmqfte.database.port の値も指定する必要があります。 両方のプロパティーが定義されていない場合は、データベース・ロガーがデフォルトの Type 2 JDBC ドライバーを使用して接続されます。

このプロパティーに値を指定する場合は、データベースに接続するユーザー名とパスワードを定義するために、このロガー用の資格情報ファイル (wmqfte.database.credentials.file プロパティーでファイル・パスを定義) が存在しており、アクセス可能であることが必要です。資格情報ファイルは、データベースがローカル・システム上にある場合でも必要です。

デフォルト値なし
wmqfte.database.name Managed File Transfer ログ表を含むデータベース・インスタンス (または、 Db2 for z/OSを使用する場合はサブシステム) の名前。 デフォルト値なし
wmqfte.database.type

使用中のデータベース管理システム。Db2 または Oracle。 この値を db2 または oracleに設定します。

db2
wmqfte.database.port

Db2 のみ:

IBM WebSphere MQ 7.5以降の場合は、Type 4 JDBC ドライバーを使用して接続するデータベース・サーバーのポート番号。 このプロパティーの値を指定する場合は、wmqfte.database.host の値も指定する必要があります。 両方のプロパティーが定義されていない場合は、データベース・ロガーがデフォルトの Type 2 JDBC ドライバーを使用して接続されます。

このプロパティーに値を指定する場合は、データベースに接続するユーザー名とパスワードを定義するために、このロガー用の資格情報ファイル (wmqfte.database.credentials.file プロパティーでファイル・パスを定義) が存在しており、アクセス可能であることが必要です。資格情報ファイルは、データベースがローカル・システム上にある場合でも必要です。

デフォルト値なし
wmqfte.database.schema

Db2 のみ:

Managed File Transfer ロギング表を含むデータベース・スキーマ。 ほとんどの場合、デフォルト値が適切ですが、サイト固有のデータベースに関する考慮事項に応じて代替値を指定する必要がある場合があります。

FTELOG
wmqfte.database.native.library.path 選択したデータベース・ドライバーが必要とするネイティブ・ライブラリーを含むパス (該当する場合)。

[AIX]例えば、 AIX システム上の Db2 用のタイプ 2 ドライバーには、 /opt/IBM/db2/V9.5/lib32/からのライブラリーが必要です。 このプロパティーの代わりに、他の方法を使用して java.library.path システム・プロパティーを設定できます。

デフォルト値なし
wmqfte.file.logger.fileDirectory ファイル・ロガーのログ・ファイルを配置するディレクトリー。 mqft/logs/coordination_dir/loggers/logger_name/logs
wmqfte.file.logger.fileSize ログ・ファイルが大きくなることが許可される最大サイズ。 サイズの値は、ゼロより大きい正整数で、単位 KB、MB、GB、m (分)、h (時)、d (日)、w (週) のいずれか 1 つを後に付けます。 例えば、wmqfte.file.logger.fileSize=5MB は最大ファイル・サイズとして 5MBを指定し、wmqfte.file.logger.fileSize=2d は最大ファイル・サイズとして 2 日分のデータを指定します。 10MB
wmqfte.file.logger.fileCount 作成するログ・ファイルの最大数。 データ量がこの数のファイルに保管できる最大量を超えた場合、最も古いファイルが削除されます。そのため、ファイル数が指定された値より大きくなることはありません。 3
wmqfte.file.logger.mode 使用しているロガー・モード (circular または linear)。 この値を 循環または LINEARに設定します。
CIRCULAR - ファイル・ロガーは、wmqfte.file.logger.fileSize プロパティーを使用して定義される最大サイズにファイルが到達するまで、そのファイルに情報を書き込みます 最大サイズに到達すると、ファイル・ロガーは新規ファイルを開始します。 このモードで書き込まれるファイルの最大数は、wmqfte.file.logger.fileCount プロパティーを使用して定義される値によって制御されます。 このファイル最大数に到達すると、ファイル・ロガーは最初のファイルを削除して再作成し、それを現行のアクティブ・ファイルとして使用します。 wmqfte.file.logger.fileSize プロパティーに定義されている値が固定サイズのバイト単位 (例えば、KB、MB、または GB) である場合、このモードで使用されるディスク・スペースの上限は、fileSize に fileCount を乗算した値になります。 wmqfte.file.logger.fileSize プロパティーで定義された値が時間単位 (例えば、mhdw) の場合、最大サイズは、ご使用のシステムにおけるその時間内のログ・メッセージのスループットによって決まります。 このモードで実行される場合に使用されるログ・ファイル命名規則は、logger_namenumber-timestamp.log です。説明:
  • logger_name は、fteCreateLogger コマンドでロガーに付けられた名前です。
  • number は、セット内のファイルの番号です。
  • timestamp はは、ファイルが作成されたときのタイム・スタンプです。

例えば、LOGGER1-20111216123430147.log

LINEAR - ファイル・ロガーは、wmqfte.file.logger.fileSize プロパティーを使用して定義される最大サイズにファイルが到達するまで、そのファイルに情報を書き込みます。 最大サイズに到達すると、ファイル・ロガーは新規ファイルを開始します。 以前に書き込まれたファイルは削除されないため、それらをログ・メッセージの履歴レコードとして保持できます。 linear モードで実行している場合、ファイルは削除されず、作成可能なファイル数の上限もないため、wmqfte.file.logger.fileCount プロパティーは無視されます。 このモードで実行している場合には上限がないため、ディスク・スペースが少なくならないように、ログ・ファイルによって使用されているディスク・スペースの量を追跡する必要があります。 このモードで実行される場合に使用されるログ・ファイル命名規則は、logger_name-timestamp.log です。説明:
  • logger_name は、fteCreateLogger コマンドでロガーに付けられた名前です。
  • timestamp はは、ファイルが作成されたときのタイム・スタンプです。

例えば、LOGGER-20111216123430147.log

デフォルト値なし
wmqfte.max.retry.interval ロガーが永続エラーを検出した場合の、再試行間の最大時間 (ミリ秒)。

エラー条件によっては (例えば、データベース接続が失われた場合)、ロガーが続行できなくなります。 このタイプの条件が発生した場合、ロガーは現行トランザクションをロールバックし、ある一定の時間待機した後、再試行します。 ロガーの待機時間は最初非常に短いため、一時的なエラーであればすぐに克服できます。 しかし、ロガーの再試行のたびに、待機時間は増大します。 これにより、エラー条件がより長く続く場合、例えば、データベースが保守のためのサービス停止になっている場合に、あまりに多くの不要な作業が発生しないようになっています。

このプロパティーを使用して待機時間の長さに制限を設けると、エラー条件が解決される妥当な時間で再試行が発生します。

600
[MQ 9.2.0 Jul 2020]immediateShutdownTimeout

未処理の操作が完了して、適切にシャットダウンするのをロガーが待機する時間 (秒数)。 デフォルトでは、ロガーは操作が完了するまで 10 秒間待機します。 タイムアウトまでに操作が完了しない場合、ロガーは以下のイベント・メッセージを output0.log に書き込んでから終了します。

BFGDB0082I: The logger is ending immediately.

ゼロの値を指定すると、ロガーは現在の操作が完了するまで待機します。

immediateShutdownTimeout の値がゼロより小さい値に設定されている場合は、デフォルト値が使用されます。

このプロパティーは、スタンドアロン・データベース・ロガーとファイル・タイプ・ロガーの両方に適用されます。

10
[MQ 9.2.0 Jul 2020]loggerCredentialsKeyFile 資格情報の暗号化の際に使用される資格情報キーが含まれるファイルの名前。 ストリング・プロパティーにデフォルト値はありません。
loggerQMgrRetryInterval ロガーのプロセス・コントローラーがキュー・マネージャーの使用可否を検査する間隔 (秒単位)。 30
maxRestartCount maxRestartInterval プロパティーの値によって指定された時間間隔内に行える再開の最大回数。 この値を超えると、ロガーのプロセス・コントローラーはロガーの再開を中止し、その代わりに maxRestartDelay プロパティーの値に基づいたアクションを実行します。 4
maxRestartInterval ロガーのプロセス・コントローラーがロガーの再開数を測定する間隔 (秒単位)。 この間隔内に行われた再開の回数が maxRestartCount プロパティーの値を超過すると、ロガーのプロセス・コントローラーはそのロガーの再開を中止します。 ロガーのプロセス・コントローラーは、その代わりに maxRestartDelay プロパティーの値に基づいたアクションを実行します。 120
maxRestartDelay ロガーの再開率が maxRestartCount プロパティーおよび maxRestartInterval プロパティーの値を超過した場合にロガーのプロセス・コントローラーがとる動作を決定します。 ゼロ以下の値を指定すると、ロガーのプロセス・コントローラーは停止します。 ゼロより大きな値を指定した場合、この秒数だけ待機した後、ロガーのプロセス・コントローラーが保持する再開履歴情報がリセットされ、ロガーが再開されます。 -1
wmqfte.oracle.port ロガーが Oracle インスタンスへの接続に使用するポート。 このポートを TNS リスナーとも言います。 1521
wmqfte.oracle.host ロガーが Oracle インスタンスへの接続に使用するホスト。 localhost
armELEMTYPE オプションのプロパティー。 ロガーを自動リスタート・マネージャー (ARM) で再始動するように構成する場合は、関連付けられた ARM ポリシー内で指定された ARM ELEMTYPE パラメーター値をこのプロパティーに設定します。 ロガーの場合、ELEMTYPE は SYSBFGLG に設定します。 設定なし
armELEMENT オプションのプロパティー。 ロガーを自動リスタート・マネージャー (ARM) で再始動するように構成する場合は、関連付けられた ARM ポリシー内で指定された ARM ELEMENT パラメーター値をこのプロパティーに設定します。 ELEMENT 値には、ロガー名に対応する値を設定できます。 設定なし
loggerQMgrAuthenticationCredentialsFile ロガーの調整キュー・マネージャーに接続するための MQ 接続資格情報が入ったファイルへのパス。

[z/OS]認証資格情報ファイルの作成については、 z/OSでの MQMFTCredentials.xml の構成を参照してください。

[AIX、Linux、Windows]このファイルの場所と許可については、 MQMFTCredentials.xmlの構成を参照してください。

[AIX、Linux、Windows] MFT および IBM MQ 接続認証 (connection authentication)も参照してください。

トレース オプションのプロパティー。 ロガーの開始時にトレースを有効にしてロガーを実行するトレース仕様。 トレース仕様は、クラス、等号、およびトレース・レベルのコンマ区切りのリストです。

例えば、com.ibm.wmqfte.databaselogger、および com.ibm.wmqfte.databaselogger.operation=all です。

コロン区切りのリストで、複数のトレース仕様を指定できます。 例えば、com.ibm.wmqfte.databaselogger=moderate:com.ibm.wmqfte.databaselogger.operation=all

なし
traceFiles オプションのプロパティー。 保持するトレース・ファイルの合計数。 この値は、ロガーのプロセス・コントローラーに加え、ロガー自体にも適用されます。 5
traceSize オプションのプロパティー。 トレースが次のファイルで折り返す前の、各トレース・ファイルの最大サイズ (MB 単位)。 この値は、ロガーのプロセス・コントローラーとロガー自体に適用されます。 20
[MQ 9.2.0 Jul 2020]wmqfte.file.logger.filePermissions オプションのプロパティー。 ロガーのログ・ファイルに必要な権限の種類を指定するために使用します。

このプロパティーは、リニア・ログと循環ログの両方に適用され、値として UserReadWriteOnly または UserReadWriteAllRead を取ることができます。

UserReadWriteOnly 値には既存の同等の権限 600 があり、UserReadWriteAllRead 値には同等の権限 644 があります。

権限の変更は、新しく作成されたロガー・ファイルに適用されます。

無効なプロパティーに値を入力すると、ロガーはデフォルト値を使用し、メッセージ BFGDB0083W を出力ログに発行します。

UserReadWriteOnly

クライアント・モード SSL/TLS 接続のプロパティー

SSL/TLS を使用したロガー・キュー・マネージャーへのクライアント・モード接続をサポートするために必要なプロパティー。

表 2. logger.properties ファイルのクライアント・モード SSL/TLS 接続のプロパティー
プロパティー名 説明 デフォルト値
wmqfte.queue.manager.host ロガー・キュー・マネージャーのホスト名または IP アドレス。 デフォルト値なし
wmqfte.queue.manager.port ロガー・キュー・マネージャーが listen するポート。 1414
wmqfte.queue.manager.channel ロガー・キュー・マネージャーのサーバー接続チャネルの名前。 SYSTEM.DEF.SVRCONN
wmqfte.Ssl.CipherSuite

ロガーとロガー・キュー・マネージャーのデータ交換方法に関する TLS の動作を指定します。

wmqfte.Ssl.CipherSuite の値は CipherSuite 名です。 この CipherSuite 名は、ロガー・キュー・マネージャー・チャネルで使用される CipherSpec 名にマップされます。

詳しくは、 CipherSuite と CipherSpec の名前のマッピングを参照してください。

デフォルト値なし
wmqfte.Ssl.PeerName ロガー・キュー・マネージャーによって提供される名前と合致しなければならない識別名の骨組みを指定します。 その識別名に基づいて、接続時にキュー・マネージャーによって提示される識別用証明書が検査されます。 デフォルト値なし
wmqfte.Ssl.TrustStore ロガーが信頼する証明書の場所を指定します。 wmqfte.Ssl.TrustStore の値はファイル・パスです。

[Windows]If the file path is a Windows file path the backslash character (\) must be escaped with a further backslash character (\\).

このプロパティーの値には環境変数を含めることができる点にご注意ください。

デフォルト値なし
wmqfte.Ssl.TrustStoreCredentialsFile wmqfte.Ssl.TrustStore 資格情報が含まれているファイルのパス。

このプロパティーの値には環境変数を含めることができる点にご注意ください。

デフォルト値なし
wmqfte.Ssl.TrustStoreType 使用する SSL 鍵ストアのタイプ。 JKS および PKCS#12 の鍵ストアがサポートされています。 このプロパティーの値は、jks または pkcs12 のいずれかになります。 jks
wmqfte.Ssl.KeyStore ロガーの秘密鍵の場所を指定します。 wmqfte.Ssl.KeyStore の値はファイル・パスです。

[Windows]If the file path is a Windows file path the backslash character (\) must be escaped with a further backslash character (\\).

このプロパティーの値には環境変数を含めることができる点にご注意ください。

デフォルト値なし
wmqfte.Ssl.KeyStore.CredentialsFile wmqfte.Ssl.KeyStore 資格情報が含まれているファイルのパス。

このプロパティーの値には環境変数を含めることができる点にご注意ください。

デフォルト値なし
wmqfte.Ssl.KeyStoreType 使用する SSL 鍵ストアのタイプ。 JKS および PKCS#12 の鍵ストアがサポートされています。 このプロパティーの値は、jks または pkcs12 のいずれかになります。 jks
wmqfte.Ssl.FipsRequired ロガーのレベルで FIPS サポートを使用可能にすることを指定します。 このプロパティーの値は、true または false のいずれかになります。 詳しくは、 MFT での FIPS サポートを参照してください。 false