EMQXプラグインの開発

このページでは、EMQXモノレポ外でカスタムEMQXプラグインを開発する手順を説明します。

EMQX公式プラグインは通常、EMQXモノレポ内で開発されます。詳細はEMQXプラグイン開発ガイドをご参照ください。

前提条件

開始する前に、以下を準備してください。

EMQXのフックの知識
makeを含む動作するビルド環境（例：build_essential）
rebar3
対象とするEMQXリリースと同じメジャーバージョンのErlang/OTP。詳細はDockerのorg.opencontainers.image.otp.version属性や、使用バージョンを示す.tool-versionsファイル（例：https://github.com/emqx/emqx/blob/e5.9.0-beta.4/.tool-versions）を参照してください。Erlang/OTPのバージョン管理には[ASDF](https://asdf-vm.com/)の利用を推奨します。あるいは、[こちらのコマンド](https://github.com/emqx/emqx-builder/blob/main/show-latest-images.sh)を実行してemqx-builderイメージを取得できます。

スタンドアロンプラグイン開発

スタンドアロンプラグイン開発には以下の2つのスタイルがあります。

rebar3テンプレート： emqx-plugin-templateを使ってプラグインプロジェクトを生成します。このスタイルはrebar3のみを使用します。
Gitサブモジュールスタイル： EMQX 6.0以降で、プラグインを独立したリポジトリに保持し、EMQXをGitサブモジュールとして追加してモノレポのツールでビルドします。

Gitサブモジュールスタイル

プラグインのソースコードがプライベートで独立したリポジトリに置く必要がありつつ、EMQXモノレポのツールでビルドしたい場合にこのスタイルを使います。

EMQXをサブモジュールとして追加します。

bash

git submodule add --depth 1 git@github.com:emqx/emqx.git emqx

対象バージョンに対応するEMQXブランチをチェックアウトします。例：EMQX 6.0の場合はrelease-60。
プラグインリポジトリをサブモジュールのplugins/ディレクトリにシンボリックリンクします。
bash
```
ln -s ../.. emqx/plugins/{plugin_name}
```
EMQXサブモジュールからプラグインパッケージをビルドします。
bash
```
cd emqx
make plugin-{plugin_name}
```

.tar.gzアーティファクトはemqx/_build/plugins/以下に生成されます。

rebar3テンプレートスタイルの場合は以下の手順に進んでください。

プラグインテンプレートのインストール

EMQXはカスタムEMQXプラグイン作成を簡単にするためにemqx-plugin-templateを提供しています。新しいプラグインを作成するには、rebar3テンプレートとしてemqx-plugin-templateをインストールしてください。

Linux環境では以下のコマンドでemqx-plugin-templateをダウンロードします。

shell

$ mkdir -p ~/.config/rebar3/templates
$ pushd ~/.config/rebar3/templates
$ git clone https://github.com/emqx/emqx-plugin-template
$ popd

TIP

もしREBAR_CACHE_DIR環境変数が設定されている場合、テンプレートのディレクトリは$REBAR_CACHE_DIR/.config/rebar3/templatesになります。関連Issueはこちら。

インストール確認は以下のコマンドで行います。

shell

$ rebar3 new help

出力にemqx-plugin (custom)がテンプレートとして表示されれば成功です。

プラグインスケルトンの生成

インストールしたテンプレートを使って新しいプラグインプロジェクトを生成します。

shell

$ rebar3 new emqx-plugin my_emqx_plugin

このコマンドにより、my_emqx_pluginディレクトリに動作するプラグインのスケルトンが作成されます。

ディレクトリ構成

rebar3 new emqx-pluginコマンドは、emqxを依存として含む標準的なErlangアプリケーションを以下の構成で作成します。

shell

my_emqx_plugin
├── LICENSE
├── Makefile
├── README.md
├── erlang_ls.config
├── priv
│   ├── config.hocon.example
│   ├── config_i18n.json.example
│   ├── config_schema.avsc.enterprise.example
│   └── config_schema.avsc.example
├── rebar.config
├── scripts
│   ├── ensure-rebar3.sh
│   └── get-otp-vsn.sh
└── src
    ├── my_emqx_plugin_app.erl
    ├── my_emqx_plugin.app.src
    ├── my_emqx_plugin_cli.erl
    ├── my_emqx_plugin.erl
    └── my_emqx_plugin_sup.erl

