15 診断フレームワーク・カスタムWLSTコマンド

診断フレームワークによって、クリティカル・エラーについて関連する診断を適時に捕捉できます。診断は、詳細に分析するためにOracleサポートに送信できます。診断フレームワークのコマンドを使用して、インシデントを生成し、既存のインシデントを問い合せ、個別の診断ダンプを実行して特定の診断データを収集します。この章では、診断フレームワーク用のWLSTコマンド、およびそのコマンド構文、引数、コマンド例を詳細に説明します。

診断フレームワークの使用方法の詳細は、Oracle Fusion Middleware管理者ガイドの問題の診断に関する項を参照してください。

注意: これらの診断フレームワーク・カスタムWLSTコマンドを使用するには、Oracle共通ホームからWLSTスクリプトを起動する必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

表15-1は、診断フレームワークのコマンドの様々なカテゴリを示しています。

表15-1 診断コマンドのカテゴリ

コマンド・カテゴリ	説明
インシデント・コマンド	問題およびインシデントを表示し、インシデントを作成します。
診断ダンプ・コマンド	ダンプに関する情報を表示し、ダンプを実行します。
ダンプ・サンプリング・コマンド	指定された間隔で診断ダンプのサンプルを取得します。

インシデント・コマンド

表15-2のコマンドを使用して、問題およびインシデントを表示し、インシデントを作成します。

表15-2 インシデント・コマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
createIncident	診断インシデントを作成します。	オンライン
getIncidentFile	指定したインシデント・ファイルの内容を取得します。	オンライン
listADRHomes	一連のADRホームのパスを一覧表示します。	オンライン
listIncidents	一連の診断インシデントを一覧表示します。	オンライン
listProblems	一連の診断問題を一覧表示します。	オンライン
reloadCustomRules	すべてのカスタム診断ルールまたは指定されたルールを再ロードします。	オンライン、オフライン
showIncident	指定したインシデントの詳細を表示します。	オンライン

createIncident

WLSTでの使用: オンライン

説明

診断インシデントを作成し、指定した情報を使用して、実行する一連の診断ルールおよびアクションを決定します。

構文

createIncident([adrHome] [,incidentTime] [,messageId] [,ecid] [,appName]
  [,description] [,server])

引数	定義
adrHome	インシデントを作成するADRホームのパス。ADRホームが存在している必要があります。この引数が指定されていない場合、デフォルトADRホームが使用されます。 デフォルトADRホームは次の場所です。 ADR_BASE/diag/OFM/domain_name/server_name
incidentTime	インシデントが発生した時点のタイムスタンプ。これが指定されていない場合、現在の時刻が使用されます。次のものを指定できます。 HH:MMの形式の現在の日の時刻。例: 19:45 MM/DD/YYYY HH:MMの形式の日付と時刻
messageId	エラー・メッセージのID。たとえば、MDS-50400です。
ecid	エラー・メッセージの実行コンテキストID。
appNname	診断を収集する対象となるデプロイされたアプリケーションの名前。 たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。
description	インシデントと関連付ける説明テキスト。これは、後でインシデントを確認する場合に便利です。
server	情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、IDがMDS-50400のメッセージに関連するインシデントを作成します。

createIncident(messageId="MDS-50400", description="sample incident")
Incident Id: 55
Problem Id: 4
Problem Key: MDS-50400 [MANUAL]
Incident Time: 25th March 2010 11:55:45 GMT
Error Message Id: MDS-50400
Flood Controlled: false

getIncidentFile

WLSTでの使用: オンライン

説明

指定したインシデント・ファイルの内容を取得します。

構文

getIncidentFile(id, name [,outputFile] [,adrHome] [,server])

引数	定義
id	取得するインシデントのID。
name	取得するファイルの名前。ファイルの名前を見つけるには、showIncident コマンドを使用します。
outputFile	出力の書き込み先となるファイルの名前。
adrHome	情報の取得元となるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。 デフォルトADRホームは次の場所です。 ADR_BASE/diag/OFM/domain_name/server_name
server	情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、インシデントdms_metrics3_i1.dmpの内容を、指定した出力ファイルに書き込みます。

getIncidentFile(id='1', name='dms_metrics3_i1.dmp', outputFile='/tmp/incident1_dms.txt')
The content of 'dms_metrics3_i1.dmp'is written to /tmp/incident1_dms.txt

listADRHomes

WLSTでの使用: オンライン

説明

