Skip to content

MQTT ブリッジ(ディスクキュー付き) ​

このプラグインを使用すると、ローカルの MQTT メッセージを別の MQTT ブローカーに転送し、ディスクバッファによる高いレジリエンスを実現できます。

特長 ​

  • ブリッジごとのディスクバッファリング。
  • リモートブローカーが利用できない場合の自動リトライ。
  • ${topic} を使ったトピック書き換え対応。
  • 1つのプラグインで複数のブリッジを管理可能。
  • 設定更新はブリッジ単位で適用(変更のないブリッジは継続稼働)。

動作概要 ​

  1. ローカルのパブリッシュが各ブリッジの filter_topic とマッチするか判定。
  2. マッチしたメッセージをディスクキューのパーティションに追記。
  3. キューに溜まったメッセージをリモートブローカーにパブリッシュ。
  4. ネットワークや接続障害でパブリッシュに失敗した場合は自動リトライ。
  5. キューパーティションのサイズが queue.max_total_bytes を超えた場合、当該パーティションの最古レコードから破棄。

設定 ​

EMQX ダッシュボード(推奨)またはプラグイン設定ファイルから設定します。

本番環境では、まず1つのブリッジでトラフィックを検証し、その後スケールアウトしてください。

設定ファイルの場所 ​

関連する設定ファイルは以下の2種類です:

  • インストールされたプラグインパッケージ内のデフォルトファイル:

    • docker インストール例(バージョン 0.2.0): /opt/emqx/plugins/emqx_bridge_mqtt_dq-0.2.0/emqx_bridge_mqtt_dq-0.2.0/priv/config.hocon
    • deb/rpm インストール例(バージョン 0.2.0): /usr/lib/emqx/plugins/emqx_bridge_mqtt_dq-0.2.0/emqx_bridge_mqtt_dq-0.2.0/priv/config.hocon
  • ダッシュボードや API 経由で設定保存後に EMQX が管理する永続化プラグイン設定ファイル:

    • docker: /opt/emqx/data/plugins/emqx_bridge_mqtt_dq/config.hocon
    • deb/rpm: /var/lib/emqx/plugins/emqx_bridge_mqtt_dq/config.hocon

priv/config.hocon はパッケージに含まれるデフォルトテンプレートです。
data/plugins/.../config.hocon は EMQX が設定変更を保存後に使用する永続化設定ファイルです。

クイックスタート(ダッシュボード) ​

  1. プラグインを有効化。
  2. remotes に再利用可能なリモートブローカーを1つ追加。
  3. bridges にブリッジを1つ追加。
  4. remote、filter_topic、remote_topic を設定。
  5. 保存してリモート配信を検証。
  6. ベースライン検証後にキューやプール設定を調整。

例 ​

hocon
bridges {
  to-cloud {
    enable = true
    remote = cloud
    proto_ver = "v4"
    keepalive_s = 60
    pool_size = 4
    filter_topic = "devices/#"
    remote_topic = "fwd/${topic}"
    remote_qos = "${qos}"
    remote_retain = "${retain}"
    queue {
      seg_bytes = "100MB"
      max_total_bytes = "1GB"
    }
  }
}

remotes {
  cloud {
    server = "cloud-broker.example.com:8883"
    username = "bridge_user"
    password = "secret"
    ssl {
      enable = true
      verify = verify_none
      # cacertfile = "/path/to/ca.pem"
      # certfile = "/path/to/client-cert.pem"
      # keyfile = "/path/to/client-key.pem"
    }
  }
}

環境変数の置換 ​

設定ファイル内の任意の文字列値は、${EMQXDQ_*} 形式で OS 環境変数を参照できます。
EMQXDQ_ プレフィックス付きの変数のみ解決され、それ以外の ${...}(例:remote_topic の ${topic})はそのまま残ります。
値全体がプレースホルダーである必要があり、部分的な埋め込み(例:"prefix-${EMQXDQ_VAR}-suffix")はサポートされません。

制限: ${EMQXDQ_*} は文字列型フィールド(例:server、username、password)のみ対応し、
ブール型(enable)、整数型(pool_size、keepalive_s)には使用できません。

例:

