Oracle® Fusion Middlewareインフラストラクチャ・コンポーネントのためのWLSTコマンド・リファレンス 12c (12.1.2) E48021-01 |
|
前 |
次 |
診断フレームワークでは、クリティカル・エラーについて関連する診断を適時に捕捉するのに役立ちます。診断は、詳細に分析するためにOracleサポートに送信できます。診断フレームワークのコマンドを使用して、インシデントを生成し、既存のインシデントを問い合せ、個別の診断ダンプを実行して特定の診断データを収集します。この章では、コマンド構文、引数、コマンド例などの診断フレームワークのWLSTコマンドについて詳細に説明します。
診断フレームワークの使用に関する詳細は、『Oracle Fusion Middlewareの管理』の「問題の診断」を参照してください。
注意: 診断フレームワークのカスタムWLSTコマンドを使用するには、Oracle共通ホームからWLSTスクリプトを起動する必要があります。『Oracle Fusion Middlewareの管理』のカスタムWLSTコマンドの使用に関する項を参照してください。 |
表8-1に、診断フレームワーク・コマンドの各種カテゴリをリストします。
表8-1 診断コマンド・カテゴリ
コマンド・カテゴリ | 説明 |
---|---|
|
問題およびインシデントを表示し、インシデントを作成します。 |
|
ダンプに関する情報を表示し、ダンプを実行します。 |
|
指定した間隔で診断ダンプのサンプルを取得します。 |
表8-2のコマンドを使用して、問題およびインシデントを表示し、インシデントを作成します。
表8-2 インシデント・コマンド
使用するコマンド | 目的 | WLST使用 |
---|---|---|
|
指定した基準に一致するインシデントのコピーを含むzipファイルが含まれている集計インシデントを作成します。 |
オンライン |
|
診断インシデントを作成します。 |
オンライン |
|
指定したインシデント・ファイルの内容を取得します。 |
オンライン |
|
一連のADRホーム・パスをリストします。 |
オンライン |
|
一連の診断インシデントをリストします。 |
オンライン |
|
一連の診断問題をリストします。 |
オンライン |
|
指定した基準に一致するインシデントをリストします。 |
オンライン |
|
すべてのカスタム診断ルールまたは指定したルールをリロードします。 |
オンライン、オフライン |
|
指定したインシデントの詳細を表示します。 |
オンライン |
WLST使用: オンライン
createAggregatedIncident(query [, servers])
引数 | 定義 |
---|---|
query
|
単純式で構成された式で、ブール演算子で連結できます。式には、インシデント属性、演算子および文字列が次の書式で含まれます。 attribute operator "string" 単純式はカッコ()でグループ化されたブール演算子ANDまたはORで連結できます。 次のインシデント属性がサポートされています。
カスタム・インシデント属性もサポートされています。たとえば、TRACEID、APP、URI、AND DSIDがサポートされています。 サポートされている演算子は次のとおりです。
|
servers
|
問い合せる1つ以上のサーバーの名前。この引数はオプションです。指定しない場合、ドメイン内のすべてのサーバーに対してコマンドが実行されます。 このオプションは、管理サーバーに接続している場合にのみ有効です。 |
次の例では、サーバーwls_server1でODL_TRACE_IDに123456を含むすべてのインシデントに対する集計インシデントを作成します。
createAggregatedIncident(query="ORDL_TRACE_ID equals 123456", servers="wls_server1")
Incident 55 created, containing the following incidents:
Server wls_server1
Incident Id Problem Key Incident Time
15 TRACE [123456] [MANUAL] Mon Apr 15 11:22:12 EDT 2013
次の例では、ドメイン内のすべてのサーバーでODL_TRACE_IDに123456を含むすべてのインシデントに対する集計インシデントを作成します。
createAggregatedIncident(query="ORDL_TRACE_ID equals 123456", servers="wls_server1")
Incident 55 created, containing the following incidents:
Server wls_server1, wls_server2
Incident Id Problem Key Incident Time
15 TRACE [123456] [MANUAL] Mon Apr 15 11:22:12 EDT 2013
WLST使用: オンライン
createIncident([adrHome] [,incidentTime] [,messageId] [,ecid] [,appName] [,description] [,server])
引数 | 定義 |
---|---|
adrHome
|
インシデントを作成するADRホームのパス。ADRホームが存在している必要があります。この引数が指定されない場合、デフォルトのADRホームが使用されます。 デフォルトのADRホームの場所は、次のとおりです。 ADR_BASE/diag/OFM/domain_name/server_name |
incidentTime
|
インシデントが発生した時点のタイムスタンプ。これが指定されない場合、現在の日時が使用されます。次の内容を指定できます。
|
messageId
|
エラー・メッセージのID。たとえば、MDS-50400です。 |
ecid
|
エラー・メッセージの実行コンテキストID。 |
appNname
|
診断を収集する対象となるデプロイ済アプリケーションの名前。 たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。 |
description
|
インシデントに関連付ける説明テキスト。これは、後でインシデントを確認する場合に便利です。 |
server
|
情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。 |
次の例では、IDがMDS-50400のメッセージに関連するインシデントを作成します。
createIncident(messageId="MDS-50400", description="sample incident")
Incident Id: 3
Problem Id: 2
Problem Key: MDS-50400 [MANUAL]
Incident Time:Tue May 28 11:52:45 PDT 2013
Error Message Id: MDS-50400
Execution Context:null
Flood Controlled: false
Dump Files :
jvm_threads25_i3.txt
dms_metrics26_i3.txt
dfw_samplingArchive28_i3.readme.txt
odl_logs29_i3.txt
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
|
情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。 |
WLST使用: オンライン
listIncidents([id] [, adrHome] [,server])
引数 | 定義 |
---|---|
id
|
一連の診断インシデントをリストする問題のID。 |
adrHome
|
インシデントを問い合せるADRホームのパス。この引数が指定されない場合、デフォルトのADRホームが問い合せされます。 デフォルトのADRホームの場所は、次のとおりです。 ADR_BASE/diag/OFM/domain_name/server_name |
server
|
情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。 |
WLST使用: オンライン
listProblems([adrHome][,server])
引数 | 定義 |
---|---|
adrHome
|
問題を問い合せるADRホームのパス。この引数が指定されない場合、デフォルトのADRホームが問い合せされます。 デフォルトのADRホームの場所は、次のとおりです。 ADR_BASE/diag/OFM/domain_name/server_name |
server
|
情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。 |
WLST使用: オンライン
queryIncidents(query [,servers])
引数 | 定義 |
---|---|
query
|
単純式で構成された式で、ブール演算子で連結できます。式には、インシデント属性、演算子および文字列が次の書式で含まれます。 attribute operator "string" 単純式はカッコ()でグループ化されたブール演算子ANDまたはORで連結できます。 次のインシデント属性がサポートされています。
カスタム・インシデント属性もサポートされています。たとえば、TRACEID、APP、URI、AND DSIDがサポートされています。さらに、インシデントreadme.txtファイルに示すとおり、コンテキスト値がサポートされます。たとえば、DFW_APP_NAMEおよびDFW_USER_NAMEがサポートされています。 サポートされている演算子は次のとおりです。
|
servers
|
問い合せる1つ以上のサーバーの名前。この引数はオプションです。指定しない場合、ドメイン内のすべてのサーバーに対してコマンドが実行されます。 このオプションは、管理サーバーに接続している場合にのみ有効です。 |
WLST使用: オンライン、オフライン
reloadCustomRules([name] [, server])
引数 | 定義 |
---|---|
name
|
カスタム診断ルールの名前。この引数はオプションです。指定した場合、指定したルールのみがリロードされます。この引数を指定しない場合、すべてのカスタム診断ルールがリロードされます。 カスタム診断ルールが含まれているファイルは、次のいずれかのディレクトリにある必要があります。 DOMAIN_HOME/config/fmwconfig/dfw DOMAIN_HOME/config/fmwconfig/servers/server_name/dfw |
server
|
ルールのリロード先サーバーの名前。この引数はオプションです。指定しない場合、すべてのサーバーにルールがリロードされます。 このオプションは、管理サーバーに接続している場合にのみ有効です。 |
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: 10
Problem Key: MDS-50500 [MANUAL]
Incident Time:Tue May 28 11:02:22 PDT 2013
Error Message Id: MDS-50500
Execution Context:
Flood Controlled: false
Dump Files :
readme.txt
jvm_threads10_i1.txt
dms_metrics11_i1.txt
dfw_samplingArchive13_i1.JVMThreadDump.txt
dfw_samplingArchive13_i1.readme.txt
odl_logs14_i1.txt
dms_metrics20_i1.txt
表8-3のコマンドを使用して、ダンプに関する情報を表示し、ダンプを実行します。
表8-3 診断ダンプ・コマンド
使用するコマンド | 目的 | WLST使用 |
---|---|---|
|
指定した診断ダンプの説明を表示します。 |
オンライン |
|
指定した診断ダンプを実行します。 |
オンライン |
|
実行可能な一連の診断ダンプを表示します。 |
オンライン |
WLST使用: オンライン
describeDump(name [,appName] [.server])
引数 | 定義 |
---|---|
name
|
情報を表示するダンプの名前。 |
appName
|
情報を収集するデプロイ済アプリケーションの名前。 たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。 |
server
|
情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。 |
次の例では、odl.logsという名前のダンプに関する情報を表示します。listDumpsコマンドを使用して、使用可能なダンプのリストを取得します。
describeDump(name="odl.logs")
Name: odl.logs
Description: Dump contents of diagnostic logs
Run Mode: asynchronous
Mandatory Arguments:
Optional Arguments:
Name Type Description
match_all BOOLEAN Whether to match both ECID and time range or any one of them.
timestamp LONG Log message timestamp in milliseconds
ecid STRING Log message execution context ID (ecid)
exclude_access_logs BOOLEAN Excludes access logs from dump.
timerange LONG Time range in minutes
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"})
WLST使用: オンライン
listDumps([appName] [,server])
引数 | 定義 |
---|---|
appName
|
診断を収集する対象となるデプロイ済アプリケーションの名前。 たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。 この引数を指定した場合、指定したアプリケーションのダンプがコマンドによって返されます。この引数を指定しない場合、システム・ダンプがコマンドによって返されます。 |
server
|
情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。 |
次の例では、使用可能なすべてのダンプをリストします。
listDumps()
adf.DiagnosticsJarsVersionDump
dfw.samplingArchive
dms.configuration
dms.ecidctx
dms.metrics
http.requests
jvm.classhistogram
jvm.threads
mds.MDSInstancesDump
odl.activeLogConfig
odl.logs
odl.quicktrace
opss.diagTest
opss.identityStoreUserRoleApiConfig
opss.securityContext
wls.image
Use the command describeDump(name=<dumpName>) for help on a specific dump.
表8-4のコマンドを使用して、指定した間隔で診断ダンプのサンプルを取得します。
表8-4 ダンプ・サンプリング・コマンド
使用するコマンド | 目的 | WLST使用 |
---|---|---|
|
診断フレームワーク・ダンプのサンプリングを作成します。 |
オンライン |
|
すべてのダンプ・サンプリングを有効化または無効化します。 |
オンライン |
|
すべてのダンプ・サンプルを、個々のサンプリング・ファイルとREADMEファイルを含むzipファイルに収集します。 |
オンライン |
|
ダンプ・サンプリングが有効か無効かをリストします。 |
オンライン |
|
すべてのダンプ・サンプリング、指定したダンプ・サンプリングまたは指定したサーバーに関連付けられているすべてのダンプ・サンプリングをリストします。 |
オンライン |
|
指定したダンプ・サンプリングを削除します。 |
オンライン |
|
指定したダンプ・サンプリングを更新し、サンプリングの設定を変更します。 |
オンライン |
WLST使用: オンライン
addDumpSample(sampleName, diagnosticDumpName [, appName], samplingInterval, rotationCount [, dumpedImplicitly] [, toAppend] [, args] [, server])
引数 | 定義 |
---|---|
sampleName
|
サンプリングの名前。 |
diagnosticDumpName
|
サンプリング対象の診断ダンプの名前。 |
appName
|
オプション。指定された診断ダンプに関連付けられたアプリケーションの名前。appNameが指定されていない場合、診断ダンプはシステム・スコープを使用します。 |
samplingInterval
|
サンプリング間隔(秒)。ゼロまたは負数を指定した場合、サンプリングは一時停止します。 |
rotationCount
|
ローテーション・リストに保存される診断ダンプ・サンプルの最大数。この上限に達すると、最も古いサンプルが削除されます。 |
dumpedImplicitly
|
オプション。診断ダンプのアーカイブをdfw.samplingArchiveに含むかどうかを指定するブール値。有効な値は 値がfalseで、ダンプ・アーカイブをdfw.samplingArchiveに含む場合、argsパラメータを使用してサンプリング名をexecuteDumpコマンドに渡す必要があります。 |
toAppend
|
オプション。dfw.samplingArchiveの実行時に診断ダンプ・サンプルが前のサンプルに追加され、単一アーカイブとなるようにするどうかを指定するブール値。有効な値は |
args |
オプション。毎回のサンプリング時に診断ダンプで使用される診断ダンプ引数。引数は、名前と値のペアとして表示されます。 |
server
|
オプション。情報の収集元となるサーバーの名前。このパラメータを指定しない場合、このコマンドによってダンプ・サンプリングが管理サーバーに関連付けられます。 |
WLST使用: オンライン
enableDumpSampling(enable [,server])
引数 | 定義 |
---|---|
enable
|
ダンプ・サンプリングを有効化または無効化するかを指定するブール値。有効な値は |
server
|
オプション。ダンプ・サンプリングを有効化または無効化するサーバーの名前。このパラメータを指定しない場合、このコマンドによって管理サーバーに対するダンプ・サンプリングが有効化または無効化されます。 |
WLST使用: オンライン
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 05-21-13 07:25 dfw_samplingArchive1065570966467923683.JVMThreadDump.dmp 840 05-21-13 07:25 dfw_samplingArchive7749640004639161119.readme.txt -------- ------- 509620 2 files
WLST使用: オンライン
isDumpSamplingEnabled([server])
引数 | 定義 |
---|---|
server
|
オプション。ダンプ・サンプリングが有効化または無効化されているかどうかを判断するためのサーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。 |
WLST使用: オンライン
listDumpSamples([sampleName] [, server])
引数 | 定義 |
---|---|
sampleName
|
オプション。サンプリングの名前。 |
server
|
オプション。ダンプ・サンプリングをリストするサーバーの名前。このパラメータを指定しない場合、このコマンドによって管理サーバーに対するダンプ・サンプリングがリストされます。 |
次の例では、サーバーwls_server_1に関連付けられているすべてのダンプ・サンプリングをリストします。
listDumpSamples(server="wls_server_1")
Name : JVMThreadDump
Dump Name : jvm.threads
Application Name :
Sampling Interval : 30
Rotation Count : 20
Dump Implicitly : true
Append Samples : true
Dump Arguments : context=true, timing=true, progressive=true, depth=20, threshold=30000
Name : JavaClassHistogram
Dump Name : jvm.classhistogram
Application Name :
Sampling Interval : 1800
Rotation Count : 5
Dump Implicitly : false
Append Samples : true
Dump Arguments :
WLST使用: オンライン
removeDumpSample(sampleName [,server])
引数 | 定義 |
---|---|
sampleName
|
削除するダンプ・サンプリングの名前。 |
server
|
オプション。サンプリングの削除元となるサーバーの名前。このパラメータを指定しない場合、管理サーバーからダンプ・サンプリングが削除されます。 |
WLST使用: オンライン
updateDumpSample(sampleName [, appName], samplingInterval, rotationCount [,dumpedImplicitly] [, toAppend] [, arg,] [, server])
引数 | 定義 |
---|---|
sampleName
|
ダンプ・サンプリングの名前。 |
appName
|
オプション。指定された診断ダンプに関連付けられたアプリケーションの名前。appNameが指定されていない場合、診断ダンプはシステム・スコープを使用します。 |
samplingInterval
|
オプション。サンプリング間隔(秒)。ゼロまたは負数を指定した場合、サンプリングは一時停止します。 |
rotationCount
|
オプション。ローテーション・リストに保存される診断ダンプ・サンプリングの最大数。この上限に達すると、最も古いサンプリングが削除されます。 |
dumpedImplicitly
|
オプション。診断ダンプのアーカイブをdfw.samplingArchiveに含むかどうかを指定するブール値。有効な値は 値がfalseで、ダンプ・アーカイブをdfw.samplingArchiveに含む場合、argsパラメータを使用してサンプリング名をexecuteDumpコマンドに渡す必要があります。 |
toAppend
|
オプション。dfw.samplingArchiveの実行時に診断ダンプ・サンプルが前のサンプルに追加され、単一アーカイブとなるようにするどうかを指定するブール値。有効な値は |
args |
オプション。毎回のサンプリング時に診断ダンプで使用される診断ダンプ引数。引数は、名前と値のペアとして表示されます。 |
server
|
オプション。情報の収集元となるサーバーの名前。このパラメータを指定しない場合、管理サーバーに対するダンプ・サンプリングが更新されます。 |