サーバーのすべてのADRホームのパスを一覧表示します。

構文

listADRHomes([server])

引数	定義
server	情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、ADRホームのパスを一覧表示します。

listADRHomes()
diag/ofm/base_domain/WLS_Spaces

diag/ofm/fusionapps/GeneralLedger

listIncidents

WLSTでの使用: オンライン

説明

指定した問題ID(指定されている場合)または使用可能なすべてのインシデントの一連の診断インシデントを一覧表示します。

構文

listIncidents([id] [, adrHome] [,server])

引数	定義
id	一連の診断インシデントを一覧表示する問題のID。
adrHome	インシデントを問い合せるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。 デフォルトADRホームは次の場所です。 ADR_BASE/diag/OFM/domain_name/server_name
server	情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、IDが1の問題に関連付けられているインシデントを一覧表示します。

listIncidents(id="1")
Incident Id   Problem Key                                 Incident Time
         10   MDS-50300 [WLS_Spaces] [oracle.mds.repos]   Mon Mar 15 11:22:12 PDT 2010
         24   MDS-50300 [WLS_Spaces] [oracle.mds.repos]   Thu Mar 11 15:11:35 PDT 2010

listProblems

WLSTでの使用: オンライン

説明

指定したADRホームに関連付けられている一連の診断問題を一覧表示します。

構文

listProblems([adrHome][,server])

引数	定義
adrHome	問題を問い合せるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。 デフォルトADRホームは次の場所です。 ADR_BASE/diag/OFM/domain_name/server_name
server	情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、デフォルトADRホームの診断問題を一覧表示します。

listProblems()
Problem Id        Problem Key
         1        MDS-50300 [WLS_Spaces] [oracle.mds.repos]
         2        JOC-38922 [AdminServer] [oracle.cache.network]

reloadCustomRules

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

説明

すべてのカスタム診断ルールまたは指定されたカスタム診断ルールを再ロードします。

構文

reloadCustomRules([name] [, server])

引数	定義
name	カスタム診断ルールの名前。この引数はオプションです。指定した場合は、指定したルールのみが再ロードされます。この引数を指定しない場合、すべてのカスタム診断ルールが再ロードされます。 カスタム診断ルールを含むファイルが、次のいずれかのディレクトリに置かれている必要があります。 DOMAIN_HOME/config/fmwconfig/dfw DOMAIN_HOME/config/fmwconfig/servers/server_name/dfw
server	ルールの再ロード先のサーバーの名前。この引数はオプションです。指定しない場合、ルールはすべてのサーバーに再ロードされます。 このオプションは、管理サーバーに接続している場合にのみ有効です。

例

次の例では、カスタム診断ルールmyCustomRules.xmlを再ロードします。

reloadCustomRules(name='myCustomRules.xml')

showIncident

WLSTでの使用: オンライン

説明

指定したインシデントの詳細を表示します。

構文

showIncident(id, [adrHome][, server])

引数	定義
id	表示するインシデントのID。
adrHome	インシデントを問い合せるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。 デフォルトADRホームは次の場所です。 ADR_BASE/diag/OFM/domain_name/server_name
server	情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、IDが10のインシデントに関する情報を表示します。

showIncident(id="10")
Incident Id: 10
Problem Id: 1
Problem Key: MDS-50300 [WLS_Spaces] [oracle.mds.repos]
Incident Time: 25th March 2010 10:12:15 GMT
Error Message Id: MDS-50300
Execution Context: 0000ICK4rbYC8xT6uBf9EH1AX1qF000000
Flood Controlled: false
Dump Files :
      dms_ecidctx1_i1.dmp
      jvm_threads2_i1.dmp
      dms_metrics3_i1.dmp
      odl_logs4_i1.dmp
      diagnostic_image_AdminServer_2010_03_25_11_12_15.zip
      readme.txt

診断ダンプ・コマンド

表15-3のコマンドを使用して、ダンプに関する情報を表示し、ダンプを実行します。

表15-3 診断ダンプ・コマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
describeDump	指定した診断ダンプの説明を表示します。	オンライン
executeDump	指定した診断ダンプを実行します。	オンライン
listDumps	実行できる一連の診断ダンプを表示します。	オンライン

describeDump

WLSTでの使用: オンライン

説明

指定した診断ダンプの説明を表示します。

構文

describeDump(name [,appName] [.server])

