Durable Sessions の設定と管理
本ドキュメントでは、EMQX における MQTT Durable Sessions 機能の設定、管理、および最適化に関するリファレンスと手順を提供します。セッションおよびストレージの設定も含みます。
設定パラメータ
MQTT Durable Sessions の設定は主に以下の2つのカテゴリに分かれます。
durable_sessions：MQTT クライアントのセッションに関連する設定で、耐久ストレージからのデータ消費方法やデータ保持パラメータを含みます。durable_storage：MQTT メッセージデータを保持する耐久ストレージシステムの設定を管理します。
Durable Sessions の設定
Dashboard で Durable Sessions のパラメータを設定できます。Dashboard の左メニューから Management -> MQTT Settings をクリックし、Durable Session タブを選択してパラメータを設定してください。
| パラメータ | Dashboard UI 表示名 | 説明 |
|---|---|---|
durable_sessions.enable | Enable Durable Sessions | セッションの耐久性を有効化します。この設定は Dashboard、REST API、CLI から変更できず、設定ファイルでのみ指定可能です。変更を反映するには EMQX ノードの再起動が必要です。 |
durable_sessions.message_retention_period | Message Retention Period | Durable Sessions 内の MQTT メッセージの保持期間を定義します。注意：このパラメータはグローバル設定です。 |
durable_sessions.batch_size | Message Query Batch Size | Durable Sessions がストレージから消費するメッセージバッチの最大サイズを制御します。 |
durable_sessions.checkpoint_interval | Session Checkpoint Interval | セッションメタデータを保存する間隔を指定します。 |
以下のパラメータは ゾーンごとに上書き可能です。
durable_sessions.enabledurable_sessions.batch_sizedurable_sessions.checkpoint_interval
Durable Storage の設定
<DS> プレースホルダーは「durable storage」を表します。現時点で <DS> に指定可能なパラメータは message のみです。
コア Durable Storage パラメータ
| パラメータ | 説明 |
|---|---|
durable_storage.n_sites | サイト数を指定します。 |
durable_storage.<DS>.data_dir | EMQX がデータを保存するファイルシステム上のディレクトリです。 |
durable_storage.<DS>.n_shards | シャード数を指定します。 |
durable_storage.<DS>.replication_factor | レプリケーション係数で、各シャードのレプリカ数を決定します。 |
durable_storage.<DS>.transaction | メッセージのバッファリングに関するパラメータを含みます。詳細は バッファリング を参照してください。 |
durable_storage.<DS>.layout | EMQX がディスク上にデータを配置する方法を制御するパラメータを含みます。詳細は ストレージレイアウトの設定 を参照してください。 |
データベースグループの設定
EMQX 6.0.2 以降、Durable Storage はノードレベルのリソースガバナンスをサポートするために データベースグループを導入しました。データベースグループにより、複数の耐久ストレージデータベースを論理データモデルを変更せずに共有リソース制限のもとでまとめて管理できます。
デフォルトでは、各耐久ストレージデータベースは自身の名前を持つデータベースグループに属し、そのグループにはその単一のデータベースのみが含まれ、以前のリリースの動作を維持します。
データベースグループは durable_storage.db_groups ネームスペースで設定します。
| パラメータ | 説明 |
|---|---|
durable_storage.db_groups.<group>.storage_quota | グループの SST ファイルの合計ディスク使用量に対するソフトクォータです。 |
durable_storage.db_groups.<group>.write_buffer_size | グループの RocksDB メモリテーブルの最大合計サイズです。 |
durable_storage.db_groups.<group>.rocksdb_nthreads_high | 高優先度 RocksDB バックグラウンドスレッド数です。 |
durable_storage.db_groups.<group>.rocksdb_nthreads_low | 低優先度 RocksDB バックグラウンドスレッド数です。 |
バッファリング
EMQX は MQTT クライアントからのメッセージをスループット最大化のためバッチ単位で耐久ストレージに書き込みます。
バッチングは durable_storage.<DS>.transaction 設定サブツリーの以下のパラメータで制御します。
| パラメータ | 説明 |
|---|---|
max_pending | 指定したメッセージ数に達したらバッファをフラッシュします。 |
flush_interval | バッファに少なくとも1件のメッセージがあれば、この時間間隔でフラッシュします。 |
idle_flush_interval | 新規メッセージがこの間隔内に到着しなければ早期にバッファをフラッシュします。 |
ストレージレイアウトの設定
ストレージレイアウトは EMQX がディスク上にデータをどのように配置するかを決定します。durable_storage.<DS>.layout.type パラメータを設定することで、新しい 世代で使用されるレイアウトを変更できます。この変更は既存の世代には影響しません。
各レイアウトタイプの設定は durable_storage.<DS>.layout サブツリーに含まれます。現在は wildcard_optimized レイアウトタイプが利用可能です。
wildcard_optimized レイアウトタイプの設定
wildcard_optimized レイアウトは、多数の MQTT トピックに対するワイルドカードサブスクライブのマッチングを最適化することを目的としています。
トピック構造に関する知識を時間経過で自律的に蓄積し、軽量な機械学習アルゴリズムを活用してクライアントがサブスクライブしそうなワイルドカードトピックフィルターを予測します。
その後、これらのトピックを統合されたストリームに整理し、一度のスイープで効率的に消費できるようにします。
| パラメータ | 説明 |
|---|---|
bytes_per_topic_level | トピックレベルハッシュのサイズを決定します。 |
topic_index_bytes | ストリーム識別子のバイトサイズを指定します。 |
CLI コマンド
耐久ストレージの管理に利用可能な CLI コマンドは以下の通りです。
emqx ctl ds info
耐久ストレージの状態概要を表示します。
例：
$ emqx ctl ds info
THIS SITE:
D8894F95DC86DFDB
SITES:
.------------------.-------------------.----------.
: Site : Node : Status :
:------------------:-------------------:----------:
: 5C6028D6CE9459C7 : 'emqx@n2.local' : up :
: D8894F95DC86DFDB : 'emqx@n1.local' : up :
: F4E92DEA197C8EBC : 'emqx@n3.local' : (x) down :
`------------------`-------------------`----------`
SHARDS:
.-------------.------------------.-------------.
: DB/Shard : Replicas : Transitions :
:-------------:------------------:-------------:
:-messages/0--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/1--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/10-:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/11-:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/12-:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/2--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/3--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/4--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/5--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/6--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/7--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/8--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
:-messages/9--:------------------:-------------:
: : 5C6028D6CE9459C7 : :
`-------------`------------------`-------------`このコマンド出力には以下が含まれます。
THIS SITE：ローカル EMQX ノードが管理するサイトの ID。SITES：既知の全サイト一覧。EMQX ノード名とステータスを含みます。SHARDS：耐久ストレージのシャード一覧と、そのレプリカが配置されているサイト ID。
emqx ctl ds set-replicas all <site1> <site2> ...
クラスタ内の耐久ストレージのレプリカを保持するサイトのリストを設定します。
実行すると、シャードをサイト間で公平に割り当てる操作計画を作成し、バックグラウンドで実行を継続します。
重要なお知らせ
耐久ストレージのレプリカリストの更新は、サイト間で大量のデータコピーを伴うためコストがかかる場合があります。
例：
$ emqx ctl ds set-replicas all 5C6028D6CE9459C7 D8894F95DC86DFDB F4E92DEA197C8EBC
okこのコマンド実行後、ds info の出力は以下のようになることがあります。
$ emqx ctl ds info
THIS SITE:
D8894F95DC86DFDB
SITES:
.------------------.-------------------.----------.
: Site : Node : Status :
:------------------:-------------------:----------:
: 5C6028D6CE9459C7 : 'emqx@n2.local' : up :
: D8894F95DC86DFDB : 'emqx@n1.local' : up :
: F4E92DEA197C8EBC : 'emqx@n3.local' : up :
`------------------`-------------------`----------`
SHARDS:
.-------------.------------------.--------------------.
: DB/Shard : Replicas : Transitions :
:-------------:------------------:--------------------:
:-messages/0--:------------------:--------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : D8894F95DC86DFDB : :
:-messages/1--:------------------:--------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : D8894F95DC86DFDB : :
:-messages/10-:------------------:--------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : : + D8894F95DC86DFDB :
:-messages/11-:------------------:-------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : D8894F95DC86DFDB : :
:-messages/2--:------------------:--------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : D8894F95DC86DFDB : :
:-messages/3--:------------------:--------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : : + D8894F95DC86DFDB :
:-messages/4--:------------------:-------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : D8894F95DC86DFDB : :
:-messages/5--:------------------:--------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : D8894F95DC86DFDB : :
:-messages/6--:------------------:--------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : : + D8894F95DC86DFDB :
:-messages/7--:------------------:-------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : D8894F95DC86DFDB : :
:-messages/8--:------------------:--------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : D8894F95DC86DFDB : :
:-messages/9--:------------------:--------------------:
: : 5C6028D6CE9459C7 : + F4E92DEA197C8EBC :
: : : + D8894F95DC86DFDB :
`-------------`------------------`--------------------`新たに追加された REPLICA TRANSITIONS セクションは保留中の操作を示します。すべての操作が完了すると、このリストは空になります。
emqx ctl ds join all <site> / emqx ctl ds leave all <site>
これらのコマンドは、耐久ストレージのレプリカサイトリストにサイトを追加または削除します。set_replicas コマンドに似ていますが、1サイトずつ更新します。
例：
$ emqx ctl ds join all B2A7DBB2413CD6EE
ok詳細は Add Sites および Remove Sites を参照してください。
REST API
組み込み Durable Sessions の管理および監視に利用可能な REST API エンドポイントは以下の通りです。
/ds/sites：既知のサイト一覧を取得します。/ds/sites/:site：サイトの情報（ステータス、現在管理している EMQX ノード名など）を取得します。/ds/storages：耐久ストレージ一覧を取得します。/ds/storages/:ds：耐久ストレージおよびそのシャードの情報を取得します。/ds/storages/:ds/replicas：耐久ストレージのレプリカを保持するサイトの一覧取得および更新を行います。/ds/storages/:ds/replicas/:site：特定サイトの耐久ストレージレプリカを追加または削除します。
詳細は EMQX OpenAPI スキーマを参照してください。
メトリクス
Durable Sessions に関連する Prometheus メトリクスは以下の通りです。
emqx_ds_egress_batches
メッセージバッチが耐久ストレージに正常に書き込まれるたびにインクリメントされます。
emqx_ds_egress_messages
耐久ストレージに正常に書き込まれたメッセージ数をカウントします。
emqx_ds_egress_bytes
耐久ストレージに正常に書き込まれたペイロードデータの合計バイト数をカウントします。
注意：このメトリクスはメッセージペイロードのみを対象としているため、実際の書き込みデータ量はこれより多い場合があります。
emqx_ds_egress_batches_failed
耐久ストレージへの書き込みが何らかの理由で失敗した場合にインクリメントされます。
emqx_ds_egress_flush_time
耐久ストレージへのバッチ書き込みに要した時間（μ秒）のローリング平均です。レプリケーション速度の重要な指標です。
emqx_ds_store_batch_time
ローカル RocksDB ストレージへのバッチ書き込みに要した時間（μ秒）のローリング平均です。emqx_ds_egress_flush_time と異なり、ネットワークレプリケーションコストを除外しているため、ディスク I/O の効率を示す重要な指標です。
emqx_ds_builtin_next_time
耐久ストレージからメッセージバッチを消費するのに要した時間（μ秒）のローリング平均です。
emqx_ds_storage_bitfield_lts_counter_seek および emqx_ds_storage_bitfield_lts_counter_next
これらのカウンターは「wildcard optimized」ストレージレイアウト固有のもので、ローカルストレージからのデータ消費効率を測定します。seek 操作は一般的に遅いため、emqx_ds_storage_bitfield_lts_counter_next の増加率が seek より速いことが望ましいです。
durable_storage.messages.layout.epoch_bits パラメータを増やすことで、この比率の改善に寄与します。
emqx_ds_raft_db_shards_num
DB が分割されているシャード数を示します。
emqx_ds_raft_db_sites_num
DS DB がレプリケートされている現在および割り当てられたサイト数を追跡するゲージです。
通常、現在のサイト数は割り当てられたサイト数と等しいはずです。長期間異なる場合はレプリカ転送に問題がある可能性があります。
emqx_ds_raft_shard_replication_factor
DS DB シャードのレプリカセット内のレプリカ数を追跡します。
この数が設定されたレプリケーション係数を下回る場合、耐久性が危険にさらされます。より多くのサイトにレプリカを再配置することを検討してください。
emqx_ds_raft_db_shards_online_num
このノードでアクティブに管理されている DS DB シャード数を追跡します。
この数は現在このノードに割り当てられているシャード数と一致するはずです。異なる場合は可用性に問題がある可能性があるため、ログを確認してください。
emqx_ds_raft_shard_transition_queue_len
DS DB シャードの保留中のレプリカセット遷移数を追跡します。
この数が長期間ゼロでない場合、レプリカ転送に問題があります。
emqx_ds_raft_shard_transitions
DB シャードのレプリカセット遷移の開始・完了・スキップ・クラッシュ数をカウントします。
クラッシュした遷移は常にゼロであるべきです。そうでない場合はログを確認してください。
emqx_ds_raft_shard_transition_errors
DB シャードのレプリカセット遷移のオーケストレーション中に発生した一時的なエラー数をカウントします。
このカウンターが増加する場合、レプリカ転送に問題がある可能性があるためログを確認してください。
emqx_ds_raft_snapshot_reads
シャードがスナップショットレプリケーションのソースとなった際のスナップショット読み込みの開始・完了数をカウントします。
emqx_ds_raft_snapshot_read_errors
スナップショット読み込み中に発生し、スナップショットレプリケーションが中断されたエラー数をカウントします。
エラーは発生しないことが期待されます。原因はログで確認してください。
emqx_ds_raft_snapshot_read_chunks
スナップショット転送のソース DS DB シャードで読み込まれ、その後受信側に転送された個別チャンク数をカウントします。
emqx_ds_raft_snapshot_read_chunk_bytes
ソース DS DB シャードでチャンクとして読み込まれたバイト数をカウントします。
emqx_ds_raft_snapshot_writes
シャードがスナップショットレプリケーションの受信側となった際のスナップショット書き込みの開始・完了数をカウントします。
emqx_ds_raft_snapshot_write_errors
受信側 DS DB シャードへのスナップショット書き込み中に発生し、レプリケーションが中断されたエラー数をカウントします。
こちらも増加は想定されません。詳細はログを確認してください。
emqx_ds_raft_snapshot_write_chunks
ソース DS DB シャードから受信し、受信側に書き込まれた個別チャンク数をカウントします。
emqx_ds_raft_snapshot_write_chunk_bytes
受信側 DS DB シャードでチャンクとして書き込まれたバイト数をカウントします。
emqx_ds_raft_current_timestamp_us
シャードサーバーが現在レプリケートしている最新の操作タイムスタンプ（マイクロ秒単位）を追跡します。
通常、各レプリカは同じタイムスタンプを持つべきです。異なる場合はレプリケーションに問題があります。
emqx_ds_raft_rasrv_state_changes
Raft サーバーが候補者／フォロワー／リーダーに変わった回数をカウントします。
頻繁な状態変化は不安定の兆候です。ログを確認してください。
データベースグループのメトリクス
以下の Prometheus メトリクスは耐久ストレージのデータベースグループに対するノードレベルの可視性を提供します。
emqx_ds_disk_usage
グループ内のすべてのデータベースが使用する SST ファイルの合計サイズ。
emqx_ds_write_buffer_memory_usage
グループが使用する RocksDB メモリテーブルの合計メモリ使用量。
emqx_ds_total_trash_size
削除予定の不要な SST ファイルのディスク使用量。
これらのメトリクスはノードごとおよびデータベースグループごとに報告されます。クラスタ環境では、運用者が外部で集約し、クラスタ全体の容量を評価できます。