hocon
remotes {
  cloud {
    server = "${EMQXDQ_REMOTE_SERVER}"
    username = "${EMQXDQ_REMOTE_USER}"
    password = "${EMQXDQ_REMOTE_PASSWORD}"
  }
}

環境変数が設定されていない場合、プラグインはエラーをログに出力し、元の ${EMQXDQ_...} 文字列をリテラル値として保持します。
これにより接続失敗(例:"${EMQXDQ_REMOTE_SERVER}" に接続しようとする)が発生し、ログやステータス API で誤設定が明示されます。

警告 — 動的設定更新とノードローカル環境変数

環境変数は設定解析時に、そのノード上で解決されます。
EMQX ダッシュボード、REST API、CLI でプラグイン設定を更新すると、設定テキストはクラスタ内の全ノードで再解析されます。
ノードごとに環境変数の値が異なるか未設定の場合、ノードごとに異なる実効設定となります。

そのため、クラスタ内の全ノードで同一の環境変数が設定されている場合を除き、ダッシュボードや API、CLI 経由の ${EMQXDQ_...} 置換は避けてください。
ノードローカルなシークレットは、設定ファイルを直接編集してプラグインをリロードするか、Kubernetes ConfigMaps/Secrets のような全ノードで一貫したシークレット注入機構を利用してください。

設定リファレンス ​

トップレベル ​

フィールド型デフォルト説明
bridgesmap{}ブリッジ名をキーとしたブリッジ設定のマップ。
remotesmap{}再利用可能なリモートブローカー定義のマップ。

ブリッジ(bridges.<name>) ​

フィールド型デフォルト説明
enablebooleantrueこのブリッジを有効または無効にします。
remotestring—remotes 内のリモートブローカー定義名。
proto_verstring"v4"MQTT プロトコルバージョン:v3、v4、v5。
clientid_prefixstring"emqx-dq-<name>-"自動生成される MQTT クライアントIDのプレフィックス。各接続はユニークなインデックスを付加(例:emqx-dq-mybridge-0)。省略可。
keepalive_sinteger60MQTT キープアライブ間隔(秒)。
pool_sizeinteger4リモートブローカーへの MQTT 接続数。
buffer_pool_sizeinteger4ブリッジごとのディスクキューバッファワーカー数。以下の注意を参照。
filter_topicstring—ローカルトピックフィルター。+ と # ワイルドカード対応。
remote_topicstring—転送先トピックテンプレート。元のトピックは ${topic} で参照。
enqueue_timeout_msinteger5000ディスクキュー書き込み確認待ちの最大ブロック時間(ms)。QoS > 0 のみ適用。QoS 0 は常に非同期。
max_inflightinteger32リモートブローカーへの未アックメッセージ最大数。ディスクキューからのバッチポップサイズと emqtt 送信ウィンドウを制御。
remote_qosstring"${qos}"リモートブローカーへのパブリッシュ QoS レベル("0"、"1"、"2")。デフォルトの "${qos}" は元メッセージの QoS を保持。
remote_retainstring"${retain}"リモートブローカーへのパブリッシュ保持フラグ("true"、"false")。デフォルトの "${retain}" は元メッセージの保持フラグを保持。
max_publish_retriesinteger-1メッセージごとのパブリッシュリトライ最大回数。-1 は無限リトライ。失敗した PUBACK や接続断で1回消費。

リモート(remotes.<name>) ​

フィールド型デフォルト説明
serverstring—リモート MQTT ブローカーのアドレス(host:port)。
usernamestring""リモートブローカー認証用ユーザー名。
passwordstring""リモートブローカー認証用パスワード。
ssl.enablebooleanfalseリモートブローカー接続に SSL/TLS を有効化。
ssl.verifystringverify_noneTLS 検証モード。サポート値:verify_none、verify_peer。
ssl.snistringサーバーホスト名TLS Server Name Indication。デフォルトはサーバーホスト名。"disable" で SNI 無効化。
ssl.cacertfilestring—リモートブローカー証明書検証用 CA 証明書ファイル。
ssl.certfilestring—相互 TLS 認証用クライアント証明書ファイル。
ssl.keyfilestring—相互 TLS 認証用クライアント秘密鍵ファイル。

キュー ​

