ja:documentation:pandorafms:technical_reference:11_pfms_plugis

差分

このページの2つのバージョン間の差分を表示します。

この比較画面へのリンク

両方とも前のリビジョン 前のリビジョン
次のリビジョン		 前のリビジョン
ja:documentation:pandorafms:technical_reference:11_pfms_plugis [2024/12/21 23:07] – [XML ヘッダ例] junichija:documentation:pandorafms:technical_reference:11_pfms_plugis [2026/05/09 23:26] (現在) – [プラグインのコンパイル] junichi
行 3: 行 3:
 {{indexmenu_n>11}} {{indexmenu_n>11}}
  
-[[:ja:documentation:start|Pandora FMS ドキュメント一覧に戻る]]+[[:ja:documentation:pandorafms:start|Pandora FMS ドキュメント一覧に戻る]] 
 + 
 +<wrap #ks1 />
  
 ===== 概要 ===== ===== 概要 =====
行 10: 行 12:
  
 このプラグイン開発ガイドには、独自のプラグインを作成したいユーザ向けのドキュメントが含まれています。 このドキュメントを使用して、ビジネスニーズを解決するプラグインを作成する方法を学習してください。 このプラグイン開発ガイドには、独自のプラグインを作成したいユーザ向けのドキュメントが含まれています。 このドキュメントを使用して、ビジネスニーズを解決するプラグインを作成する方法を学習してください。
 +
 +<wrap #ks2 />
  
 ===== プラグインとは? ===== ===== プラグインとは? =====
行 16: 行 20:
  
 プラグインとも呼ばれるコンピュータアドオンは、別のアプリケーション (この場合は Pandora FMS) の機能を拡張できるようにするアプリケーションです。 プラグインとも呼ばれるコンピュータアドオンは、別のアプリケーション (この場合は Pandora FMS) の機能を拡張できるようにするアプリケーションです。
 +
 +<wrap #ks3 />
  
 ===== プラグインはなぜ便利なのか? ===== ===== プラグインはなぜ便利なのか? =====
行 34: 行 40:
  
 ほとんどのプラグインは、Pandora FMS の外部サービスから収集されたデータまたはパフォーマンス統計を表示できるようにするのに便利です。 ほとんどのプラグインは、Pandora FMS の外部サービスから収集されたデータまたはパフォーマンス統計を表示できるようにするのに便利です。
 +
 +<wrap #ks4 />
  
 ===== Pandora FMS におけるプラグインタイプ ===== ===== Pandora FMS におけるプラグインタイプ =====
行 41: 行 49:
 実行タイプ別: 実行タイプ別:
  
