8 ロギング カスタム WLST コマンド

ロギング コマンドを使用して、ログ ファイルの設定をコンフィグレーション、およびログ ファイルを表示および検索します。表 8-1 では、ロギング コマンドの各種カテゴリを説明します。

ログ ファイルのコンフィグレーションおよび検索の詳細については、『Oracle Fusion Middleware 管理者ガイド』の「ログ ファイルおよび診断データの管理」を参照してください。

注意 : これらのコマンドを使用するには、コンポーネントがインストールされる Oracle ホームから WLST を呼び出す必要があります。『Oracle Fusion Middleware 管理者ガイド』の「カスタム WLST コマンドの使用」を参照してください。

表 8-1 ロギング コマンドのカテゴリ

コマンド カテゴリ	説明
ログのコンフィグレーション コマンド	ファイルに書き込まれる情報レベルやファイルの最大サイズなどのログ ファイルの設定をコンフィグレーションします。
検索および表示コマンド	Oracle Fusion Middleware ログ ファイルを表示し、特定のメッセージのログ ファイルを検索します。

ログのコンフィグレーション コマンド

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

表 8-2 ロギング コンフィグレーションのコマンド

コマンド	説明	WLST の使用状況
configureLogHandler	既存のログ ハンドラをコンフィグレーションし、新しいハンドラを追加または既存ハンドラを削除します。	オンライン
getLogLevel	指定したログ機能のレベルを取得します。	オンライン
listLoggers	ログ機能の一覧および各ログ機能のレベルを取得します。	オンライン
listLogHandlers	1 つまたは複数のログ ハンドラのコンフィグレーションを示します。	オンライン
setLogLevel	指定したログ機能のレベルを設定します。	オンライン

configureLogHandler

コマンド カテゴリ : ログ コンフィグレーション

WLST の使用状況 : オンライン

説明

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

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

構文

configureLogHandler(options)

引数	定義
options	オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです。 target — WebLogic server の名前または OPMN で管理されるコンポーネントを定義する文字列。OPMN で管理されるコンポーネントの詳細については、『コンポーネントのマニュアル』を参照してください。 デフォルト値は WLST が接続しているサーバです。 name — ログ ハンドラの名前。このオプションは必須です。 maxFileSize — ODL ハンドラのための maxFileSize 属性の値。この値は、オプションとして、サイズ単位を示す (キロバイト (k)、メガバイト (m)、ギガバイト (g)) サフィックスを付加した数値を表す文字列です。 サフィックスを指定しない場合、値がバイト単位で返されます。 maxLogSize — ODL ハンドラのための maxLogSize 属性の値。この値は、オプションとして、サイズ単位を示す (キロバイト (k)、メガバイト (m)、ギガバイト (g)) サフィックスを付加した数値を表す文字列です。 rotationFrequency — ODL ハンドラのローテーション頻度の値。この値は、オプションとして、時間単位を示すサフィックス (分 (m)、時 (h)、日 (d)) を付加した数値を表す文字列です。デフォルトの単位は分です。HOUR、HOURLY、DAY、DAILY、WEEK、WEEKLY、MONTH、MONTHLY の特定の値も使用でき、これらの値を分の数値に変換されます。 baseRotationTime — rotationFrequency オプションで使用する基本ローテーション時刻。値は、日付と時刻値を表す文字列である必要があります。これには、ISO 8601 日付と時間フォーマットで完全な日付と時間、または時間数および分数のみが含まれる短縮形を使用できます。デフォルトの baseRotationTime は 00:00 です。 retentionPeriod — ログ ファイルが保持される時間 (分単位)。この値は、オプションとして時間単位を示すサフィックス (分 (m)、時 (h)、日 (d)) を付加した数値を表す文字列でる必要があります。デフォルトの単位は分です。HOUR、HOURLY、DAY、DAILY、WEEK、WEEKLY、MONTH、MONTHLY の特定の値も使用でき、これらの値を分の数値に変換されます。 format — ODL ハンドラの形式。有効な値は「ODL-Text」または「ODL-XML」のいずれかです。デフォルト形式は ODL-Text です。 encoding — ログ ファイルの文字エンコーディング。 path—ログ ファイル パス。 handlerType — ハンドラ実装を提供する Java クラスの名前。これは、java.util.logging.Handler または oracle.core.ojdl.logging.HandlerFactory のインスタンスである必要があります。
options (続き)	propertyName — 追加または更新する詳細ハンドラ プロパティの名前。プロパティ値は、propertyValue オプションで指定します。有効なプロパティについては、ハンドラのマニュアルを参照してください。 propertyValue — propertyName オプションで定義されたハンドラのプロパティの新しい値。 addProperty — Jython ブール値。ハンドラに新しいプロパティが追加されることを定義するために propertyName および propertyValue オプションと組み合わせて使用します。 removeProperty — 削除する 1 つまたは複数のハンドラ プロパティの一覧。 addHandler — ブール値。値が true の場合、指名されたハンドラが追加されます。 removeHandler — ブール値。値が true の場合、指名されたハンドラが削除されます。 addToLogger — ログ機能名の一覧。ハンドラが指定したログ機能名に追加されます。 removeFromLogger — ログ機能名の一覧。指定したログ機能からハンドラが削除されます。