フィールド型デフォルト説明
queue.base_dirstring"emqx_bridge_mqtt_dq"ディスクキューセグメントファイルのベースディレクトリ。ブリッジ名とパーティションインデックスが自動付加される(例:<base_dir>/<bridge_name>/<index>)。相対パスは EMQX の data_dir 基準で解決。絶対パスはそのまま使用。
queue_seg_bytesstring"100MB"キューセグメントファイルの最大サイズ。
queue.max_total_bytesstring"1GB"パーティションごとの最大ディスクキューサイズ。各ブリッジは buffer_pool_size 個のパーティションを使用するため、最大総使用量は buffer_pool_size × この値。超過時は最古メッセージを破棄。

トピックテンプレート ​

remote_topic フィールドは ${topic} プレースホルダーをサポートし、転送時に元のパブリッシュトピックで置換されます。

例:

  • remote_topic = "${topic}" — 元のトピックをそのまま転送。
  • remote_topic = "forwarded/${topic}" — プレフィックスを付加。
  • remote_topic = "region1/${topic}" — リージョンのネームスペースを追加。

remote_topic はキューからメッセージ送信時に適用されます。このフィールドを変更した場合、該当ブリッジの再起動後にキュー内のメッセージは新テンプレートを使用します。

REST API ​

プラグインは EMQX プラグイン API ベースパス以下に4つのエンドポイントを公開しています:

  • GET /api/v5/plugin_api/emqx_bridge_mqtt_dq/metrics — Prometheus テキスト形式
  • GET /api/v5/plugin_api/emqx_bridge_mqtt_dq/stats — JSON ダッシュボードスナップショット
  • GET /api/v5/plugin_api/emqx_bridge_mqtt_dq/stats/<bridge> — 指定ブリッジのみ
  • GET /api/v5/plugin_api/emqx_bridge_mqtt_dq/status — プラグイン/クラスターのヘルスサマリー

すべての JSON エンドポイントは application/json; charset=utf-8 を返します。

JSON API はクラスタ集約型です。ノードが利用不可またはタイムアウトした場合でもベストエフォートでデータを返しますが、レスポンスにクラスタの完全性メタデータが含まれます。

例:

bash
curl -u admin:public \
  http://127.0.0.1:18083/api/v5/plugin_api/emqx_bridge_mqtt_dq/metrics
bash
curl -u admin:public \
  http://127.0.0.1:18083/api/v5/plugin_api/emqx_bridge_mqtt_dq/stats

/stats レスポンス構造 ​

/stats のレスポンスボディは以下を含みます:

  • cluster: クラスターの完全性と失敗ノード情報
  • uptime_seconds: 応答ノード間で観測された最大プラグインアップタイム(秒)
  • summary: 全ブリッジ合計値
  • bridges: 各ブリッジのエントリ配列

例:

json
{
  "cluster": {
    "complete": true,
    "responded_nodes": ["emqx@127.0.0.1"],
    "failed_nodes": [],
    "timeout_ms": 5000
  },
  "uptime_seconds": 123,
  "summary": {
    "bridge_count": 1,
    "running_bridge_count": 1,
    "buffered": 12,
    "backlog": 3,
    "inflight": 8,
    "enqueue": 1000,
    "dequeue": 995,
    "publish": 990,
    "drop": 5
  },
  "bridges": [
    {
      "name": "to-cloud",
      "config_state": "enabled",
      "runtime_state": "running",
      "status": "ok",
      "status_reason": null,
      "enqueue": 1000,
      "dequeue": 995,
      "publish": 990,
      "drop": 5,
      "retried_by_reason": {
        "connect_failed": 2,
        "reason_code": 3
      },
      "buffered": 12,
      "backlog": 3,
      "inflight": 8,
      "buffers": [
        {
          "bridge": "to-cloud",
          "index": 0,
          "status": "running",
          "buffered": 12
        }
      ],
      "connectors": [
        {
          "bridge": "to-cloud",
          "index": 0,
          "status": "connected",
          "backlog": 3,
          "inflight": 8
        }
      ]
    }
  ]
}

GET /stats/<bridge> は以下を返します:

