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をダウンロードします。

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 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のみを依存関係として追加しています。不要であれば削除可能です。依存関係の詳細は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
}

Kubernetes

EMQX Operator

Manage EMQX Cluster

パスワード認証

監視

アクセスコントロール

統合

管理

OpenTelemetry との統合

プラグイン

JT/T 808 ゲートウェイ

Clients Compatible with Multimedia Services

EMQXプラグインの開発 ​

前提条件 ​

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

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

ディレクトリ構成 ​

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

srcディレクトリの概要 ​

my_emqx_plugin.app.src ​

my_emqx_plugin_app.erl ​

その他のファイル ​

privディレクトリの概要 ​

config.hocon ​

config_schema.avsc ​

config_i18n.json ​

プラグインの実装 ​

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

設定更新の処理 ​

ヘルスチェックの処理 ​

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

パッケージ構成 ​

EMQXプラグインの開発

前提条件

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

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

ディレクトリ構成

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

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

`my_emqx_plugin.app.src`

`my_emqx_plugin_app.erl`

その他のファイル

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

`config.hocon`

`config_schema.avsc`

`config_i18n.json`

プラグインの実装

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

設定更新の処理

ヘルスチェックの処理

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

パッケージ構成