モジュールファイルの構造

モジュールに関連するすべてのコードは、Zabbixフロントエンドインストールのmodulesディレクトリ内の1つのディレクトリに保存されます (例: zabbix/ui/modules)。

モジュールファイルツリー

example_module_directory/          (必須)
   manifest.json                   (必須)   メタデータとアクションの定義。
   Module.php                                  モジュールの初期化とイベント処理。
   actions/                                    アクションコントローラーファイル。
       SomethingView.php
       SomethingCreate.php
       SomethingDelete.php
       data_export/
           ExportAsXml.php
           ExportAsExcel.php
   views/                                      ビューファイル。
       example.something.view.php
       example.something.delete.php
   assets/                                     ビューで使用する追加ファイル。manifest.jsonで指定する必要があります。
       js/                                     ビューで使用するJavaScriptファイル。
           example.something.view.js.php
       css/                                    ビューで使用するCSSファイル。
           example.something.css
        image.png                              ビューで使用する画像。
        example.something.file                 ビューで使用する任意のファイル。

モジュールの作成

サンプルモジュールの作成の流れは次の通りです (利用可能な場合は、ファイル名またはフォルダー名をクリックすると、手順の詳細が表示されます)。

  1. zabbix/ui/modules/内にモジュール用の新しいディレクトリを作成します。
  2. モジュールメタデータを含むmanifest.jsonファイルを追加します。
  3. viewsフォルダーを作成し、モジュールビューを定義します。
  4. actionsフォルダーを作成し、モジュールアクションを定義します。
  5. Module.php (またはダッシュボードウィジェットの場合はWidget.php) ファイルを作成し、初期化およびイベント処理ルールを定義します。
  6. JavaScriptファイル (assets/jsに配置)、CSSスタイル (assets/cssに配置)、またはその他の追加ファイル用のassetsフォルダーを作成します。
  7. manifest.jsonで必要なビュー、アクション、アセットファイルを指定していることを確認します。
  8. Zabbixフロントエンドでモジュールを登録して、使用を開始します。

manifest.jsonファイルを作成するとすぐに、モジュールを登録して有効にすることができます。 モジュールが有効になると、Zabbixフロントエンドを更新することで、モジュールファイルに加えられたすべての変更をすぐにプレビューできます。