json
{
  "cluster": {
    "complete": true,
    "responded_nodes": ["emqx@127.0.0.1"],
    "failed_nodes": [],
    "timeout_ms": 5000
  },
  "bridge": {
    "name": "to-cloud",
    "config_state": "enabled",
    "runtime_state": "running",
    "status": "ok"
  }
}

指定ブリッジが現在の設定に存在しない場合、API は 404 を返します。

GET /status はコンパクトなヘルスビューを返します:

json
{
  "plugin": "emqx_bridge_mqtt_dq",
  "cluster": {
    "complete": true,
    "responded_nodes": ["emqx@127.0.0.1"],
    "failed_nodes": [],
    "timeout_ms": 5000
  },
  "status": "ok",
  "bridge_count": 1
}

/metrics エンドポイントはクラスタ集約された Prometheus テキストエクスポートを返し、以下のようなシリーズを含みます:

  • emqx_bridge_mqtt_dq_uptime_seconds
  • emqx_bridge_mqtt_dq_bridge_enqueue_total{bridge="..."}
  • emqx_bridge_mqtt_dq_bridge_dequeue_total{bridge="..."}
  • emqx_bridge_mqtt_dq_bridge_publish_total{bridge="..."}
  • emqx_bridge_mqtt_dq_bridge_drop_total{bridge="..."}
  • emqx_bridge_mqtt_dq_bridge_status{bridge="...",status="..."}
  • emqx_bridge_mqtt_dq_bridge_retry_reason_total{bridge="...",reason="..."}
  • emqx_bridge_mqtt_dq_buffer_buffered{bridge="...",index="..."}
  • emqx_bridge_mqtt_dq_connector_backlog{bridge="...",index="..."}
  • emqx_bridge_mqtt_dq_connector_inflight{bridge="...",index="..."}

メトリクスの意味 ​

ブリッジメトリクス ​

  • enqueue: ブリッジのエンキュー経路に受け入れたローカルメッセージ数
  • dequeue: ローカルキューから耐久的に削除されたメッセージ数
  • publish: リモートブローカーに正常にパブリッシュされたメッセージ数
  • drop: キュー内で破棄されたメッセージ数
  • retried_by_reason: リトライ理由別の試行回数
  • config_state: 設定からの望ましいブリッジ状態(enabled または disabled)
  • runtime_state: 実際のワーカー/ストレージ状態(running、degraded、purged)
  • status: オペレーター向けブリッジのヘルス状態(ok、partial、disconnected、disabled、error)

現在のリトライ理由:

  • reason_code: リモートブローカーが非成功 MQTT 理由コードを返しリトライされた
  • connect_failed: 接続またはパブリッシュ失敗でリトライされた
  • timeout: タイムアウトによるリトライ分類
  • connection_lost: クライアントプロセス終了に伴いインフライトメッセージがリトライ用に回収された
  • other: 未分類リトライ理由のフォールバック

ブリッジが完全にドレインされた後は以下を満たします:

  • enqueue = dequeue = publish + drop

バッファメトリクス ​

  • buffered: 当該耐久キューパーティションに現在格納されているメッセージ数
  • バッファ行の status: ワーカーが存在すれば running、そうでなければ missing

このゲージは replayq:open/1 直後に更新されるため、永続化されたディスク上のメッセージは新規トラフィック到着前から可視化されます。

コネクタメトリクス ​

  • backlog: コネクタのバックログキューに滞留し、emqtt への送出待ちのメッセージ数
  • inflight: すでに emqtt に渡され、完了待ちのメッセージ数
  • コネクタ行の status: connected、disconnected、partial、missing、unknown

設定変更時の挙動 ​

設定更新はブリッジ単位で適用されます:

  • 変更されたブリッジは再起動。
  • 削除されたブリッジは停止。
  • 無効化されたブリッジは停止し、キューディレクトリをパージ。
  • 新規ブリッジは起動。
  • 変更のないブリッジは継続稼働。

プラグイン全体は設定更新ごとに再起動されません。
ただし、再起動した各ブリッジには短時間の引継ぎウィンドウがあり、その間にマッチするメッセージが破棄される可能性があります。
トラフィックが少ない時間帯にブリッジに影響する変更を適用してください。