引数	定義
name	情報を表示するダンプの名前。
appName	情報を収集するデプロイされたアプリケーションの名前。 たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。
server	情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、odl.logsという名前のダンプに関する情報を表示します。listDumpsコマンドを使用して、使用可能なダンプのリストを取得します。

describeDump(name="odl.logs")
Name: odl.logs
Description: Dumps recent ODL logs, or logs correlated by ECID
Manadatory Arguments:
Optional Arguments:
   Name       Type      Description
   ECID       String    Execution Context Id to correlate log entries with
   timestamp  String    Timestamp to query logs 5 minutes before/after

executeDump

WLSTでの使用: オンライン

説明

指定した診断ダンプを実行します。

構文

executeDump(name [,args] [,outputFile] [,id] [,adrHome] [,server])

引数	定義
name	実行する診断ダンプの名前。
args	ダンプに渡す必須またはオプションの引数。
outputFile	ダンプの書き込み先となるファイルの名前。この引数を指定しない場合、出力はコンソールに書き込まれます。
id	ダンプを関連付けるインシデントのID。デフォルトでは、指定したダンプはインシデントと関連付けされません。
adrHome	インシデントが含まれているADRホーム。この引数を指定しない場合、デフォルトADRホームが使用されます。 デフォルトADRホームは次の場所です。 ADR_BASE/diag/OFM/domain_name/server_name
server	情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

argsキーワードを使用して、必須またはオプションの引数を指定できます。例:

executeDump("java.sysprops",args={"prop" : "os.name"})

例

次の例では、jvm.threadsという名前のダンプを実行し、それをdumpout.txtファイルに書き込みます。

executeDump(name="jvm.threads", outputFile="/tmp/dumpout.txt")
Diagnostic dump jvm.threads output written to /tmp/dumpoutput.txt

次の例では、jvm.threadsという名前で、インシデントIDが33のダンプを実行し、それをdumpout.txtファイルに書き込みます。

executeDump(name="jvm.threads", outputFile="/tmp/dumpout.txt", id="33")
Diagnostic dump jvm.threads output associated with incident 33 in ADR Home diag/ofm/base_domain/AdminServer

次の例では、引数propを値os.nameに設定してダンプを実行します。

executeDump(name="java.sysprops",args={"prop" : "os.name"})

listDumps

WLSTでの使用: オンライン

説明

実行できる一連の診断ダンプを表示します。

構文

listDumps([appName] [,server])

引数	定義
appName	診断を収集する対象となるデプロイされたアプリケーションの名前。 たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。 この引数を指定した場合、指定されたアプリケーションのダンプが返されます。この引数を指定しない場合、システム・ダンプが返されます。
server	情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、使用可能なすべてのダンプを一覧表示します。

listDumps()
dms.metrics
jvm.classhistogram
jvm.threads
odl.logs
 
Use the command describeDump(name=<dumpName>) for help on a specific dump.

ダンプ・サンプリング・コマンド

表15-4に示すコマンドを使用して、指定された間隔で診断ダンプのサンプルを取得します。

表15-4 ダンプ・サンプリング・コマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
addDumpSample	診断フレームワーク・ダンプに対するサンプリングを作成します。	オンライン
enableDumpSampling	すべてのダンプ・サンプリングを有効化または無効化します。	オンライン
getSamplingArchives	すべてのダンプ・サンプリングを、個々のサンプリング・ファイルとREADMEファイルを含むzipファイルに収集します。	オンライン
isDumpSamplingEnabled	ダンプ・サンプリングが有効化されているかどうかを示します。	オンライン
listDumpSamples	すべてのダンプ・サンプリング、指定されたダンプ・サンプリングまたは指定されたサーバーに関連付けられているすべてのダンプ・サンプリングを表示します。	オンライン
removeDumpSample	指定されたダンプ・サンプリングを削除します。	オンライン
updateDumpSample	サンプリングの設定を変更して、指定されたダンプ・サンプリングを更新します。	オンライン

addDumpSample

WLSTでの使用: オンライン

説明

診断フレームワーク・ダンプに対するダンプ・サンプリングを作成します。

構文

addDumpSample(sampleName, diagnosticDumpName [, appName], samplingInterval,
 rotationCount [, dumpedImplicitly] [, toAppend] [, args] [, server=])

