EMQX Enterprise

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ
お問い合わせ

MQTT 設定 ​

MQTT は、モノのインターネット（IoT）向けの標準的なメッセージングプロトコルです。非常に軽量なパブリッシュ／サブスクライブ型のメッセージトランスポートとして設計されており、リモートデバイスを小さなコードフットプリントかつ最小限のネットワーク帯域で接続するのに最適です。

EMQX は 100% MQTT 5.0 および 3.x に準拠しています。本セクションでは、基本的な MQTT 設定項目について紹介します。基本的な MQTT 設定、サブスクリプション設定、セッション設定、強制シャットダウン設定、および強制ガベージコレクション設定などを扱います。

基本的な MQTT 設定 ​

このセクションでは、パケットサイズ、クライアントIDの長さ、トピックレベル数、QoS（サービス品質）、トピックエイリアス、保持設定など、MQTT プロトコルの動作を決定する設定項目を紹介します。

TIP

対応する設定項目は EMQX ダッシュボードの Management -> MQTT Settings -> General でも確認できます。ダッシュボードで設定を行うと、設定ファイル内の同じ項目より優先されます。
設定ファイルから MQTT を設定する場合は、emqx.conf ではなく base.hocon の使用を推奨します。
emqx.conf に設定すると、ダッシュボードからの変更は一時的なものとなり、EMQX 再起動時に失われるためです。

設定例:

bash
mqtt {
  max_packet_size = 1MB
  max_clientid_len = 65535
  max_topic_levels = 128
  max_qos_allowed = 2
  max_topic_alias = 65535
  retain_available = true
}

各項目の説明は以下の通りです。

設定項目ダッシュボード表示名説明デフォルト値設定可能値
max_packet_sizeMax Packet SizeMQTT パケットは MQTT クライアントと EMQX 間でメッセージを送信するために使われます。

許可される最大 MQTT パケットサイズを設定します。		1MB
max_clientid_lenMax Client ID LengthMQTT クライアントIDの最大長を設定します。

過度に長いクライアントIDの使用を防ぐのに役立ちます。		6553523 - 65535
max_topic_levelsMax Topic LevelsMQTT トピックはメッセージの整理・分類に使用されます。

トピックの最大レベル数を設定します。		1281 - 35
max_qos_allowedMax QoSQoS（サービス品質）レベルはメッセージの信頼性と配信保証のレベルを決定します。

MQTT メッセージに許可される最大 QoS レベルを設定します。
max_topic_aliasMax Topic Aliasトピックエイリアスは、完全なトピック名の代わりに短いエイリアスを使用して MQTT パケットのサイズを削減する方法です。

MQTT セッションで使用可能なトピックエイリアスの最大数を設定します。		655351 - 65535
retain_availableRetain Available保持メッセージは、トピックに最後にパブリッシュされたメッセージを保存し、新しいサブスクライバーが最新のメッセージを受け取れるようにします。

MQTT の保持メッセージ機能を有効にするかどうかを設定します。		truetrue, false

サブスクリプション設定 ​

EMQX におけるサブスクリプションとは、クライアントが EMQX のトピックにサブスクライブするプロセスを指します。クライアントがトピックにサブスクライブすると、そのトピックにパブリッシュされたメッセージを受信したいことを示します。

このセクションでは、共有サブスクリプション、ワイルドカードサブスクリプション、排他サブスクリプションの設定方法を紹介します。

TIP

対応する設定項目は EMQX ダッシュボードの Management -> MQTT Settings -> General でも確認できます。ダッシュボードで設定を行うと、設定ファイル内の同じ項目より優先されます。
設定ファイルから MQTT を設定する場合は、emqx.conf ではなく base.hocon の使用を推奨します。
emqx.conf に設定すると、ダッシュボードからの変更は一時的なものとなり、EMQX 再起動時に失われるためです。

設定例:

bash
mqtt {
	wildcard_subscription = true
  exclusive_subscription = false
  shared_subscription = true
  shared_subscription_strategy  =  round_robin
}

