gRPC Hook Extension

Extension Hook は emqx-exhook プラグインによってサポートされています。これにより、ユーザーは他のプログラミング言語を使って EMQX の Hooks を処理できます。

この仕組みにより、他のプログラミング言語で emqx のイベントを処理し、emqx のカスタマイズや拡張が可能になります。例えば、以下のような実装が可能です。

• クライアント接続時の認証
• パブリッシュ／サブスクライブの認可
• メッセージのパーシステンスやブリッジ処理
• クライアントの接続／切断イベントの処理

設計

emqx-exhook プラグインは RPC の通信フレームワークとして gRPC を使用しています。

アーキテクチャは以下の図の通りです。

この図は、EMQX が gRPC クライアントとして動作し、EMQX からユーザーの gRPC サーバーへフックイベントを送信することを示しています。

EMQX のネイティブフックと同様に、計算と返却のチェーン方式もサポートしています。

コールバック関数チェーン

API

イベントハンドラー、すなわちユーザーが実装する gRPC サーバー側として、マウントすべきフックのリストを定義し、各イベント到着時の処理方法をコールバック関数として実装します。

これらのインターフェースは HookProvider という gRPC サービスとして定義されています。

syntax = "proto3";

package emqx.exhook.v2;

service HookProvider {

  rpc OnProviderLoaded(ProviderLoadedRequest) returns (LoadedResponse) {};

  rpc OnProviderUnloaded(ProviderUnloadedRequest) returns (EmptySuccess) {};

  rpc OnClientConnect(ClientConnectRequest) returns (EmptySuccess) {};

  rpc OnClientConnack(ClientConnackRequest) returns (EmptySuccess) {};

  rpc OnClientConnected(ClientConnectedRequest) returns (EmptySuccess) {};

  rpc OnClientDisconnected(ClientDisconnectedRequest) returns (EmptySuccess) {};

  rpc OnClientAuthenticate(ClientAuthenticateRequest) returns (ValuedResponse) {};

  rpc OnClientAuthorize(ClientAuthorizeRequest) returns (ValuedResponse) {};

  rpc OnClientSubscribe(ClientSubscribeRequest) returns (EmptySuccess) {};

  rpc OnClientUnsubscribe(ClientUnsubscribeRequest) returns (EmptySuccess) {};

  rpc OnSessionCreated(SessionCreatedRequest) returns (EmptySuccess) {};

  rpc OnSessionSubscribed(SessionSubscribedRequest) returns (EmptySuccess) {};

  rpc OnSessionUnsubscribed(SessionUnsubscribedRequest) returns (EmptySuccess) {};

  rpc OnSessionResumed(SessionResumedRequest) returns (EmptySuccess) {};

  rpc OnSessionDiscarded(SessionDiscardedRequest) returns (EmptySuccess) {};

  rpc OnSessionTakenover(SessionTakenoverRequest) returns (EmptySuccess) {};

  rpc OnSessionTerminated(SessionTerminatedRequest) returns (EmptySuccess) {};

  rpc OnMessagePublish(MessagePublishRequest) returns (ValuedResponse) {};

  rpc OnMessageDelivered(MessageDeliveredRequest) returns (EmptySuccess) {};

  rpc OnMessageDropped(MessageDroppedRequest) returns (EmptySuccess) {};

  rpc OnMessageAcked(MessageAckedRequest) returns (EmptySuccess) {};
}

HookProvider の役割：

• OnProviderLoaded：HookProvider のロード方法を定義します。このメソッドはマウントすべきフックのリストを返します。このリストにあるフックのみがユーザーの HookProvider サービスにコールバックされます。
• OnProviderUnloaded：HookProvider が emqx からアンインストールされたことをユーザーに通知します。

フックイベントの役割：

• OnClient、OnSession、OnMessage で始まるメソッドは hooks のメソッドに対応しており、呼び出しタイミングや引数リストもほぼ同様です。
• OnClientAuthenticate、OnClientCheckAcl、OnMessagePublish のみが EMQX に返却値を返すことが許可されており、その他のコールバックは返却値をサポートしていません。

インターフェースやパラメータの詳細は以下を参照してください。
exhook.proto

開発ガイド

ユーザーは HookProvider の gRPC サービスを実装し、EMQX からのコールバックイベントを受け取る必要があります。

主な開発手順は以下の通りです。

1. lib/emqx_exhook-<x.y.z>/priv/protos/exhook.proto ファイルをプロジェクトにコピーします。
2. 対応するプログラミング言語の gRPC フレームワークを使い、exhook.proto の gRPC サーバー側コードを生成します。
3. 必要に応じて exhook.proto で定義されたインターフェースを実装します。

開発が完了したら、EMQX と通信可能なサーバーにサービスをデプロイし、ポートが開放されていることを確認してください。

EMQX ダッシュボード から ExHook サービスの管理と監視が可能です。

各言語向けの gRPC フレームワークは以下で確認できます。
grpc-ecosystem/awesome-grpc

また、いくつかの一般的なプログラミング言語向けのサンプルプログラムも提供しています。
emqx-extension-examples