引数	定義
sampleName	サンプリングの名前。
diagnosticDumpName	取得する診断ダンプの名前。
appName	オプション。指定された診断ダンプに関連付けられているアプリケーションの名前。appNameを指定しない場合、診断ダンプの対象はシステムになります。
samplingInterval	秒単位のサンプリング間隔。0または負の値を指定すると、サンプリングは一時停止されます。
rotationCount	ローテーション・リストに含める診断ダンプ・サンプルの最大数。この上限に達すると、最も古いサンプルが削除されます。
dumpedImplicitly	オプション。診断ダンプ・アーカイブをdfw.samplingArchiveに含めるかどうかを指定するブール値。有効な値は、trueおよびfalseです。デフォルトはtrueです。 値がfalseの場合に、ダンプ・アーカイブをdfw.samplingArchiveに含めるには、argsパラメータを使用してサンプリング名をexecuteDumpコマンドに渡す必要があります。
toAppend	オプション。診断ダンプ・サンプルを前のサンプルに追加するかどうかを指定するブール値(dfw.samplingArchiveの実行時にアーカイブは1つしか作成されない)。有効な値は、trueおよびfalseです。デフォルトはtrueです。値がtrueの場合、サンプルはその前のサンプルに追加されます。値がfalseの場合、dfw.sampleArchiveにより、個々のサンプル・ファイルを含むzipファイルが返されます。ダンプ・サンプルにバイナリ・データが含まれる場合はfalseを指定してください。
args	オプション。各サンプリング時に診断ダンプにより使用される診断ダンプ引数。引数は名前/値ペアで指定します。
server	オプション。情報の収集元となるサーバーの名前。このパラメータを指定しないと、このコマンドにより、ダンプ・サンプリングが管理サーバーに関連付けられます。

例

次の例では、ダンプdms.metricsに対するサンプリングを追加します。

addDumpSample(sampleName='dms_metrics', diagnosticDumpName='dms.metrics',
               samplingInterval=300, rotationCount=10)
 
dms_metrics is added

enableDumpSampling

WLSTでの使用: オンライン

説明

すべてのダンプ・サンプリングを有効化または無効化します。このコマンドは構成済のすべてのダンプ・サンプリングに影響します。

構文

enableDumpSampling(enable [,server])

引数	定義
enable	ダンプ・サンプリングを有効化するかどうかを指定するブール値。有効な値は、trueおよびfalseです。
server	オプション。ダンプ・サンプリングを有効化または無効化するサーバーの名前。このパラメータを指定しないと、このコマンドにより、管理サーバーに対するダンプ・サンプリングが有効化または無効化されます。

例

次の例では、すべてのダンプ・サンプリングを無効化します。

enableDumpSampling(enable=false)

Dump sampling disabled

getSamplingArchives

WLSTでの使用: オンライン

説明

すべてのダンプ・サンプリングを、個々のサンプリング・ファイルとREADMEファイルを含むzipファイルに収集します。この方法は、バイナリ形式のダンプを扱う場合に特に有用です。

構文

getSamplingArchives([sampleName,] outputFile [,server])

引数	定義
name	オプション。取得する特定のダンプ・サンプリングの名前。この引数を指定しない場合、このコマンドにより、すべてのダンプ・サンプリングが返されます。
outputFile	ダンプ・サンプリングが書き込まれるファイルの絶対パス。
server	オプション。情報の収集元となるサーバーの名前。このパラメータを指定しないと、このコマンドにより、管理サーバーに対するダンプ・サンプリングが収集されます。

例

次の例では、ダンプJVMThreadDumpに対するダンプ・サンプリングを取得します。

getSamplingArchives(sampleName="JVMThreadDump", outputFile="/tmp/jvm_dump.zip")
wrote 63518 bytes to /tmp/jvm_dump.zip

zipファイルの内容を次に示します。

 unzip -l jvm_dump.zip
Archive:  jvm_dump.zip
  Length     Date   Time    Name
 --------    ----   ----    ----
   508780  08-21-12 07:25   dfw_samplingArchive1065570966467923683.JVMThreadDump.dmp
      840  08-21-12 07:25   dfw_samplingArchive7749640004639161119.readme.txt
 --------                   -------
   509620                   2 files

isDumpSamplingEnabled

WLSTでの使用: オンライン

説明

ダンプ・サンプリングが有効化されているかどうかを示します。

構文

isDumpSamplingEnabled([server])

引数	定義
server	オプション。ダンプ・サンプリングが有効化されているかどうかを判断するサーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、サーバーsoa_server1に対してダンプ・サンプリングが有効化されているかどうかを示します。