各項目の説明は以下の通りです。

設定項目ダッシュボード表示名説明デフォルト値設定可能値
wildcard_subscriptionWildcard Subscription Availableワイルドカードサブスクリプションは、+ や # といったワイルドカードを使い、複数のトピックに一括でサブスクライブできます。

ワイルドカードサブスクリプションを有効にするかどうかを設定します。		truetrue, false
exclusive_subscriptionExclusive Subscription排他サブスクリプションは、同時に1つの MQTT クライアントのみがトピックにサブスクライブできます。

排他サブスクリプションを有効にするかどうかを設定します。		truetrue, false
shared_subscriptionShared Subscription Available共有サブスクリプションは複数の MQTT クライアントがトピックのサブスクリプションを共有できます。

共有サブスクリプションを有効にするかどうかを設定します。		truetrue, false
shared_subscription_strategy共有サブスクリプションを持つ MQTT クライアント間でメッセージを配信する戦略を定義します。

shared_subscription が true の場合にのみ必要です。		round_robin- random（ランダムにサブスクライバーへ配信）

- round_robin（ラウンドロビン方式でサブスクライバーを選択）

- sticky（最後に選択されたサブスクライバーに常に配信、切断時まで維持）

- hash（clientIds のハッシュでサブスクライバーを選択）

遅延パブリッシュ設定 ​

遅延パブリッシュ機能は、クライアントがメッセージのパブリッシュを指定した時間だけ遅延させることを可能にします。この機能は、特定の時間にメッセージをパブリッシュしたい場合や、特定の条件が満たされたときにメッセージを送信したい場合に有用です。

このセクションでは、遅延パブリッシュの有効化方法と、許可される遅延メッセージの最大数の設定方法を紹介します。

設定例:

bash
delay {
  delayed_publish_enabled = true
  max_delayed_messages = 0
}

各項目の説明は以下の通りです。

  • delayed_publish_enabled は EMQX で遅延パブリッシュ機能を有効にするかどうかを設定します。デフォルト値は true、設定可能値は true または false です。
  • max_delayed_messages は許可される遅延メッセージの最大数を設定します。デフォルト値は 0 です。

キープアライブ設定 ​

キープアライブは 2 バイトの整数で、秒単位の時間間隔を表します。これは、MQTT クライアントと EMQX 間の接続がデータ送信がなくてもアクティブな状態を維持するための仕組みです。MQTT クライアントが EMQX に接続を確立するとき、CONNECT パケットのヘッダーに非ゼロのキープアライブ値を設定することで、双方の間でキープアライブ機構を有効にできます。キープアライブの動作詳細については、MQTT キープアライブパラメータとは？ を参照してください。

MQTT 5.0 プロトコルによれば、キープアライブが有効なクライアントに対し、サーバーがクライアントからキープアライブ時間の1.5倍以内に MQTT コントロールパケットを受信しなければ、ネットワーク接続を切断しなければなりません。
そのため、EMQX ではクライアントのキープアライブタイムアウト状態を定期的にチェックするための設定 keepalive_multiplier を導入しています。デフォルト値は 1.5 です。

bash
keepalive_multiplier = 1.5

タイムアウトの計算式は以下の通りです。

Keep Alive×keepalive_multiplier

動的キープアライブ調整 ​

車載ネットワーク（T-Box）やモバイル IoT のようなシナリオでは、MQTT クライアントは「アクティブ状態」（頻繁な通信）と「スリープ状態」（低消費電力の待機）を切り替える必要があります。単一の固定キープアライブ値では両方のニーズを同時に満たせません。

  • 短いキープアライブはアクティブ時の切断検知を高速化しますが、駐車中や待機時には過剰なハートビート通信とバッテリー消費を招きます。
  • 長いキープアライブはスリープ時の通信量を減らしますが、アクティブ時の切断検知が遅れます。

