7.1 ログの構成コマンド

表7-2のコマンドを使用して、ファイルに書き込まれる情報レベルやファイルの最大サイズなどのログ・ファイルの設定を構成します。WLST列で使用する場合は、オンラインとは、コマンドが実行中のサーバーに接続されている場合のみに使用されることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表7-2 ロギング構成のコマンド

使用するコマンド	用途	使用するWLST
configureLogHandler	既存のログ・ハンドラを構成し、新しいハンドラを追加または既存ハンドラを削除します。	オンライン
getLogLevel	指定したロガーのレベルを取得します。	オンライン
listLoggers	ロガーの一覧および各ロガーのレベルを取得します。	オンライン
listLogHandlers	1つまたは複数のログ・ハンドラの構成を示します。	オンライン
setLogLevel	指定したロガーのレベルを設定します。	オンライン

7.1.1 configureLogHandler

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

既存のJavaロギング・ハンドラを構成し、新しいハンドラを追加、既存のハンドラを削除します。ハンドラごとに1つのエントリを持つjava.util.Listを返します。各エントリは、ハンドラを記述するjavax.management.openmbean.CompositeDataオブジェクトです。

このコマンドを使用して、ログ・ファイルの場所、ログ・ファイルのローテーション頻度および他のログ・ファイルのプロパティを変更できます。

構文

configureLogHandler([target,] name [, maxFileSize] [,maxLogSize] [, rotationFrequency] 
 [, baseRotationTime] [, retentionPeriod] [, format] [, encoding] [, path] 
 [, handlerType] [, propertyName] [, propertyValue] [, addProperty] 
 [, removeProperty] [, addHandler] [, removeHandler] [, level] [, addToLogger] 
 [, removeFromLogger] [, useParentHandlers]  )

引数	説明
target	オプション。WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。デフォルト値はWLSTが接続しているサーバーです。
name	必須。ログ・ハンドラの名前。
maxFileSize	オプション。ODLハンドラの最大ファイル・サイズの値。この値は数値を表す文字列で、オプションとしてサイズ単位を示す接尾辞(キロバイトは`k`、メガバイトは`m`、ギガバイトは`g`)が付加されます。接尾辞を指定しない場合、値がバイト単位で返されます。このオプションはQuickTraceハンドラには適用されないことに注意してください。
maxLogSize	オプション。ODLハンドラの最大ログ・ファイルのサイズの値。この値は数値を表す文字列で、オプションとしてサイズ単位を示す接尾辞(キロバイトは`k`、メガバイトは`m`、ギガバイトは`g`)が付加されます。このオプションはQuickTraceハンドラには適用されないことに注意してください。
rotationFrequency	オプション。ODLハンドラのローテーション頻度の値。この値は数値を表す文字列で、オプションとして時間単位を示す接尾辞(分は`m`、時間は`h`、日は`d`)が付加されます。デフォルトの時間単位は分(m)です。特殊な値(HOUR、HOURLY、DAY、DAILY、WEEK、WEEKLY、MONTH、MONTHLY)も使用でき、分単位の数値に変換されます。このオプションはQuickTraceハンドラには適用されないことに注意してください。
baseRotationTime	オプション。rotationFrequencyオプションとともに使用されるベース・ローテーション時間。値は、日付と時刻値を表す文字列である必要があります。これには、ISO 8601日付と時間フォーマットで完全な日付と時間、または時間数および分数のみが含まれる短縮形を使用できます。デフォルトのbaseRotationTimeは00:00です。このオプションはQuickTraceハンドラには適用されないことに注意してください。
retentionPeriod	オプション。ログ・ファイルが保持される時間。この値は数値を表す文字列である必要があり、オプションとして時間単位を示す接尾辞(分は`m`、時間は`h`、日は`d`)が付加されます。デフォルトの時間単位は分(m)です。特殊な値(HOUR、HOURLY、DAY、DAILY、WEEK、WEEKLY、MONTH、MONTHLY)も使用でき、分単位の数値に変換されます。このオプションはQuickTraceハンドラには適用されないことに注意してください。
format	オプション。ODLハンドラのフォーマット。有効な値は「ODL-Text」または「ODL-XML」のいずれかです。デフォルト形式はODL-Textです。
encoding	オプション。ログ・ファイルのキャラクタ・エンコーディング。
path	オプション。ログ・ファイルのパス。このオプションはQuickTraceハンドラには適用されないことに注意してください。
handlerType	オプション。ハンドラの実装を用意しているJavaクラスの名前。これは、java.util.logging.Handlerまたはoracle.core.ojdl.logging.HandlerFactoryのインスタンスである必要があります。
propertyName	オプション。追加または更新される拡張ハンドラ・プロパティの名前。プロパティ値は、propertyValueオプションで指定します。有効なプロパティについては、ハンドラのドキュメントを参照してください。
propertyValue	オプション。propertyNameオプションで定義されたハンドラ・プロパティの新規の値。
addProperty	オプション。Jythonブール値。ハンドラに新しいプロパティが追加されることを定義するためにpropertyNameおよびpropertyValueオプションと組み合せて使用します。
removeProperty	オプション。1つ以上の削除対象ハンドラ・プロパティのリスト。
addHandler	オプション。ブール値。値がtrueの場合、指名されたハンドラが追加されます。
removeHandler	オプション。ブール値。値がtrueの場合、指名されたハンドラが削除されます。
level	オプション。JavaまたはODLレベル値。ハンドラ・レベルが指定のレベルに設定されます。
addToLogger	オプション。ログ出力名のリスト。ハンドラが指定したロガー名に追加されます。
removeFromLogger	オプション。ログ出力名のリスト。指定したロガーからハンドラが削除されます。
useParentHandlers	オプション。ブール値。addToLoggerまたはremoveFromLoggerオプションによって定義されるロガーにuseParentHandlersフラグを設定します。

