クラスター設定

EMQXはホット設定機能を提供しており、EMQXノードを再起動することなく、実行時に設定を動的に変更できます。EMQXダッシュボードはホット設定機能を備えた視覚的な設定ページを提供しており、EMQXの設定を簡単に変更できます。

クラスター設定モジュールは以下のサブモジュールを提供します：

• MQTT設定
• クラスター
• ネームスペース
• リスナー
• ロギング
• モニタリング
• クラスターリンク

MQTT設定

MQTT設定ページはMQTTプロトコルに関連する設定機能を提供します。このページでは、以下のようなさまざまなMQTT関連パラメータを設定できます。

一般

一般タブページには、アイドルタイムアウト、最大パケットサイズ、最大クライアントID長、最大トピックレベル数、最大許容QoSレベルなど、MQTTプロトコルの基本的な一般設定項目が含まれています。

セッション

セッションタブページには、MQTTセッション管理に関連する設定項目が含まれており、セッション有効期限間隔（MQTT 5.0以外の接続のみサポート。MQTT 5.0接続はクライアント側で設定が必要）、最大サブスクリプション数、最大フライトウィンドウ、QoS 0メッセージの保存有無などが設定可能です。

Durable Sessions

Durable Sessionsタブページには、MQTT Durable Sessions機能に関連する設定項目が含まれており、メッセージ保持期間、メッセージクエリバッチサイズ、アイドルポーリング間隔、セッションハートビート間隔などが設定できます。

Retainer

Retainerタブページには、保持メッセージに関連するMQTTプロトコルの設定項目があり、保持メッセージの有効化、メッセージの保存タイプと方法、最大保持メッセージ数、保持メッセージのペイロードサイズ、メッセージ有効期限間隔などが含まれます。詳細は保持メッセージの設定をご参照ください。

保持メッセージが無効化されている場合、既存の保持メッセージは削除されません。

システムトピック

システムトピックタブページでは、EMQXの組み込みシステムトピックに関する設定項目を提供します。EMQXは定期的に運用状態、使用統計、リアルタイムクライアントイベントを$SYS/で始まるシステムトピックにパブリッシュします。クライアントがこれらのトピックをサブスクライブすると、関連情報がパブリッシュされます。システムトピックの設定項目には、メッセージパブリッシュ間隔、ハートビート間隔などがあります。

強制シャットダウン

強制シャットダウンタブでは、リソース使用量の閾値に基づく自動シャットダウン動作を設定できます。この機能は、メッセージキューの長さやヒープサイズなどの過剰なリソース消費によるEMQXの不安定化を防止します。

強制シャットダウンタブページで設定可能な項目は以下の通りです：

• 強制シャットダウンを有効にする：このトグルスイッチは強制シャットダウン機能の有効・無効を切り替えます。有効時は指定されたリソース閾値を超えた場合にクライアントプロセスのシャットダウンを自動的にトリガーします。デフォルトで有効です。
• 最大ヒープサイズ：システムで許容する最大ヒープサイズを指定します。このサイズを超えると、システムの安定性を保つために強制シャットダウンが開始されます。デフォルト値は32 MBです。
• 最大メールボックスサイズ：メールボックスメッセージキューの最大長を定義します。この長さを超えると、システム過負荷を防止するために強制シャットダウンがトリガーされます。デフォルト値は1000です。

クラスター

クラスター設定ページでは、EMQXクラスターのノード管理が可能で、ノードの詳細表示、新規ノードの招待、既存ノードの削除が行えます。

注意

EMQX Community Editionを使用している場合、新規ノードの招待はサポートされていません。クラスタリング機能はトライアル期間中のみ利用可能で、トライアル終了後は商用ライセンスが必要です。ライセンスがない場合、機能は無効化されます。

EMQX v6.0.0以降、クラスターの目的や環境を識別するためのクラスター説明を追加できるようになりました。入力欄に意味のある説明を入力し、保存をクリックして適用してください。

保存後、クラスター説明はダッシュボードの上部に表示され、クラスターやクラスター概要などのページで素早く参照できます。編集アイコンをクリックするとクラスターページに戻り、説明を更新可能です。

• ノードの詳細を確認するには、ノード名をクリックしてください。クラスター表示ページにリダイレクトされ、詳細情報が表示されます。

• ノードを招待するには、招待をクリックし、ノード名欄にノードのIPアドレスまたはホスト名を入力して、確認をクリックします。

• ノードを削除するには、削除をクリックします。削除前に確認ダイアログが表示されます。

EMQXはコマンドラインインターフェース（CLI）を使ったクラスターの作成および管理もサポートしています。詳細はクラスターの作成と管理をご参照ください。

ネームスペース

EMQXのネームスペース機能は、単一クラスター内で異なるクライアントグループを論理的に分離します。ネームスペースはネームスペースページで管理できます。ネームスペースの管理および設定方法の詳細はネームスペースをご参照ください。

リスナー

リスナーページはデフォルトでリスナーの一覧を表示します。EMQXは以下の4つの一般的なリスナーを提供しています：

• ポート1883を使用するTCPリスナー
• ポート8883を使用するSSL/TLSセキュア接続リスナー
• ポート8083を使用するWebSocketリスナー
• ポート8084を使用するWebSocketセキュアリスナー