EMQX は $SETOPTS/ 系のシステムトピックを通じて、クライアントごとに動的なキープアライブ調整をサポートしています。クライアントはこれらのトピックにパブリッシュすることで、自身のブローカー側キープアライブ許容値を更新できます。また、権限を持つバックエンドサービスが複数クライアントを一括更新することも可能です。MQTT 接続の切断や再交渉は不要です。調整はアクティブなセッションのメモリ上でのみ適用され、永続化されません。

単一クライアント更新：$SETOPTS/mqtt/keepalive ​

クライアントはこのトピックにパブリッシュして自身のブローカー側キープアライブタイムアウトを更新します。EMQX は自動的にパブリッシュ元のセッションからクライアントIDを取得します。

ペイロード: 秒単位の非負整数を文字列で指定します。

text
300

有効範囲: 0～65535 秒。0 はそのセッションのキープアライブチェックを無効化します。65535 を超える値は 65535 に制限されます。クライアントのゾーンに mqtt.server_keepalive が設定されている場合、実効値は両者の最小値となります。

利用例: 車両が駐車状態に入ると、T-Box クライアントが $SETOPTS/mqtt/keepalive に 300 をパブリッシュします。EMQX はブローカー側のキープアライブ許容値を 300 秒に延長（デフォルトの 1.5× 乗数で実効アイドルタイムアウトは 450 秒）し、リモートコマンド配信のために MQTT 接続を維持します。なお、これはブローカー側のタイムアウトのみ調整し、クライアントの実際の PINGREQ 間隔は変わりません。ハートビート通信量を減らすには、クライアント側もキープアライブ間隔を延長する必要があります。

バッチ更新：$SETOPTS/mqtt/keepalive-bulk ​

バックエンドサービスはこのトピックにパブリッシュして複数クライアントのキープアライブを一括更新できます。

ペイロード: JSON 配列。各要素は以下を含みます。

フィールド型必須説明
clientid文字列はい対象の MQTT クライアントID
keepalive整数はい新しいキープアライブ間隔（秒、0～65535）
json
[
  { "clientid": "tbox-001", "keepalive": 300 },
  { "clientid": "tbox-002", "keepalive": 60 }
]

バッチ更新は非同期で処理され、クラスター対応です。EMQX は対象クライアントが存在するノードを特定し、ノード間 RPC で更新を適用します。内部キューに 10 件以上のバッチ要求が溜まると、追加要求は破棄され警告ログが記録されます。

アクセス制御 ​

2 つのトピックは細かい ACL をサポートするために意図的に分離されています。

  • 認証済みクライアントに $SETOPTS/mqtt/keepalive へのパブリッシュを許可し、各デバイスが自身のキープアライブを調整可能にします。
  • $SETOPTS/mqtt/keepalive-bulk は信頼できるバックエンドサービスのみに制限します。

TIP

信頼できないクライアントに $SETOPTS/mqtt/keepalive へのパブリッシュ権限を与えないでください。キープアライブを 0 に設定すると、そのセッションのキープアライブチェックが完全に無効化され、過度に大きな値は切断されない接続を長時間維持し、ブローカーリソースを消費する恐れがあります。

これらのトピックにパブリッシュされたメッセージは、EMQX によってインターセプトされ消費され、サブスクライバーには配信されません。

セッション設定 ​

MQTT におけるセッションとは、クライアントとブローカー間の接続を指します。EMQX では、クライアントが EMQX に接続するとセッションが確立され、トピックのサブスクライブやメッセージ受信、EMQX へのメッセージパブリッシュが可能になります。

このセクションでは、セッションの設定方法を紹介します。

設定例:

bash
mqtt {
    max_subscriptions = infinity
    upgrade_qos = false
    max_inflight = 32
    retry_interval = 30s
    max_awaiting_rel = 100
    await_rel_timeout = 300s
    session_expiry_interval = 2h
    max_mqueue_len = 1000
    mqueue_priorities = disabled
    mqueue_default_priority = lowest
    mqueue_store_qos0 = true
    force_shutdown {
      max_mailbox_size = 1000
      max_heap_size = 32MB
    }
    force_gc {
      count  =  16000
      bytes  =  16MB
    }
  }