設定変更前の注意 ​

  1. 影響を受けるブリッジを特定。
  2. トラフィックの少ない時間帯に適用。
  3. ダッシュボードのステータスやログで再起動・再接続エラーを監視。
  4. 重要なパイプラインは変更後にエンドツーエンドの配信検証を実施。

queue.base_dir の変更 ​

有効なブリッジで queue.base_dir を変更すると、新ディレクトリでブリッジが再起動します。
実際のキューパスは <base_dir>/<bridge_name>/<index> です。
古いディレクトリは自動的に削除されず、オーファンデータとして残ります。
不要な場合は、ブリッジが新パスで稼働していることを確認後、手動で削除してください。

buffer_pool_size の変更 ​

buffer_pool_size はブリッジごとのディスクキューパーティション数を制御します。
メッセージは erlang:phash2(Topic, buffer_pool_size) でパーティションに割り当てられます。
この値の変更は以下の副作用があります:

  1. プール縮小(例:8 → 4):新サイズ以上のインデックスのパーティションは消費されなくなります。古いファイルは queue.base_dir に残り手動でクリーンアップが必要。
  2. プール拡大(例:4 → 8):ハッシュ空間が変わり、以前パーティション N に割り当てられたトピックがパーティション M に変わる可能性があります。古いパーティションのメッセージは順序を保って配信されますが、新規メッセージは別パーティションに行くため、トピック単位のエンドツーエンド順序が一時的に崩れます。
  3. ブリッジ単位のドロップウィンドウ:buffer_pool_size の変更によりブリッジが再起動し、引継ぎ中にインフライトメッセージが破棄される可能性があります。

メッセージ配信保証 ​

このプラグインは通常動作下で 少なくとも1回配信(at-least-once) を提供し、持続的障害時は ベストエフォート配信 となります。以下のケースでメッセージが失われる可能性があります。

ディスクキューのオーバーフロー ​

キューパーティションが queue.max_total_bytes を超えると、当該パーティションの最古メッセージが新規データのために静かに破棄されます。
警告ログ(mqtt_dq_buffer_overflow)が定期的に出力されます(メッセージ単位ではありません)。

対策:queue.max_total_bytes を増やす、buffer_pool_size を増やして負荷分散、またはメッセージスループットを減らす。

リモートブローカーによるパブリッシュ拒否 ​

リモートブローカーが PUBACK(QoS 1)または PUBREC(QoS 2)で非成功 MQTT 理由コードを返すと、コネクターは最大3回リトライします。
リトライが尽きるとメッセージは破棄され、警告ログ(mqtt_dq_publish_dropped)が出力されます。

主な拒否理由コード:

コード意味(MQTT 5.0)
16マッチするサブスクライバーなし
128未指定エラー
131実装固有エラー
135認可されていない
144トピック名が無効
145パケット識別子が使用中
151クォータ超過

注:理由コード 0(成功)と 16(マッチするサブスクライバーなし)は成功扱いでリトライ対象外。

対策:リモートブローカーの ACL やトピックポリシーを確認し、ログの理由コードを調査。

接続障害の繰り返し ​

リモートブローカーへの接続が切断されるたびに、未アックのメッセージはリトライ回数を1回消費します。
3回の接続障害が成功配信なしで累積するとメッセージは破棄されます。

例:ネットワーク障害中にパブリッシュされたメッセージ

  1. ローカルキューに格納(リトライカウンター=3)
  2. リモート再接続、送出 → ACK 前に切断(リトライカウンター=2)
  3. 再接続、再送 → 切断(リトライカウンター=1)
  4. 再接続、再送 → 拒否または切断(リトライカウンター=0)
  5. メッセージ破棄、警告ログ出力

対策:リモートブローカーが繰り返し到達不能になる原因を調査。
一時的なネットワーク断は透過的に処理されますが、持続的な不安定さは問題です。

エンキュー時のバックプレッシャー(QoS > 0 のローカルパブリッシュ) ​

QoS 1 または 2 のクライアントがブリッジにマッチするメッセージをパブリッシュすると、プラグインはバッファワーカーのメールボックスにメッセージを送信し、ディスク書き込み確認まで最大 enqueue_timeout_ms(デフォルト 5000 ms)までパブリッシュセッションプロセスをブロックします。

