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

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

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

表8-1に、診断フレームワーク・コマンドの各種カテゴリをリストします。

表8-1 診断コマンド・カテゴリ

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

8.1 インシデント・コマンド

インシデントとは、問題の1回の発生です。問題(クリティカル・エラー)が複数回発生すると、インシデントはそれぞれの発生分に対して作成されます。WLST診断フレームワークのインシデント・コマンドでは、問題とインシデントの表示、およびインシデントの作成が可能です。

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

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

使用するコマンド	目的	WLSTでの使用
createAggregatedIncident	指定した基準に一致するインシデントのコピーを含むzipファイルが含まれている集計インシデントを作成します。	オンライン
createIncident	診断インシデントを作成します。	オンライン
getIncidentFile	指定したインシデント・ファイルの内容を取得します。	オンライン
listADRHomes	一連のADRホームのパスを一覧表示します。	オンライン
listIncidents	一連の診断インシデントを一覧表示します。	オンライン
listProblems	一連の診断問題を一覧表示します。	オンライン
queryIncidents	指定した基準に一致するインシデントをリストします。	オンライン
reloadCustomRules	すべてのカスタム診断ルールまたは指定したルールをリロードします。	オンライン、オフライン
showIncident	指定したインシデントの詳細を表示します。	オンライン

8.1.1 createAggregatedIncident

WLSTでの使用: オンライン

説明

指定した基準に一致するインシデントのコピーを含むzipファイルが含まれている集計インシデントを作成します。

構文

createAggregatedIncident(query [, servers])

引数定義

引数	定義
query	単純式で構成された式で、ブール演算子で連結できます。式には、インシデント属性、演算子および文字列が次の書式で含まれます。 attribute operator "string" 単純式はカッコ()でグループ化されたブール演算子ANDまたはORで連結できます。次のインシデント属性がサポートされています。 TIMESTAMP: インシデント作成時間。`from`および`to`演算子を使用して時間範囲を指定できます。日付書式は`YYYY-MM-DD HH:MM`です。 ECID: 実行コンテキストID PROBLEM_KEY: 問題キー MSG_FACILITY: エラー・メッセージ機能(ORA、OHSなど) MSG_NUMBER: エラー・メッセージID (600など) カスタム・インシデント属性もサポートされています。たとえば、TRACEID、APP、URI、AND DSIDがサポートされています。サポートされている演算子は次のとおりです。 equals notEqual startsWith endsWith contains isNull notNull
servers	問い合せる1つ以上のサーバーの名前。この引数はオプションです。指定しない場合、ドメイン内のすべてのサーバーに対してコマンドが実行されます。このオプションは、管理サーバーに接続している場合にのみ有効です。

query

単純式で構成された式で、ブール演算子で連結できます。式には、インシデント属性、演算子および文字列が次の書式で含まれます。

attribute operator "string"

単純式はカッコ()でグループ化されたブール演算子ANDまたはORで連結できます。

次のインシデント属性がサポートされています。

TIMESTAMP: インシデント作成時間。fromおよびto演算子を使用して時間範囲を指定できます。日付書式はYYYY-MM-DD HH:MMです。
ECID: 実行コンテキストID
PROBLEM_KEY: 問題キー
MSG_FACILITY: エラー・メッセージ機能(ORA、OHSなど)
MSG_NUMBER: エラー・メッセージID (600など)

カスタム・インシデント属性もサポートされています。たとえば、TRACEID、APP、URI、AND DSIDがサポートされています。

サポートされている演算子は次のとおりです。

equals
notEqual
startsWith
endsWith
contains
isNull
notNull

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

8.1.2 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: 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

8.1.3 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

8.1.4 listADRHomes

WLSTでの使用: オンライン

説明

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

構文

listADRHomes([server])

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

例

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

listADRHomes()
diag/ofm/base_domain/AdminServer
diag/ofm/EMGC_DOMAIN/EMOMS

8.1.5 listIncidents

WLSTでの使用: オンライン

説明

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

構文

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

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

引数

定義

id

一連の診断インシデントを一覧表示する問題のID。

adrHome

インシデントを問い合せるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。

