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
  • EMQX がダッシュボードや API 経由で設定保存後に管理する永続化プラグイン設定ファイル:

    • 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. remotefilter_topicremote_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_*} の置換は文字列型のフィールド(例:serverusernamepassword)のみ対応し、ブール型(enable)、整数型(pool_sizekeepalive_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 の ConfigMap/Secret のように全ノードで一貫してマウントされる仕組みを利用してください。

設定リファレンス

トップレベル

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

ブリッジ(bridges.<name>

フィールドデフォルト説明
enablebooleantrueこのブリッジを有効化または無効化します。
remotestringremotes 配下のリモートブローカー定義名。
proto_verstring"v4"MQTT プロトコルバージョン:v3v4v5 のいずれか。
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_noneverify_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"
  }
}

指定したブリッジが設定に存在しない場合は 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: 実際のワーカー/ストレージ状態(runningdegradedpurged
  • status: 運用者向けのブリッジヘルス状態(okpartialdisconnecteddisablederror

現在のリトライ理由:

  • 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: connecteddisconnectedpartialmissingunknown

設定変更時の挙動

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

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

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

設定変更前の注意

  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回 配信を保証し、持続的障害時は ベストエフォート 配信となります。以下のケースでメッセージが失われる可能性があります。

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

キューパーティションが 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_sizepool_size 以上に設定してください。
  • buffer_pool_sizepool_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)