各項目の説明は以下の通りです。

設定項目ダッシュボード表示名説明デフォルト値設定可能値
max_subscriptionsMax Subscriptionsクライアントが持てる最大サブスクリプション数を設定します。infinity1 - infinity
upgrade_qosUpgrade QoSメッセージパブリッシュ後に QoS（サービス品質）レベルをアップグレードできるかどうかを設定します。false（無効）true, false
max_inflightMax InflightQoS 1 および QoS 2 メッセージの送信済みだが未アックの最大数を設定します。321 - 65535
retry_intervalRetry IntervalQoS 1 または QoS 2 メッセージの再送間隔を設定します。30s
単位: 秒		--
max_awaiting_relMax Awaiting PUBREL各セッションで PUBREL 受信またはタイムアウトまで保留できる QoS 2 メッセージの最大数を設定します。
この制限を超えると、新しい QoS 2 PUBLISH はエラーコード 147(0x93) で拒否されます。
MQTT における PUBREL は QoS 2 メッセージフローの制御パケットです。		1001 - infinity
await_rel_timeoutMax Awaiting PUBREL TIMEOUTQoS 2 メッセージの PUBREL 受信までの待機時間を設定します。タイムアウト時にパケットIDを解放し、警告ログを出力します。
注：EMQX は PUBREL 受信の有無にかかわらず QoS 2 メッセージの転送を行います。		300s
単位: 秒		--
session_expiry_intervalSession Expiry Intervalセッションがアイドル状態で自動的に閉じられるまでの時間を設定します。
注：MQTT 5.0 非対応クライアント向け。		2h
max_mqueue_lenMax Message Queue Length永続クライアントが切断された場合やインフライトウィンドウが満杯のときの最大キュー長を設定します。10000 - infinity
mqueue_prioritiesTopic Prioritiesトピック優先度を設定します。ここでの設定は mqueue_default_priority の設定を上書きします。disabled
セッションは mqueue_default_priority の優先度を使用		disabled
または
1 - 255
mqueue_default_priorityDefault Topic Prioritiesデフォルトのトピック優先度を設定します。lowesthighest， lowest
mqueue_store_qos0Store QoS 0 Message接続が切断されてもセッションが維持されている場合に、QoS 0 メッセージをメッセージキューに保存するかどうかを設定します。truetrue, false
force_shutdownEnable Force Shutdown強制シャットダウン機能を有効にするかどうかを設定します。メールボックスキュー長（max_mailbox_size）またはヒープサイズ（max_heap_size）が指定値に達するとクライアント接続を強制終了します。truetrue, false
force_shutdown.max_mailbox_sizeMax Mailbox Size強制シャットダウンをトリガーする最大メールボックスキュー長を設定します。10001 - infinity
force_shutdown.max_heap_sizeMax Heap Size強制シャットダウンをトリガーする最大ヒープサイズを設定します。32MB--
force_gc--指定されたメッセージ数（count）または受信バイト数（bytes）に達した場合に強制ガベージコレクションを有効にするかどうかを設定します。truetrue, false
force_gc.count--強制ガベージコレクションをトリガーする受信メッセージ数を設定します。160000 - infinity
force_gc.bytes--強制ガベージコレクションをトリガーする受信バイト数を設定します。16MB
単位: MB		--

TIP

ダッシュボードで MQTT 設定を行うには、ダッシュボード左のナビゲーションメニューから Management -> MQTT Settings をクリックしてください。ダッシュボードで設定を行うと、設定ファイル内の同じ項目より優先されます。
設定ファイルから MQTT を設定する場合は、emqx.conf ではなく base.hocon の使用を推奨します。
emqx.conf に設定すると、ダッシュボードからの変更は一時的なものとなり、EMQX 再起動時に失われるためです。

TIP

EMQX はカスタマイズニーズに応じたより多くの設定項目を提供しています。詳細は EMQX Enterprise Configuration Manual for Enterprise をご参照ください。