デフォルトADRホームは次の場所です。

ADR_BASE/diag/OFM/domain_name/server_name

server

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

例

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

listIncidents(id="1")
Incident Id     Incident Time                   Problem Key
        2       Tue May 28 11:05:59 PDT 2013    MDS-50500 [MANUAL]
        1       Tue May 28 11:02:22 PDT 2013    MDS-50500 [MANUAL]

8.1.6 listProblems

WLSTでの使用: オンライン

説明

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

構文

listProblems([adrHome][,server])

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

引数

定義

adrHome

問題を問い合せるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。

デフォルトADRホームは次の場所です。

ADR_BASE/diag/OFM/domain_name/server_name

server

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

例

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

listProblems()
Problem Id        Problem Key
         1        MDS-50500 [MANUAL]
         2        JOC-38922 [AdminServer] [oracle.cache.network]

8.1.7 queryIncidents

WLSTでの使用: オンライン

説明

指定した基準に一致するインシデントをリストします。1つ以上のサーバー間、またはドメイン内のすべてのサーバーに対して特定の属性の値を問い合わせできます。

構文

queryIncidents(query [,servers])

引数定義

引数	定義
query	単純式で構成された式で、ブール演算子で連結できます。式には、インシデント属性、演算子および文字列が次の書式で含まれます。 attribute operator "string" 単純式はカッコ()でグループ化されたブール演算子ANDまたはORで連結できます。次のインシデント属性がサポートされています。 TIMESTAMP: インシデント作成時間。`from`および`to`演算子を使用して時間範囲を指定できます。日付書式は`YYYY-MM-DD HH:MM`です。 ECID: 実行コンテキストID PROBLEM_KEY: 問題キー MSG_FACILITY: エラー・メッセージ機能(ORA、OHSなど) MSG_NUMBER: エラー・メッセージID (600など) カスタム・インシデント属性もサポートされています。たとえば、TRACEID、APP、URI、AND DSIDがサポートされています。さらに、インシデントのreadme.txtファイルに示されるコンテキスト値がサポートされています。たとえば、DFW_APP_NAMEおよびDFW_USER_NAMEがサポートされています。サポートされている演算子は次のとおりです。 equals notEqual startsWith endsWith contains isNull notNull
servers	問い合せる1つ以上のサーバーの名前。この引数はオプションです。指定しない場合、ドメイン内のすべてのサーバーに対してコマンドが実行されます。このオプションは、管理サーバーに接続している場合にのみ有効です。

query

単純式で構成された式で、ブール演算子で連結できます。式には、インシデント属性、演算子および文字列が次の書式で含まれます。

attribute operator "string"

単純式はカッコ()でグループ化されたブール演算子ANDまたはORで連結できます。

次のインシデント属性がサポートされています。

TIMESTAMP: インシデント作成時間。fromおよびto演算子を使用して時間範囲を指定できます。日付書式はYYYY-MM-DD HH:MMです。
ECID: 実行コンテキストID
PROBLEM_KEY: 問題キー
MSG_FACILITY: エラー・メッセージ機能(ORA、OHSなど)
MSG_NUMBER: エラー・メッセージID (600など)

カスタム・インシデント属性もサポートされています。たとえば、TRACEID、APP、URI、AND DSIDがサポートされています。さらに、インシデントのreadme.txtファイルに示されるコンテキスト値がサポートされています。たとえば、DFW_APP_NAMEおよびDFW_USER_NAMEがサポートされています。

サポートされている演算子は次のとおりです。

equals
notEqual
startsWith
endsWith
contains
isNull
notNull

servers

このオプションは、管理サーバーに接続している場合にのみ有効です。

例

次の例では、ドメイン内のすべてのインシデントに対してECID f19wAgN000001を問い合せます。

queryIncidents(query="ECID equals f19wAgN000001")

次の例では、2013年4月1日から2013年4月15日の間に発生したすべてのインシデントをサーバーwls_server1に問い合せます。

 queryIncidents(query="TIMESTAMP from '2013-04-01 00:00'AND TIMESTAMP to '2013-04-15 00:00'", servers=["wls_server1"])