-  * Agent plugin: Agent plugins are run by Pandora FMS software agent, they are usually local and do not work remotely so execution will be performed by the agent daemon. Agent plugins usually print an XML in their execution, modules with data. +  * Agent plugin: Agent plugins are run by Pandora FMS EndPoint, they are usually local and do not work remotely, so execution will be performed by the agent daemon. Agent plugins usually generate an XML in their execution, modules with data. 
-  * Server plugin: Server plugins are executed by the [[:es:documentation:pandorafms:introduction:02_architecture#the_plugin_server|server plugin]], they usually retrieve data remotely, either by API or another method, so although they can be configured as an agent plugin (mostly), the recommended option is to configure them as a server plugin. Server plugins print only one value, such as a ''1''  to indicate their successful execution.+  * Server plugin: Server plugins are executed by the [[:en:documentation:pandorafms:introduction:02_architecture#ks1_1_6|server plugin]], they usually retrieve data remotely, either by API or another method, so although they can be configured as an agent plugin (mostly), the recommended option is to configure them as a server plugin. Server plugins generate only one value, such as a ''1''  to indicate their successful execution.
  
-  * エージェントプラグイン: エージェントプラグインは Pandora FMS ソフトウェアエージェントによって実行されます。通常はローカルにあり、リモートでは動作しないため、エージェントデーモンによって実行されます。 エージェントプラグインは通常、実行時に XML を出力し、モジュールにはデータが含まれます。+  * エージェントプラグイン: エージェントプラグインは Pandora FMS エンドポイントによって実行されます。通常はローカルにあり、リモートでは動作しないため、エージェントデーモンによって実行されます。 エージェントプラグインは通常、実行時に XML を出力し、モジュールにはデータが含まれます。
   * サーバプラグイン: サーバプラグインは [[:ja:documentation:pandorafms:introduction:02_architecture#プラグインサーバ|プラグインサーバ]] によって実行され、通常は API または別の方法でリモートでデータを取得します。(ほとんどの場合)エージェントプラグインとして設定することもできますが、推奨されるオプションは、サーバプラグインとして設定することです。 サーバプラグインは、実行の成功を示す ''1''  などの 1 つの値のみを返します。   * サーバプラグイン: サーバプラグインは [[:ja:documentation:pandorafms:introduction:02_architecture#プラグインサーバ|プラグインサーバ]] によって実行され、通常は API または別の方法でリモートでデータを取得します。(ほとんどの場合)エージェントプラグインとして設定することもできますが、推奨されるオプションは、サーバプラグインとして設定することです。 サーバプラグインは、実行の成功を示す ''1''  などの 1 つの値のみを返します。
 +
 +<wrap #ks5 />
  
 ===== プラグインの見つけ方 ===== ===== プラグインの見つけ方 =====
行 59: 行 69:
 <WRAP center round download 60%> <WRAP center round download 60%>
  
-[[https://pandorafms.com/library/|https://pandorafms.com/library/]]+[[https://marketplace.pandorafms.com/]]
  
 </WRAP> </WRAP>
行 74: 行 84:
  
 通常、各プラグインには、インストール、プラグインの設定、およびプラグインが収集するデータの詳細が記載されたドキュメントが付属しています。 通常、各プラグインには、インストール、プラグインの設定、およびプラグインが収集するデータの詳細が記載されたドキュメントが付属しています。
 +
 +<wrap #ks6 />
  
 ===== プラグインのインストール方法 ===== ===== プラグインのインストール方法 =====
  
-Plugins can be installed from Pandora FMS console. Depending on their type they can be run in two different ways, which will create different ways of plugin configuration. Agent plugins are however run by the software agent, while server plugins are run by the plugin server. Usually server plugins create agents and modules while agent plugins only create modules within the software agent in which it is configured.+Plugins can be installed from Pandora FMS console. Depending on their type they can be run in two different ways, which will create different ways of plugin configuration. Agent plugins are however run by the EndPoint, while server plugins are run by the plugin server. Usually server plugins create agents and modules while agent plugins only create modules within the EndPoint in which it is configured.
  
-プラグインは、Pandora FMS コンソールからインストールできます。 タイプに応じて 2 つの異なる方法で実行でき、プラグイン設定が作成されます。 ただし、エージェントプラグインはソフトウェアエージェントによって実行され、サーバプラグインはプラグインサーバによって実行されます。 通常、サーバプラグインはエージェントとモジュールを作成しますが、エージェントプラグインは、それが設定されているソフトウェアエージェント内でのみモジュールを作成します。+プラグインは、Pandora FMS コンソールからインストールできます。 タイプに応じて 2 つの異なる方法で実行でき、プラグイン設定が作成されます。 ただし、エージェントプラグインはエンドポイントによって実行され、サーバプラグインはプラグインサーバによって実行されます。 通常、サーバプラグインはエージェントとモジュールを作成しますが、エージェントプラグインは、それが設定されているエンドポイント内でのみモジュールを作成します。
  
 Installing the plugin consists of creating its custom execution in Pandora FMS. Every certain configurable time interval, the plugin will run and display the updated modules. Installing the plugin consists of creating its custom execution in Pandora FMS. Every certain configurable time interval, the plugin will run and display the updated modules.
  
 プラグインをインストールするには、Pandora FMS でカスタム実行を作成します。 設定可能な特定の時間間隔ごとにプラグインが実行され、更新されたモジュールが表示されます。 プラグインをインストールするには、Pandora FMS でカスタム実行を作成します。 設定可能な特定の時間間隔ごとにプラグインが実行され、更新されたモジュールが表示されます。
 +
 +<wrap #ks7 />
  
 ===== プラグインのライフサイクル ===== ===== プラグインのライフサイクル =====
  
 [[:wiki:pfms-plugins-development-05.png?id=ja%3Adocumentation%3Apandorafms%3Atechnical_reference%3A11_pfms_plugis&media=wiki:pfms-plugins-development-05.png|{{  :wiki:pfms-plugins-development-05.png  }}]] [[:wiki:pfms-plugins-development-05.png?id=ja%3Adocumentation%3Apandorafms%3Atechnical_reference%3A11_pfms_plugis&media=wiki:pfms-plugins-development-05.png|{{  :wiki:pfms-plugins-development-05.png  }}]]
 +
 +<wrap #ks8 />
  
 ===== プラグインの計画 ===== ===== プラグインの計画 =====
行 157: 行 173:
 データをリモートで取得できるプラグインは、データを取得するためにサービスマシン上に存在する必要がないため、プラグインサーバで実行できます。 データをリモートで取得できるプラグインは、データを取得するためにサービスマシン上に存在する必要がないため、プラグインサーバで実行できます。
  
-There are certain plugins that can only be run through the software agent since they need to be on the same system as the service from which you want to get data in order to get them.+There are certain plugins that can only be run through the EndPoint since they need to be on the same system as the service from which you may want to get data in order to get them.
  
-ソフトウェアエージェントを介してのみ実行できる特定のプラグインもあります。データの取得がサービスと同じシステム上である必要がある場合です。+エンドポイントを介してのみ実行できる特定のプラグインもあります。データの取得がサービスと同じシステム上である必要がある場合です。
  
 ==== データをどのように表示しますか? ==== ==== データをどのように表示しますか? ====
行 174: 行 190:
  
 プラグイン内に、エージェントまたはモジュールの名前をカスタマイズするオプションを含めたり、それらの名前にある種のプレフィックスを追加して、それらをより見やすく、区別しやすくすることができます。 プラグイン内に、エージェントまたはモジュールの名前をカスタマイズするオプションを含めたり、それらの名前にある種のプレフィックスを追加して、それらをより見やすく、区別しやすくすることができます。
 +
 +<wrap #ks9 />
  
 ===== プラグインの要件と依存関係 ===== ===== プラグインの要件と依存関係 =====
行 276: 行 294:
  
 Fedora および Ubuntu で作成したバイナリを使用すると、他のシステムで依存関係エラーが発生することを確認しています。 Fedora および Ubuntu で作成したバイナリを使用すると、他のシステムで依存関係エラーが発生することを確認しています。
 +
 +<wrap #ks10 />
  
 ===== プラグインの開発 ===== ===== プラグインの開発 =====
行 412: 行 432:
 各 ''モジュール'' にはモジュール要素が必要であり、次の要素をネストして定義できます。 各 ''モジュール'' にはモジュール要素が必要であり、次の要素をネストして定義できます。
  
-   * **name**: Module name.+<WRAP group> \\ <WRAP half column> 
 + 
 +  * **name**: Module name.
   * **description**: Module description.   * **description**: Module description.
   * **tags**: Tags associated with the module.   * **tags**: Tags associated with the module.
行 426: 行 448:
   * **max_warning**: Maximum value for alert status.   * **max_warning**: Maximum value for alert status.
   * **disabled**: Disable (0) or enable the module. Disabled modules are not processed.   * **disabled**: Disable (0) or enable the module. Disabled modules are not processed.
-  * **min_ff_event**: FF threshold (see [[:en:documentation:01_understanding:03_glossary#flip-flop_protection|Flip-Flop]]).+  * **min_ff_event**: FF threshold (see [[:en:documentation:pandorafms:introduction:03_glossary#flip-flop_protection|Flip-Flop]]).
   * **status**: Module status (NORMAL, WARNING or CRITICAL). Critical and alert status limits are ignored if the status is specified.   * **status**: Module status (NORMAL, WARNING or CRITICAL). Critical and alert status limits are ignored if the status is specified.
   * **datalist**: It sends the module data in datalist format (one database entry for each of the values received) [0/1].   * **datalist**: It sends the module data in datalist format (one database entry for each of the values received) [0/1].
   * **unit**: Module unit. It supports ''_timeticks_''  macro to transform data in timeticks format to ''dd/hh/mm/ss''.   * **unit**: Module unit. It supports ''_timeticks_''  macro to transform data in timeticks format to ''dd/hh/mm/ss''.
-  * **timestamp**: It sets a timestamp on the data received from the module (to use timestamp in modules they must be in a datalist block, [[:en:documentation:pandorafms:technical_reference:11_pfms_plugis#ks12_5|as shown in the examples below]]).+  * **timestamp**: It sets a timestamp on the data received from the module (to use timestamp in modules they must be in a datalist block, [[#ks12_6|as shown in the examples below]]).
   * **module_group**: Group of modules to which the module will be added.   * **module_group**: Group of modules to which the module will be added.
   * **custom_id**: Module custom ID.   * **custom_id**: Module custom ID.
行 436: 行 458:
   * **str_critical**: Critical threshold for string modules.   * **str_critical**: Critical threshold for string modules.
   * **critical_instructions**: Critical module instructions.   * **critical_instructions**: Critical module instructions.
 +</WRAP>
 +
 +<WRAP half column>
 +
   * **warning_instructions**: Warning module instructions.   * **warning_instructions**: Warning module instructions.
   * **unknown_instructions**: Module unknown instructions.   * **unknown_instructions**: Module unknown instructions.
行 457: 行 483:
   * **str_warning_forced**: It forces str_warning to the new specified value even if the module exists, it takes precedence over **str_warning**.   * **str_warning_forced**: It forces str_warning to the new specified value even if the module exists, it takes precedence over **str_warning**.
   * **str_critical_forced**: It forces str_critical to the new specified value even if the module exists, it takes precedence over **str_critical**.   * **str_critical_forced**: It forces str_critical to the new specified value even if the module exists, it takes precedence over **str_critical**.
 +</WRAP> \\ </WRAP>
 +
 +<WRAP group> \\ <WRAP half column>
   * **name**: モジュール名。   * **name**: モジュール名。
   * **description**: モジュールの説明。   * **description**: モジュールの説明。
行 471: 行 500:
   * **max_warning**: 警告状態の最大値。   * **max_warning**: 警告状態の最大値。
   * **disabled**: モジュールの無効化・有効化。無効化モジュールは処理されません。   * **disabled**: モジュールの無効化・有効化。無効化モジュールは処理されません。
-  * **min_ff_event**: 連続抑制回数 ([[:ja:documentation:01_understanding:03_glossary#連続抑制回数|連続抑制回数]] を参照)。+  * **min_ff_event**: 連続抑制回数 ([[:ja:documentation:pandorafms:introduction:03_glossary#連続抑制回数|連続抑制回数]] を参照)。
   * **status**: モジュールの状態(NORMAL, WARNING または CRITICAL)。ステータスが指定されている場合、障害およびアラートステータスの制限は無視されます。   * **status**: モジュールの状態(NORMAL, WARNING または CRITICAL)。ステータスが指定されている場合、障害およびアラートステータスの制限は無視されます。
   * **datalist**: モジュールデータを datalist フォーマットで送信。(受け取った値ごとに 1 つのデータベースエントリ) [0/1]   * **datalist**: モジュールデータを datalist フォーマットで送信。(受け取った値ごとに 1 つのデータベースエントリ) [0/1]
行 481: 行 510:
   * **str_critical**: 文字列モジュールの障害閾値。   * **str_critical**: 文字列モジュールの障害閾値。
   * **critical_instructions**: 障害モジュール手順。   * **critical_instructions**: 障害モジュール手順。
 +</WRAP>
 +<WRAP half column>
   * **warning_instructions**: 警告モジュール手順。   * **warning_instructions**: 警告モジュール手順。
   * **unknown_instructions**: 不明モジュール手順。   * **unknown_instructions**: 不明モジュール手順。
行 502: 行 533:
   * **str_warning_forced**: モジュールが存在する場合でも、str_warning を新しい指定値に強制し、**str_warning**  よりも優先されます。   * **str_warning_forced**: モジュールが存在する場合でも、str_warning を新しい指定値に強制し、**str_warning**  よりも優先されます。
   * **str_critical_forced**: モジュールが存在する場合でも、str_critical を新しい指定値に強制し、**str_critical**  よりも優先されます。   * **str_critical_forced**: モジュールが存在する場合でも、str_critical を新しい指定値に強制し、**str_critical**  よりも優先されます。
 +</WRAP> \\ </WRAP>
  
 +<wrap #ks12_4 />
  
 ==== モジュールの要素 ==== ==== モジュールの要素 ====
行 525: 行 558:
 XML データ ファイルには、任意の数の要素を含めることができます。 XML データ ファイルには、任意の数の要素を含めることができます。
  
-<WRAP center round important 60%>+<WRAP center round important 90%>
  
 Do not forget to close the tag ''agent_data''! Do not forget to close the tag ''agent_data''!
行 531: 行 564:
 </WRAP> </WRAP>
  
-<WRAP center round important 60%>+<WRAP center round important 90%>
  
 ''agent_data'' タグを閉じることを忘れないでください! ''agent_data'' タグを閉じることを忘れないでください!
行 537: 行 570:
 </WRAP> </WRAP>
  
 +<wrap #ks12_5 />
  
 ==== リストタイプモジュール ==== ==== リストタイプモジュール ====
行 556: 行 590:
  
 </code> </code>
 +
 +<wrap #ks12_6 />
  
 ==== モジュールのタイムスタンプ ==== ==== モジュールのタイムスタンプ ====
行 584: 行 620:
  
 </code> </code>
 +
 +<wrap #ks12_7 />
  
 ==== しきい値と単位 ==== ==== しきい値と単位 ====
行 667: 行 705:
  
 プラグインの設定は、これがエージェントプラグインかサーバプラグインかによって異なる場合があります。 プラグインの設定は、これがエージェントプラグインかサーバプラグインかによって異なる場合があります。
 +
 +<wrap #ks16_1 />
  
 ==== サーバプラグイン ==== ==== サーバプラグイン ====
行 746: 行 786:
 ==== エージェントプラグイン ==== ==== エージェントプラグイン ====
  
-In order to monitor from Pandora FMS with an agent plugin, call it from the software agent ''.conf''  file that is in the following path, in GNU/Linux:+In order to monitor from Pandora FMS with an agent plugin, call it from the EndPoint ''.conf''  file found at the following path, in Linux:
  
-エージェントプラグインを使用して Pandora FMS で監視するには、GNU/Linux の次のパスにあるソフトウェアエージェントの ''.conf''  ファイルから呼び出します。+エージェントプラグインを使用して Pandora FMS で監視するには、Linux の次のパスにあるエンドポイントの ''.conf''  ファイルから呼び出します。
 <file> <file>
  
行 844: 行 884:
 **total_modules_provided**: ''.ini''  ファイルの次のセクションで定義されているモジュールの数を指定します。 少なくとも 1 つ設定します (少なくとも例で使用)。 **total_modules_provided**: ''.ini''  ファイルの次のセクションで定義されているモジュールの数を指定します。 少なくとも 1 つ設定します (少なくとも例で使用)。
  
-**execution_command**: If it is used, it must be placed before script. It could be an interpreter, such as ''java -jar''. Therefore, the plugin will be called for execution, from the Pandora FMS Plugin Server, with the following code: ''java -jar < plugin_path/ plugin_filename''.+**execution_command**: If it is used, it must be entered before the script. It could be an interpreter, such as Python.
  
-**execution_command**: 使用する場合は、script の前に置かなければなりません。これは、''java -jar''  のようなインタプリタかもしれません。プラグインは Pandora FMS プラグインサーバから次のようなコードで呼び出され実行されます: ''java -jar < plugin_path/ plugin_filename''+**execution_command**: 使用する場合は、script の前に置かなければなりません。Pythonなどのインタープリタでも構いません。
  
 **execution_postcommand**: If used, it defines the additional parameters transmitted to the plugin after ''< plugin_filename >'', which is invisible to the user. **execution_postcommand**: If used, it defines the additional parameters transmitted to the plugin after ''< plugin_filename >'', which is invisible to the user.
行 973: 行 1013:
   * コードのテストをします。プラグインの動作をテストして、すべてが問題ないことを確認することが重要です。エラーを時間内に発見して修正することで、将来的な問題を回避することができます。   * コードのテストをします。プラグインの動作をテストして、すべてが問題ないことを確認することが重要です。エラーを時間内に発見して修正することで、将来的な問題を回避することができます。
  
-[[:ja:documentation:start|Pandora FMS ドキュメント一覧に戻る]]+[[:ja:documentation:pandorafms:start|Pandora FMS ドキュメント一覧に戻る]]
  
  
  • ja/documentation/pandorafms/technical_reference/11_pfms_plugis.1734822457.txt.gz
  • 最終更新: 2024/12/21 23:07
  • by junichi