通常は、対応するポートとプロトコルタイプを指定してこれらのデフォルトリスナーを使用します。別のタイプのリスナーを追加するには、右上の**+Add Listener**ボタンをクリックして新しいリスナーを作成します。

リスナーの追加

Add Listenerポップアップパネルにはリスナー追加用のフォームが表示され、基本的な設定項目が含まれています。リスナーを識別するための名前を入力し、リスナータイプ（TCP、SSL、WS、WSS）を選択、リスナーアドレス（IPアドレスとポート番号）を入力します。IPアドレスを指定するとリスナーのアクセス範囲を制限できます。ポート番号のみ指定も可能です。

レート制限

Add ListenerフォームのLimiterセクションでは、EMQX稼働中のメッセージ受信およびパブリッシュレートを制限できます。例えば：

• 最大接続レート（リスナー単位）
• 最大メッセージパブリッシュレート（クライアント単位）
• 最大メッセージパブリッシュトラフィック（クライアント単位）

レート制限を設定することで、メッセージデータの過負荷や過剰なクライアント要求発生時のシステムおよびネットワークの安定性を確保します。

レート制限の詳細設定はレート制限をご参照ください。

リスナー設定の詳細はEMQX Enterprise設定マニュアルをご覧ください。

リスナーの管理

リスナーを追加するとリストに表示されます。リスナー名をクリックすると編集ページに入り、設定の変更や削除が可能です。なお、リスナー名、タイプ、リスナーアドレスは設定画面で変更できません。

編集ページの削除ボタンをクリックするとリスナーを削除できます。削除時にはリスナー名の入力による確認が必要です。リスナーの有効・無効はトグルスイッチで切り替え可能です。リストには各リスナーの接続数も表示されます。

警告

リスナーの変更および削除はリスクの高い操作であり、慎重に行う必要があります。リスナーを更新または削除すると、そのリスナー上のクライアント接続は切断されます。

ロギング

ロギングページには、コンソールログ、ファイルログ、ログスロットリング、監査ログのタブがあります。

EMQXはコンソールログとファイルログの2種類のログ出力をサポートしており、必要に応じていずれかまたは両方を選択できます。対応する設定ページでログハンドラーの有効・無効、ログレベル、ログフォーマットタイプを設定でき、ファイルログの場合はログファイルのパスやログ名も指定可能です。ログの詳細設定方法はダッシュボードによるロギング設定をご参照ください。

ログスロットリングタブページでは、ログスロットリングの時間ウィンドウを設定できます。ログスロットリングの詳細はログレート制限をご覧ください。

監査ログページでは、EMQXの監査ログ機能を有効・無効にし、設定できます。詳細な設定手順は監査ログをご参照ください。

モニタリング

注意

モニタリング機能はEMQX Enterpriseエディションのみで利用可能です。

モニタリングページには以下の2つのタブがあります：

• システム：ユーザーのニーズに応じて、アラーム機能の閾値やチェック間隔などの設定を調整可能です。
• 統合：サードパーティのモニタリングプラットフォームとの統合設定を提供します。

システム

現在のアラームトリガー閾値やアラーム監視チェック間隔のデフォルト値が実際の要件に合わない場合、このページで設定を調整できます。設定はErlang VMとオペレーティングシステムの2モジュールに分かれており、各設定項目のデフォルト値と説明はアラームに記載されています。

統合

このページは主にサードパーティのモニタリングプラットフォームとの統合設定を提供します。現在、EMQXはPrometheus、OpenTelemetry、Datadogとの統合をサポートしています。

Prometheusを使用する場合、このページで設定を素早く有効化し、プッシュデータのアドレスやデータ報告間隔などのパラメータを設定できます。EMQXが提供するAPI /prometheus/stats を直接利用してモニタリングデータを取得可能で、このAPI利用時には認証情報は不要です。詳細はPrometheusをご参照ください。

ほとんどの場合、EMQXのメトリクスデータの監視にPushgatewayは不要です。必要に応じてPushgatewayサービスのアドレスを設定し、モニタリングデータをPushgatewayにプッシュし、PushgatewayがPrometheusサービスにデータを転送する構成も可能です。詳細はPushgatewayの利用タイミングをご覧ください。

ページ下部のヘルプボタンをクリックし、デフォルトまたはPushgateway方式を選択、提供された手順に従って関連サービスのアドレスやAPI情報を設定すると、対応するPrometheus設定ファイルを素早く生成できます。生成した設定ファイルを使ってPrometheusサービスを起動してください。

ユーザーはニーズに応じてGrafanaでモニタリングデータをカスタマイズ・修正可能です。Prometheusサービス起動後、ヘルプページの最後にあるGrafanaテンプレートをダウンロードボタンをクリックすると、弊社提供のデフォルトダッシュボード設定ファイルをダウンロードできます。ファイルをGrafanaにインポートすると、可視化パネルを通じてEMQXのモニタリングデータを閲覧可能です。テンプレートはGrafana公式サイトからも入手可能です。

OpenTelemetryおよびDatadog統合の詳細設定はOpenTelemetryとの統合およびDatadogとの統合をご参照ください。

クラスターリンク

クラスターリンク機能は複数の独立したEMQXクラスターを接続し、地理的に分散したクラスター間でクライアント同士の通信を可能にします。ユーザーはこのページでクラスターリンクを作成および設定できます。作成と設定の詳細はEMQXクラスターリンクをご参照ください。