| Oracle® Enterprise Manager Cloud Control拡張プログラマーズ・リファレンス 13c リリース2 E92082-01 |
|
 前 |
 次 |
この章の内容は次のとおりです。
Enterprise Managerプラグイン・ビルダーは、統合者がJDeveloperエディタを使用してプラグインを作成できるようにするJDeveloper拡張機能です。プラグイン・ビルダー内にある直感的なGUIウィザードによって、Enterprise Managerにインポートおよびデプロイできるプラグインを簡単に開発できます。様々なXMLエディタを使用してメタデータ・プラグインを作成する従来の方法では、セマンティックおよび構文の面でエラーが発生しがちでした。したがって、拡張機能に組み込まれている様々な実行時検証インテリジェンスを活用するために、対話型開発環境を使用することをお薦めします。
プラグインを開発するには、拡張開発キット(EDK)に付属しているプラグイン・ビルダー・ツールをダウンロードする必要があります。EDKキットをダウンロードするには、Cloud Controlコンソールで、「設定」を選択し、「拡張性」を選択し、「開発キット」 を選択します。メタデータ・プラグインの開発に必要な主要なコンポーネントは、次のとおりです。
Plugin.xml: plugin.xmlファイルは、プラグインを記述するメタデータを提供し、プラグインのデプロイに使用されます。これには、名前やバージョンなどのプラグインを識別するプロパティが含まれます。また、Enterprise Manager Cloud Controlに追加されるターゲット・タイプのセットを宣言します。
Plugin_registry.xml: plugin_registry.xmlファイルは、プラグインがデプロイされる管理エージェントで必要なメタデータを提供します。これはプラグイン・アーカイブ内の/agentディレクトリにパッケージ化され、ターゲットを監視する管理エージェントにデプロイされます。
ターゲット・タイプ: ターゲット・タイプ・メタデータ・ファイルは、新しいターゲット・タイプを定義するうえで不可欠な部分です。ターゲット・タイプ・ファイルには、特定のタイプのターゲットについて収集できるメトリックのセットを記述します。基本的に、取得するデータ、およびこの特定のターゲット・タイプでそのデータを取得する方法を管理エージェントに指示します。新しいターゲット・タイプを追加するには、次の詳細を指定します。
インスタンス・プロパティは、この特定のターゲット・タイプの新規ターゲット・インスタンスを追加する際に管理者がEnterprise Manager Cloud Controlコンソールで指定する必要のあるプロパティを定義します。
資格証明は、データを収集したり、ジョブを実行する各ターゲット・インスタンスとの認証を行うプラグインに必要です。認証を有効にするには、資格証明タイプおよび資格証明セットが必要です。
メトリックは、Cloud Controlのターゲット・モニタリング機能の中核です。基本的に、様々なターゲットをモニターおよび管理するCloud Controlの機能です。これはターゲット・メトリックを収集、処理および表示する機能のことです。
デフォルトの収集: デフォルトの収集ファイルは、ターゲットから収集され、収集頻度などの情報とともに管理リポジトリに書き込まれるメトリック・データを定義します。ターゲット・タイプのデフォルトの収集メタデータ・ファイルでは、次を定義します。
このメトリック・データが収集される頻度。
超過した場合に、メトリック・アラート・イベントが発生する原因となるしきい値。
しきい値を超過した場合に表示されるオプションのメッセージ。
システムに最新バージョンのJDK 6をダウンロードしてインストールしていることを確認してください。
プラグイン・ビルダーを使用してプラグインを開発するには、Oracle JDeveloper 11.1.1.7 Studioバージョンを使用することをお薦めします。プラグインとともにこのJDeveloperバージョンをインストールするには、プラグイン・ビルダーのインストールおよび新しいJDeveloperインスタンスに関する説明に記載されている手順を実行してください。
注意:
「Oracle JDeveloper 11g 11.1.1.7.0」→「Java Edition」→「汎用」を選択した場合、既存のJDeveloperインスタンスを実行しておく必要があります。JDeveloperをインストールするには、http://www.oracle.com/technetwork/developer-tools/jdev/documentation/index.htmlを参照してください。既存のJDeveloperインスタンスへのプラグイン・ビルダーのインストールに関する説明に記載されている手順を使用して、プラグイン・ビルダーをインストールします。
ローカル・システムに最新のEDKキットをダウンロードしたことを確認してください。そうするには、拡張開発キット(EDK)に関する説明に記載されている手順を実行します。
この項の内容は次のとおりです。
注意:
プラグイン・ビルダーをインストールしたら、プラグイン・ビルダー拡張機能が適切にデプロイされているかどうかを検証するために、次の手順を実行します。
「Oracle JDeveloper」ページで、「ヘルプ」メニューから「バージョン情報」を選択します。
「Oracle JDeveloperのバージョン情報」ダイアログ・ボックスで、「拡張機能」を選択します。
「拡張機能」タブで、次のものを探します。
名前: EM Plug-in Builder
識別子: oracle.em.edk.pluginbuilder
バージョン: 12.1.0.1.0
ステータス: Loaded
JDeveloper Studioバージョンおよびプラグイン・ビルダー・コンポーネントをインストールするには、次の手順を実行します。
既存のJDeveloperインスタンスがある場合、JDeveloper更新メカニズムを使用してプラグイン・ビルダー拡張機能をインストールする必要があります。次の手順を実行します。
次の環境変数を設定します。
On Unix: export JAVA_HOME=/usr/jdk6 On Windows: set JAVA_HOME=C:\Program Files\Java\jdk6
コマンドを実行して既存のJDeveloperインスタンスを起動します。
「Oracle JDeveloper」ページで、「ヘルプ」メニューから「更新の確認」を選択します。更新の確認ウィザードが表示されます。
「ようこそ」ページで、「次へ」をクリックします。
「ソース」ページで、「ローカル・ファイルからインストール」を選択します。「参照」をクリックするか、プラグイン・ビルダー・ファイルへのパスを入力します。
Linuxの場合
<EDK_INSTALL_DIR>/lib/empluginbuilder.zip
Windowsの場合:
<EDK_INSTALL_DIR>\lib\empluginbuilder.zip
EDK_INSTALL_DIRは、EDKがインストールされているディレクトリです。
「次へ」をクリックします。
「サマリー」ページには、アップグレードされた拡張機能および新しい拡張機能が表示されます。「終了」をクリックします。
JDeveloperウィザードを終了するように求められます。
JDeveloperのEDKへの参照を更新するには、次の手順を実行します。
JDeveloperインスタンスを起動します。
「Oracle JDeveloper」ページで、「ツール」メニューから「設定」を選択します。
「設定」ページで、「EMプラグイン・ビルダー」を選択し、EDKの場所を更新します。
注意:
EDKのホーム・ロケーションの更新を逃すと、EDKのロケーションの設定エラーとともにプラグイン・プロジェクトは失敗します。
Enterprise Managerプロジェクトを作成するには、次の手順を実行します。
表4-1 EMプラグインの作成
| 属性 | 説明 |
|---|---|
会社名 |
名前はアルファベットの値で始めます。長さは1文字から8文字にまでできます。例: Sam123 |
製品名 |
製品名はアルファベットの値で始めます。長さは1文字から8文字にまでできます。例: p123 |
製品タグ |
製品タグは |
表示名 |
プラグインのわかりやすい表示名です。例: Plugin1 |
バージョン |
これは事前移入値です。プラグインのバージョンを記述します。例: 12.1.0.1.0 |
カテゴリ |
メニューからカテゴリを選択します。デフォルトでは、 |
初期ターゲット・タイプ名 |
これは、初期ターゲット・タイプの接尾辞を含んでいる事前移入値です。例: Type 1 |
ターゲット・タイプ表示名 |
ターゲット・タイプのわかりやすい表示名です。例: Basic Target Data |
プラグイン・ディレクトリ |
これはプラグイン・プロジェクトが作成される場所です。ディレクトリの場所を変更するには、「参照」をクリックします。例: |
「OK」をクリックします。
サンプル・プラグインを使用してEnterprise Managerプラグイン・プロジェクトを作成するには、次の手順を実行します。
リストの次のサンプルからいずれかを選択します。
Basic - oracle.samples.xsh1: これは、ターゲット、メトリック定義、レポートなどの最低限のモニタリング機能を示す基本プラグインです。
Intermediate - oracle.samples.xsh2: これは、基本機能に加えて構成収集、ジョブ・タイプおよびターゲット・アソシエーションのサンプルをカバーする中間プラグインです。
Advanced - oracle.samples.xsh3: これは、中間機能とともに自動検出、BI Publisherレポート、導出された関連付けおよびコンプライアンス標準をカバーする高度なプラグインです。
新しいプラグイン・プロジェクトの場所を入力します。
「OK」をクリックします。
これは、サンプルを指定プロジェクト・ディレクトリにコピーします。次に、ターゲット・タイプおよび収集ファイルを変更して新しい標準(company_product_tag_type)を使用し、plugin、agent-registry、targettypeおよびdefault_collectionファイルのxmlコンテンツを修正して、ウィザードに入力されたデータを反映します。
EDK 12.1.0.4.0以上では、プラグイン・ビルダーは検出メタデータおよびターゲット固有の検出コードの指定をサポートしています。これは、新しいターゲット・タイプが作成されるたびに、新しく追加されたターゲット・タイプを含めるために検出メタデータが自動的に更新されるということです。一部のターゲット・タイプを検出しない場合、その情報をdiscovery.xmlファイル(<project_name>/Resources/oms/metadata/discoveryで入手できます)から手動で削除できます。このXMLファイルの詳細にアクセスして表示するには、「基本検出情報の表示」を参照してください。ターゲット固有の検出コードは/Resources/discoveryフォルダの下にあるPerlスクリプトを使用してサポートされます。新しく追加されたすべてのターゲット・タイプに対して、対応する検出コードをPerlスクリプトに追加する必要があります。Perlスクリプトを更新してターゲットを検出する方法の例は、「ユーザー入力を必要とする検出統合の例」を参照してください。
関連項目:
ターゲットの検出をEnterprise Managerで手動で実行できるようにする方法の詳細は、「ターゲット検出の定義」を参照してください。
検出メタデータを使用せずに作成されたプラグインがある場合、プラグイン・ビルダーを使用して検出ファイルを適切なフォルダに手動で追加できます。既存のプラグインに検出サポートを有効にするには、次の手順に従ってください。
プラグイン・アーカイブ・ファイルをEnterprise Managerにデプロイする前に、次の前提条件タスクを実行します。
プラグイン・アーカイブ・ファイル(.opar)の準備が完了したら、プラグイン・アーカイブ・ファイルをEnterprise Managerにデプロイするために、プロジェクト名を右クリックし、コンテキスト・メニューから「プラグインのデプロイ」を選択して「OK」をクリックします。
注意:
プラグイン・アーカイブ・ファイルを作成済でない場合、デプロイ・ステップは実行できません。
プラグインが正常にデプロイされたら、プラグインにアクセスするために、Cloud Controlにログインし、「設定」メニューから「拡張性」を選択して「プラグイン」をクリックします。「プラグイン」ページに、新たにデプロイされたプラグインが表示されます。
新しいターゲット・タイプを追加するには、2つの方法があります。これらは次のとおりです。
表4-2 新しいターゲット・タイプの追加
| 方法1 | 方法2 |
|---|---|
「Oracle JDeveloper」ページで、「ファイル」メニューから「新規」を選択します。「新規ギャラリ」ダイアログ・ボックスが表示されます。 |
アプリケーションのメニューからプロジェクト名を選択します。 |
「カテゴリ」セクションで、「メタデータ」を選択し、「ターゲット・タイプ」を選択します。 |
プロジェクト・フォルダ内に存在するomsフォルダを展開し、targetTypeフォルダにドリルダウンします。 |
「OK」をクリックします。 |
targetTypeフォルダを右クリックし、「新規」を選択します。 |
「新規ギャラリ」ウィンドウで、「メタデータ」を選択し「ターゲット・タイプ」をクリックします。 「OK」をクリックします。 |
注意:
新しく追加したターゲット・タイプは、検出用として自動的に使用できるようになります。ターゲットを検出するために、/Resources/discoveryディレクトリ内の使用可能なPerlスクリプトを、すべてのターゲット・タイプ情報を含めるために手動で更新する必要があります。詳細は、「ターゲットの検出」を参照してください。
新しいターゲット・タイプの場合、次の詳細を指定する必要があります。
注意:
メトリック参照は、収集メタデータと完全に同期しているため、ターゲット・タイプのメトリックを削除または名前変更すると、収集項目内の対応する参照もそれに従って更新されます。
この特定のターゲット・タイプの新しいターゲット・インスタンスを追加するときに、管理者がEnterprise Manager Cloud Controlコンソールに指定する必要のあるプロパティを定義するには、次の手順を実行します。
動的なインスタンス・プロパティの値は、ターゲット・インスタンスからデータを収集している管理エージェントによって戻されます。通常、メトリック収集を実行するfetchletに渡すプロパティを定義するために、QueryDescriptor内で使用されます。動的インスタンス・プロパティを追加するには、次の手順を実行します。
資格証明タイプは、ターゲット・タイプでサポートされる認証タイプです。資格証明タイプを追加するには、次の手順を実行します。
target_type.xml)をダブルクリックして概要エディタで開きます。たとえば、UserNameとPasswordという2つの列を持つホスト資格証明を作成するには、次の詳細を指定する必要があります。
In the Insert CredentialType dialog box, enter the following details: NAME: XP2HostCreds NLSID: CREDS_HOST_HOSTCREDS LABEL: XP2 Host Credentials In the AddCredentialType Column, enter the following details: NAME: XP2HostUserName NLSID: CREDS_HOST_USERNAME LABEL: XP2 Host UserName NAME: XP2HostPassword NLSID: CREDS_HOST_Password LABEL: XP2 Password
「CredentialType」セクションにある各オプションを選択すると、資格証明を編集または削除できます。
CredentialTypeのインスタンスを作成するには、次の手順を実行します。
target_type.xml)をダブルクリックして概要エディタで開きます。たとえば、Normal UsernameとNormal Passwordという2つの列を持つ、通常ホスト資格証明と呼ばれるホスト資格証明タイプのインスタンスを作成するには、次の詳細を指定します。
In the Insert CredentialSet dialog box, enter the following details: NAME: HostCredsNormal CREDENTIALTYPE: XP2HostCreds USAGE: PREFERRED_CRED NLSID: CREDS_HOST_HOSTCREDS_NORMAL LABEL: Normal Host Credentials In the AddCredentialSet Column, enter the following details: SET_COLUMN: username TYPE_COLUMN: XP2HostUsername NLSID: CREDS_HOST_HOSTCREDS_NORMAL LABEL: Normal Username SET_COLUMN: password TYPE_COLUMN: XP2HostPassword NLSID: CREDS_HOST_HOSTCREDS_NORMAL LABEL: Normal Password
「CredentialType」セクションにある各オプションを選択すると、資格証明を編集または削除できます。
メトリック・プロパティを追加するには、次の手順を実行します。
target_type.xml)をダブルクリックして概要エディタで開きます。たとえば、次の図は、CPUパフォーマンス・データを収集するメトリックを含むメトリック・グループを作成する方法について説明しています。
「メトリック」セクションにある各オプションを選択すると、メトリック・プロパティを編集または削除できます。
ColumnDescriptorを追加するには、次の手順を実行します。
QueryDescriptorを追加するには、次の手順を実行します。
ExecutionDescriptor表を追加するには、次の手順を実行します。
ExecutionDescriptorビューを追加するには、次の手順を実行します。
「収集の構成」タブで、次のタスクを実行できます。
スキップ: 「スキップ」を選択して、この手順を省略します。基本的に、このメトリックに関連付けられた収集項目はありません。
新規追加: 「新規追加」を選択して、このメトリックのデータを収集する新しい収集項目を構成します。収集項目のプロパティを追加または編集するには、「収集項目プロパティの挿入または更新」を参照してください。
既存のものを使用: 「既存のものを使用」を選択して、メニューから収集項目を選択し、データ収集のために既存の収集項目をこのメトリックに関連付けます。
ターゲットの新しい収集項目を追加するには2つの方法があります。
表4-3 収集項目の追加または更新
| 方法1 | 方法2 |
|---|---|
アプリケーションのメニューからプロジェクト名を選択します。 |
|
プロジェクトのomsフォルダを展開して、「ターゲット・タイプ」を選択します。 ターゲット・タイプのリストが表示されます。 |
概要エディタでplugin.xmlファイルを開きます。 |
収集項目に関連付けるターゲット・タイプを選択します。 |
「コレクション・アイテム」タブを選択します。 ターゲットに使用可能なすべての収集項目のリストが表示されます。 |
「メトリック」タブを選択して、「追加」アイコンをクリックします。メトリックの挿入ウィザードで、「収集の構成」を選択し、「新規追加」をクリックします。 注意: 収集項目のプロパティを追加または編集するには、「収集項目プロパティの挿入または更新」を参照してください。 |
リストから収集項目を1つ選択して、次の手順を実行します。 「一般」タブに、メタデータ・バージョンおよびターゲット・タイプの情報が表示されます。 「コレクション・アイテム」タブに、収集項目の名前が表示されます。 注意: 収集項目のプロパティを追加または編集するには、「収集項目プロパティの挿入または更新」を参照してください。 |
収集項目のプロパティを追加または編集するには、次の手順を実行します。
次の例は、Statusメトリックを含む、基本レスポンス・メトリック・グループのCollectionItemエントリを表しています。これは、このメトリックのデータを5分ごと(このタイプのメトリックの標準的な収集間隔)に収集する必要があることを指定しています。条件は、Statusメトリックに設定されています。
In the General tab, enter the following details: META_VER: 1.0 TYPE: test_demo_targetType In the CollectionItem tab, enter the following details: NAME: Response UPLOAD: 6 INTERVAL: 5 TIME_UNIT: Min In the Add Condition Dialog box, enter the following details: COLUMN_NAME: Status CRITICAL: 0 OPERATOR: EQ CLEAR_MESSAGE_NLSID: Response_Status_clearalertmessage MESSAGE: Failed to connect to database instance: %oraerr%.
この項の内容は次のとおりです。
「概要」セクションを使用するかわりに、「プロパティ・インスペクタ」セクションにあるプラグイン・ビルダー固有のラベルおよび要素を使用すると、プラグインのソースXMLコードを変更できます。このセクションには、編集作業をユーザーフレンドリにするプラグイン固有のすべての属性が用意されています。
注意:
DTD要素とその使用方法の完全なリストは、「Enterprise Manager DTD」を参照してください。
