1. インフラストラクチャ・コンポーネントのためのWLSTコマンド・リファレンス
  2. ロギング・カスタムWLSTコマンド

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

ログ・ファイルの設定の構成、およびログ・ファイルの表示と検索には、カスタムWLSTロギング・コマンドを使用します。

この章では、ログ・ファイルの構成および検索のためのコマンドの構文および引数を説明し、コマンドの例を示します。

ログ・ファイルの構成および検索の詳細は、『Oracle Fusion Middlewareの管理』のログ・ファイルと診断データの管理に関する項を参照してください。

次のトピックでは、ロギング・コマンドの様々なカテゴリについて説明します。

  • ログ構成コマンド
    WLSTログ構成コマンドを使用すると、ファイルに書き込まれる情報のレベルやファイルの最大サイズなど、ログ・ファイルの設定を構成できます。
  • 検索および表示コマンド
    WLSTロギング・コマンドを使用すると、ログ・ファイルの検索やログ・ファイル内の情報の表示が可能です。
  • 選択的トレース・コマンド
    選択的トレースにより、リクエストで指定されたユーザーまたは他のプロパティに対するきめ細かいロギングを実行できます。WLST選択的トレース・コマンドでは、選択的トレースを構成および使用できます。

ログの構成コマンド

WLSTログ構成コマンドでは、ファイルに書き込まれる情報のレベルやファイルの最大サイズなど、ログ・ファイルの設定を構成できます。

次の項のコマンドを使用して、ログ・ファイルの設定を構成します。

  • オンライン - 実行中のサーバーに接続されているときにのみ、そのコマンドを使用できることを示します。

  • オフライン - 実行中のサーバーに接続されていないときにのみ、そのコマンドを使用できることを示します。

  • オンラインまたはオフライン - どちらの場合にもそのコマンドを使用できることを示します。

  • configureLogHandler
    このコマンドは、既存のログ・ハンドラの構成、新しいハンドラの追加または既存のハンドラの削除に使用します。
  • getLogLevel
    このコマンドは、特定のロガーのレベルを取得するために使用します。
  • listLoggers
    このコマンドは、ロガーのリストおよび各ロガーのレベルを取得するために使用します。
  • listLogHandlers
    このコマンドは、1つ以上のログ・ハンドラの構成をリストします。
  • setLogLevel
    このコマンドは、特定のロガーのレベルを設定するために使用します。

親トピック: ロギング・カスタムWLSTコマンド

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")

親トピック: ログの構成コマンド

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

親トピック: ログの構成コマンド

listLoggers

このコマンドは、ロガーのリストおよび各ロガーのレベルを取得するために使用します。

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

WLSTでの使用: オンライン

説明

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

構文

listLoggers([target] [, pattern] [,runtime])
引数 定義

target

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

デフォルト値は、WLSTの接続先となるサーバーです。

pattern

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

runtime

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

例

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

listLoggers()

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

listLoggers(pattern="oracle.*")

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

listLoggers(runtime=0)

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

listLoggers(target="server1")

親トピック: ログの構成コマンド

listLogHandlers

このコマンドは、1つ以上のログ・ハンドラの構成をリストします。

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

WLSTでの使用: オンライン

説明

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

構文

listLogHandlers([target] [, name])
引数 定義

target

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

デフォルト値は、WLSTの接続先となるサーバーです。

name

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

例

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

listLogHandlers()

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

listLogHandlers(name="odl-handler")

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

listLogHandlers(target="server1")

親トピック: ログの構成コマンド

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)

親トピック: ログの構成コマンド

検索および表示コマンド

WLSTロギング・コマンドでは、ログ・ファイルの検索やログ・ファイル内の情報の表示が可能です。

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

  • displayLogs
    このコマンドは、1つ以上のコンポーネントのログをリストします。
  • listLogs
    このコマンドは、ログ・ファイルの内容を検索して表示するために使用します。

親トピック: ロギング・カスタムWLSTコマンド

displayLogs

このコマンドは、1つ以上のコンポーネントのログをリストします。

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

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

説明

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

構文