src：プラグインのOTPアプリケーションのコードを含みます。
priv：プラグインの設定ファイルやスキーマ（サンプルファイル付き）を格納します。
rebar.config：アプリケーションのビルドやリリースパッケージ化に使うrebar3の設定ファイルです。
Makefile：プラグインビルドのエントリポイントです。
scripts：Makefile用の補助スクリプトです。注意： テンプレートはemqxに依存しているため、カスタム版rebar3を必要とし、同梱の./scripts/ensure-rebar3.shでインストールできます。
README.md：ドキュメント用のプレースホルダーです。
LICENSE：プラグインのサンプルライセンスファイルです。

設定ファイル`rebar.config`の理解

rebar.configはプラグインのビルドとリリースパッケージ化に使います。内容を確認し、プラグインの要件に応じて調整してください。

重要なセクションは以下です。

依存関係（deps）セクション
リリースセクション（relx）
プラグイン記述（emqx_plugin）セクション

depsセクションでは、プラグインが依存する他のOTPアプリケーションを追加できます。

{deps,
    [
        ...
        %% これはプラグインの依存関係です
        {map_sets, "1.1.0"}
    ]}.

テンプレートではmap_setsという依存が1つ追加されています。不要なら削除可能です。依存関係の詳細はrebar3の依存関係ドキュメントを参照してください。

relxセクションでは、リリース名とバージョン、リリースに含めるアプリケーションのリストを指定します。

{relx, [ {release, {my_emqx_plugin, "1.0.0"},
            [ my_emqx_plugin
            , map_sets
            ]}
       ...
       ]}.

通常、depsセクションのランタイム依存アプリケーションをリリースに追加します。

リリース名とバージョンは、プラグインがEMQXにインストールされた際の識別子として重要です。APIやCLIでプラグインを指定する際の一意の識別子（例：my_emqx_plugin-1.0.0）になります。

プラグイン記述セクションでは、プラグインに関する追加情報を指定します。

{emqx_plugrel,
  [ {authors, ["Your Name"]}
  , {builder,
      [ {name, "Your Name"}
      , {contact, "your_email@example.com"}
      , {website, "http://example.com"}
      ]}
  , {repo, "https://github.com/emqx/emqx-plugin-template"}
  , {functionality, ["Demo"]}
  , {compatibility,
      [ {emqx, "~> 5.0"}
      ]}
  , {description, "Another amazing EMQX plugin"}
  ]
}

`src`ディレクトリの概要

srcディレクトリにはプラグインのOTPアプリケーションのコードが含まれます。

`my_emqx_plugin.app.src`

標準的なErlangアプリケーション記述ファイルで、リリース時にmy_emqx_plugin.appにコンパイルされます。

アプリケーションのバージョンはリリースバージョンと一致する必要はなく、別のバージョニング方式でも構いません。
特にapplicationsセクションに注意してください。プラグインはOTPアプリケーションとしてビルドされるため、プラグインの起動・停止・再起動はこのOTPアプリケーションの操作と同じです。プラグインが他のアプリケーションに依存する場合は、このapplicationsセクションに必ず記載してください。

`my_emqx_plugin_app.erl`

applicationビヘイビア（start/2とstop/1関数）を実装するメインモジュールで、プラグインのアプリケーションとスーパービジョンツリーを起動・停止します。

start/2関数でよく行う処理は以下です。

EMQXのフックポイントへのフック登録
CLIコマンドの登録
スーパービジョンツリーの起動

オプションで、_app.erlモジュールはon_config_changed/2とon_health_check/1のコールバック関数を実装できます。

on_config_changed/2は、ダッシュボード、API、CLI経由でプラグインの設定が変更されたときに呼ばれます。
on_health_check/1はプラグインの状態が要求されたときに呼ばれます。プラグインはこの関数から自身の状態を報告できます。

