1 プラグイン開発の開始

この章の構成は、次のとおりです。

• プラグインの作成プロセスについて

• 拡張開発キット(EDK)について

• 拡張開発キット(EDK)のインストール

• プラグインの設計

• 基本プラグインの作成

• 中間プラグインの作成

• 拡張プラグインの作成

プラグインの作成プロセスについて

プラグインの作成には、次のステップが含まれています。すべてのステップは、このマニュアルで説明されています。

1. プラグインを設計します。
2. プラグインを開発します。これには、プラグイン機能を有効にする要件メタデータ・ファイルの作成が含まれています。
3. プラグインをステージングします。
4. プラグインを検証します。
5. アーカイブ(.opar)ファイルとしてプラグインをパッケージ化します。
6. Enterprise Managerにプラグインをインポートします。
7. Oracle Management Serviceにプラグインをデプロイします。
8. ターゲットの監視を開始するために環境からターゲットを追加します。このとき、管理エージェントがターゲットを監視するために必要なプラグイン・ファイルは、エージェントに送信されます。
9. 期待したとおりにプラグインが動作することを確認するために、プラグインをテストします。

引き続き、プラグイン・メタデータを変更すると、メタデータ登録サービスを使用して、プラグイン・アーカイブを再デプロイすることなく、新しいメタデータ・ファイルをEnterprise Managerにアップロードできます。このサービスの使用方法の詳細は、メタデータ登録サービス(MRS)を使用してデプロイされたメタデータ・ファイルの更新に関する説明を参照してください。

さらに、更新したそれぞれのバージョンのプラグインを追跡するには、プラグイン・バージョンを次のプラグイン・メタデータ・ファイルで加算する必要があります。

• プラグインがデプロイされるOracle Management Serviceに対して、プラグインを記述するplugin.xmlファイルのPluginVersion属性。plugin.xmlファイルの作成に関する説明を参照してください。

• プラグインがデプロイされる管理エージェントに対して、プラグインを記述するplugin_registry.xmlファイルのVersion属性。plugin_registry.xmlファイルの作成に関する説明を参照してください。

拡張開発キット(EDK)について

Enterprise Managerアーキテクチャのキー・コンポーネントは拡張フレームワークです。Enterprise Managerプラットフォームを拡張するOracle Partnerを有効にするために、拡張開発キット(EDK)が製品に提供されています。

EDKは、次のものを含む、ツール、ユーティリティおよびドキュメントの集まりです。

• Enterprise Managerの拡張性についてのマニュアル: Enterprise Managerプラグインの一般的なガイドラインの提供

• リファレンスの実装: 様々なEnterprise Manager機能のリファレンス・コード、コード・スニペットなど

• EDK適合性を確認するためのビルド・タイム・ツール: Enterprise Manager拡張性ガイドラインへの違反の検証と報告を行うために使用できるツール

• パッケージ化ツール: プラグイン・コンポーネント・ツール(empdk)をパッケージ化するツール

• 検証ツール: プラグイン・コード・コンポーネントを検証し、違反(ある場合)を報告するツール

Enterprise Manager EDKには、empdkと呼ばれるコマンドライン・ユーティリティがあります。このユーティリティを使用して、プラグイン・アーカイブをパッケージ化または検証します。empdkコマンドおよびそのオプションの詳細は、「プラグインの検証」を参照してください。

EDKのダウンロード後、ローカル・システムでEDKを解凍し、現在のディレクトリをその解凍場所に変更します。EDKには、プラグインの開発に役立つリファレンス・マニュアル、およびプラグインの開発時に統合する必要のあるAPIリファレンスが含まれています。

EDKのダウンロードの詳細は、拡張開発キット(EDK)のインストールに関する説明を参照してください。

EDKの内容

EDKアーカイブには、次のディレクトリが格納されています。

• /bin

  次の作業に使用するempdkユーティリティが含まれています。

  • プラグインの構造の検証

  • プラグインのパッケージ化

  • 既存の(Enterprise Manager 12より前の)プラグインのメタデータの新しいメタデータ形式への変換

• /doc

  管理ビューについてのマニュアルを含め、『Oracle Enterprise Manager拡張プログラマーズ・ガイド』、『Oracle Enterprise Manager拡張プログラマーズ・リファレンス』およびAPIリファレンス・マニュアルが含まれています。提供されるマニュアルへのリンクについてoverview.htmlを確認します。

  索引ページ(sdk_api_ref.html)を使用して、EDK APIリファレンス・マニュアルに直接アクセスすることもできます。

• /lib

  EDKで使用される内部ライブラリが含まれています。

• /oui

  EDKで使用される内部ライブラリが含まれています。

• /samples

  demo_hostsample.zipとしてパッケージ化されたプラグインの完全なリファレンス実装が含まれています。含まれているサンプルのメタデータ・ファイルは、EDKマニュアル全体で参照されるファイルの例として使用されます。

  サンプル・プラグインの構築、デプロイおよび使用についての詳細は、アーカイブにパッケージ化されたREADMEを参照してください。

EM CLIおよびEM CTLを含め、このマニュアルで参照される他のユーティリティは、Enterprise Managerにインストールされています。通常、Oracle Management Service (OMS)ホストにデプロイされます。

拡張開発キット(EDK)のインストール

プラグインの開発を開始する前に、拡張開発キット(EDK)をインストールします。

ノート:

EDKをインストールするには、次のものが必要です。

• 自己更新コンソールの最新バージョンのEDK ZIPアーカイブ。(自己更新コンソールにアクセスするには、Enterprise Managerコンソールから、「設定」、「拡張性」、「自己更新」の順に選択します。)

• Javaバージョン1.7.0_51以上。

