10 カスタム・プロセスの構成

この章では、OPMN opmn.xmlファイルのカスタム・プロセス構成について説明します。

この章の項目は次のとおりです。

10.1 カスタム・プロセス・モジュールの構成

次のコードは、カスタム・プロセス・モジュールのロードと識別を行います。プロセス・モジュールによるカスタム・プロセスの管理は、module idによって識別されます。

<module path="ORACLE_HOME/opmn/lib/libopmncustom.so">
   <module-id id="CUSTOM" />
</module>

10.2 カスタム・プロセスの最小構成

次のコードは、カスタム・プロセスの最小限の構成を示します。カスタム・プロセスの他のすべての構成要素と属性にはデフォルト値が割り当てられます。

<ias-component id="Custom">
   <process-type id="Custom" module-id="CUSTOM">
   <process-set id="Custom" numprocs="1">
      <module-data>
         <category id="start-parameters">
            <data id="start-executable" value="Your start executable here" />
         </category>
      </module-data>
   </process-set>
   </process-type>
</ias-component>

10.3 カスタム・プロセスの完全構成

例10-1に、カスタム・プロセスの完全な構成を示します。これには、カスタム・プロセスに使用できる構成要素と属性がすべて含まれています。

他の任意のOracle Application Serverコンポーネントの一部にカスタム・プロセスを使用することができます。その場合、例10-1のprocess-type要素は、コンポーネント構成の一部である必要があります。

10.3.1 ping

カスタム・モジュールは、次の2つのいずれかの方法で、カスタム・プロセスのpingを実行するフレームワークを提供します。

HTTP ping
スクリプトping

pingのタイプは、ping-parametersカテゴリ内に適切なデータを指定することによって構成できます。サンプルのOracle Application Server構成である例10-1に、HTTP pingを使用したカスタム・プロセスを示します。例10-2は、コンポーネント構成で使用可能なスクリプトpingの例です。

例10-1 カスタム・プロセスの完全構成

<ias-component id="Custom" status="enabled" id-matching="false">
   <environment>
      <variable id="TEST_ENV_VARIABLE" value="/your/test/value" 
      append="false"/>
   </environment>
   <process-type id="Custom" module-id="CUSTOM">
   <process-set id="Custom" restart-on-death="true" numprocs="1">
      <module-data>
         <category id="start-parameters">
            <data id="start-executable" value="Your start executable here" />
            <data id="start-args" value="Your start args here" />
         </category>
         <category id="stop-parameters">
            <data id="stop-executable" value="Your stop executable here" />
            <data id="stop-args" value="Your stop args here" />
         </category>
         <category id="restart-parameters">
            <data id="restart-executable" value="Your restart executable here"/>
            <data id="restart-args" value="Your restart args here" />
         </category>
         <category id="ping-parameters">
            <data id="ping-type" value="http" />
            <data id="ping-url" value="/your/ping/url" />
            <data id="ping-host" value="abc.company.com" />
            <data id="ping-port" value="7777" />
            <data id="ping-limit" value="3" />
            <data id="ping-timeout" value="300" />
         </category>
         <category id="ready-parameters">
            <data id="use-ping-for-ready" value="false" />
         </category>
      </module-data>
   </process-set>
   </process-type>
</ias-component>

例10-2に、スクリプトを使用したpingの構成を示します。

例10-2 pingタイプ・スクリプト

<category id="ping-parameters">
   <data id="ping-type" value="script" />
   <data id="script-executable" value="Ping executable here" />
   <data id="script-args" value="Ping arguments here " />
</category>

