プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle WebLogic Server診断フレームワークの構成と使用
12c (12.2.1.1.0)
E77393-01
目次へ移動
目次

前
次

B WLDF Beanおよび関数のリファレンス

この付録では、共通のWebLogic Server JMXデータ・ソースへのアクセスを取得するために、収集対象メトリックのポリシー式で使用できるWLDFに付属するBeanおよび関数のリファレンスを提供します。

この付録の内容は次のとおりです。

WLDF Beanのリファレンス

WLDFでは、収集対象メトリックのポリシー式で使用できる次のBeanが提供されます。

clusterRuntime

clusterRuntime Beanは、ドメインのアクティブ・クラスタの統計に対するクラスタ全体のアクセスを提供します。

属性

名前 説明
clusters

クラスタ名をキーとして、ドメイン内のアクティブ・クラスタ・オブジェクトを表すBeanのマップを提供します。

タイプ: interface java.util.Map

name

クラスタの名前。

タイプ: class java.lang.String

メソッド

名前 説明
query

オブジェクト名パターンおよび属性式に基づいて、MBean属性値のセットの問合せを実行します。

パラメータ:

  • onPattern

    有効なJMXオブジェクト名またはオブジェクト名パターン

  • attributePattern

    一致する各MBeanインスタンスから値を取得するために使用するEL式(式は、各MBeanを基準とする属性式)。

    たとえば、MBeanがServerRuntimeMBeanである場合、式'OpenSocketsCurrentCount'は、OpenSocketsCurrentCount属性の値を取得します。これに対して、'HealthState.State'は、HealthState子オブジェクトのState値を取得します。

戻り値:

指定したObjectNameパターンおよび属性式に一致する値のセットを返します。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。

getClusters

ドメイン内のアクティブ・クラスタ・オブジェクトを表すBeanのマップを提供します。

戻り値:

domainRuntime

domainRuntime Beanは、ドメイン・ランタイムMBeanサーバーに登録されたMBeanへのアクセスを提供します。

属性

名前 説明
domain

ドメイン・ランタイムMBeanサーバーのルートDomainRuntimeMBean

name

Bean名。

タイプ: class java.lang.String

serverRuntimes

ドメインのアクティブなServerRuntimeMBeanインスタンスの配列を返します。

タイプ: class weblogic.management.runtime.ServerRuntimeMBean[]

メソッド

名前 説明
query

オブジェクト名パターンおよび属性式に基づいて、MBean属性値のセットの問合せを実行します。

パラメータ:

  • onPattern

    有効なJMXオブジェクト名またはオブジェクト名パターン

  • attributePattern

    一致する各MBeanインスタンスから値を取得するために使用するEL式(式は、各MBeanを基準とする属性式)。

    たとえば、MBeanがServerRuntimeMBeanである場合、式'OpenSocketsCurrentCount'は、OpenSocketsCurrentCount属性の値を取得します。これに対して、'HealthState.State'は、HealthState子オブジェクトのState値を取得します。

戻り値:

指定したオブジェクト名パターンおよび属性式に一致する値のセットを返します。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。

query

ドメイン・ランタイムMBeanサーバー内のターゲットのセットに対してJMX問合せを実行します。

パラメータ:

  • targets

    カンマ区切りのStringで指定されるサーバーまたはクラスタ・ターゲットのリスト

  • onPattern

    有効なJMXオブジェクト名またはオブジェクト名パターン

  • expression

    一致する各MBeanインスタンスで値を取得するために使用するEL式

戻り値:

指定したターゲット名全体を対象として、指定したオブジェクト名パターンおよび属性式に一致する値のセットを返します。

ターゲット名には、ドメインの有効なWebLogic Serverインスタンスまたはクラスタを指定できます。

これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。

lookupServerRuntime

指定されたサーバー・インスタンスのServerRuntimeMBeanを返します(指定がない場合はnullを返します)。

パラメータ:

  • serverName

    ルックアップするServerRuntimeMBeanの名前

戻り値:

指定したオブジェクト名パターンおよび属性式に一致する値を返します。

instrumentationEvent

instrumentationEvent Beanは、インストゥルメンテーション・ポリシー式のインストゥルメンテーション・イベント・フィールドへのアクセスを提供します。

属性

名前 説明
timeStamp

イベント作成に関連付けられたタイムスタンプ値。

タイプ: class java.lang.Long

contextId

インストゥルメンテーション・イベントに関連付けられた診断コンテキストID。

タイプ: class java.lang.String

txId

インストゥルメンテーション・イベントに関連付けられたJTAトランザクションID。

タイプ: class java.lang.String

userId

インストゥルメンテーション・イベントが生成されるリクエストに関連付けられたユーザー名。

タイプ: class java.lang.String