• Solaris、Linux、HP-UX、AIXまたはNew Technology File System (NTFS)を持つWindowsを実行するローカル・システム

EDKをインストールするには、次の手順を実行します。

1. 次のオプションのいずれかを使用して、EDK ZIPアーカイブをローカル・システムにダウンロードします。

   • Enterprise Manager

     1. Enterprise Managerにログインします。

     2. 「設定」メニューで、「拡張性」、「開発キット」の順に選択します。

        拡張開発キット(EDK)ページが表示されます。

     3. 「EDKのインストール中」で、「拡張開発キットをワークステーションにダウンロードします。」を選択します。

     4. 13.1.0.0.0_edk_partner.zipをローカル・システムに保存します。

   • Enterprise Managerコマンドライン・ユーティリティ(EM CLI)

     ノート:

     EM CLIの設定の詳細は、「EM CLIユーティリティの設定」を参照してください。

     コマンド・プロンプトを開き、次のコマンドを実行します。

     emcli get_ext_dev_kit
     

     このコマンドでは、コマンドを実行したディレクトリと同じディレクトリにEDK zipアーカイブがダウンロードされます。このコマンドには、パラメータは必要ありません。

2. JAVA_HOME環境変数を設定し、PATHに含まれていることを確認します。たとえば:

   setenv JAVA_HOME /usr/local/packages/j2sdk1.7.0_51
   
   setenv PATH $JAVA_HOME/bin:$PATH
   

3. ダウンロードしたEDK ZIPアーカイブをローカル・システム上のディレクトリでパッケージ化を解除します。たとえば:

   Unzip 13.1.0.0.0_edk_partner.zip
   

   このコマンドでは、EDK ZIPアーカイブのパッケージ化を解除したディレクトリ(release_edk_partner)で次のディレクトリが作成されます。

   release_edk_partner
                      |
                       bin
                       doc
                       lib
                       oui
                       samples
                       README
   

   ディレクトリの内容の詳細は、「EDKの内容」を参照してください。

プラグインの設計

プラグインを作成する前に、ターゲット・タイプの監視と管理を行うために収集する必要のある情報を最初に決定する必要があります。内容は次のとおりです。

• 収集する必要のあるパフォーマンス・メトリックおよび構成メトリックの識別。

• 各メトリックの収集頻度の決定。メトリックの収集頻度は5分間に1回を下回らないようにすることをお薦めします。

• 顧客固有の運用に基づいた、これらのメトリックに対するデフォルトの警告およびクリティカルしきい値の指定。しきい値を超えるたびに、Enterprise Managerは、考えられる問題を管理者に通知するアラートを生成します。

基本プラグインの作成

原則として、次のように基本的な必須メタデータを含む、基本の監視プラグインの作成から開始します。

• 次の内容を定義するターゲット・タイプ定義ファイル。

  • 必要な「レスポンス」メトリック・グループ。これには、ステータス・メトリックとパフォーマンス・メトリックが含まれています。

  • ターゲットで認証するために必要な資格証明。

  詳細は、「ターゲット・メタデータ・ファイルの作成」を参照してください。

• メトリック・データと構成データを収集する頻度を定義する、デフォルトの収集ファイル。詳細は、「デフォルトの収集ファイルの作成」を参照してください。

• 収集したターゲット・データを表示するOracle Business Intelligence Publisher (BI Publisher)レポート。

  詳細は、「BI Publisherレポートの開発」を参照してください。

作成後、プラグインを検証およびパッケージ化します。「プラグインの検証、パッケージ化およびデプロイ」を参照してください。

最後のステップとして、プラグインをEnterprise Managerにデプロイし、テストを開始して「レスポンス」メトリックのデータが返されることを確認します。

ノート:

EDKでは、サンプルのホスト・プラグインを提供しています。これには、前述のすべての機能の例が含まれています。詳細は、サンプル・プラグインにバンドルされたREADMEを参照してください。

中間プラグインの作成

基本プラグインを作成した後、さらに複雑な機能を追加することによって、プラグインの機能を拡張する場合があります。

• さらに複雑なメトリックを追加します。

  詳細は、「拡張メトリックの定義」を参照してください。

• ターゲットの構成データを収集する機能を提供します。これは、特定の時点でのターゲットの構成のスナップショットを作成するために使用します。

  詳細は、「ターゲット構成データの収集」を参照してください。

• メタデータ・ベースのメタデータ・カスタム・ユーザー・インタフェースを作成します。これは、基本的に、Enterprise Managerに対するターゲット・メトリックを表示するためのカスタムのターゲット・ホームページを追加します。

  詳細は、「管理ユーザー・インタフェースの定義」を参照してください。

• ターゲット・アソシエーションを定義します。これは、プラグインで管理されるターゲットのトポロジ・モデルを作成するために使用できます。

  詳細は、「導出されたアソシエーションの使用」を参照してください。

• ターゲット・タイプに固有の特定のタスクを実行するジョブ・タイプを定義します。

  詳細は、「ジョブ・タイプの追加」を参照してください。

拡張プラグインの作成

基本プラグインまたは中間プラグインの作成および検証に成功すると、拡張機能を追加してこれを拡張する場合があります。拡張機能には、次のものがあります。

• プラグインで管理されるターゲット・タイプの新規追加インスタンスを自動的に検出する機能の追加。

  詳細は、「ターゲット検出の定義」を参照してください。

• Flexベースのカスタム管理ユーザー・インタフェースの構築。このページは、Enterprise Managerコンソールを介して、他のターゲット・ホームページでアクセスされます。

  詳細は、「管理ユーザー・インタフェースの定義」を参照してください。

• ターゲット・タイプに固有のコンプライアンス標準および監視ルールの定義。

  詳細は、「コンプライアンス標準の追加」を参照してください。