次の表では、quicktrace-handlerのプロパティを示します。このハンドラにより、特定のロガーのメッセージをトレースし、メモリー内にそれらのメッセージを格納できます。詳細は、『Oracle Fusion Middlewareの管理』のQuickTraceの構成に関する項を参照してください。

QuickTraceプロパティ	説明
bufferSize	循環QuickTraceバッファのおおよそのサイズ。ログ・レコードは、メモリー内のこのバッファに格納されます。実際のメモリー消費量は、この値より少なくなることはありますが、多くなることはありません。
enableDMSMetrics	trueに指定された場合、quicktrace-handlerに対してDMSメトリックが有効になります。デフォルトは、trueです。
enableUserBuffer	trueに指定された場合、ハンドラは、reserveBufferUserIDプロパティで指定されているユーザーごとに個別のバッファを維持します。reserveBufferUserIDプロパティでユーザーが定義されていない場合、メッセージはCOMMONバッファにキャッシュされます。 falseに指定された場合、ハンドラは、COMMONという1つのバッファのみを維持します。デフォルトはfalseです。
flushOnDump	trueに指定された場合、executeDumpコマンドを実行すると、バッファがフラッシュされます。デフォルトは、trueです。
includeMessageArguments	trueに指定された場合、メッセージIDを持つフォーマット済ログ・メッセージにメッセージ引数が含まれます。デフォルトはfalseです。
maxFieldLength	メッセージ内の各フィールドの最大長(バイト単位)。フィールドには、メッセージ・テキスト、サプリメンタル属性、スレッド名、ソース・クラス名、ソース・メソッド名およびメッセージ引数が含まれます。デフォルトは240バイトです。小さい数値を指定すると、メッセージに対して戻される情報の量を制限することができます。非常に大きな数値を指定すると、各メッセージでより多くのバイトが使用されるため、バッファ内のログ・レコードの量を削減できます。
reserveBufferUserID	カンマで区切られた、ユーザーIDのリスト。enableUserBufferがtrueに指定された場合、そのユーザーに関連するすべてのログ・メッセージは別のバッファに書き込まれます。
supplementalAttributes	サプリメンタル属性名のリスト。属性は、logging.xmlファイルにリストされます。サプリメンタル属性の設定には、追加のメモリーまたはCPU時間が必要になります。
useDefaultAttributes	trueに指定された場合、デフォルトの属性値が各ログ・メッセージに追加されます。デフォルト属性は、HOST_ID、HOST_NWADDRおよびUSER_IDです。
useLoggingContext	trueに指定された場合、ログ・メッセージにはDMSロギング・コンテキスト属性が含まれます。デフォルトはfalseです。このオプションを有効にした場合、トレースでは追加のCPU時間が必要になります。
useRealThreadID	trueに指定された場合、ハンドラは、jave.util.logging.logRecordによって提供されるスレッドIDではなく、実際のスレッドIDを使用しようとします。デフォルトはfalseです。このオプションを有効にした場合、トレースでは追加のCPU時間が必要になります。
useThreadName	trueに指定された場合、ログ・メッセージにはスレッドIDではなく、スレッド名が含まれます。デフォルトはfalseです。