その他のファイル

my_emqx_plugin_cli.erlモジュールはプラグインのCLIコマンドを実装します。登録されると、emqx ctlコマンド経由で呼び出されます。

my_emqx_plugin_sup.erlはプラグインの典型的なスーパーバイザを実装します。

my_emqx_plugin.erlはプラグインのメインモジュールで、プラグインのロジックを実装します。スケルトンでは簡単なログ出力を伴うデモ用フックをいくつか実装しています。必要に応じて他のモジュールも追加可能です。

注意

アプリケーションモジュールやファイル名は任意ですが、以下の条件は満たす必要があります。

アプリケーション名はプラグイン名と同じであること
アプリケーションモジュール（_app）は{plugin_name}_appという名前であること

`priv`ディレクトリの概要

privディレクトリにはプラグインの設定ファイルやスキーマが格納されます。

`config.hocon`

プラグインの初期設定をHOCON形式で記述したファイルです。config.hocon.exampleを参照用に利用できます。

`config_schema.avsc`

プラグイン設定のスキーマをAvro形式で定義したファイルです。存在する場合、EMQXは設定更新時にこのスキーマに基づくバリデーションを行います。config.hoconがスキーマに準拠しない場合、リリースビルドは失敗します。

さらに、このファイルにはUIヒントを含めることができ、EMQXダッシュボードでの対話的な設定が可能になります。参考としてconfig_schema.avsc.enterprise.exampleを参照してください。

`config_i18n.json`

プラグイン設定UIの翻訳をJSON形式で記述したファイルです。例：

{
  "$key": {
    "zh": "中文翻译",
    "en": "English translation"
  },
  ...
}

翻訳はconfig_schema.avscのUIヒントで参照されます。詳細はconfig_i18n.json.exampleとconfig_schema.avsc.enterprise.exampleを参照してください。

プラグインの実装

スケルトンが準備できたら、プラグインのロジック実装を始めます。プラグイン実装には通常以下のロジックが必要です。

フックとCLIコマンドの実装
設定更新の処理
ヘルスチェックの処理

フックとCLIコマンドの実装

EMQXは様々なイベントに対するフックポイントを定義しています。任意のアプリケーション（プラグインも含む）はこれらのフックポイントにコールバックを登録し、イベントに応答したり既定の動作を変更できます。

よく使われるフックポイントはスケルトンファイルに用意されています。フックポイントの一覧、引数、期待される戻り値はEMQXコードに記載されています。

フックポイントにコールバックを登録するにはemqx_hooks:add/3関数を使います。以下のパラメータを指定してください。

フックポイント名
コールバックのモジュールと関数、およびEMQXが渡す追加引数（任意）
コールバックの優先度（通常は?HP_HIGHESTで最優先）

コールバックを解除するにはemqx_hooks:del/2を使い、フックポイント名とモジュール/関数を指定します。

例として、client.authenticateとclient.authorizeフックポイントの登録/解除は以下のようにします。

-module(my_emqx_plugin).
...
hook() ->
  emqx_hooks:add('client.authenticate', {?MODULE, on_client_authenticate, []}, ?HP_HIGHEST),
  emqx_hooks:add('client.authorize', {?MODULE, on_client_authorize, []}, ?HP_HIGHEST).

unhook() ->
  emqx_hooks:del('client.authenticate', {?MODULE, on_client_authenticate}),
  emqx_hooks:del('client.authorize', {?MODULE, on_client_authorize}).

通常、フックはプラグインの起動・停止と連動して有効化・無効化するため、start/2とstop/1関数内でhook/unhookを呼びます。

start(_StartType, _StartArgs) ->
    {ok, Sup} = my_emqx_plugin_sup:start_link(),
    my_emqx_plugin:hook(),

    {ok, Sup}.

stop(_State) ->
    my_emqx_plugin:unhook().

コールバック関数のシグネチャはフックポイント仕様にあります。例：

