ja:documentation:pandorafms:technical_reference:11_pfms_plugis

差分

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

この比較画面へのリンク

両方とも前のリビジョン 前のリビジョン
次のリビジョン		 前のリビジョン
ja:documentation:pandorafms:technical_reference:11_pfms_plugis [2024/12/17 08:26] – [エージェントとモジュール] kanayamaja:documentation:pandorafms:technical_reference:11_pfms_plugis [2024/12/21 23:12] (現在) – [モジュールのタイムスタンプ] junichi
行 314: 行 314:
  
 プラグインの開発には、通常、監視するサービスのインストール、アカウントなどのテスト環境が必要です。速度とシンプルさから環境作成に役立つ 2 つの技術としては、docker と vagrant があります。 もちろん、テストしたいサービスのプロジェクトでソリューションを用意する必要がありますが、いくつかのコマンドまたは小さな構成のみで実行できます。 プラグインの開発には、通常、監視するサービスのインストール、アカウントなどのテスト環境が必要です。速度とシンプルさから環境作成に役立つ 2 つの技術としては、docker と vagrant があります。 もちろん、テストしたいサービスのプロジェクトでソリューションを用意する必要がありますが、いくつかのコマンドまたは小さな構成のみで実行できます。
 +
 +<wrap #ks11 />
  
 ===== XML ===== ===== XML =====
行 338: 行 340:
  
 ただし、プラグインとそのデータが XML に基づいているのはエージェントプラグインのみです。エージェントプラグインのみがターミナル実行で XML を出力します。サーバプラグインは単純なデータのみを表示します。サーバプラグインにおける最も基本的なことは、正常な場合は ''1''  を出力し、逆に何らかのエラーが発生した場合は ''0''  を出力することです。 ただし、プラグインとそのデータが XML に基づいているのはエージェントプラグインのみです。エージェントプラグインのみがターミナル実行で XML を出力します。サーバプラグインは単純なデータのみを表示します。サーバプラグインにおける最も基本的なことは、正常な場合は ''1''  を出力し、逆に何らかのエラーが発生した場合は ''0''  を出力することです。
 +
 +<wrap #ks12 />
  
 ===== エージェントとモジュール ===== ===== エージェントとモジュール =====
行 399: 行 403:
  
 </code> </code>
 +
 +<wrap #ks12_3 />
  
 ==== モジュール ==== ==== モジュール ====
行 404: 行 410:
 An module element is needed for each ''module'', and the following elements can be nested to define the module: An module element is needed for each ''module'', and the following elements can be nested to define the module:
  
-各 ''モジュール''  にはモジュール要素が必要であり、次の要素をネストして定義できます。+各 ''モジュール'' にはモジュール要素が必要であり、次の要素をネストして定義できます。 
 + 
 +<WRAP group> \\ <WRAP half column>
  
   * **name**: Module name.   * **name**: Module name.
行 420: 行 428:
   * **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.+  * **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.
行 430: 行 438:
   * **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.
行 451: 行 463:
   * **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**.
-  * A module must have at least one name, type and data element.+</WRAP> \\ </WRAP> 
 + 
 +<WRAP group> \\ <WRAP half column>
   * **name**: モジュール名。   * **name**: モジュール名。
   * **description**: モジュールの説明。   * **description**: モジュールの説明。
行 466: 行 480:
   * **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]
   * **unit**: モジュールの単位。timeticks フォーマットを ''dd/hh/mm/ss''  に変換する ''_timeticks_''  マクロをサポートします。   * **unit**: モジュールの単位。timeticks フォーマットを ''dd/hh/mm/ss''  に変換する ''_timeticks_''  マクロをサポートします。
-  * **timestamp**: モジュールから受信したデータにタイムスタンプを設定します。+  * **timestamp**: モジュールから受信したデータにタイムスタンプを設定します(モジュールで timestamp を利用するには、[[:ja:documentation:pandorafms:technical_reference:11_pfms_plugis#データリストブロック|以下に示すように]]データリストブロックにする必要があります)。
   * **module_group**: モジュールが追加されるモジュールグループ。   * **module_group**: モジュールが追加されるモジュールグループ。
   * **custom_id**: モジュールカスタム ID。   * **custom_id**: モジュールカスタム ID。
行 476: 行 490:
   * **str_critical**: 文字列モジュールの障害閾値。   * **str_critical**: 文字列モジュールの障害閾値。
   * **critical_instructions**: 障害モジュール手順。   * **critical_instructions**: 障害モジュール手順。
 +</WRAP>
 +<WRAP half column>
   * **warning_instructions**: 警告モジュール手順。   * **warning_instructions**: 警告モジュール手順。
   * **unknown_instructions**: 不明モジュール手順。   * **unknown_instructions**: 不明モジュール手順。
行 497: 行 513:
   * **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**  よりも優先されます。
-  * モジュールには、少なくとも 1 つの名前、型、およびデータ要素が必要です。+</WRAP> \\ </WRAP> 
 + 
 +<wrap #ks12_4 />
  
 ==== モジュールの要素 ==== ==== モジュールの要素 ====
 +
 +A module must have at least one name, type and data element.
 +
 +モジュールには、少なくとも 1 つの名前、型、およびデータ要素が必要です。
  
 <code xml> <code xml>
行 516: 行 538:
 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''!
行 522: 行 544:
 </WRAP> </WRAP>
  
-<WRAP center round important 60%>+<WRAP center round important 90%>
  
-''agent_data''  タグを閉じることを忘れないでください!+''agent_data'' タグを閉じることを忘れないでください!
  
 </WRAP> </WRAP>
 +
 +<wrap #ks12_5 />
  
 ==== リストタイプモジュール ==== ==== リストタイプモジュール ====
行 546: 行 570:
  
 </code> </code>
 +
 +<wrap #ks12_6 />
  
 ==== モジュールのタイムスタンプ ==== ==== モジュールのタイムスタンプ ====
行 574: 行 600:
  
 </code> </code>
 +
 +<wrap #ks12_7 />
  
 ==== しきい値と単位 ==== ==== しきい値と単位 ====
  • ja/documentation/pandorafms/technical_reference/11_pfms_plugis.1734423999.txt.gz
  • 最終更新: 2024/12/17 08:26
  • by kanayama