3 OIG構成ユーティリティの使用

Oracle WebLogic Server (WLS)には、数百の構成可能な値があります。特定の値のグループは、システムのコンポーネントの動作に影響を与えます。たとえば、WLSのデータベース設定を構成することで、データベースのパフォーマンスをチューニングできます。

オラクル社では、WLSの各種コンポーネントのチューニング・ガイドを提供しています。コンポーネントを適切にチューニングするには、数十のステップを実行する必要があり、入力する値も数多く存在します。これらの値を手動で入力すると、入力エラーが発生したり、1つ以上のステップが抜けてしまったりする恐れがあります。

oig-configuration-attributes.jsonは、属性ファイルの値を使用してWLSシステムを構成することで、手動構成エラーを回避するのに役立ちます。ユーティリティでは、変更を加える前のシステムの状態が取得され、ジェスチャの実行前後のシステム値を示すレポートが作成されます。一連の変更によってシステムの安定性が低下した場合には、ユーティリティを使用して、システムを以前取得した状態に復元できます。

デフォルトでは、設定する値は、config/ディレクトリ内のoig-configuration-attributes.jsonファイルに格納されています。構成を変更するには、oig-configuration-attributes.jsonを編集して、属性に使用する値を入力し、OIG構成ユーティリティを実行して、実行するジェスチャおよび操作を指定します。

• 対話型モードとサイレント・モード
  OIG構成ユーティリティは、対話型モードとサイレント・モードの2つのモードで実行できます。
• ベースラインとリストア
  OIG構成ユーティリティには、システム構成のベースライン・イメージを作成する機能があります。ベースラインには、ベースライン作成の時点で定義されていたすべての操作によって変更可能なすべての属性のシステム状態が含まれています。ベースラインを使用すると、システムを以前の構成にリストアして、指定したベースラインに格納されている状態にシステム属性を設定できます。
• ジェスチャと操作
  OIG構成ユーティリティで実行可能な構成操作は、ジェスチャによって定義および実装されます。
• レポート
  OIG構成ユーティリティを使用して対話型モードで1つ以上の操作を実行する場合、システムに変更が加えられる前に、初期および最終の属性値を示すレポートが生成されます。

対話型モードとサイレント・モード

OIG構成ユーティリティは、対話型モードとサイレント・モードの2つのモードで実行できます。

対話型モードでは、ユーザーは、実行する操作に必要な詳細(ユーザー名、パスワードなど)の入力を求められます。

サイレント・モードでは、必要なすべての入力を実行前にユーティリティに指定する必要があります。ユーザーの介入は必要ありません。このモードはスクリプトと組み合せるのが理想的です。そうすることで、WebLogic Server管理者は、エンド・ユーザーが押したボタンまたはリンク経由で構成サービスを提供することができ、それによって構成が実行されます。

サイレント・モードと対話型モードのどちらでも、1つ以上の操作で使用される入力の値をinputs.propertiesファイルに指定できます。対話型モードでは、操作が実行されるときに、ユーザーが入力ファイルで定義されていない必須入力の値を入力するよう求められます。サイレント・モードでは、ユーティリティのコール時に必須入力が不足していると、コールは失敗します。

• 対話型モード
  対話型モードでは、ユーティリティで1つ以上の操作が実行されるときに、必須入力の値を入力するよう求められます。このモードは、管理者がコマンド・プロンプトからシステムの構成を行う場合に便利です。
• サイレント・モード
  サイレント・モードでは、ユーティリティの起動時に実行するジェスチャ操作のすべての必須入力に値を指定する必要があります。入力が不足している場合、コールは失敗します。不足している値の入力は求められません。このモードは、エンドユーザーがシステム構成タスクを実行できるようにする場合に役立ちます。たとえば、ボタンを含むWebページを作成し、ボタンをクリックするとOIG構成ユーティリティがサイレント・モードで起動して、ユーザー入力なしで目的の構成が実行されるようにすることができます。

対話型モード

対話型モードでは、ユーティリティで1つ以上の操作が実行されるときに、必須入力の値を入力するよう求められます。このモードは、管理者がコマンド・プロンプトからシステムの構成を行う場合に便利です。

対話型モードでのOIG構成ユーティリティの起動