pingを実行すると（使用できる場合）、プロセスが動作可能であるかどうかを判断できます。OPMNでは、プロセスの作成後、管理対象プロセスが正常に起動していることを確認する必要があります。プロセスは、様々な方法でOPMNに準備ができていることを伝えます。カスタム・モジュールを使用すると、それらのプロセスは、pingを使用して動作可能であることを伝えることができます。カスタム・プロセスに対してpingを構成する場合、このメカニズムを使用して、そのプロセスの準備ができているかどうかを判断することもできます。プロセスが正常に起動していることを前提としてカスタム・モジュールの処理を進める場合は、動作可能かどうかを判断するメカニズムを構成しないこともできます。

注意
pingが構成されている場合、プロセスの作成後すぐにpingが実行されます。プロセスの初期化およびpingへの応答に時間がかかる場合は、pingを使用して動作可能かどうかを判断することは適切ではありません。プロセスがこのpingに応答しない場合、OPMNはプロセスが正常に起動していないと判断し、プロセスを停止します。

10.4 カスタム・プロセスの属性の説明

この項では、カスタム・プロセスに固有の属性について紹介するとともに、これらの属性について説明します。

カスタム・プロセス属性について、次の形式で記述します。

タイトル: 属性名とその設定値を示します。たとえば、id="Custom"のように記述します。
必須: コンポーネントの定義において、この属性が必須かどうかを示します。
デフォルト値: この属性に割り当てられるデフォルトの値を示します。デフォルト値は、インストールされたバージョンのopmn.xmlファイルに表示されるか、属性が存在しない場合は内部的に割り当てられます。
有効値: 該当する場合、この属性に対する有効値を示します。たとえば、customのように記述します。
パス: この属性をどの要素内で指定できるかを示します。たとえば、ias-componentのように記述します。

id="Custom"

必須: ○
デフォルト値: なし
有効値: 任意のid
パス: ias-component
パス: ias-component/process-type
パス: ias-component/process-type/process-set

このidは必須で、任意の名前を指定できます。ただし、既存の名前と重複しないようにしてください。

module-id="CUSTOM"

必須: ○
デフォルト値: なし
有効値: 第10.1項「カスタム・プロセス・モジュールの構成」で指定されるmodule-idと同じ
パス: ias-component/process-type

module-idは、プロセスをモジュールと関連付けます。カスタム・プロセスでは、このidは、カスタム・モジュールのプロセス・モジュール構成で指定されるmodule-idと一致している必要があります。

id="start-parameters"

必須: ○
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

start-parametersカテゴリには、起動実行可能ファイルおよび起動引数を指定する子要素が含まれます。

id="start-executable"

必須: ○
デフォルト値: なし
有効値: 実行する有効な実行可能ファイル
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素は、起動する実行可能ファイルの名前を指定します。

id="start-args"

必須: ×
デフォルト値: なし
有効値: 起動実行可能ファイルのデータ要素によって指定される実行可能ファイルへの有効な引数
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素の値は、起動実行可能ファイルへのすべての引数を含む文字列である必要があります。このidに複数のデータ要素を指定しないでください。

id="stop-parameters"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

stop-parametersカテゴリには、停止実行可能ファイルおよび停止引数を指定する子要素が含まれます。このカテゴリが構成されていない場合、OPMNは、killコマンドを使用してプロセスを停止します。

id="stop-executable"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素は、プロセスの停止に使用される実行可能ファイルの名前を指定します。

id="stop-args"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素の値は、停止実行可能ファイルへのすべての引数を含む文字列である必要があります。このidに複数のデータ要素を指定しないでください。

id="restart-parameters"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

restart-parametersカテゴリには、再起動実行可能ファイルおよび再起動引数を指定する子要素が含まれます。プロセスに明示的な再起動コマンドがある場合、このカテゴリを構成する必要があります。再起動コマンドがない場合、プロセスの再起動が必要なときは、停止コマンドに続いて起動コマンドが実行されます。

再起動データが指定されると、OPMNは、そのプロセスのプロセスIDを再起動後も同じであると見なします。プロセスに使用できる明示的な再起動コマンドがない場合、停止コマンドに続いて起動コマンドが発行されます。この場合はプロセスIDの変更が許容されます。

