プラグイン
EMQXのプラグインは、ユーザーがErlangを用いてブローカーのコア機能を拡張したり、カスタムロジックを統合したりするための仕組みです。このシステムは、カスタム認証、認可、ログ記録、メトリクス取得、プロトコル変換などの機能を実装するのに最適です。
本節では、プラグインとは何か、どのように開発・カスタマイズ・管理するかを紹介します。
プラグインとは？
EMQXにおけるプラグインは、EMQXノード内で動作するErlang/OTPアプリケーションです。プラグインは、クライアント接続、メッセージパブリッシュ、認証などの事前定義されたイベントであるフックポイントを通じてEMQXコアと連携します。
EMQXで使用するためには、プラグインは以下の条件を満たす必要があります。
- リリースとしてビルドされていること – コンパイル済みプラグインとメタデータを含む
.tar.gzパッケージ。 - Dashboard、REST API、またはCLIを通じてインストールされること。
- 設定やライフサイクル操作（起動、停止、アンインストール）で管理されること。
起動時に、プラグインは通常、自身の関数の一部をEMQXのコールバックとして登録し、EMQXの動作を変更または拡張します。プラグインはEMQXコアや他のプラグインから独立して動作し、互いに干渉しないよう設計されています。また、インストール、起動、停止、削除の明確なプロセスに従うため、運用環境での安全かつ容易な管理が可能です。
主要な概念
- フックポイント：EMQXのワークフローにおける拡張ポイントで、プラグインがカスタムロジックを挿入できる場所。
- コールバック：プラグインモジュール内の関数で、フックポイントに登録されるもの。
- 設定スキーマ：プラグイン設定の検証やEMQXダッシュボードでのUIフォームの動的生成に用いる、オプションのAvroベースのスキーマ。
プラグインのワークフロー概要
- 公式のプラグインテンプレートを使ってプラグインを開発する。
- 認証など、用途に合わせてロジックをカスタマイズする。
make relコマンドでプラグインをビルドし、.tar.gzファイルにパッケージングする。- Dashboard、CLI、またはAPIを使ってEMQXにプラグインをインストール・起動する。
- 必要に応じて設定を更新したり、停止・アンインストールを行う。
詳細情報
- EMQXプラグインの開発：公式テンプレートを使ったプラグインのゼロからの構築方法を学べます。
- プラグインロジックのカスタマイズ：認証、認可などのフックコールバック実装例を紹介します。
- プラグインの管理：EMQXノードやクラスター上でのプラグインのインストール、設定、起動・停止、アンインストール方法を解説します。