Skip to content

クラスター設定

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

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

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

MQTT設定

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

一般

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

セッション

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

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セキュアリスナー

image

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

リスナー追加

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

image

レート制限

リスナー追加フォームのリミッターセクションでは、EMQX稼働時のメッセージ受信およびパブリッシュレートを制限できます。例えば:

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

レート制限を設定することで、メッセージデータの過負荷やクライアントからの過剰なリクエスト発生時でもシステムやネットワークの安定性を確保できます。

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

リスナー設定の詳細はEMQX Enterprise設定マニュアルを参照してください。

リスナー管理

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

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

警告

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

ロギング

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

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

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

監査ログページでは、EMQXの監査ログ機能の有効化・無効化および設定が可能です。詳細な設定方法は監査ログを参照してください。

モニタリング

注意

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

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

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

システム

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

システムモニタリング

統合

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

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

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

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

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

image

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

クラスターリンク

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