2013-03-27 Junichi Satoh <junichi@rworks.jp>
* include/help/ja/help_plugin_definition.php: Updated help. git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@7893 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
jsatoh
parent
0e4b787d52
commit
8e9bcab4cf
|
|
@ -1,3 +1,7 @@
|
|||
2013-03-27 Junichi Satoh <junichi@rworks.jp>
|
||||
|
||||
* include/help/ja/help_plugin_definition.php: Updated help.
|
||||
|
||||
2013-03-27 Junichi Satoh <junichi@rworks.jp>
|
||||
|
||||
* include/help/ja/help_conf_alert_template.php: Added a new help file.
|
||||
|
|
|
|||
|
|
@ -3,60 +3,61 @@
|
|||
* @package Include/help/ja
|
||||
*/
|
||||
?>
|
||||
<h1>プラグインの作成</h1>
|
||||
<h1>プラグイン登録</h1>
|
||||
|
||||
プラグイン作成インタフェースは、それぞれのプラグインに対して渡す必要があるオプションを Pandora FMS プラグインサーバに設定するためのものです。
|
||||
設定したオプションと共にそれに対応するデータが渡されます。
|
||||
他のコンポーネントとは異なり、デフォルトでは Pandora FMS にあらかじめ設定されたコンポーネントが存在しません。そのため、エージェントのモジュールに追加できるよ、作成する必要があります。Pandora FMS のインストールディレクトリにはいくつかのプラグインが含まれていますが、前述の通りデータベースに設定はされていません。
|
||||
<br><br>
|
||||
たとえば、Informix の表空間をチェックするための "Aleph" というプラグインがあり、IP アドレスが "192.168.50.2"、ユーザ名が "Calabria"、そしてパスワードが "malcolm45" であったとします。
|
||||
このプラグインは、表空間の問題有無、1秒あたりのクエリ数、負荷、断片化およびメモリ使用量を返します。
|
||||
Pandora FMS にすでに存在するプラグインを追加するには、コンソールの管理メニューで、サーバ管理をクリックします。その後、プラグイン管理をクリックします。
|
||||
<br><br>
|
||||
このプラグインは、次のようなインタフェースを持っています。
|
||||
<br>
|
||||
<pre>
|
||||
informix_plugin_pandora -H ip_address -U user -P password -T tablespace -O operation
|
||||
</pre>
|
||||
<br>
|
||||
"operation" は、"status", "qps", "load", "fragment" そして "memory" です。
|
||||
Pandora FMS で利用するために、このプラグインは単一の値を返します。
|
||||
このプラグインを Pandora で定義するには、次のように各フィールドを定義します。
|
||||
プラグイン管理画面に行ったら、追加ボタンをクリックします。それ以外のメニューはありません。
|
||||
<br><br>
|
||||
|
||||
<table cellpadding=4 cellspacing=4 class=databox width=80%>
|
||||
<tr>
|
||||
<td valign='top'>プラグインコマンド</td><td>/usr/share/pandora/util/plugins/informix_plugin_pandora (プラグインのデフォルト配置ディレクトリ)</td>
|
||||
<tr>
|
||||
<td>最大タイムアウト</td><td> 15 (例)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>IPアドレスオプション</td><td> -H</td>
|
||||
|
||||
<tr>
|
||||
<td>Port オプション</td><td> 未記入</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>User オプション</td><td> -U</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Password オプション</td><td> -P</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<br>
|
||||
|
||||
このプラグインを使うモジュールを作成する必要がある場合は、「モジュール管理」にてプラグインを選択する必要があります(新しいプラグインは、選択メニューに表示されます)。
|
||||
その後、IPアドレス、ユーザ名、パスワードを設定します。
|
||||
Pandora FMS は、外部プラグインを実行するときに、こられを引数として渡します。
|
||||
次のように、プラグイン作成のフォームを入力します。
|
||||
<?php html_print_image ("images/help/plugin1.png", false, array('width' => '550px')); ?>
|
||||
<br><br>
|
||||
引数の入れ替えは常にあり得ますが、一般化することはできません。
|
||||
上記のシナリオでは、"tablespace" パラメータを利用しています。
|
||||
これは、Informix 特有のものですが、それ以外のツールでもさまざまな特別なオプションがあります。
|
||||
こういった任意のオプションを渡す場合には、「プラグインパラメータ」フィールドを利用します。
|
||||
上記の例であれば、"-T tablespace" を設定します。
|
||||
<b>名前(Name)</b><br>
|
||||
プラグイン名です。ここでは、Nmap です。
|
||||
<br><br>
|
||||
もし他の表空間を扱いたい場合は、"-T" オプションの後を異なる設定にした別のモジュールを作成します。
|
||||
<b>プラグインタイプ(Plugin type)</b><br>
|
||||
プラグインは、標準と Nagios の 2種類があります。標準プラグインは、処理を実行し値を取得するものです。Nagios プラグインは、その名の通り Pandora FMS で Nagios プラグインを利用できるようにするものです。Nagios プラグインの主な違いは、実行結果の成功・失敗を戻値で返すことです。
|
||||
<br><br>
|
||||
もちろん、「プラグインパラメータ」には、複数の引数を定義できます。
|
||||
設定されたすべての引数がプラグインに渡されます。
|
||||
Nagios プラグインを利用して正常・異常の状態ではなくデータを取得したい場合は、Nagios プラグインを "標準" モードで利用します。
|
||||
<br><br>
|
||||
ここでの例(NMAPを実行するプラグイン)では、標準を選択します。
|
||||
<br><br>
|
||||
<b>最大タイムアウト(Max. timeout)</b><br>
|
||||
|
||||
プラグインの有効期間です。この時間内に応答を得られなかった場合、モジュールは不明状態となり、値は更新されません。これは、プラグインを使って監視を実装する場合にとても重要な要素です。この時間を越えてプラグインの実行に時間がかかるような場合は、実行結果を得ることができません。プラグインを実行して結果を得られるまでにかかる時間よりも常に大きい値にする必要があります。特に指定しない場合は、設定ファイルの plugin_timeout の値が利用されます。
|
||||
<br><br>
|
||||
この例では、15を設定しています。
|
||||
<br><br>
|
||||
<b>説明(Description)</b><br>
|
||||
|
||||
プラグインの説明です。例えば、"Test # UDP open ports" といった簡単な説明を書きます。可能であれば、プラグインがどんなパラメータを受け付けるのか後でわかりやすいように、パラメータの説明を書くと良いでしょう。
|
||||
<br><br>
|
||||
<b>プラグインコマンド(Plug-in command)</b><br>
|
||||
|
||||
プラグインコマンドのパスを設定します。デフォルトのディレクトリは、標準のインストールをした場合、/usr/share/pandora_server/util/plugin/ です。システム上の任意のパスを指定することができます。この例では、/usr/share/pandora_server/util/plugin/udp_nmap_plugin.shin を設定しています。
|
||||
<br><br>
|
||||
Pandora サーバは、このスクリプトを実行します。このファイルは、アクセスし実行できるパーミッションになっている必要があります。
|
||||
<br><br>
|
||||
<b>プラグインパラメータ(Plug-in parameters)</b><br>
|
||||
|
||||
コマンドにスペースをあけて付けられるパラメータ文字列です。このパラメータフィールドでは、_filed1_ _filed2_ ... _filedN_ といったマクロを利用できます。
|
||||
<br><br>
|
||||
<b>パラメータマクロ(Parameters macros)</b><br>
|
||||
|
||||
プラグインパラメータフィールドで利用するマクロを無制限で追加できます。このマクロは、モジュール設定内に通常のテキストフィールドとして表示されます。
|
||||
<br><br>
|
||||
それぞれのマクロには 3つのフィールドがあります。
|
||||
<br><br>
|
||||
<i>説明(Description):</i> マクロの簡単な説明です。フィールドのラベルになります。<br>
|
||||
<i>デフォルト値(Default value):</i> フィールドのデフォルト値です。<br>
|
||||
<i>ヘルプ(Help):</i> マクロの説明テキストです。<br>
|
||||
<br><br>
|
||||
マクロ設定例:
|
||||
<br><br>
|
||||
<?php html_print_image ("images/help/plugin2.png", false, array('width' => '550px')); ?>
|
||||
<br><br>
|
||||
モジュールの編集画面におけるこのマクロの例:
|
||||
<br><br>
|
||||
<?php html_print_image ("images/help/plugin3.png", false, array('width' => '550px')); ?>
|
||||
|
|
|
|||
Loading…
Reference in New Issue