例

次の例では、odlハンドラの最大ファイル・サイズを指定します。

configureLogHandler(name="odl-handler", maxFileSize="5M")

次の例では、odlハンドラのローテーション頻度を指定します。

configureLogHandler(name="odl-handler", rotationFrequency="daily")

次の例では、odlハンドラのローテーション頻度および保存期間を指定します。さらに、maxFileSizeプロパティを削除します。

configureLogHandler(name="odl-handler", rotationFrequency="daily", 
         retentionPeriod="week", removeProperty='maxFileSize'])

次の例では、quicktrace-handlerを構成します。ロガーoracle.adf.facesを追加し、user1およびuser2に対してユーザー・バッファを有効にします。

configureLogHandler(name="quicktrace-handler", addToLogger="oracle.adf.faces",
       propertyName="enableUserBuffer", propertyValue="true",
      propertyName="reserveBufferUserID", propertyValue="user1, user2")

oracle.adfロガーは、ハンドラodl-handler、wls-domainおよびconsole-handlerに関連付けられています。ロガーのレベルを設定すると、これらのハンドラは、ロガーoracle.adfに対して同じレベル(TRACE:1)を使用します。結果として、ログ・ファイルに多くの情報が書き込まれ、リソースが消費されることになります。リソースの消費を避けるためには、ハンドラのレベルを、WARNINGまたはINFORMATIONなど、より低いレベルに設定します。例:

configureLogHandler(name="odl-handler", level="WARNING:1")
configureLogHandler(name="wls-domain", level="WARNING:1")
configureLogHandler(name="console-handler", level="WARNING:1")

7.1.2 getLogLevel

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

特定のJavaロガーのレベルを返します。

戻り値は、ロガーのレベルを示す文字列で、ロガーが存在しない場合はNoneです。空の文字列は、ロガー・レベルがNullになることを示します。

構文

getLogLevel( [target,] logger [, runtime] )

引数

説明

target

オプション。WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。

デフォルト値はWLSTが接続しているサーバーです。

logger

ロガーの名前。空の文字列はルート・ロガーを示します。

このオプションは必須で、デフォルト値はありません。

runtime

オプション。操作によりランタイム・ロガーと構成ロガーのどちらがリストされるかを決定するJythonブール値(0または1)。デフォルト値は1 (実行時)です。

例

次の例では、ロガーOracleのレベルを返します。

getLogLevel(logger='oracle')
NOTIFICATION:1

次の例では、ラインタイム・ロガーではなく、構成ロガーのみを指定して、ロガーOracleのレベルを戻します。

getLogLevel(logger='oracle', runtime=0)
NOTIFICATION:1

次の例では、Oracle WebLogic Server server2上のロガーOracleのレベルを返します。

getLogLevel(logger='oracle', target='server2')
NOTIFICATION:1

7.1.3 listLoggers

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

Javaロガーおよびそれらのレベルを示します。このコマンドは、キーはロガー名であり、関連付けられた値はロガー・レベルであるPyDictionaryオブジェクトを返します。空のレベルは、ロガーにレベル・セットはないことを示すために使用されます。

構文

listLoggers([target] [, pattern] [,runtime])

引数

説明

target

デフォルト値はWLSTが接続しているサーバーです。

pattern

runtime

例

次の例では、すべてのロガーを示します。

listLoggers()

次の例では、「oracle.*」という名前で開始するすべてのロガーを表示します。

listLoggers(pattern="oracle.*")

次の例では、すべての構成ロガーを表示します。

listLoggers(runtime=0)

次の例では、WebLogic Server server1のすべてのロガーを一覧表示します。