例

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

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

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

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

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

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

getLogLevel

コマンド カテゴリ : ログ コンフィグレーション

WLST の使用状況 : オンライン

説明

特定の Java ログ機能のレベルを返します。

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

構文

getLogLevel(options)

引数	定義
options	オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです。 target — WebLogic Server の名前または OPMN で管理されるコンポーネントを定義する文字列。OPMN で管理されるコンポーネントの詳細については、『コンポーネントのマニュアル』を参照してください。 デフォルト値は WLST が接続しているサーバです。 logger — ログ機能名。空の文字列はルート ログ機能を示します。 このオプションは必須で、デフォルト値はありません。 runtime — オペレーションは実行時ログ機能またはコンフィグレーション ログ機能をリストするかを決定する Jython ブール値 (0 または 1)。デフォルト値は 1 (実行時) です。

例

次の例では、ログ機能 Oracle のレベルを返します。

getLogLevel(logger='oracle')

次の例では、コンフィグレーション ログ機能のみを指定する場合、ログ機能 Oracle のレベルを返します。

getLogLevel(logger='oracle', runtime=0)

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

getLogLevel(logger='oracle', target='server2')

listLoggers

コマンド カテゴリ : ログ コンフィグレーション

WLST の使用状況 : オンライン

説明

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

構文

listLoggers([options])

引数	定義
options	オプションのカンマ区切りのリスト (省略可能)。名前と値のペアで指定します。有効なオプションは次のとおりです。 target — WebLogic Server の名前または OPMN で管理されるコンポーネントを定義する文字列。OPMN で管理されるコンポーネントの詳細については、『コンポーネントのマニュアル』を参照してください。 デフォルト値は WLST が接続しているサーバです。 pattern — ログ機能名をフィルタするために使用する正規表現パターン。デフォルト値はすべてのログ機能名を返します。 runtime — オペレーションは実行時ログ機能またはコンフィグレーション ログ機能をリストするかを決定する Jython ブール値 (0 または 1)。デフォルト値は 1です。

例

次の例では、すべてのログ機能を示します。

listLoggers()

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

listLoggers(pattern="oracle.*")

次の例では、すべてのコンフィグレーション ログ機能を表示します。

listLoggers(runtime=0)

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

listLoggers(target="server1")

listLogHandlers

コマンド カテゴリ : ログ コンフィグレーション

WLST の使用状況 : オンライン

説明

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

構文

listLogHandlers([options])

引数	定義
options	オプションのカンマ区切りのリスト (省略可能)。名前と値のペアで指定します。有効なオプションは次のとおりです。 target — WebLogic Server の名前または OPMN で管理されるコンポーネントを定義する文字列。OPMN で管理されるコンポーネントの詳細については、『コンポーネントのマニュアル』を参照してください。 デフォルト値は WLST が接続しているサーバです。 name — ログ ハンドラの名前。名前を指定しない場合、すべてのハンドラを表示します。

例

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

listLogHandlers()

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

listLogHandlers(name="odl-handler")

次の例では、WebLogic server server1 用のすべてのログ ハンドラを表示します。

listLogHandlers(target="server1")

setLogLevel

コマンド カテゴリ : ログ コンフィグレーション

WLST の使用状況 : オンライン

説明

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

構文

setLogLevel(options)

引数

定義

options

オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです。 target — WebLogic Server の名前または OPMN で管理されるコンポーネントを定義する文字列。OPMN で管理されるコンポーネントの詳細については、『コンポーネントのマニュアル』を参照してください。 デフォルト値は 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 (最低の重大度) までです。 このオプションは必須で、デフォルト値はありません。 runtime — オペレーションは実行時ログ機能またはコンフィグレーション ログ機能をリストするかを決定する Jython ブール値 (0 または 1)。デフォルト値は 1 (実行時) です。ターゲットは、変更する実行時ログ機能をサポートしない OPMN で管理されるコンポーネントである場合、このオプションが無視されます。 persist — レベルをコンフィグレーション ファイルに保存する必要があるかを決定する Jython ブール値 (0 または 1)。デフォルト値は 1 です。

例

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

