プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle WebLogic Server診断フレームワークの構成と使用
12c (12.2.1)
E69998-01
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次
前
前 		 次
次		  

11 アクションの構成

この章では、WebLogic診断フレームワーク(WLDF)で利用可能なアクションの種類とその構成オプションについて説明します。

この章には次の項が含まれます:

WebLogic Server管理コンソールを使用してアクションを作成する方法の詳細は、Oracle WebLogic Server管理コンソール・オンライン・ヘルプの診断システム・モジュールのポリシー用のアクションの作成に関する項を参照してください。

アクションの概要

次の項には、WLDFアクションに関するバックグラウンド情報が含まれます。

アクションの種類

アクションは、ポリシー式がtrueに評価されたときに実行される操作です。WLDFでは、配信メカニズムに従って、次の種類の診断アクションがサポートされます。

  • Java Management Extensions (JMX)

  • Java Message Service (JMS)

  • Simple Network Management Protocol (SNMP)

  • 簡易メール転送プロトコル(SMTP)

  • 診断イメージ・キャプチャ

  • 拡張度フレームワーク

  • REST

  • WebLogicロギング・システム

  • WebLogic Scripting Tool(WLST)

診断モジュールの構成ファイルでは、ドメインのconfig.xmlファイルの次の要素によって、種類の異なるアクションが識別されます。

  • <jmx-notification>

  • <jms-notification>

  • <snmp-notification>

  • <smtp-notification>

  • <image-notification>

  • <scale-up-action>

  • <scale-down-action>

  • <rest-notification>

  • <log-action>

  • <script-action>

前述のいずれのアクション・タイプにも、<name>および<enabled>構成オプションがあります。<name>の値は、ポリシーを対応するアクションにマップするためにポリシーの<notification>要素の値として使用されます。<enabled>要素をtrueに設定すると、そのアクションが有効になります。つまり、関連するポリシーがtrueに評価されると、アクションが実行されます。<name>および<enabled>を除き、各アクション・タイプは一意です。

カスタマイズ可能なアクションの変数

ログ、SMTPおよびRESTアクション・タイプでは、表11-1に示されている1つ以上の変数を含むカスタマイズされた文字列の生成がサポートされます。トリガーされたポリシーによってこれらのアクション・タイプのいずれかが呼び出されると、アクションによって生成されるカスタマイズ済の文字列で使用される各変数が、この表に示されている値に置き換えられます。

表11-1 置換変数

変数名 値 
WatchName

アクションに対応するポリシーの名前

 
WatchRuleType

ポリシー・タイプ(Harvester、LogまたはEventData)

 
WatchRule

ポリシー式

 
WatchTime

対応するポリシーがトリガーされた日時を識別するタイムスタンプ

 
WatchSeverityLevel

ポリシー重大度オプション

 
WatchData

ログ・メッセージ

 
WatchAlarmType

ポリシー・アラーム・タイプの指定(None、AutomaticResetまたはManualResetのいずれか)。

 
WatchAlarmResetPeriod

WLDFWatchNotificationRuntimeMBeanで構成されているアラーム・リセット期間。

 
WatchDomainName

WebLogicドメイン名

 
WatchServerName

サーバー・インスタンス名

ログ、RESTおよびSMTPアクションは、実行時に様々な種類のメッセージを送信します。これらのアクションは、それぞれ異なりますが、表11-1に定義された1つ以上の変数の使用をサポートする1つ以上のプロパティを持ちます。たとえば、SMTPメッセージ本文は、次のようにポリシー名、式、およびポリシーのトリガー日時を示すタイムスタンプを含むように指定できます。

"Test ${WatchName} with policy ${WatchRule} fired at ${WatchTime}."

これらの置換変数の使用方法の詳細は、次の項を参照してください。

アクション・タイムアウト

すべてのWLDFアクションで、アクションが実行を完了するための時間を秒単位で指定するタイムアウトがサポートされます。デフォルトでは、タイムアウトは0で、アクション・タイムアウトは無効です。アクション・タイムアウトを指定するには、WLDFNotificationBean.Timeout属性を使用します。

また、WebLogic Server管理コンソールまたはFusion Middleware Controlでアクションを構成する際にタイムアウトを設定できます。詳細は、以下のトピックを参照してください。

JMXアクションの構成