displayLogs([searchString,][target] [, oracleInstance] [, log] [, last] [, tail]
[, pattern] [, ecid] [, component] [, module] [, type] [, app] [, query] [, groupBy]
[, orderBy [, returnData] [, format] [, exportFile] [, follow])
引数 定義

searchString

オプションの検索文字列。指定した文字列(大文字と小文字は区別されない)を含むメッセージのみが返されます。

displayLogsコマンドでは、複数のフォーマットでログを読み込むことができ、ODLフォーマットにメッセージを変換できます。検索は、可能な場合はネイティブ書式で実行されます。それ以外の場合、検索がメッセージ・コンテンツ内に実行され、マークアップを除外する場合もあります。したがって、検索文字列でマークアップ文字の使用を避ける必要があります。

target

オプションです。WebLogic Serverインスタンス、またはシステム・コンポーネントの名前。

システム・コンポーネントの場合、ターゲットの構文は次のとおりです: 

sc:component-name

接続モードでは、デフォルトのターゲットはWebLogicドメインです。接続解除モードでは、デフォルト値がない、ターゲット・オプションは必須です。

oracleInstance

オプションです。ORACLE_INSTANCEまたはWebLogicドメイン・ホームへのパスを定義します。このパラメータを使用すると、コマンドは接続解除モードで実行されます。

log

オプションです。ログ・ファイルのパス。コマンドは、指定されたログ・ファイルからメッセージを読み取ります。ログのファイル・パスが指定されない場合、コマンドは指定されたターゲットに関連付けられているすべてのログを読み取ります。

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の管理』のWLSTを使用したログ・ファイルの検索に関する項を参照してください。

groupBy

オプションです。文字列リスト。groupByオプションを使用する場合、出力は文字列リストに定義された属性でグループしたログ・メッセージの数です。

orderBy

オプションです。結果のソート順序を定義する文字列リスト。値はログ・メッセージの属性名です。必要に応じて、名前に:ascまたは:descの接尾辞を追加することで昇順または降順のソートを指定できます。デフォルトのソート順序は昇順です。

デフォルトでは、結果は時間でソートされます。

returnData

オプションです。Jythonブール値(0または1)。この値がtrueの場合、このコマンドは(たとえば、スクリプトで使用される)データを返します。デフォルト値がfalseです。つまり、コマンドはデータを表示するだけで、戻しません。

format

オプションです。出力形式を定義する文字列。有効な値は、ODL-Text、ODL-XML、ODL-completeおよびsimpleです。デフォルト形式はODL-Textです。

exportFile

オプションです。コマンド出力が書き込まれるファイルの名前。デフォルトでは、出力は標準出力に書き込まれます。

follow (f)

オプションです。コマンドで引き続きログを読み取り、新規メッセージがログに追加された際にメッセージを表示するために、コマンドをフォロー・モードに設定します(Unixのtail -fコマンドと同様)。fオプションが使用されている場合、このコマンドは値を返しません。このオプションは、現在システム・コンポーネントではサポートされていません。

例

次の例では、ドメインのすべてのログ・ファイルから最後の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")

次の例では、システム・コンポーネントohs1のメッセージを表示します。

displayLogs(target="sc: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([target] [, oracleInstance] [, unit] [, fullTime]
引数 定義

target

オプションです。WebLogic ServerインスタンスまたはOracle Fusion Middlewareシステム・コンポーネントの名前。

システム・コンポーネントの場合、ターゲットの構文は次のとおりです: 

sc: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="sc:ohs1")

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

listLogs(oracleInstance="/scratch/Oracle/domains/base_domain",
           target="server1")

親トピック: 検索および表示コマンド

選択的トレース・コマンド

選択的トレースにより、指定されたユーザーまたはリクエストの他のプロパティに対するきめ細かいロギングを実行することができます。WLST選択的トレース・コマンドでは、選択的トレースを構成および使用できます。

次の項のコマンドを使用して、選択的トレースを構成および使用します。

WLSTでの使用によっては、コマンドがオンラインの場合、コマンドを使用できるのは実行中のサーバーに接続されているときのみになります。

  • configureTraceProvider
    このコマンドは、トレース・プロバイダを構成するために使用します。
  • configureTracingLoggers
    このコマンドは、選択的トレースの1つ以上のロガーを構成するために使用します。
  • listActiveTraces
    このコマンドは、アクティブなトレースをリストします。
  • listTraceProviders
    このコマンドは、トレース・プロバイダをリストします。
  • listTracingLoggers
    このコマンドは、選択的トレースをサポートするロガーをリストします。
  • startTracing
    このコマンドは、選択的トレース・セッションを開始するために使用します。
  • stopTracing
    このコマンドは、1つ以上の選択的トレース・セッションを停止するために使用します。

親トピック: ロギング・カスタムWLSTコマンド

configureTraceProvider

このコマンドは、トレース・プロバイダを構成するために使用します。

コマンド・カテゴリ: 選択的トレース

WLSTでの使用: オンライン

説明

トレース・プロバイダを構成します。現在は、プロバイダの有効化または無効化のオプションのみを使用できます。

構文

configureTraceProvider([target,] name, action)
引数 定義

target

オプションです。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ターゲットは、JRFが有効化されたドメイン内の実行中のすべてのサーバーです。

name

必須。トレース・プロバイダ名。

action

プロバイダのトレースを有効または無効にします。有効な値はenableおよびdisableです。このオプションは必須で、デフォルト値はありません。

例

次の例では、ドメイン内の実行中のすべてのサーバーでDMSトレースを無効化します。 

configureTraceProvider(name='DMS', action='disable')

次の例では、サーバーwls_server1でDMSトレース・プロバイダを有効化します。

configureTraceProvider(target='wls_server1', name='DMS', action='enable')

親トピック: 選択的トレース・コマンド

configureTracingLoggers

このコマンドは、選択的トレースの1つ以上のロガーを構成するために使用します。

コマンド・カテゴリ: 選択的トレース

WLSTでの使用: オンライン

説明

選択的トレースに対する1つ以上のロガーを構成します。このコマンドはまた、選択的トレースに対するロガーを有効または無効にします。

構文

configureTracingLoggers([target] [, pattern,] action)
引数 定義

target

オプションです。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーがトレースに対して構成されます。

pattern

オプションです。ロガー名のフィルタ処理に使用される正規表現パターン。デフォルト値は、すべてのトレース・ロガー名に一致します。

action

必須。すべてのログ出力のトレースを有効または無効にします。有効な値はenableおよびdisableです。デフォルト値はありません。

例

次の例では、oracle.securityで始まるすべてのログ出力について選択的トレースを構成します。 

configureTracingLoggers(pattern='oracle.security.*', action="enable")
Configured 80 loggers

次の例では、すべてのロガーについて選択的トレースを無効にします。

configureTracingLoggers(action="disable")
Configured 969 loggers

親トピック: 選択的トレース・コマンド

listActiveTraces

このコマンドは、アクティブなトレースをリストします。

コマンド・カテゴリ: 選択的トレース

WLSTでの使用: オンライン

説明

アクティブなトレースを一覧表示します。

構文

listActiveTraces([target])
引数 定義

targer

オプションです。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーが一覧表示されます。

例

次の例では、アクティブなトレースを一覧表示します。

listActiveTraces()
-------------------------------------+----------+-----------+------+-------------------+---
Trace ID                             |Attr. Name|Attr. Value| Level| Start Time        |Exp. Time
-------------------------------------+----------+-----------+------+-------------------+---
bf13025b-b8f8-480d-8d92-14200a669b3e |USER_ID   |user1      | FINE |  1/28/17 12:28 PM | 
a04b47f7-2830-4d80-92ee-ba160cdacf6b |USER_ID   |user2      | FINE |  1/28/17 12:30 PM |

親トピック: 選択的トレース・コマンド

listTraceProviders

このコマンドは、トレース・プロバイダをリストします。

コマンド・カテゴリ: 選択的トレース

WLSTでの使用: オンライン

説明

使用可能なトレース・プロバイダの名前、ステータス、説明およびサポートされるパラメータをリストします。プロバイダのステータスは、プロバイダがすべてのターゲット上で有効化されるenabled、プロバイダがすべてのターゲット上で無効化されるdisabledまたはプロバイダが一部のターゲット上で有効化されるmixedのいずれかになります。

構文

listTraceProviders([target,] [name])
引数 定義

target

オプションです。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、JRFが有効化されたドメイン内の実行中のすべてのサーバー・インスタンス上のプロバイダがリストされます。

name

オプションです。トレース・プロバイダ名。このパラメータを指定した場合、このプロバイダのみがリストされます。

例

次の例では、ドメイン内の実行中のすべてのサーバーのトレース・プロバイダをすべてリストします。

listTraceProviders()

親トピック: 選択的トレース・コマンド

listTracingLoggers

このコマンドは、選択的トレースをサポートするロガーをリストします。

コマンド・カテゴリ: 選択的トレース

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

説明

選択的トレースをサポートするログ出力をリストします。このコマンドでは、ログ出力名およびそのトレース・ステータスの表が表示されます。ステータスenabledは、すべてのサーバー上のトレースでログ出力が有効であることを意味します。ステータスdisabledは、すべてのサーバー上のトレースでログ出力が無効であることを意味します。ステータスmixedは、一部のサーバー上のトレースでログ出力が有効であり、他のサーバー上では無効であることを意味します。

構文

listTracingLoggers([target] [, pattern])
引数 定義

target

オプションです。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーが一覧表示されます。

pattern

オプションです。ロガー名のフィルタ処理に使用される正規表現パターン。デフォルト値は、すべてのトレース・ロガー名に一致します。

例

次の例では、oracle.securityで始まるすべてのトレース・ログ出力をリストします。 

listTracingLoggers(pattern="oracle.security.*")
------------------------------------------------------------------+--------
Logger                                                            | Status 
------------------------------------------------------------------+--------
oracle.security                                                   | enabled
oracle.security.audit.logger                                      | enabled
oracle.security.audit.config                                      | enabled
 .
 .
 .

親トピック: 選択的トレース・コマンド

startTracing

このコマンドは、選択的トレース・セッションを開始するために使用します。

コマンド・カテゴリ: 選択的トレース

WLSTでの使用: オンライン

説明

指定されたユーザーまたはDMSコンテキスト属性に対する新しい選択的トレース・セッションを、指定されたトレース・レベルで開始します。

構文

startTracing([target,] [ traceId,] [attrName, attrValue,] [user,] level [, desc])
引数 定義

target

オプションです。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーがトレースに含まれます。

traceId

オプションです。トレース・セッションの識別子。traceIdが指定されない場合、コマンドは一意のtraceIdを生成します。

attrName

user引数が指定されない場合を除いて、オプション。有効な値は、USER _ID、APP、CLIENT_HOST、CLIENT_ADDR、composite_name、WEBSERVICE.name、WEBSERVICE_PORT.nameです。

attrValue

attrNameが指定されている場合は必須。属性の値。

user

ユーザー名。このユーザーに関連付けられているメッセージが戻されます。これは、attrNameおよびAttrValueオプションを指定してUSER_IDを渡すことと同じです。

level

必須。トレース・レベル。このレベルは、有効なJavaまたはODLレベルであることが必要です。『Oracle Fusion Middlewareの管理』の表「ODL、Oracle WebLogic ServerおよびJava間のログ・レベルのマッピング」を参照してください。

desc

オプションです。トレース・セッションの説明。

例

次の例では、user1に関連付けられているメッセージのトレースを開始し、情報のレベルをFINEに設定します。

startTracing(user="user1",level="FINE")
Started tracing with ID: 885649f7-8efd-4a7a-9898-accbfc0bbba3

親トピック: 選択的トレース・コマンド

stopTracing

このコマンドは、1つ以上の選択的トレース・セッションを停止するために使用します。

コマンド・カテゴリ: 選択的トレース

WLSTでの使用: オンライン

説明

1つ以上の選択的トレース・セッションを停止します。

構文

stopTracing([target,] {stopAll] | traceId | attrName, attrValue | user} [, createIncident)
引数 定義

target

オプションです。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーが操作に含まれます。

stopAll

アクティブなトレースをすべて停止するかどうかを決定するJythonブール値(0または1)。traceId、user、またはattrNameおよびattrValue引数が指定されていない場合は必須。デフォルト値は0 (false)です。

traceId

停止するトレース・セッションの識別子。stopAll、user、またはattrNameおよびattrValue引数が指定されていない場合は必須。

attrName

有効な値は、USER _ID、APP、CLIENT_HOST、CLIENT_ADDR、composite_name、WEBSERVICE.name、WEBSERVICE_PORT.nameです。traceId、user、stopAll引数が指定されていない場合は必須。

attrValue

attrNameが指定されている場合は必須。属性の値。

user

ユーザー名。このユーザーに関連付けられているすべてのトレース・セッションが停止されます。stopAll、traceId、またはattrNameおよびattrValue引数が指定されていない場合は必須。

createIncident

オプションです。Jythonブール値(0または1)。trueの場合、停止するトレースごとにインシデントが作成されます。デフォルト値は0 (false)です。

例

次の例では、指定されたtraceIdを持つトレース・セッションを停止します。

stopTracing(traceId="a04b47f7-2830-4d80-92ee-ba160cdacf6b")
Stopped 1 traces

次の例では、すべてのトレース・セッションを停止します。

stopTracing(stopAll=1)
Stopped 1 traces

親トピック: 選択的トレース・コマンド