OIG構成ユーティリティを対話型モードで起動するには、ご使用の環境に適したスクリプトを使用し、引数を指定せずにユーティリティを実行します。

UNIX、LinuxおよびMac OSXシステムでは、スクリプトを実行することで、ユーティリティを対話型モードで実行します:

cd $ORACLE_HOME/idm/server/bin/OIGConfigUtility
./oig-config-utility.sh

Windowsシステムでは、バッチ・ファイルを実行することで、ユーティリティを対話型モードで実行します:

cd $ORACLE_HOME\idm\server\bin\OIGConfigUtility
oig-config-utility.bat

便宜上、このドキュメントの他の例では、シェル・スクリプトを使用してユーティリティを起動する方法を示しています。Windowsシステムでは、かわりにバッチ・ファイルをコールしてください。

ユーティリティの基本的な使用方法に関する情報が表示され、対話型ユーティリティのプロンプトが次のように表示されます:

$oig>

このプロンプトからコマンドを入力できます。たとえば、tuneジェスチャのジェスチャ固有のヘルプを表示するには、次のように入力します:

$oig> tune –h

tuneジェスチャ固有のヘルプがユーティリティに表示されます。コマンドgestureName -hを入力することで、任意のジェスチャについてジェスチャ固有のヘルプを表示できます。使用可能なジェスチャの名前は、ユーティリティ・ヘルプの「Configured Gestures」セクションにリストされます。

ジェスチャ操作を実行するには、ジェスチャ固有のヘルプに基づいてジェスチャの名前と操作を入力します。たとえば、次のように入力してデータベースのチューニング操作を開始できます:

$oig> tune –database

ユーティリティで操作が実行される際に、操作で使用される値がinputs.propertiesから取得されます。値が定義されていない入力ごとに、値を入力するよう求められます。

対話型モードのオプション

対話型モードでは次のオプションを使用できます。

オプション	説明
-a | -all	このオプションを使用して、すべての有効なジェスチャに定義されたすべての操作を実行します。
-b | -baseline	このオプションを使用して、すべての有効なジェスチャについて、現在のシステム状態のベースラインを作成します。
-rpt | -report	このオプションを使用して、すべての有効なジェスチャの事前レポートを生成します。このレポートは、すべての有効なジェスチャの操作前および操作後の値を示しますが、システムに変更を加えることはありません。
-r | -restore	このオプションを使用して、ベースライン・ファイルからシステムをリストアします。これにより、システム構成がベースライン・ファイルに格納されている構成にリストアされます。この操作には、入力として有効なファイル・パスが必要です。
-h | -help	このオプションを使用して、OIG構成ユーティリティのヘルプを表示します。これには、ユーティリティの使用に関する一般的な説明と、どのジェスチャが有効であるかが含まれています。
gestureName –h	このオプションを使用して、指定したジェスチャのジェスチャ固有のヘルプを表示します。

対話型モードでのOIG構成ユーティリティの終了

OIG構成ユーティリティを終了するには、プロンプトにquitまたはq!を入力します。次に例を示します:

$oig> quit

または

$oig> q!

サイレント・モード

サイレント・モードでは、ユーティリティの起動時に実行するジェスチャ操作のすべての必須入力に値を指定する必要があります。入力が不足している場合、コールは失敗します。不足している値の入力は求められません。このモードは、エンドユーザーがシステム構成タスクを実行できるようにする場合に役立ちます。たとえば、ボタンを含むWebページを作成し、ボタンをクリックするとOIG構成ユーティリティがサイレント・モードで起動して、ユーザー入力なしで目的の構成が実行されるようにすることができます。

サイレント・モードでのOIG構成ユーティリティの起動

OIG構成ユーティリティをサイレント・モードで起動するには、ご使用の環境に適したスクリプトを使用し、-Sスイッチを指定してユーティリティを実行します。

UNIX、LinuxおよびMac OSXシステムでは、スクリプトを実行することで、ユーティリティをサイレント・モードで実行します:

cd $ORACLE_HOME/idm/server/bin/OIGConfigUtility
./oig-config-utility.sh -S

Windowsシステムでは、バッチ・ファイルを実行することで、ユーティリティをサイレント・モードで実行します:

cd $ORACLE_HOME\idm\server\bin\OIGConfigUtility
oig-config-utility.bat -S

便宜上、このドキュメントの他の例では、シェル・スクリプトを使用してユーティリティを起動する方法を示しています。Windowsシステムでは、かわりにバッチ・ファイルをコールしてください。

ユーティリティを引数なしでサイレント・モードで実行すると、ユーティリティのヘルプ・テキストが表示されます。これは、ユーティリティの使用に関する一般的な説明と、どのジェスチャが有効であるかを示します。

ユーティリティを起動するときは、実行するジェスチャと操作を指定し、すべての必須入力に値を指定する必要があります。これらの値は、コマンドラインで引数として指定することも、inputs.propertiesの一部として指定することも、両方を組み合せて指定することもできます。入力値が不足しているか無効である場合、ユーティリティは変更を行わずに終了します。

次のコマンドを入力すると、ユーティリティのヘルプ・テキストにリストされている任意の使用可能なジェスチャについて、ジェスチャ固有のヘルプを表示できます:

./oig-config-utility.sh –S gestureName -h

たとえば、tuneジェスチャのジェスチャ固有のヘルプを表示するには、次のコマンドを使用します:

./oig-config-utility.sh –S tune -h

ベースラインとリストア

OIG構成ユーティリティには、システム構成のベースライン・イメージを作成する機能があります。ベースラインには、ベースライン作成の時点で定義されていたすべての操作によって変更可能なすべての属性のシステム状態が含まれています。ベースラインを使用すると、システムを以前の構成にリストアして、指定したベースラインに格納されている状態にシステム属性を設定できます。

OIG構成ユーティリティを初めて使用するときは、ベースラインを作成する必要があります。これにより、現在のシステムのバックアップが作成されるので、行った変更を元に戻す必要がある場合には、ユーティリティを使用して、システムをこの既知の状態にリストアできます。

OIG構成ユーティリティには、システム構成をベースライン・ファイルに格納されている状態に戻すことのできるリストア機能があります。

• ベースラインの作成
  OIG構成ユーティリティを使用すると、対話型モードとサイレント・モードの両方でシステムのベースラインを作成できます。
• ベースライン・ファイルからのシステムのリストア
  OIG構成ユーティリティのリストア機能を使用すると、ベースライン、バックアップまたは現在の状態ファイルの属性値でWebLogic Serverを構成できます。デフォルトでは、backup/、baseline/およびcurrent_state/ディレクトリのファイルはすべて、システムのリストアに使用できます。リストア・オプションを実行するには、-restoreまたは-rをユーティリティに渡した後、使用するベースライン・ファイルを指定します。

ベースラインの作成

OIG構成ユーティリティを使用すると、対話型モードとサイレント・モードの両方でシステムのベースラインを作成できます。

対話型モードの場合、ユーティリティを起動し、コマンド-bまたは-baselineを入力します。ユーティリティにより、inputs.propertiesに定義されていない、操作に必要な各値を入力するよう求められます。

サイレント・モードの場合、-bまたは-baselineスイッチを指定して、ユーティリティをサイレント・モードで起動します。次に例を示します:

./oig-config-utility.sh –S -baseline

ベースライン操作に必要な値は、inputs.propertiesで、またはユーティリティに渡されるフラグ(-weblogicPort 1234など)として指定する必要があります。入力がない場合、ベースライン操作は失敗します。作成したベースライン・ファイルは、デフォルトでbaseline/ディレクトリに格納されます。

ユーザーが明示的に作成するベースライン・ファイルに加えて、ユーティリティでは、操作の試行前に操作に関連付けられたシステム属性のバックアップを作成します(たとえば、データベースのチューニング操作を試行する前にデータベース属性のコピーを作成します)。また、操作の実行後にシステムの現在の状態のバックアップを作成します。デフォルトでは、これらのファイルはそれぞれbackup/ディレクトリとcurrent_state/ディレクトリに格納されます。

ベースライン・ファイルからのシステムのリストア

OIG構成ユーティリティのリストア機能を使用すると、ベースライン、バックアップまたは現在の状態ファイルの属性値でWebLogic Serverを構成できます。デフォルトでは、backup/、baseline/およびcurrent_state/ディレクトリのファイルはすべて、システムのリストアに使用できます。リストア・オプションを実行するには、-restoreまたは-rをユーティリティに渡した後、使用するベースライン・ファイルを指定します。