関連するポリシーがトリガーされると、WLDFは、定義されたJMXアクションごとにJMXイベント(通知)を発行します。すべてのJMX通知を受信し、指定した出力をフィルタするために、各アプリケーションは、アクション・リスナーをサーバーのWLDFWatchNotificationSourceRuntimeMBeanに登録できます。JMXクライアントがフィルタとして使用できるJMX「通知タイプ」の文字列を指定することもできます。

例11-1では、JMXアクションの構成のサンプルを示します。

例11-1 JMXアクションの構成のサンプル

<wldf-resource xmlns="http://xmlns.oracle.com/weblogic/weblogic-diagnostics" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
   xsi:schemaLocation="http://xmlns.oracle.com/weblogic/weblogic-diagnostics/1.0/weblogic-diagnostics.xsd">
  <name>mywldf1</name> 
  <watch-notification>
    <!-- One or more policy configurations -->
    <jmx-notification>
      <name>myJMXNotif</name>
      <enabled>true</enabled>
    </jmx-notification>
    <!-- Other action configurations -->
  </watch-notification>
</wldf-resource>

次に、JMXアクションの例を示します。

 Notification name:    myjmx called. Count= 42.
 Watch severity:         Notice
 Watch time:             Jul 19, 2005 3:40:38 PM EDT
 Watch ServerName:       myserver
 Watch RuleType:         Harvester
 Watch Rule:               ${com.bea:Name=myserver,Type=ServerRuntime//OpenSocketsCurrentCount} > 1
 Watch Name:             mywatch
 Watch DomainName:       mydomain
 Watch AlarmType:        None
 Watch AlarmResetPeriod: 10000

JMSアクションの構成

JMSアクションは、関連するポリシーのトリガーに応答してJMSトピックまたはキューに通知を送信するために使用します。システム・リソース構成ファイルの<destination-jndi-name>要素と<connection-factory-jndi-name>要素で、通知の配信方法を定義します。

例11-2に、指定した接続ファクトリを使用して、指定トピックおよびキューからJMS通知を送信する2つのJMSアクションを示します。この処理を適切に行うためには、ドメインのconfig.xmlファイルでJMSが適切に構成されている必要があります。また、JMSリソースがこのサーバーに対象指定されている必要があります。

例11-2 JMSアクションのサンプル

<wldf-resource xmlns="http://xmlns.oracle.com/weblogic/weblogic-diagnostics" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
   xsi:schemaLocation="http://xmlns.oracle.com/weblogic/weblogic-diagnostics/1.0/weblogic-diagnostics.xsd">
  <name>mywldf1</name> 
  <watch-notification>
    <!-- One or more policy configurations -->
    <jms-notification>
      <name>myJMSTopicNotif</name>
      <destination-jndi-name>MyJMSTopic</destination-jndi-name>
      <connection-factory-jndi-name>weblogic.jms.ConnectionFactory
           </connection-factory-jndi-name>
    </jms-notification>
    <jms-notification>
      <name>myJMSQueueNotif</name>
      <destination-jndi-name>MyJMSQueue</destination-jndi-name>
      <connection-factory-jndi-name>weblogic.jms.ConnectionFactory
          </connection-factory-jndi-name>
    </jms-notification>
    <!-- Other action configurations -->
  </watch-notification>
</wldf-resource>

ポリシーおよびアクションの詳細は、アクション・メッセージの内容で示されます。

SNMPアクションの構成

簡易ネットワーク管理プロトコル(SNMP)アクションは、関連ポリシーのトリガーに応答してSNMPトラップを送信するために使用されます。SNMPアクションを定義するには、例11-3に示すように、アクション名を指定するだけで済みます。生成されたトラップには、トラップが生成される原因になったポリシーおよびアクションの両方の名前が含まれます。SNMPトラップを適切に行うためには、ドメインのconfig.xml構成ファイルでSNMPが適切に構成されている必要があります。

例11-3 SNMP通知の構成のサンプル

<wldf-resource xmlns="http://xmlns.oracle.com/weblogic/weblogic-diagnostics" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
   xsi:schemaLocation="http://xmlns.oracle.com/weblogic/weblogic-diagnostics/1.0/weblogic-diagnostics.xsd">
  <name>mywldf1</name> 
  <watch-notification>
    <!-- One or more policy configurations -->
    <snmp-notification>
      <name>mySNMPNotif</name>
    </snmp-notification>
    <!-- Other action configurations -->
  </watch-notification>
</wldf-resource>

例11-3のSNMPアクションの構成によって生成されるトラップの型は85です。ここには、以下の値が含まれます(構成された値は山カッコ「<>」で示します)。

    .1.3.6.1.4.1.140.625.100.5   timestamp (e.g. Dec 9, 2004 6:46:37 PM EST
    .1.3.6.1.4.1.140.625.100.145  domainName (e.g. mydomain")
    .1.3.6.1.4.1.140.625.100.10   serverName (e.g. myserver)
    .1.3.6.1.4.1.140.625.100.120  <severity> (e.g. Notice)
    .1.3.6.1.4.1.140.625.100.105  <name> [of watch] (e.g.
          simpleWebLogicMBeanWatchRepeatingAfterWait)
    .1.3.6.1.4.1.140.625.100.110  <rule-type> (e.g. HarvesterRule)
    .1.3.6.1.4.1.140.625.100.115  <rule-expression>
    .1.3.6.1.4.1.140.625.100.125  values which caused rule to 
        fire (e.g..State =
        null,weblogic.management.runtime.WLDFHarvesterRuntimeMBean.
        TotalSamplingTime = 886,.Enabled =
        null,weblogic.management.runtime.ServerRuntimeMBean.
    OpenSocketsCurrentCount = 1,)
    .1.3.6.1.4.1.140.625.100.130  <alarm-type> (e.g. None)
    .1.3.6.1.4.1.140.625.100.135  <alarm-reset-period> (e.g. 10000)
    .1.3.6.1.4.1.140.625.100.140  <name> [of notification] 
                                   (e.g.mySNMPNotif)

ログ・アクションの構成

ログ・アクションを作成して、カスタマイズされたメッセージをサーバー・ログに送信できます。カスタマイズされたメッセージには、「カスタマイズ可能なアクションの変数」で説明されている任意の変数をオプションで含めることができます。

次のWLSTの例は、ログ・アクションの構成を示しています。

wn=res.getWatchNotification()
 
actionName="myaction"
action = wn.lookupLogAction(actionName);
if action is None:
  action = wn.createScriptAction(actionName);
action.setMessage("Message with substitution on server ${WatchServerName} in domain ${WatchDomainName}");
action.setSubsystemName("SpecialLogAction);
action.setSeverity("Info");

前述のログ・アクションが実行されると、太字で示されているカスタム・メッセージは、次の項目を識別する変数を使用します。

  • WebLogic Serverインスタンス名(${WatchServerName}変数で表現)

  • WebLogicドメイン名(${WatchDomainName}変数で表現)

RESTアクションの構成

RESTアクションを使用して、通知ペイロードにカスタマイズされたメッセージを含むRESTエンドポイントに通知を送信できます。認証なしまたはBasic認証では、RESTエンドポイント呼出しを構成できます。

RESTアクションを構成する場合、「カスタマイズ可能なアクションの変数」で説明されている任意の変数をオプションで使用できる通知プロパティのカスタマイズされたセットを作成できます。たとえば、次のWLSTの例は、カスタマイズされたメッセージを送信するRESTアクションの構成を示しています。

wn = res.getWatchNotification();
 
#No Auth REST invocation
rest1 = wn.createRESTNotification('r1')
rest1.setEndpointURL("http://localhost:7001/rest-no-auth/resources/watch-listener")
customNotif = java.util.Properties()
customNotif.put('message','Policy ${WatchName} with rule ${WatchRule} fired.')
rest1.setCustomNotificationProperties(customNotif)
rest1.setEnabled(true)
 
#Basic Auth REST invocation
rest2 = wn.createRESTNotification('r2')
rest2.setEndpointURL("http://localhost:7001/rest-basic-auth/resources/watch-listener")
rest2.setHttpAuthenticationMode('Basic')
rest2.setHttpAuthenticationUserName('restuser1')
rest2.setHttpAuthenticationPassword('restuser1')
rest2.setEnabled(true)

前述のRESTアクションが実行されると、次の項目を識別する太字で示されているメッセージを使用してRESTエンドポイントが呼び出されます。

  • 対応するRESTアクションを実行したトリガー済ポリシーの名前(${WatchName}変数で表現)

  • ポリシー式(${WatchRule}変数で表現)

SMTPアクションの構成

簡易メール転送プロトコル(SMTP)アクションは、関連ポリシーのトリガーに応答してSMTPプロトコルを介してメッセージ(電子メール)を送信するために使用されます。SMTPアクションを定義するには、最初にSMTPセッションを構成します。その構成は、ドメインのconfig.xml構成ファイルで永続化されます。DIAG_MODULE.xmlで、下位要素<mail-session-jndi-name>を使用して構成済SMTPセッションを指定し、下位要素<recipients>を使用して宛先(少なくとも1つ)のリストを指定します。下位要素<subject>では件名、<body>では本文を指定できます(いずれも省略可能)。これらを指定しない場合、デフォルトが使用されます。

例11-4に、構成されたSMTPセッションから構成された宛先にSMTP (電子メール)メッセージを配信するSMTPアクションを示します。このアクションの構成では、カスタムの件名および本文が記述されています。件名または本文を指定しなかった場合は、デフォルト設定(ポリシーおよびアクションの詳細表示)が使用されます。

例11-4 SMTP通知の構成のサンプル(DIAG_MODULE.xml内)

<wldf-resource xmlns="http://xmlns.oracle.com/weblogic/weblogic-diagnostics" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
   xsi:schemaLocation="http://xmlns.oracle.com/weblogic/weblogic-diagnostics/1.0/weblogic-diagnostics.xsd">
  <name>mywldf1</name> 
  <watch-notification>
    <!-- One or more policy configurations -->
    <smtp-notification>
      <name>mySMTPNotif</name>
      <mail-session-jndi-name>MyMailSession</mail-session-jndi-name>
      <subject>Critical Problem!</subject>
      <body>A system issue occurred. Call Winston ASAP. 
           Reference number 81767366662AG-USA23.</body>
      <recipients>administrator@myCompany.com</recipients>
    </smtp-notification>
    <!-- Other policy configurations -->
  </watch-notification>
</wldf-resource>

ポリシーおよびアクションの詳細は、アクション・メッセージの内容で示されます。

WLDFでは、「カスタマイズ可能なアクションの変数」で説明されている任意の変数を使用して、送信される電子メールのsubjectおよびbody要素をカスタマイズすることもできます。

次のWLSTの例は、カスタマイズされた件名および本文テキストを含むSMTPアクションの構成を示しています。メッセージの件名および本文では、ポリシー名と、ポリシーのトリガー日時を示すタイムスタンプを指定する変数を使用しています。

smtp=wn.lookupSMTPNotification('smtp1')
if smtp is None:
  smtp=wn.createSMTPNotification('smtp1')

smtp.setMailSessionJNDIName('test.MailSession')
smtp.setSubject("WatchRule ${WatchName} alert")
smtp.setBody("Test ${WatchName} with rule ${WatchRule} fired at ${WatchTime}.")
smtp.setRecipients(["john.smith@foo.com"])

前述のSMTPアクションが実行されると、次の項目を識別する太字で示されているカスタムの件名および本文を使用して電子メールが生成されます。

  • SMTPアクションを実行したポリシーの名前(${WatchName}変数で表現)。この変数は、件名と本文の両方で使用されます。

  • ポリシー式(${WatchRule}変数で表現)

  • 対応するポリシーのトリガー日時を識別するタイムスタンプ(${WatchTime}変数で表現)

イメージ・アクションの構成

イメージ・アクションによって、関連ポリシーのトリガーに応答して診断イメージが生成されます。イメージ・アクションには、ディレクトリとロックアウト期間の2つのオプションを構成できます。

ディレクトリ名はイメージの生成先を示します。ロックアウト期間には、最後にイメージが生成されてから新しいイメージが生成されるまでに経過する必要のある秒数を指定します。サーバーの障害と回復が繰り返される場合に、生成されるイメージの数を制限するのに便利です。

DOMAIN_HOME\servers\SERVER_NAMEを基準にした相対パスでディレクトリ名を指定できます。デフォルト・ディレクトリはDOMAIN_HOME\servers\SERVER_NAME\logs\diagnostic-imagesです。

イメージ・ファイル名は、その時点のタイムスタンプを基に生成されます(たとえば、diagnostic_image_myserver_2005_08_09_13_40_34.zip)。このアクションは、実行されるたびに別個のイメージ・ファイルを生成するので、何度でも実行可能です。

構成はDIAG_MODULE.xml構成ファイルに保存されます。例11-5に、ロックアウト期間が2分間で、イメージがDOMAIN_HOME\servers\SERVER_NAME\imagesディレクトリに生成されるように指定したイメージ・アクションの構成を示します。

例11-5 イメージ通知の構成のサンプル( DIAG_MODULE.xml内)

<wldf-resource xmlns="http://xmlns.oracle.com/weblogic/weblogic-diagnostics" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
   xsi:schemaLocation="http://xmlns.oracle.com/weblogic/weblogic-diagnostics/1.0/weblogic-diagnostics.xsd">
  <name>mywldf1</name> 
  <watch-notification>
    <!-- One or more policy configurations -->
    <image-notification>
      <name>myImageNotif</name>
      <enabled>true</enabled>
      <image-lockout>2</image-lockout>
      <image-directory>images</image-directory>
    </image-notification>
    <!-- Other action configurations -->
  </watch-notification>
</wldf-resource>

診断イメージの詳細は、第6章「診断イメージの構成とキャプチャ」参照してください。

エラスティック・アクションの構成

WLDFでは、動的クラスタで実行できる次のエラスティック・アクションが提供されます。

各アクションBeanには、次の構成属性があります。

  • clusterName - スケーリングの必要がある動的クラスタの名前

  • scalingSize - 動的クラスタをスケール・アップまたはスケール・ダウンする必要がある管理対象サーバー・インスタンスの数

スケール・アップおよびスケール・ダウン・アクションでは、clusterNameパラメータで指定された動的クラスタを、scalingSizeの値で指定されたサーバーの数だけスケーリングしようと試みます。WLDFは、拡張度フレームワークと対話して、それに基づいて動的クラスタをスケーリングします。

次のWLSTスニペットは、スケール・アップ・アクションを構成するためのコマンドを示しています。この例で、動的クラスタmyClusterは、1つの管理対象サーバー・インスタンスの分だけスケール・アップされます。

wn=res.getWatchNotification()
 
scaleUp=wn.lookupScaleUpAction('scaleUp')
if scaleUp == None:
  print "Creating scale up action”
  scaleUp=wn.createScaleUpAction('scaleUp')
scaleUp.setScalingSize(1)
scaleUp.setClusterName(myCluster)

次の例は、myClusterでスケール・ダウン・アクションを構成するためのWLSTコマンドを示しています。

wn=res.getWatchNotification()
 
scaleDown=wn.lookupScaleDownAction('scaleDown')
if scaleDown == None:
  print "Creating scale down action”
  scaleDown=wn.createScaleDownAction('scaleDown')
scaleDown.setScalingSize(1)
scaleDown.setClusterName(myCluster)

これらのエラスティック・アクションの使用方法の詳細は、次を参照してください。

  • 『Oracle WebLogic Server動的クラスタの拡張度の構成』のエラスティック・アクションに関する項

  • 『Oracle WebLogic Serverクラスタの管理』の動的クラスタの拡張または縮減に関する項

スクリプト・アクションの構成

スクリプト・アクションを使用して、任意の言語で記述できる外部コマンドライン・スクリプトを実行できます。スクリプトが実行される実行環境を設定するには、WLDFScriptActionBeanの次の属性を構成します。

  • PathToScript - スクリプトへのフルパス(DOMAIN_HOME/bin/scriptsディレクトリに存在する必要があります)

  • WorkingDirectory - WebLogic Serverプロセスの実行元のディレクトリ(通常はドメイン・ルート・ディレクトリです)。

  • Environment - 子プロセスに設定する環境変数のマップ

  • Parameters - スクリプトに渡すパラメータまたはコマンド・オプションの配列

  • Timeout - スクリプト・アクションが実行を完了するための時間(秒単位)。デフォルトでは、タイムアウトは0で、スクリプト・アクション・タイムアウトは無効です。

トリガーされたポリシーによってスクリプト・アクションが実行されると、WLDFによって構成済のスクリプトが呼び出され、構成済のスクリプトのIDで実行されます。スクリプト・プロセスは、それを生成したWebLogic Serverプロセスの子プロセスとして実行されます。そのため、スクリプト・プロセスは、WebLogic Serverプロセスと同じオペレーティング・システムIDを持ちますが、どの親プロセス環境も継承しません。

次の例では、WLSTを使用したスクリプト・アクションの構成を示します。

wn=res.getWatchNotification()
 
actionName="myaction"
action = wn.lookupScriptAction(actionName);
if action is None:
  action = wn.createScriptAction(actionName);
 
action.setWorkingDirectory("somedir");
action.setPathToScript("myScript.sh");
action.setParameters(["param1", "param2"]);
action.setTimeout(300);
  前
前 		 次
次
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次