isDumpSamplingEnabled(server="soa_server1")
Location changed to domainRuntime tree. This is a read-only tree with
DomainMBean as the root. 
For more help, use help(domainRuntime)

true

listDumpSamples

WLSTでの使用: オンライン

説明

すべてのダンプ・サンプリング、指定されたダンプ・サンプリングまたは指定されたサーバーに関連付けられているすべてのダンプ・サンプリングを表示します。

構文

listDumpSamples([sampleName] [, server])

引数	定義
sampleName	オプション。サンプリングの名前。
server	オプション。ダンプ・サンプリングを一覧表示するサーバーの名前。このパラメータを指定しないと、このコマンドにより、管理サーバーに対するダンプ・サンプリングが一覧表示されます。

例

次の例では、サーバーsoa_server1に関連付けられているすべてのダンプ・サンプリングを一覧表示します。

listDumpSamples(server="soa_server1")
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean as the root. 
For more help, use help(domainRuntime)
 
Name              : JavaClassHistogram
Dump Name         : jvm.classhistogram
Application Name  : 
Sampling Interval : 1800
Rotation Count    : 5
Dump Implicitly   : false
Append Samples    : true
Dump Arguments    : 
 
Name              : JVMThreadDump
Dump Name         : jvm.threads
Application Name  : 
Sampling Interval : 60
Rotation Count    : 10
Dump Implicitly   : true
Append Samples    : true
Dump Arguments    : context=true, timing=true

removeDumpSample

WLSTでの使用: オンライン

説明

ダンプ・サンプリングを削除します。

構文

removeDumpSample(sampleName [,server])

引数	定義
sampleName	削除するダンプ・サンプリングの名前。
server	オプション。サンプリングの削除元となるサーバーの名前。このパラメータを指定しないと、管理サーバーからダンプ・サンプリングが削除されます。

例

次の例では、サーバーsoa_server1に関連付けられているHTTPSamplingという名前のダンプ・サンプリングを削除します。

removeDumpSample(sampleName="HTTPSampling", server="soa_server1")

Removed HTTPSampling

updateDumpSample

WLSTでの使用: オンライン

説明

サンプリングの設定を変更して、指定されたダンプ・サンプリングを更新します。サンプリングの名前は変更できません。変更は、次回のサンプリング間隔から有効になります。

構文

updateDumpSample(sampleName [, appName], samplingInterval, 
    rotationCount [,dumpedImplicitly] [, toAppend] [, arg,] 
    [, server])

引数	定義
sampleName	ダンプ・サンプリングの名前。
appName	オプション。指定された診断ダンプに関連付けられているアプリケーションの名前。appNameを指定しない場合、診断ダンプの対象はシステムになります。
samplingInterval	オプション。秒単位のサンプリング間隔。0または負の値を指定すると、サンプリングは一時停止されます。
rotationCount	オプション。ローテーション・リストに含める診断ダンプ・サンプリングの最大数。この上限に達すると、最も古いサンプリングが削除されます。
dumpedImplicitly	オプション。診断ダンプ・アーカイブをdfw.samplingArchiveに含めるかどうかを指定するブール値。有効な値は、trueおよびfalseです。デフォルトはtrueです。 値がfalseの場合に、ダンプ・アーカイブをdfw.samplingArchiveに含めるには、argsパラメータを使用してサンプリング名をexecuteDumpコマンドに渡す必要があります。
toAppend	オプション。診断ダンプ・サンプルを前のサンプルに追加するかどうかを指定するブール値(dfw.samplingArchiveの実行時にアーカイブは1つしか作成されない)。有効な値は、trueおよびfalseです。デフォルトはtrueです。値がtrueの場合、サンプルはその前のサンプルに追加されます。値がfalseの場合、dfw.sampleArchiveにより、個々のサンプリング・ファイルを含むzipファイルが返されます。ダンプ・サンプリングにバイナリ・データが含まれる場合はfalseを指定してください。
args	オプション。各サンプリング時に診断ダンプにより使用される診断ダンプ引数。引数は名前/値ペアで指定します。
server	オプション。情報の収集元となるサーバーの名前。このパラメータを指定しないと、管理サーバーに対してダンプ・サンプリングが更新されます。

例

次の例では、サンプリング間隔、ローテーション数およびサーバーを変更して、ダンプ・サンプリングHTTPSamplingを更新します。

updateDumpSample(sampleName="HTTPSampling", samplingInterval=200,
                   rotationCount=5, server="soa_server1")
 
HTTPSampling is updated