-callback 'client.authorize'(
    emqx_types:clientinfo(), emqx_types:pubsub(), emqx_types:topic(), allow | deny
) ->
    fold_callback_result(#{result := allow | deny, from => term()}).

-callback 'client.authenticate'(emqx_types:clientinfo(), ignore) ->
    fold_callback_result(
        ignore
        | ok
        | {ok, map()}
        | {ok, map(), binary()}
        | {continue, map()}
        | {continue, binary(), map()}
        | {error, term()}
    ).

コールバック関数の実装例：

erlang

%% クライアントIDがA-Z、a-z、0-9、アンダースコアのいずれかにマッチする場合のみ接続を許可
on_client_authenticate(_ClientInfo = #{clientid := ClientId}, Result) ->
  case re:run(ClientId, "^[A-Za-z0-9_]+$", [{capture, none}]) of
    match -> {ok, Result};
    nomatch -> {stop, {error, banned}}
  end.
%% クライアントは/room/{clientid}形式のトピックのみサブスクライブ可能、パブリッシュは任意のトピックに可能
on_client_authorize(_ClientInfo = #{clientid := ClientId}, subscribe, Topic, Result) ->
  case emqx_topic:match(Topic, <<"/room/", ClientId/binary>>) of
    true -> {ok, Result};
    false -> stop
  end;
on_client_authorize(_ClientInfo, _Pub, _Topic, Result) -> {ok, Result}.

スケルトンアプリでは、フックはmy_emqx_plugin:load/1で登録され、my_emqx_plugin:unload/0で解除されます。

設定更新の処理

ユーザーがプラグインの設定を更新すると、プラグインアプリケーションのon_config_changed/2コールバック関数が呼ばれます。

このコールバック内で通常行う処理は以下です。

新しい設定のバリデーション
プラグインが稼働中なら変更に対応する処理

設定のバリデーション時、アプリケーションがまだ起動していない可能性があるため、ステートレスなチェックを行い、ノード間で不整合を起こす環境依存のチェックは避けてください。

プラグインが稼働中の場合、設定変更を適用できます。一般的なパターンは以下です。

アプリケーション起動時に設定を扱うgen_serverを起動
そのサーバー（例：my_emqx_plugin_config_server）が現在の設定を読み込み状態を初期化
on_config_changed/2が設定を検証し、新しい設定をmy_emqx_plugin_config_serverに送信
サーバーが稼働中なら状態を新設定で更新、そうでなければ何もしない

ヘルスチェックの処理

on_health_check/1コールバックはEMQXがプラグインの状態を要求した際に呼ばれます。プラグインは以下のように状態を報告できます。

正常ならokを返す
問題がある場合はバイナリの理由を含む{error, Reason}を返す

外部リソースに依存し、利用不可になる可能性があるプラグインで特に重要です。

詳細はスケルトンアプリのmy_emqx_plugin_app:on_health_check/1を参照してください。

TIP

この関数はプラグイン稼働中に呼ばれますが、起動や停止時の並行処理の影響で呼ばれることもあります。

より多くの実装例はカスタムプラグインロジックの実装をご覧ください。

プラグインパッケージのビルド

以下のコマンドでプラグインのリリースを作成します。

shell

$ cd my_emqx_plugin
$ make rel

これにより、プラグインリリース_build/default/emqx_plugin/my_emqx_plugin-1.0.0.tar.gzが作成されます。このパッケージはプラグインのプロビジョニングやインストールに使用できます。

パッケージ構成

プラグインがリリースとしてビルドされると、パッケージ構成は以下のようになります。

└── my_emqx_plugin-1.1.0.tar.gz
    ├── map_sets-1.1.0
    ├── my_emqx_plugin-0.1.0
    ├── README.md
    └── release.json

tarballにはコンパイル済みアプリケーション（rebar.configのrelxセクションで指定したもの）、README.md、プラグインのメタデータを含むrelease.jsonが含まれます。

json

{
    "hidden": false,
    "name": "my_emqx_plugin",
    "description": "Another amazing EMQX plugin.",
    "authors": "Anonymous",
    "builder": {
        "name": "Anonymous",
        "contact": "anonymous@example.org",
        "website": "http://example.com"
    },
    "repo": "https://github.com/emqx/emqx-plugin-template",
    "functionality": "Demo",
    "compatibility": {
        "emqx": "~> 5.7"
    },
    "git_ref": "unknown",
    "built_on_otp_release": "27",
    "emqx_plugrel_vsn": "0.5.1",
    "git_commit_or_build_date": "2025-04-29",
    "metadata_vsn": "0.2.0",
    "rel_apps": [
        "my_emqx_plugin-0.1.0",
        "map_sets-1.1.0"
    ],
    "rel_vsn": "1.1.0",
    "with_config_schema": true
}

プラグイン拡張APIとUI

プラグインはEMQXプラグインAPIゲートウェイを通じてカスタムHTTPエンドポイントを公開でき、オプションでダッシュボードにネイティブUIを埋め込むことも可能です。

プラグインHTTP API

プラグインAPIゲートウェイは以下のパスでプラグインへのリクエストをルーティングします。

/api/v5/plugin_api/{plugin_name}/...

これらのリクエストを処理するには、プラグインアプリモジュールでon_handle_api_call/4を実装し、HTTPメソッドやパスでディスパッチします。参考実装はplugins/emqx_username_quota/src/emqx_username_quota_app.erlやemqx_username_quota_api.erlを参照してください。

コールバック契約

erlang

on_handle_api_call(Method, PathRemainder, Request, Context) -> Result

パラメータ	説明
`Method`	`get \| post \| put \| patch \| delete`
`PathRemainder`	`{plugin_name}`以降のパスセグメントのリスト（バイナリ、パーセントデコード済み）
`Request`	`query_string`、`headers`、`body`（非GET/DELETEはJSON）を含むマップ
`Context`	認証メタデータやネームスペース情報を含むマップ

受け入れ可能な戻り値：

{ok, StatusCode, Headers, Body}
{error, StatusCode, Headers, Body}
{error, not_found}

ダッシュボードのプラグインネイティブUI

emqx_pluginのメタデータにindexフィールドがある場合、EMQXダッシュボードはプラグインのネイティブUIをiframeで表示します。ダッシュボードはプラグインAPIのベースパスを先頭に付加します。

/api/v5/plugin_api/{plugin_name}{index}

例：index: "/ui"の場合は/api/v5/plugin_api/{plugin_name}/uiに解決されます。

ネイティブUIを無効化するには、indexフィールドを省略するか空文字に設定してください。

パスワード認証

エンドツーエンドトレース

EMQXプラグインの開発 ​

前提条件 ​

スタンドアロンプラグイン開発 ​

Gitサブモジュールスタイル ​

プラグインテンプレートのインストール ​

プラグインスケルトンの生成 ​

ディレクトリ構成 ​

設定ファイルrebar.configの理解 ​

srcディレクトリの概要 ​

my_emqx_plugin.app.src ​

my_emqx_plugin_app.erl ​

その他のファイル ​

privディレクトリの概要 ​

config.hocon ​

config_schema.avsc ​

config_i18n.json ​

プラグインの実装 ​

フックとCLIコマンドの実装 ​

設定更新の処理 ​

ヘルスチェックの処理 ​

プラグインパッケージのビルド ​

パッケージ構成 ​

プラグイン拡張APIとUI ​

プラグインHTTP API ​

コールバック契約 ​

ダッシュボードのプラグインネイティブUI ​

EMQXプラグインの開発

前提条件

スタンドアロンプラグイン開発

Gitサブモジュールスタイル

プラグインテンプレートのインストール

プラグインスケルトンの生成

ディレクトリ構成

設定ファイル`rebar.config`の理解

`src`ディレクトリの概要

`my_emqx_plugin.app.src`

`my_emqx_plugin_app.erl`

その他のファイル

`priv`ディレクトリの概要

`config.hocon`

`config_schema.avsc`

`config_i18n.json`

プラグインの実装

フックとCLIコマンドの実装

設定更新の処理

ヘルスチェックの処理

プラグインパッケージのビルド

パッケージ構成

プラグイン拡張APIとUI

プラグインHTTP API

コールバック契約

ダッシュボードのプラグインネイティブUI