プラグイン
EMQXのプラグインは、Erlangを用いてブローカーのコア機能を拡張したり、カスタムロジックを統合したりすることを可能にします。このシステムは、カスタム認証、認可、ログ記録、メトリクス、プロトコル変換などの機能を実装するのに最適です。
本セクションでは、プラグインとは何か、そしてプラグインの開発、カスタマイズ、管理方法について紹介します。
EMQX 6.3.0以降、プラグインフレームワークはplugins機能ゲートによって制御されます。FULLプリセットではデフォルトで有効になっています。カスタムのEMQX_FEATURESリストを使用する場合は、プラグイン機能を利用するためにpluginsを含める必要があります。pluginsが無効の場合、EMQXはプラグインフレームワークを起動せず、EMQXダッシュボードはプラグイン管理UIを非表示にし、/api/v5/plugins/*および/api/v5/plugin_api/*のルートは登録されません。詳細は機能ゲートをご参照ください。
プラグインとは?
EMQXのプラグインは、EMQXノード内で動作するErlang/OTPアプリケーションです。プラグインは、クライアント接続、メッセージパブリッシュ、認証などの事前定義されたイベントであるフックポイントを通じてEMQXコアと連携します。
EMQXでプラグインを使用するには、まずリリースパッケージとしてビルドします。その後、各ノードでの管理方法を選択します。
- クラスター管理プラグイン:
.tar.gzパッケージをダッシュボード、REST API、またはCLIを通じてインストールします。EMQXはパッケージをクラスター全体に配布し、そのライフサイクルを管理します。 - ノードピン留めプラグイン:EMQX 6.2.4以降、特定のノードにパッケージを展開し、
node.pinned_pluginsに名前とバージョンを記載します。ノードはクラスターのプラグイン設定に依存せずにプラグインを独立して実行します。
起動時に、プラグインは通常、自身の関数の一部をEMQXのコールバックとして登録し、EMQXの動作を変更または拡張します。プラグインはEMQXコアおよび他のプラグインから独立して動作し、相互干渉を防ぎます。クラスター管理プラグインはインストール、起動、停止、削除の定義されたライフサイクルに従います。ノードピン留めプラグインは特定ノードに事前展開され、ローカルで起動・停止が可能です。削除する場合は、node.pinned_pluginsから該当エントリを削除し、ノードのデプロイメントアーティファクトからプラグインを除去した上でノードを再起動します。
主要な概念
- フックポイント:EMQXのワークフローにおける拡張ポイントで、プラグインがカスタムロジックを注入できます。
- コールバック:プラグインモジュール内の関数で、フックポイントに登録されます。
- 設定スキーマ:プラグイン設定の検証やEMQXダッシュボードでのUIフォームの動的生成に使用される、オプションのAvroベースのスキーマです。
プラグインのワークフロー概要
- 公式のプラグインテンプレートを使ってプラグインを開発します。
- 認証など、ユースケースに合わせてロジックをカスタマイズします。
make relコマンドでプラグインをビルドし、.tar.gzファイルにパッケージングします。- ダッシュボード、CLI、APIを通じてプラグインをインストール・起動するか、ノードピン留めプラグインとして展開・設定します。
- 選択した管理モードに従ってプラグインを設定・運用します。
さらに学ぶ
- EMQXプラグインの開発:公式テンプレートを使ったプラグインのゼロからの構築方法を学べます。
- プラグインロジックのカスタマイズ:認証、認可などのフックコールバック実装例を紹介します。
- プラグインの管理:EMQXノードおよびクラスター全体でのプラグインのインストール、設定、起動・停止、アンインストール方法を解説します。
- プラグインカタログ:データ統合、ガバナンス、アクセス制御向けの即利用可能なプラグインを閲覧できます。