Liberty でのバイナリー・ロギングの構成

この情報は、 Libertyでバイナリー・ロギングを構成するためのガイドとして使用してください。

このタスクについて

バイナリー・ロギングは、ログおよびトレースの処理機能を高速化し、ログおよびトレースの内容をデフォルトの Liberty ログおよびトレース・フレームワークよりも柔軟に使用できるようにします。

サーバー構成は、bootstrap.properties ファイル、server.xml ファイル、およびそれらのファイルにインクルードされている (オプションの) ファイルから成ります。 bootstrap.properties ファイルは、メイン構成の処理前に使用可能にする必要がある、最小限に抑えられたプロパティーを指定します。 server.xml ファイルは、サーバーの主要な構成ファイルです。

server.xml ファイルとその関連ファイルは、多くのテキスト・エディターに適合する単純な xml 形式を使用します。

bootstrap.properties ファイルで、サーバーがログおよびトレース・フレームワークとしてバイナリー・ロギングを使用するか、デフォルトのログおよびトレース・フレームワークを使用するかを指定します。 バイナリー・ロギングとデフォルトのログおよびトレースのフレームワークを切り替えるには、サーバーの再始動が必要です。

バイナリー・ロギングの構成は、サーバー構成ファイルまたは bootstrap.properties ファイルを通して変更できます。
  • サーバー構成ファイル: ユーザー独自のコード (サーバー構成の処理後にロードされる) からログを取得するには、サーバー構成ファイルを使用してバイナリー・ロギングを構成します。
  • bootstrap.properties ファイル: サーバー構成ファイルの処理前にロギング・プロパティーが有効になるように設定する必要が生じる場合があります。 例えば、サーバーの始動または構成処理の初期に発生する問題の分析が必要な場合などです。 この場合は、bootstrap.properties ファイルでバイナリー・ロギングを構成できます。

ロギング・プロパティーは、bootstrap.properties ファイルまたは server.xml ファイルで設定することができます。 server.xml ファイルでは属性を使用し、bootstrap.properties ファイルでは同等のプロパティーを使用します。 bootstrap.properties ファイル内のすべての設定は、サーバーが bootstrap.properties ファイルを読み取ってから、server.xml ファイルが処理されるまで使用されます。 bootstrap.properties ファイルのロギング・プロパティーが server.xml ファイルで置換または再設定されない場合、 bootstrap.properties ファイルのプロパティー値が引き続き使用されます。

バイナリー・ロギングが有効になっている場合、 maxFileSize、 maxFiles、 messageFileName、 traceFileName、および traceFormat の各ロギング・エレメント属性は無視されます (バイナリー・ロギングは trace.log ファイルと messages.log ファイルなしで実行されるため)。 traceSpecification 属性、consoleLogLevel 属性、 logDirectory 属性、および hideMessage 属性は、トレース仕様、コンソール・ログのレベル、ログ・ファイルとトレース・ファイルの配置、ならびに console.log ファイルで非表示にするメッセージの構成を設定するために引き続き使用されます。

server.xml ファイル内でロギング属性またはバイナリー・ロギング属性を設定した場合、bootstrap.properties ファイル内の該当するプロパティーを同じ値に設定することで、起動時とランタイム時の、構成における変更を避けることができます。 ロギング・プロパティーまたはバイナリー・ロギング・プロパティーが bootstrap.properties ファイルに設定されていない場合、サーバーがデフォルトのロギング設定を使用します。

手順

  • bootstrap.properties ファイルを更新して、サーバーのバイナリー・ロギングを有効にします。
    bootstrap.properties ファイルで、次のテキストを単独で 1 行に追加します。
    websphere.log.provider=binaryLogging-1.0
  • バイナリー・ロギングの構成には、以下のパラメーターを使用します。
    リストされたサブエレメントはすべて、server.xml ファイルのロギング・エレメントのサブエレメントです。
    以下の表に、server.xml ファイルで構成可能な属性と、bootstrap.properties ファイルで設定可能な同等のプロパティーをリストします。
    表 1. server.xml で構成可能なバイナリー・ロギング属性と bootstrap.properties で設定可能な同等のプロパティー
    ロギングのサブエレメント 属性 同等の bootstrap.properties プロパティー
    binaryLog

    purgeMaxSize

    purgeMinTime

    fileSwitchTime

    bufferingEnabled

    outOfSpaceAction

    		 
    com.ibm.hpel.log.purgeMaxSize  
    com.ibm.hpel.log.purgeMinTime  
    com.ibm.hpel.log.fileSwitchTime  
    com.ibm.hpel.log.bufferingEnabled 
    com.ibm.hpel.log.outOfSpaceAction
    binaryTrace

    purgeMaxSize

    purgeMinTime

    fileSwitchTime

    bufferingEnabled

    outOfSpaceAction

    		 
    com.ibm.hpel.trace.purgeMaxSize
    com.ibm.hpel.trace.purgeMinTime 
    com.ibm.hpel.trace.fileSwitchTime  
    com.ibm.hpel.trace.bufferingEnabled
    com.ibm.hpel.trace.outOfSpaceAction
    以下の例は、バイナリー・ロギングを使用可能にするように構成した bootstrap.properties ファイルを示しています。
    websphere.log.provider=binaryLogging-1.0
    以下の例は、バイナリー・ロギング・サブエレメントを指定した server.xml ファイルを示しています。 ログ・コンテンツは 96 時間後に期限切れになり、トレース・コンテンツには最大 1024 MB を保存するように、それぞれ設定されています。
    <server description="new server">

    <logging>
        <binaryLog purgeMinTime="96"/>
        <binaryTrace purgeMaxSize="1024"/>
    </logging>

</server>

    完全なロギング構成のリファレンスについては、 Liberty カーネルの logging エレメントを参照してください。 binaryLog エレメントおよび binaryTrace エレメントについて詳しくは、 バイナリー・ロギングを参照してください。

結果

サーバーを再始動すると、バイナリー・ロギングが使用可能になって構成されます。