setLogLevel(logger="oracle.my.logger", level="NOTICATION: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)

検索および表示コマンド

表 8-3 のコマンドを使用して、Oracle Fusion Middleware ログ ファイルを表示し、特定のメッセージのログ ファイルを検索します。

表 8-3 検索および表示コマンド

コマンド	説明	WLST の使用状況
displayLogs	1 つまたは複数のログを表示します。	オンラインまたはオフライン
listLogs	ログ ファイルの内容を検索し、表示します。	オンラインまたはオフライン

displayLogs

コマンド カテゴリ : 検索および表示

WLST の使用状況 : オンラインまたはオフライン

説明

診断ログ ファイルの内容を検索し、表示します。コマンドは、returnData オプションを true に設定した場合のみ値を返します。デフォルトでは、このコマンドによってデータは返されません。戻り値は使用するオプションによって異なります。

構文

displayLogs([searchString,][options])

引数	定義
searchString	省略可能な検索文字列。指定した文字列 (大文字と小文字は区別されない) を含むメッセージのみが返されます。 displayLogs コマンドでは、複数のフォーマットでログを読み込むことができ、ODL フォーマットにメッセージを変換できます。検索は、できるだけネイティブ フォーマットで実行されます。それ以外の場合、検索がメッセージ コンテンツ内に実行され、マークアップを除外する場合もあります。したがって、検索文字列でマークアップ文字の使用を避ける必要があります。
options	オプションのカンマ区切りのリスト (省略可能)。名前と値のペアで指定します。有効なオプションは次のとおりです。 target — WebLogic Server または OPMN で管理されるコンポーネントの名前。 OPMN で管理されるコンポーネントの場合、ターゲットの構文は、「opmn:instance-name/component-name」です。 接続モードでは、デフォルトのターゲットは WebLogic ドメインです。接続解除モードでは、デフォルト値がない、ターゲット オプションは必須です。 oracleInstance — 接続解除モードでは、ORACLE_INSTANCE (または WebLogic ドメイン ホーム) のパスを定義する。接続モードでは、このオプションが無視されます。 log — ログ ファイルのパス。コマンドは、指定したログ ファイルからメッセージを読み込みます。ログ ファイルのパスを指定しない場合、コマンドは、指定したターゲットに関連付けられるすべてのログを読み込みます。
options (続き)	last — 整数値。時間制限に達する数分前にログされたメッセージに検索を制限します。異なる時間単位を指定するために、値に「s」 (秒)、「m」 (分)、「h」 (時) または「d」 (日) のサフィックスを追加できます。(たとえば、last='2h' は最後の 2 時間として解釈されます)。 tail — 整数値。検索を各ログ ファイルからの最後の n メッセージに制限し、n に表示されるメッセージ数を制限します。 pattern — 正規表現パターン。特定のパターンを含むメッセージのみが返されます。パターン オプションの使用は、searchString 引数の使用と同様ですが、正規表現を使用できる点が異なります。 正規表現パターンの検索では大文字と小文字が区別されます。(パターンの大文字と小文字は区別されないフラグを明示的に有効にしない限り)。パターンは java.util.regex 構文に従う必要があります。 ecid — ログ メッセージのフィルタとして使用する 1 つまたは複数の実行コンテキスト ID (ECID) 値を含む文字列または文字列の系列。 component — ログ メッセージのフィルタとして使用する 1 つまたは複数のコンポーネント ID 値を含む文字列または文字列の系列。 module — ログ メッセージのフィルタとして使用する 1 つまたは複数のモジュール ID 値を含む文字列または文字列の系列。 type — ログ メッセージのフィルタとして使用する 1 つまたは複数のメッセージ タイプ値を含む文字列または文字列の系列。 app — ログ メッセージのフィルタとして使用する 1 つまたは複数のアプリケーション値を含む文字列または文字列の系列。 query — ログ メッセージのコンテンツをフィルタするために使用する式を指定する文字列。 単純な式の形式は次のとおりです。 field-name operator value field-name はログ レコード フィールド名で、operator はフィールド タイプに適する演算子です (たとえば、文字列フィールドのために equals、startsWith、contains または matches を指定できます)。 フィールド名は、標準 ODL 属性名 (COMPONENT_ID、MSG_TYPE、MSG_TEXT および SUPPL_DETAIL など) または SUPPL_ATTR というプレフィックスを付けた補足な属性名 (アプリケーション固有の) のいずれかです。(たとえば、SUPPL_ATTR.myAttribute)。 いくつかの一般的な補足な属性はプレフィックスなしで使用できます (たとえば、アプリケーション名でフィルタするために「APP」を使用できます)。 ブール演算子「and」、「or」および「not」を使用し複数の単純な式を組み合わせて複雑な式を作成することができます。そして、丸括弧を使用して式をグループ化できます。 クエリ構文の詳細については、『Oracle Fusion Middleware 管理者ガイド』を参照してください。 groupBy — 文字列のリスト。groupBy オプションを使用する場合、出力は文字列リストに定義された属性でグループしたログ メッセージの数です。 orderBy — 結果のソート順を定義する文字列のリスト。値はログ メッセージ属性の名前です。必要に応じて、名前に「:asc」または「:desc」のサフィックスを追加することで昇順または降順のソートを指定できます。デフォルトのソート順を昇順です。 デフォルトでは、結果は時間でソートされます。
options (続き)	format — 出力形式を定義する文字列。有効な値は、ODL-Text、ODL-XML、ODL-complete および simple です。デフォルト形式は ODL-Text です。 exportFile — コマンドの出力が書き込まれるファイル名。デフォルトでは、出力は標準出力に書き込まれます。 follow (f) — ログに新しいメセッジが追加されるとき、ログを引き続き読み込んでメセッジを表示するために、コマンドを「follow」モードに設定します。(UNIX の "tail -f" コマンドと同様)。f オプションを使用すると、コマンドによって値が返されません。現在、このオプションは OPMN で管理されるコンポーネントではサポートされていません。 returnData — Jython ブール値 (0 または 1)。値が true の場合、コマンドによってデータが返されます。(たとえば、スクリプトで使用するデータ)。デフォルト値が false で、コマンドによってデータが表示されるが、返されません。

例

次の例では、ドメインのすべてのログ ファイルから最後の 100 メッセージを表示します。

displayLogs(tail=100)

次の例では、最後の 15 分にログされるすべてのメッセージを表示します。

displayLogs(last='15m')

次の例では、指定した文字列を含むログ メッセージを表示します。

displayLogs('Exception')

次の例では、指定した ECID を含むログ メッセージを表示します。

displayLogs(ecid='0000Hl9TwKUCslT6uBi8UH18lkWX000002')

次の例では、ERROR または INCIDENT_ERROR タイプのログ メッセージを表示します。

displayLogs(type=['ERROR','INCIDENT_ERROR'])

次の例では、指定した Java EE アプリケーションのログ メッセージを表示します。

displayLogs(app="myApplication")

次の例では、OPMN で管理されるコンポーネント用のメッセージを表示します。

displayLogs(target="opmn:instance1/ohs1")

次の例では、コンポーネントとタイプでメッセージ概要を表示します。

displayLogs(groupBy=['COMPONENT_ID', 'MSG_TYPE'])

次の例では、特定の時間間隔のメッセージを表示します。

displayLogs(query="TIME from 11:15 and TIME to 11:20")

次の例では、詳細なクエリを示します。

displayLogs(query="TIME from 11:15 and TIME to 11:20 and ( MSG_TEXT contains 
exception or SUPPL_DETAIL contains exception )")

同じクエリを次のように記述すことができます。

displayLogs("exception", query="TIME from 11:15 and TIME to 11:20")

listLogs

コマンド カテゴリ : 検索および表示

WLST の使用状況 : オンラインまたはオフライン

説明

Oracle Fusion Middleware コンポーネントのログ ファイルの一覧を表示します。このコマンドは、ログごとに 1 つの要素を含む PyArray を返します。配列の要素は、各ログを記述する javax.management.openmbean.CompositeData オブジェクトです。

構文

listLogs([options]

引数

定義

options

オプションのカンマ区切りのリスト (省略可能)。名前と値のペアで指定します。有効なオプションは次のとおりです。 target — Weblogic server または OPMN で管理される Oracle Fusion Middleware コンポーネントの名前。OPMN で管理されるコンポーネントの場合、ターゲットの構文は、「opmn:instance-name/component-name」です。 接続モードでは、デフォルトのターゲットは WebLogic ドメインです。 接続解除モードでは、デフォルト値はない、ターゲット オプションは必須です。 oracleInstance — 接続解除モードでは、ORACLE_INSTANCE (または WebLogic ドメイン ホーム) のパスを定義する。接続モードでは、このオプションが無視されます。 unit — ファイル サイズの表示に使用する単位を定義する。有効な値は、B (バイト)、K (キロバイト)、M (メガバイト)、G (ギガバイト) または H (人間が判読可能な形式にサイズを表示する。UNIX の "ls -h" オプションと同様) です。デフォルト値は H です。 fullTime — Jython ブール値。true の場合は、ログ ファイルの最終更新日時の全時間をレポートします。それ以外の場合、時間の短くバージョンを表示します。デフォルト値は false です。

例

次の例では、WebLogic ドメインのすべてのログ ファイルの一覧を表示します。

listLogs()

次の例では、WebLogic server server1 用のログ ファイルの一覧を表示します。

listLogs(target="server1")

次の例では、Oracle HTTP Server ohs1 用のログ ファイルの一覧を表示します。

listLogs(target="opmn:instance1/ohs1")

接続解除モードで使用する次の例では、WebLogic server server1 用のログ ファイルの一覧を表示します

listLogs(oracleInstance="/middleware/user_projects/domains/base_domain",
           target="server1")