eventType

インストゥルメンテーション・イベント・タイプ。

タイプ: class java.lang.String

domain

現在のドメインの名前。

タイプ: class java.lang.String

server

インストゥルメンテーション・イベントが発生したサーバーの名前。

タイプ: class java.lang.String

scope

このイベントのためのインストゥルメンテーション・スコープ。

タイプ: class java.lang.String

module

インストゥルメンテーション・イベント・ルールが定義されているモジュールの名前。

タイプ: class java.lang.String

monitor

インストゥルメンテーション・イベントを生成したインストゥルメンテーション・モニター。

タイプ: class java.lang.String

fileName

インストゥルメンテーション・イベントを生成したコードを含むソース・ファイル名。

タイプ: class java.lang.String

lineNumber

インストゥルメンテーション・イベントの発生源となった、ソース・ファイル内の行番号。

タイプ: class java.lang.Integer

className

インストゥルメンテーション・イベントの発生源のクラス名。

タイプ: class java.lang.String

methodName

インストゥルメンテーション・イベントの発生源のメソッド名。

タイプ: class java.lang.String

methodDesc

インストゥルメンテーション・イベントを生成したメソッドの説明。

タイプ: class java.lang.String

arguments

インストゥルメンテーション・イベントを生成したメソッドに渡された引数。

タイプ: class java.lang.String

returnValue

インストゥルメンテーション・イベントを生成したメソッドの戻り値。

タイプ: class java.lang.String

payload

インストゥルメンテーション・イベントに関連付けられたペイロード。

タイプ class java.lang.Object

contextPayload

インストゥルメンテーション・イベントに関連付けられたコンテキスト・ペイロード。

タイプ: class java.lang.String

dyeVector

インストゥルメンテーション・イベントに関連付けられた仕分けベクトル。

タイプ: class java.lang.Long

threadName

インストゥルメンテーション・イベントを生成したスレッドの名前。

タイプ: class java.lang.String

partitionId

インストゥルメンテーション・イベントに関連付けられたパーティションID。

タイプ: class java.lang.String

partitionName

インストゥルメンテーション・イベントに関連付けられたパーティション名。

タイプ: class java.lang.String

次に、インストゥルメンテーション・イベント・フィールドにアクセスするためにELポリシー式でinstrumentationEvent Beanを使用する例を示します。

instrumentationEvent.monitor == 'Servlet_Around_Service'
 
instrumentationEvent.getMonitor() == 'Servlet_Around_Service'
 
instrumentationEvent.monitor.contains('Servlet_')

log

ログ・ポリシー式で使用されるlog Beanは、ログ・メッセージ・フィールドへのアクセスを提供します。

属性

名前 説明
timestamp

ログ・メッセージが作成されたときを示すタイムスタンプ。

タイプ: class java.lang.Long

formattedDate

書式設定済の日付文字列。

タイプ: class java.lang.String

id

ログ・エントリのメッセージID。

タイプ: class java.lang.String

machineName

ログ・エントリが作成されたマシン名。

タイプ: class java.lang.String

serverName

ログ・エントリが作成されたサーバー名。

タイプ: class java.lang.String

threadName

ログ記録されたイベントが作成されたスレッド名。

タイプ: class java.lang.String

userId

ログ記録されたイベントを生成したユーザーのID。

タイプ: class java.lang.String

transactionId

ログ記録されたイベントに関連付けられたJTAトランザクションID。

タイプ: class java.lang.String

severity

ログ・メッセージの重大度レベル。

タイプ: class java.lang.Integer

severityString

ログ・メッセージの重大度文字列。

タイプ: class java.lang.String

subsystem

ログ・メッセージを生成したサブシステムの名前。

タイプ: class java.lang.String

logMessage

ログ・エントリのメッセージ・コンテンツ。

タイプ: class java.lang.String

diagnosticContextId

ログ記録されたイベントに関連付けられた診断コンテキストID。

タイプ: class java.lang.String

supplementalAttributes

ログ・エントリに含まれている補足属性の名前と値の組合せ。

タイプ: class java.util.Properties

partitionId

ログ記録されたイベントに関連付けられたパーティションID。

タイプ: class java.lang.String

partitionName

ログ記録されたイベントに関連付けられたパーティションID。

タイプ: class java.lang.String

次に、ログ・メッセージ・フィールドにアクセスするためにELポリシー式でlog Beanを使用する例を示します。

log.logMessage.contains("Part of a message")
 
log.getLogMessage().contains("Part of a message")
 
log.id == "BEA-000365"
 
log.id.endsWith('000365')

partition

partition Beanは、パーティション・スコープ・メトリックを取得するための便利なメカニズムです。このBeanを使用できるのは、このBeanがスコープ指定されている同じパーティションにデプロイされた診断システム・モジュールで構成されたポリシーのみです。