listLoggers(target="server1")

7.1.4 listLogHandlers

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

Javaログ・ハンドラ構成を示します。このコマンドは、ハンドラごとに1つのエントリを持つjava.util.Listを返します。各エントリは、ハンドラを記述するjavax.management.openmbean.CompositeDataオブジェクトです。

構文

listLogHandlers([target] [, name])

引数

説明

target

デフォルト値はWLSTが接続しているサーバーです。

name

オプション。ログ・ハンドラの名前。名前を指定しない場合、すべてのハンドラを表示します。

例

次の例では、すべてのログ・ハンドラの一覧を表示します。

listLogHandlers()

次の例では、「odl-handler」という名前のログ・ハンドラをすべて表示します。

listLogHandlers(name="odl-handler")

次の例では、WebLogic Server server1のすべてのログ・ハンドラを一覧表示します。

listLogHandlers(target="server1")

7.1.5 setLogLevel

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

特定のJavaロガーによってログ・ファイルに書き込まれた情報のレベルを設定します。

構文

setLogLevel([target,] logger [, addlogger] , level [, runtime] [, persist] )

引数	説明
target	オプション。WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。デフォルト値はWLSTが接続しているサーバーです。
logger	ロガーの名前。空の文字列はルート・ロガーを示します。このオプションは必須で、デフォルト値はありません。addLoggerオプションを使用しないかぎり、ロガーが存在しない場合このコマンドによって例外が送出されます。
addLogger	オプション。ログ出力が存在しない場合に作成する必要があるかどうかを決定するJythonブール値(0または1)。このオプションは、ランタイム・モードに対しては非推奨です。ロガーはガベージ・コレクションされる可能性があるため、ランタイム・ロガーの追加が何の効果もないことがあります。まだ作成されていないロガーのレベルを設定する必要がある場合は、永続モードを使用します。
level	レベル名。これは、JavaレベルまたはODLレベルのどちらかです。有効なJavaレベルは次のとおりです。SEVERE、WARNING、INFO、CONFIG、FINE、FINERまたはFINEST。有効なODLレベルには、コロンおよびメッセージ・レベルを付加したメッセージ・タイプが含まれます。有効なODLメッセージ・タイプは次のとおりです。INCIDENT_ERROR、ERROR、WARNING、NOTIFICATION、TRACEおよびUNKNOWN。メッセージ・レベルは、メッセージ・タイプを修飾する整数値で表現されます。指定できる値は、1 (最高の重大度)から32 (最低の重大度)までです。空の文字列を使用すると、レベルをnullに設定できます(親から継承)。このオプションは必須で、デフォルト値はありません。
runtime	オプション。操作によりランタイム・ロガーと構成ロガーのどちらがリストされるかを決定するJythonブール値(0または1)。デフォルト値は1 (実行時)です。ターゲットが、変化するランタイム・ロガーをサポートしないシステム・コンポーネントである場合、このオプションは無視されます。注意: ランタイム・ロガーはガベージ・コレクションされる可能性があるため、ランタイム・ロガーのレベルの変更は、ロガーが存在しており、かつそのロガーへの強参照があることがわかっている場合にのみ行うようにしてください。ロガーがガベージ・コレクションされた場合、ランタイム・モードでロガー・レベルに加えられた永続的ではない変更は、すべて失われる可能性があります。
persist	オプション。レベルを構成ファイルに保存するかどうかを決定するJythonブール値(0または1)。値0はレベルが保存されることを示し、値1は保存されないことを示します。デフォルト値は1です。

例

次の例では、ロガーoracle.my.loggerのためにログ・レベルをNOTIFICATION:1に設定します。

setLogLevel(logger="oracle.my.logger", level="NOTIFICATION:1")

次の例では、ロガーoracle.my.loggerのためにログ・レベルをTRACE:1に設定し、レベルは構成ファイルに保存する必要があることを指定します。

setLogLevel(logger="oracle.my.logger", level="TRACE:1", persist=0)

次の例では、WebLogic Server server1上の構成ロガーoracle.my.loggerに対するログ・レベルをWARNINGに設定します。

setLogLevel(target="server1", logger="oracle.my.logger", level="WARNING", runtime=0)