B WLDF Beanおよび関数のリファレンス
WebLogic診断フレームワーク(WLDF)にはBeanと関数のセットが用意されており、これを収集されたメトリックのポリシー式で使用して、WebLogic Server JMXの共通データ・ソースにアクセスできます。
- WLDF Beanのリファレンス
WLDFにいくつかのBeanが含まれており、これを収集されたメトリックのポリシー式で使用して、アクティブなクラスタ・オブジェクト、MBean、インストゥルメンテーション・イベント・フィールドなどに関する情報を提供する統計にアクセスできます。 - 関数のリファレンス
WLDFには関数のセットが含まれており、これをポリシー式で使用してデータの抽出または問合せを簡略化できます。
WLDF Beanのリファレンス
WLDFにいくつかのBeanが含まれており、これを収集されたメトリックのポリシー式で使用して、アクティブなクラスタ・オブジェクト、MBean、インストゥルメンテーション・イベント・フィールドなどに関する情報を提供する統計にアクセスできます。
ノート:
WebLogic Server Multitenantドメイン・パーティション、リソース・グループ、リソース・グループ・テンプレートおよび仮想ターゲットは、WebLogic Server 12.2.1.4.0で非推奨になり、次のリリースで削除されます。
- clusterRuntime
clusterRuntime
Beanは、ドメインのアクティブ・クラスタの統計に対するクラスタ全体のアクセスを提供します。 - domainRuntime
domainRuntime
Beanは、ドメイン・ランタイムMBeanサーバーに登録されたMBeanへのアクセスを提供します。 - instrumentationEvent
instrumentationEvent
Beanは、インストゥルメンテーション・ポリシー式のインストゥルメンテーション・イベント・フィールドへのアクセスを提供します。 - log
ログ・ポリシー式で使用されるlog
Beanは、ログ・メッセージ・フィールドへのアクセスを提供します。 - partition
partition
Beanは、パーティション・スコープ・メトリックを取得するための便利なメカニズムです。このBeanを使用できるのは、このBeanがスコープ指定されている同じパーティションにデプロイされた診断システム・モジュールで構成されたポリシーのみです。 - platform
platform
Beanは、JVMのプラットフォームMBeanサーバーを通じて公開されたMBeanから値を取得します。 - resource
resource
Beanは、診断システム・モジュールのデプロイメント内のBeanおよび状態情報へのアクセスを提供します。 - runtime
runtime
Beanは、WebLogic ServerランタイムMBeanサーバーに登録されたMBeanへのアクセスを提供します。
親トピック: WLDF Beanおよび関数のリファレンス
clusterRuntime
clusterRuntime
Beanは、ドメインのアクティブ・クラスタの統計に対するクラスタ全体のアクセスを提供します。
属性
名前 | 説明 |
---|---|
clusters |
クラスタ名をキーとして、ドメイン内のアクティブ・クラスタ・オブジェクトを表すBeanのマップを提供します。 |
name |
クラスタの名前。 |
メソッド
名前 | 説明 |
---|---|
query |
オブジェクト名パターンおよび属性式に基づいて、MBean属性値のセットの問合せを実行します。 パラメータ:
戻り値: 指定したObjectNameパターンおよび属性式に一致する値のセットを返します。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。 |
getClusters |
ドメイン内のアクティブ・クラスタ・オブジェクトを表すBeanのマップを提供します。 |
getAttribute |
MBeanソースから単一属性値を取得します。 パラメータ:
戻り値: 指定した JMX ObjectNameと一致する属性値を戻します。 |
親トピック: WLDF Beanのリファレンス
domainRuntime
domainRuntime
Beanは、ドメイン・ランタイムMBeanサーバーに登録されたMBeanへのアクセスを提供します。
属性
名前 | 説明 |
---|---|
domain |
ドメイン・ランタイムMBeanサーバーのルート |
name |
Bean名。 |
serverRuntimes |
ドメインのアクティブな タイプ: |
メソッド
名前 | 説明 |
---|---|
query |
オブジェクト名パターンおよび属性式に基づいて、MBean属性値のセットの問合せを実行します。 パラメータ:
戻り値: 指定したオブジェクト名パターンおよび属性式に一致する値のセットを返します。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。 |
query |
ドメイン・ランタイムMBeanサーバー内のターゲットのセットに対してJMX問合せを実行します。 パラメータ:
戻り値: 指定したターゲット名全体を対象として、指定したオブジェクト名パターンおよび属性式に一致する値のセットを返します。 ターゲット名には、ドメインの有効なWebLogic Serverインスタンスまたはクラスタを指定できます。 これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。 |
lookupServerRuntime |
指定されたサーバー・インスタンスの パラメータ:
戻り値: 指定したオブジェクト名パターンおよび属性式に一致する値を返します。 |
getAttribute |
MBeanソースから単一属性値を取得します。 パラメータ:
戻り値: 指定した JMX ObjectNameと一致する属性値を戻します。 |
親トピック: WLDF Beanのリファレンス
instrumentationEvent
instrumentationEvent
Beanは、インストゥルメンテーション・ポリシー式のインストゥルメンテーション・イベント・フィールドへのアクセスを提供します。
属性
名前 | 説明 |
---|---|
timeStamp |
イベント作成に関連付けられたタイムスタンプ値。 タイプ: |
contextId |
インストゥルメンテーション・イベントに関連付けられた診断コンテキストID。 |
txId |
インストゥルメンテーション・イベントに関連付けられたJTAトランザクションID。 |
userId |
インストゥルメンテーション・イベントが生成されるリクエストに関連付けられたユーザー名。 |
eventType |
インストゥルメンテーション・イベント・タイプ。 |
domain |
現在のドメインの名前。 |
server |
インストゥルメンテーション・イベントが発生したサーバーの名前。 |
scope |
このイベントのためのインストゥルメンテーション・スコープ。 |
module |
インストゥルメンテーション・イベント・ルールが定義されているモジュールの名前。 |
monitor |
インストゥルメンテーション・イベントを生成したインストゥルメンテーション・モニター。 |
fileName |
インストゥルメンテーション・イベントを生成したコードを含むソース・ファイル名。 |
lineNumber |
インストゥルメンテーション・イベントの発生源となった、ソース・ファイル内の行番号。 |
className |
インストゥルメンテーション・イベントの発生源のクラス名。 |
methodName |
インストゥルメンテーション・イベントの発生源のメソッド名。 |
methodDesc |
インストゥルメンテーション・イベントを生成したメソッドの説明。 |
arguments |
インストゥルメンテーション・イベントを生成したメソッドに渡された引数。 |
returnValue |
インストゥルメンテーション・イベントを生成したメソッドの戻り値。 |
payload |
インストゥルメンテーション・イベントに関連付けられたペイロード。 |
contextPayload |
インストゥルメンテーション・イベントに関連付けられたコンテキスト・ペイロード。 |
dyeVector |
インストゥルメンテーション・イベントに関連付けられた仕分けベクトル。 タイプ: |
threadName |
インストゥルメンテーション・イベントを生成したスレッドの名前。 |
partitionId |
インストゥルメンテーション・イベントに関連付けられたパーティションID。 |
partitionName |
インストゥルメンテーション・イベントに関連付けられたパーティション名。 |
例
次に、インストゥルメンテーション・イベント・フィールドにアクセスするためにELポリシー式でinstrumentationEvent
Beanを使用する例を示します。
instrumentationEvent.monitor == 'Servlet_Around_Service' instrumentationEvent.getMonitor() == 'Servlet_Around_Service' instrumentationEvent.monitor.contains('Servlet_')
親トピック: WLDF Beanのリファレンス
log
ログ・ポリシー式で使用されるlog
Beanは、ログ・メッセージ・フィールドへのアクセスを提供します。
属性
名前 | 説明 |
---|---|
timestamp |
ログ・メッセージが作成されたときを示すタイムスタンプ。 タイプ: |
formattedDate |
書式設定済の日付文字列。 |
messageId |
ログ・エントリのメッセージID。 |
machineName |
ログ・エントリが作成されたマシン名。 |
serverName |
ログ・エントリが作成されたサーバー名。 |
threadName |
ログ記録されたイベントが作成されたスレッド名。 |
userId |
ログ記録されたイベントを生成したユーザーのID。 |
transactionId |
ログ記録されたイベントに関連付けられたJTAトランザクションID。 |
severity |
ログ・メッセージの重大度レベル。 |
severityString |
ログ・メッセージの重大度文字列。 |
subsystem |
ログ・メッセージを生成したサブシステムの名前。 |
logMessage |
ログ・エントリのメッセージ・コンテンツ。 |
diagnosticContextId |
ログ記録されたイベントに関連付けられた診断コンテキストID。 |
supplementalAttributes |
ログ・エントリに含まれている補足属性の名前と値の組合せ。 |
partitionId |
ログ記録されたイベントに関連付けられたパーティションID。 |
partitionName |
ログ記録されたイベントに関連付けられたパーティションID。 |
例
次に、ログ・メッセージ・フィールドにアクセスするためにELポリシー式でlog
Beanを使用する例を示します。
log.logMessage.contains("Part of a message") log.getLogMessage().contains("Part of a message") log.messageId == "BEA-000365" log.messageId.endsWith('000365')
親トピック: WLDF Beanのリファレンス
partition
partition
Beanは、パーティション・スコープ・メトリックを取得するための便利なメカニズムです。このBeanを使用できるのは、このBeanがスコープ指定されている同じパーティションにデプロイされた診断システム・モジュールで構成されたポリシーのみです。
属性
名前 | 説明 |
---|---|
ID |
指定されたパーティションに関連付けられたグローバル一意識別子。 |
root |
パーティションの タイプ: |
runtime |
診断システム・モジュールがデプロイされているパーティションの タイプ: |
メソッド
名前 | 説明 |
---|---|
query |
パーティション名でフィルタされた、パーティション・スコープのJMX問合せを発行します。 パラメータ:
戻り値: 指定したオブジェクト名パターンおよび属性式に一致する値のセットを返します。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。 |
getAttribute |
MBeanソースから単一属性値を取得します。 パラメータ:
戻り値: 指定した JMX ObjectNameと一致する属性値を戻します。 |
親トピック: WLDF Beanのリファレンス
platform
platform
Beanは、JVMのプラットフォームMBeanサーバーを通じて公開されたMBeanから値を取得します。(WebLogic Serverでは、デフォルトで、WebLogicランタイムMBeanを格納するためにJVMのプラットフォームMBeanサーバーを使用します。したがって、プラットフォームMBeanサーバーは、1つのサーバー・インスタンス上にあるプラットフォームMXBean、WebLogicランタイムMBean、およびWebLogic構成MBeanへのアクセスを提供します。)
属性
名前 | 説明 |
---|---|
name |
platform Beanの名前( |
メソッド
名前 | 説明 |
---|---|
query |
オブジェクト名パターンおよび属性式に基づいて、MBean属性値のセットの問合せを実行します。 パラメータ:
戻り値: 指定したオブジェクト名パターンおよび属性式に一致する値のセット。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。 |
getAttribute |
MBeanソースから単一属性値を取得します。 パラメータ:
戻り値: 指定した JMX ObjectNameと一致する属性値を戻します。 |
親トピック: WLDF Beanのリファレンス
resource
resource
Beanは、診断システム・モジュールのデプロイメント内のBeanおよび状態情報へのアクセスを提供します。アクセスは、同じ診断システム・モジュール内に構成されているポリシーに限定されます。つまり、このBeanは、他の診断システム・モジュールで構成されたポリシーのBeanおよび状態情報へのアクセスを取得できません。このBeanは、ポリシー・チェーンで使用されます。
属性
名前 | 説明 |
---|---|
watches |
同じ診断システム・モジュールのデプロイメント内で現在構成されているポリシーのマップ。 |
親トピック: WLDF Beanのリファレンス
runtime
runtime
Beanは、WebLogic ServerランタイムMBeanサーバーに登録されたMBeanへのアクセスを提供します。
属性
名前 | 説明 |
---|---|
domain |
ローカルのWebLogic ServerランタイムMBeanサーバーのルート タイプ: |
name |
Bean名。 |
serverRuntime |
ローカルのWebLogic ServerランタイムMBeanサーバーのルート タイプ: |
メソッド
名前 | 説明 |
---|---|
query |
オブジェクト名パターンおよび属性式に基づいて、MBean属性値のセットの問合せを実行します。 パラメータ:
戻り値: 指定したオブジェクト名パターンおよび属性式に一致する値のセット。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。 |
getAttribute |
MBeanソースから単一属性値を取得します。 パラメータ:
戻り値: 指定した JMX ObjectNameと一致する属性値を戻します。 |
親トピック: WLDF Beanのリファレンス
関数のリファレンス
WLDFには関数のセットが含まれており、これをポリシー式で使用してデータの抽出または問合せを簡略化できます。
- wls:tableChanges
wls:tableChanges
関数は、入力値の表を取得して、入力ベクトルごとに1つある差分ベクトルの出力表を生成します。 - wls:tableAverages
wls:tableAverages
関数は、値の入力表に対して行列縮約を実行し、表の各行の平均を計算して、表の行ごとに1つとなる平均のベクトルを生成します。 - wls:extract
wls:extract
関数は、指定されたサンプリング・レート・スケジュールおよび時間ウィンドウに基づいて、指定された入力ソースのセットから時系列の表を抽出します。 - wls:average
wls:average
関数は、数値の入力値のセットに基づいて平均値を計算します。 - wls:changes
wls:changes
メソッドは、サイズnの入力値のベクトルを取得し、連続する各値間の最大n-1の差分のベクトルを生成します。 - wls:aliveServersCount
親トピック: WLDF Beanおよび関数のリファレンス
wls:tableChanges
wls:tableChanges
関数は、入力値の表を取得して、入力ベクトルごとに1つある差分ベクトルの出力表を生成します。
この関数は、入力が次のいずれかの場合、IllegalArgumentException
をスローします。
-
2次元表ではない場合
-
数値以外の値を含む場合
パラメータ
名前 | 説明 |
---|---|
inputTable |
数値の入力表(各行は、通常、同じメトリック・インスタンスからの時系列の値)。 |
親トピック: 関数のリファレンス
wls:tableAverages
wls:tableAverages
関数は、値の入力表に対して行列縮約を実行し、表の各行の平均を計算して、表の行ごとに1つとなる平均のベクトルを生成します。通常、表の各行は、特定のメトリック・インスタンスからの時系列の値を表します。
この関数は、入力が次のいずれかの場合、IllegalArgumentException
をスローします。
-
2次元表ではない場合
-
数値以外の値を含む場合
パラメータ
名前 | 説明 |
---|---|
valuesTable |
数値の入力表(各行は、通常、同じメトリック・インスタンスからの時系列の値)。 |
親トピック: 関数のリファレンス
wls:extract
wls:extract
関数は、指定されたサンプリング・レート・スケジュールおよび時間ウィンドウに基づいて、指定された入力ソースのセットから時系列の表を抽出します。入力ソースには、次のいずれかを使用できます。
-
JMX Beanの
query()
操作からの出力。たとえば:wls.runtime.query('com.bea:Type=ServletRuntime,*', 'ExecutionTimeAverage')
-
String
としてのEL式。たとえば:wls.runtime.JVMRuntime.heapFreePercent
パラメータ
名前 | 説明 |
---|---|
inputExpression |
サンプリングするBeanメトリック。 |
schedule |
文字列として指定された、時間、分または秒(デフォルト)単位のメトリックのサンプリング・レート。 |
duration |
文字列として指定された、時間、分または秒(デフォルト)単位のメトリックの必要なサンプリング・ウィンドウ |
schedule
およびduration
パラメータは、秒、分または時間単位で指定可能で、次の構文を使用して文字列として指定します。
金額[単位]
前の構文では:
-
amount
は、整数を表します。 -
[
unit
]は、seconds
、minutes
またはhours
を表します。それぞれ最初の1文字に短縮できます。たとえば、seconds
は、s
に短縮できます。 -
amount
とunit
の間に空白文字を含めることができます。
たとえば、5秒を指定するには、次のいずれかを使用します。
-
5seconds
-
5 sec
-
5s
-
5snds
親トピック: 関数のリファレンス
wls:average
wls:average
関数は、数値の入力値のセットに基づいて平均値を計算します。この関数は、入力ベクトルのスカラー平均(または、入力が空の場合はDouble.NaN
)を返します。入力に数値以外の値が含まれる場合、IllegalArgumentException
がスローされます。
ノート:
wls:average
関数は、ELに付属するaverage()
演算とは異なります。
パラメータ
名前 | 説明 |
---|---|
inputValues |
数値の入力値のベクトル |
親トピック: 関数のリファレンス
wls:changes
wls:changes
メソッドは、サイズnの入力値のベクトルを取得し、連続する各値間の最大n-1の差分のベクトルを生成します。たとえば、入力ベクトルが{ 3, 2, 5, 3, 7 }
である場合、生成されるベクトルは{ 1, -1, 3, -2, 4 }
です。
次に注意してください:
-
シーケンスに
Double.NaN
を含めることができますが、これは後続の計算ではスキップされます。 -
入力値が数値以外の場合、
IllegalArgumentException
がスローされます。
パラメータ
名前 | 説明 |
---|---|
inputValues |
数値の入力ベクトル |
親トピック: 関数のリファレンス
wls:aliveServersCount
wls:aliveServersCount
関数は、指定されたクラスタでRUNNING
状態にある管理対象サーバー・インスタンスの数をカウントするヘルパー関数です。
パラメータ
名前 | 説明 |
---|---|
clusterName |
カウントする実行中のサーバー・インスタンスを含むクラスタの名前。 |
親トピック: 関数のリファレンス