8.1.8 reloadCustomRules

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

説明

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

構文

reloadCustomRules([name] [, server])

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

引数

定義

name

カスタム診断ルールの名前。この引数はオプションです。指定した場合は、指定したルールのみが再ロードされます。この引数を指定しない場合、すべてのカスタム診断ルールが再ロードされます。

カスタム診断ルールを含むファイルが、次のいずれかのディレクトリに置かれている必要があります。

DOMAIN_HOME/config/fmwconfig/dfw
DOMAIN_HOME/config/fmwconfig/servers/server_name/dfw

server

ルールの再ロード先のサーバーの名前。この引数はオプションです。指定しない場合、ルールはすべてのサーバーに再ロードされます。

このオプションは、管理サーバーに接続している場合にのみ有効です。

例

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

reloadCustomRules(name='myCustomRules.xml')

8.1.9 showIncident

WLSTでの使用: オンライン

説明

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

構文

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

引数	定義
id	表示するインシデントのID。
adrHome	インシデントを問い合せるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。デフォルトADRホームは次の場所です。 ADR_BASE/diag/OFM/domain_name/server_name
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.2 診断ダンプ・コマンド

診断ダンプは、特定の診断情報を取得およびダンプします。この処理は、インシデントが作成された時点では自動で、管理者が要求した時点では手動で行われます。WLST診断ダンプ・コマンドでは、ダンプを表示および実行できます。

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

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

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

8.2.1 describeDump

WLSTでの使用: オンライン

説明

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

構文

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

引数	定義
name	情報を表示するダンプの名前。
appName	情報を収集するデプロイされたアプリケーションの名前。たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。
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

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

8.2.3 listDumps

WLSTでの使用: オンライン

説明

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

構文

listDumps([appName] [,server])

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

引数

定義

appName

診断を収集する対象となるデプロイされたアプリケーションの名前。

この引数を指定した場合、指定されたアプリケーションのダンプが返されます。この引数を指定しない場合、システム・ダンプが返されます。

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.3 ダンプ・サンプリング・コマンド

診断ダンプ・サンプリングは、指定された間隔で診断ダンプの出力を取得します。WLSTダンプ・サンプリング・コマンドでは、ダンプ・サンプリングを管理できます。

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

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

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

8.3.1 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の実行時に診断ダンプ・サンプルが前のサンプルに追加され、単一アーカイブとなるようにするどうかを指定するブール値。有効な値は、`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

8.3.2 enableDumpSampling

WLSTでの使用: オンライン

説明

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

構文

enableDumpSampling(enable [,server])

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

例

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

enableDumpSampling(enable=false)

Dump sampling disabled

8.3.3 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  05-21-13 07:25   dfw_samplingArchive1065570966467923683.JVMThreadDump.dmp
      840  05-21-13 07:25   dfw_samplingArchive7749640004639161119.readme.txt
 --------                   -------
   509620                   2 files

8.3.4 isDumpSamplingEnabled

WLSTでの使用: オンライン

説明

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

構文

isDumpSamplingEnabled([server])

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

例

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

isDumpSamplingEnabled(server="wls_server_1")

true

8.3.5 listDumpSamples

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    :

8.3.6 removeDumpSample

WLSTでの使用: オンライン

説明

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

構文

removeDumpSample(sampleName [,server])

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

例

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

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

Removed HTTPSampling

8.3.7 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の実行時に診断ダンプ・サンプルが前のサンプルに追加され、単一アーカイブとなるようにするどうかを指定するブール値。有効な値は、`true`および`false`です。デフォルトは、trueです。値がtrueの場合、サンプルが前のサンプルに追加されます。値がfalseの場合、dfw.sampleArchiveによって個々のサンプリング・ファイルが含まれるzipファイルが返されます。ダンプ・サンプリングにバイナリ・データが含まれている場合はfalseを指定します。
args	省略可能。各サンプリング時に診断ダンプにより使用される診断ダンプ引数。引数は名前/値ペアで指定します。
server	省略可能。情報の収集元となるサーバーの名前。このパラメータを指定しないと、管理サーバーに対してダンプ・サンプリングが更新されます。

例

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

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