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イメージを取得できます。

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

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

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

$ 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はこちらです。

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

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

$ rebar3 new emqx-plugin my_emqx_plugin

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

ディレクトリ構成

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

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はDashboard、API、CLIからプラグイン設定が変更された際に呼ばれます。
• on_health_check/1はプラグインの状態が要求された際に呼ばれ、プラグインの状態を返すことができます。

その他のファイル

my_emqx_plugin_cli.erlモジュールはプラグインのCLIコマンドを実装します。登録された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()}
    ).

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

%% クライアント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

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

実装例はカスタムプラグインロジックの実装でさらに確認できます。

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

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

$ 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が含まれます。

{
    "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
}