属性

名前 説明
ID

指定されたパーティションに関連付けられたグローバル一意識別子。

root

パーティションのPartitionMBean構成ルート。これは、WebLogic ServerランタイムMBeanサーバーに登録された読取り専用のPartitionMBeanであることに注意してください。

タイプ: interface weblogic.management.configuration.PartitionMBean

runtime

診断システム・モジュールがデプロイされているパーティションのPartitionRuntimeMBeanルート。

タイプ: interface weblogic.management.runtime.PartitionRuntimeMBean

メソッド

名前 説明
query

パーティション名でフィルタされた、パーティション・スコープのJMX問合せを発行します。

パラメータ:

  • onPattern

    JMXオブジェクト名またはオブジェクト名パターン

  • attributePattern

    問合せセットで返されたMBeanのセット内の値にアクセスするためのEL式

戻り値:

指定したオブジェクト名パターンおよび属性式に一致する値のセットを返します。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。

platform

platform Beanは、JVMのプラットフォームMBeanサーバーを通じて公開されたMBeanから値を取得します。(WebLogic Serverでは、デフォルトで、WebLogicランタイムMBeanを格納するためにJVMのプラットフォームMBeanサーバーを使用します。したがって、プラットフォームMBeanサーバーは、1つのサーバー・インスタンス上にあるプラットフォームMXBean、WebLogicランタイムMBean、およびWebLogic構成MBeanへのアクセスを提供します。)

属性

名前 説明
name

platform Beanの名前("platform")

メソッド

名前 説明
query

オブジェクト名パターンおよび属性式に基づいて、MBean属性値のセットの問合せを実行します。

パラメータ:

  • onPattern

    有効なJMXオブジェクト名またはオブジェクト名パターン

  • attributePattern

    一致する各MBeanインスタンスから値を取得するために使用するEL式(式は、各MBeanを基準とする属性式)。

    たとえば、MBeanがServerRuntimeMBeanである場合、式'OpenSocketsCurrentCount'は、OpenSocketsCurrentCount属性の値を取得します。これに対して、'HealthState.State'は、HealthState子オブジェクトのState値を取得します。

戻り値:

指定したオブジェクト名パターンおよび属性式に一致する値のセット。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。

resource

resource Beanは、診断システム・モジュールのデプロイメント内のBeanおよび状態情報へのアクセスを提供します。アクセスは、同じ診断システム・モジュール内で構成されたポリシーに制限されます。つまり、このBeanは、他の診断システム・モジュールで構成されたポリシーのBeanおよび状態情報へのアクセスを取得できません。このBeanは、ポリシー・チェーンで使用されます。

属性

名前 説明
watches

同じ診断システム・モジュールのデプロイメント内で現在構成されているポリシーのマップ。

タイプ: interface java.util.Map

runtime

runtime Beanは、WebLogic ServerランタイムMBeanサーバーに登録されたMBeanへのアクセスを提供します。

属性

名前 説明
domain

ローカルのWebLogic ServerランタイムMBeanサーバーのルートDomainMBean

タイプ: interface weblogic.management.configuration.DomainMBean

name

Bean名。

タイプ: class java.lang.String

serverRuntime

ローカルのWebLogic ServerランタイムMBeanサーバーのルートServerRuntimeMBean

タイプ: interface weblogic.management.runtime.ServerRuntimeMBean

メソッド

名前 説明
query

オブジェクト名パターンおよび属性式に基づいて、MBean属性値のセットの問合せを実行します。

パラメータ:

  • onPattern

    有効なJMXオブジェクト名またはオブジェクト名パターン

  • attributePattern

    一致する各MBeanインスタンスから値を取得するために使用するEL式(式は、各MBeanを基準とする属性式)。

    たとえば、MBeanがServerRuntimeMBeanである場合、式'OpenSocketsCurrentCount'は、OpenSocketsCurrentCount属性の値を取得します。これに対して、'HealthState.State'は、HealthState子オブジェクトのState値を取得します。

戻り値:

指定したオブジェクト名パターンおよび属性式に一致する値のセット。これらの結果は、値のメモリー内履歴を維持するためにwls:extract関数に提供できます。

関数のリファレンス

この項では、ポリシー式で使用できるWLDFに付属する関数セットのリファレンスを提供します。

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]

前の構文では:

  • amountは、整数を表します。

  • [unit]は、secondsminutesまたはhoursを表します。それぞれ最初の1文字に短縮できます。たとえば、secondsは、sに短縮できます。

  • amountunitの間に空白文字を含めることができます。

たとえば、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

カウントする実行中のサーバー・インスタンスを含むクラスタの名前。