id="restart-executable"

必須: ×
デフォルト値: なし
有効値: 有効な再起動実行可能ファイル名
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素は、プロセスの再起動に使用される実行可能ファイルの名前を指定します。

id="restart-args"

必須: ×
デフォルト値: なし
有効値: 再起動実行可能ファイルへの有効な引数
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素の値は、再起動実行可能ファイルへのすべての引数を含む文字列である必要があります。このidに複数のデータ要素を指定しないでください。

id="ping-parameters"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

HTTPプロトコルを介してpingが実行されるカスタム・プロセスでは、このカテゴリを指定する必要があります。このmodule dataは、そのようなpingの実行に必要なすべてのデータで構成されています。

id="ping-type"

必須: ×
デフォルト値: なし
有効値: http、script
パス: ias-component/process-type/process-set/module-data/category/
data

pingを実行するカスタム・プロセスでは、このmodule dataを指定する必要があります。

id="ping-url"

必須: ×
デフォルト値: /
有効値: 任意の有効なURL
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素を使用して、プロセスのpingを実行するURLを指定します。指定されたパラメータは、HTTP pingで使用されます。

id="ping-host"

必須: ×
デフォルト値: なし
有効値: カスタム・プロセスがバインドされる有効なホスト名
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素を使用して、カスタム・プロセスがバインドされるホスト名を指定します。このデータが指定されていない場合、pingは実行されません。無効なホスト名が指定された場合、process-setはdisabled（使用不可）になります。

id="ping-port"

必須: ×
デフォルト値: なし
有効値: カスタム・プロセスがHTTPリクエストをリスニングする有効なポート
パス: ias-component/process-type/process-set/module-data/category/
data

カスタム・プロセスがリスニングするポートです。このデータが指定されていない場合、pingは実行されません。無効なポートが指定された場合、process-setはdisabled（使用不可）になります。

id="ping-limit"

必須: ×
デフォルト値: 3
有効値: pingの失敗に対してOPMNが持つトレランスを示す任意の適切な値。OPMNは、このトレランスを使用して、プロセスを応答なしと宣言して再起動するタイミングを決定します。
パス: ias-component/process-type/process-set/module-data/
category/data

このmodule data要素は、pingの失敗に対するトレランスを定義します。pingが失敗した回数がこの上限値に達すると、プロセスは応答なしと見なされ、OPMNによって再起動されます。

id="ping-timeout"

必須: ×
デフォルト値: 300秒
有効値: 適切なタイムアウト値
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素で指定されたタイムアウト値は、OPMNがpingのレスポンスを待機する最大時間として使用されます。タイムアウト時間内にレスポンスがない場合、pingの試行は失敗したと見なされます。

id="script-executable"

必須: ×
デフォルト値: なし
有効値: 有効なスクリプト実行可能ファイル
パス: ias-component/process-type/process-set/module-data/
category/data

このデータ要素は、プロセスのpingに使用される実行可能ファイルの名前を指定します。この実行可能ファイルからの終了値が0の場合、pingは正常に実行されたと見なされます。その他のすべての値は、pingが失敗したことを示します。

id="script-args"

必須: ×
デフォルト値: なし
有効値: ping実行可能ファイルへの有効な引数
パス: ias-component/process-type/process-set/module-data/
category/data

このデータ要素の値は、ping実行可能ファイルへのすべての引数を含む文字列である必要があります。このidに複数のデータ要素を指定しないでください。

id="ready-parameters"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

このmodule dataカテゴリは、カスタム・プロセスが正常に起動しているかどうかを判断するためにpingを使用することを示します。

id="use-ping-for-ready"

必須: ×
デフォルト値: false
有効値: trueまたはfalse
パス: ias-component/process-type/process-set/module-data/
category/data

このデータ要素の値により、プロセスが使用可能であるかどうかを判断するためにpingを使用するかどうかが決まります。