このタイムアウト発生時もメッセージ自体は失われません。すでにバッファワーカーの Erlang メールボックスに存在し、最終的にディスクキューに書き込まれます。
タイムアウトはローカルパブリッシュパスのブロック時間制御のみを目的としています。

理由:message.publish フックは MQTT セッションプロセス内で実行されます。
フックがブロック中は当該クライアントの他メッセージ処理が停止します。
バッファワーカーが遅い(ディスク I/O ストールやメールボックス遅延)場合、タイムアウトがなければクライアントセッションが無期限に停止する恐れがあります。

タイムアウト発生時の挙動:

  1. セッションプロセスは待機をやめ通常処理を継続。
  2. クライアントは通常通り PUBACK/PUBREC を受信し、エラーは発生しない。
  3. 警告ログ(mqtt_dq_enqueue_timeout)が出力される。
  4. メッセージはバッファワーカーのメールボックスに残り、追いついた時点でディスクキューに書き込まれる。

間接的リスクとして、バッファワーカーが持続的に遅延するとメールボックスが無制限に増加し、メモリ使用量が増大します。これはブリッジが受信メッセージレートに追いつけていない兆候です。

対策:buffer_pool_size を増やして負荷分散、queue.base_dir に高速ストレージを使用、またはマッチするトピックのメッセージレートを減らす。

注:QoS 0 のローカルパブリッシュは非同期でエンキューされ、セッションにバックプレッシャーはかかりません。

ブリッジ再起動時のウィンドウ ​

ブリッジが再起動(設定変更、プラグインリロード、有効/無効切り替え)すると、マッチするメッセージが一時的に捕捉されない短いウィンドウがあります。

対策:トラフィックの少ない時間帯に設定変更を適用してください。

QoS 0 の TCP レベル配信 ​

QoS 0 でリモートブローカーにパブリッシュする場合、コネクターはメッセージがローカルの TCP 送信バッファに到達した時点で配信成功と見なします。
リモートブローカーが TCP スタック受理後にクラッシュし、ブローカー処理前に停止した場合、メッセージは失われる可能性がありますが、コネクターにはエラー通知されません。

これは MQTT QoS 0 の仕様であり、本プラグイン固有の問題ではありません。

運用上の注意 ​

永続化 ​

バッファされたメッセージは以下をまたいで保持されます:

  • EMQX ノード再起動
  • プラグインリロードおよびアップグレード
  • リモートブローカーへの一時的ネットワーク障害

キュー制限 ​

キュー使用量がパーティションごとの queue.max_total_bytes を超えると、最古メッセージが破棄されます。警告ログが出力されます。

プールサイズ設定 ​

各バッファワーカーは BufferIndex rem pool_size によって1つのコネクターに割り当てられます。負荷分散のため、以下を推奨します:

  • buffer_pool_size は pool_size 以上に設定。
  • buffer_pool_size は pool_size の倍数(buffer_pool_size mod pool_size = 0)に設定。

良い例:pool_size = 4, buffer_pool_size = 4(1:1)、pool_size = 4, buffer_pool_size = 8(2:1)。
悪い例:pool_size = 4, buffer_pool_size = 5 — コネクター0が2つのバッファを担当し、他は1つでスループット不均衡。

コネクターが切断されると、割り当てられたバッファワーカーは一時停止し、再接続時に自動再開します。

順序性 ​

安定したブリッジ設定下でトピック単位の順序は保持されます。
buffer_pool_size を変更すると、一時的に順序が乱れる可能性があります(上記参照)。

パブリッシャーのアック挙動(QoS 1/2) ​

ブリッジにマッチするメッセージについて:

  • クライアントへの PUBACK(QoS 1)および PUBREC(QoS 2)は、EMQX がディスクキューエンキュー確認を待つ間(enqueue_timeout_ms)遅延する場合があります。
  • エンキュー待ちがタイムアウトしても、EMQX はクライアントのパブリッシュ処理を完了し、クライアントにエラーは返しません。

ダウンロード ​

各 EMQX リリース用の tarball:

EMQX バージョンプラグインバージョンパッケージ
6.3.00.5.2emqx_bridge_mqtt_dq-0.5.2.tar.gz (sha256)
6.3.10.5.2emqx_bridge_mqtt_dq-0.5.2.tar.gz (sha256)