たとえば、2018年7月1日にシステムのベースラインを実行して、baseline/ディレクトリにファイルoig-baseline_2018-07-01_17_14_19.jsonを作成するとします。後日、システムのパフォーマンスに悪影響を及ぼしたデータベースおよびJVMのチューニングに構成の変更を加えます。次のコマンドを実行して、以前の設定に戻すことができます:

./oig-config-utility.sh –S –restore baseline/oig-baseline_2018-07-01_17_14_19.json

リストア操作に必要な値は、inputs.propertiesを介して、またはユーティリティに渡されるフラグ(-weblogicPort 1234など)として指定する必要があります。入力がない場合、リストア操作は失敗します。

ジェスチャと操作

OIG構成ユーティリティで実行可能な構成操作は、ジェスチャによって定義および実装されます。

OIG構成ユーティリティでは、どのジェスチャが使用可能であるかがユーティリティ・ヘルプに表示されます。この情報は、ジェスチャの短縮名とジェスチャの説明で構成されます。たとえば、tuneジェスチャに関する次の情報がヘルプに表示されます:

    tune : Tune different components.
        Use 'tune -h' to display gesture-specific help

ここで、tuneはジェスチャの短縮名と呼ばれます。

ジェスチャが実行できる操作など、ジェスチャに関する追加情報を表示するには、ユーティリティを起動し、ジェスチャの短縮名に-hを付けて渡します。

ユーティリティを使用してジェスチャ操作を実行するには、ジェスチャの短縮名と操作のショートCLIフラグまたはロングCLIフラグを指定して、ユーティリティをコールします。このコールの形式は次のとおりです:

./oig-config-utility.sh gestureName –<opr_long_flag | opr_short_flag>

たとえば、データベース・チューニング操作のCLIショート・フラグおよびロング・フラグ(-databaseおよび–d)は、TuneDBOperation.javaに定義されています。JVMチューニング操作を対話型モードで実行するには、次のいずれかのコマンドを入力してOIG構成ユーティリティを起動します:

./oig-config-utility.sh tune –database

CLIロング・フラグを使用した場合。または:

./oig-config-utility.sh tune –d

CLIショート・フラグを使用した場合。

ジェスチャを作成するには、OIGジェスチャ・フレームワークのAbstractGestureクラスを拡張し、そのジェスチャの操作を作成するには、AbstractGestureOperationを拡張します。tuneサンプル・ジェスチャの実装がOIG構成ユーティリティに付属しており、TuningGesture.javaソース・ファイルにあります。ジェスチャの作成の詳細は、「ジェスチャの追加」を参照してください。

作成したジェスチャを使用するには、ジェスチャのJARファイルをlibディレクトリにコピーして、ジェスチャをoig-utility-config.jsonのgesturesConfigセクションに追加します。ジェスチャが有効であれば、次回ユーティリティを起動したときに使用可能なジェスチャとして表示されます。

これらのジェスチャによって定義された操作では、oig-configuration-attributes.jsonの値をシステムに適用することで、WebLogic Server構成を更新できます。

レポート

OIG構成ユーティリティを使用して対話型モードで1つ以上の操作を実行する場合、システムに変更が加えられる前に、初期および最終の属性値を示すレポートが生成されます。

対話型モードとサイレント・モードのどちらでも、ユーティリティに渡すジェスチャ操作の事前実行レポートを作成するようにユーティリティに指示できます。これにより、選択した操作に基づいて、初期および最終の属性値を含むレポートが生成されます。システムに変更が加えられることはありません。

事前レポートを作成するには、–rまたは–reportオプションを使用します。たとえば、サイレント・モードで、データベースのチューニング操作の事前レポートが必要だとします。その場合、次のようにユーティリティをコールします:

./oig-config-utility.sh –S –rpt tune –d [inputs]

対話型モードで自動的に生成されるか、–rまたは-reportオプションを使用して明示的に生成されるかに関係なく、レポートはデフォルトでreports/ディレクトリに格納されます。レポートはHTML形式で、任意のWebブラウザで表示できます。