EMQX Cloud V4 から V6 へのアップグレードガイド
EMQX Dedicated デプロイメントをご利用の方は、EMQX を V4 から V6 へアップグレードできます。現在の EMQX バージョンを確認するには、デプロイメント詳細ページを開き、設定 をクリックしてデプロイメント情報を表示してください。
V4 の安定性と効率性を基盤に、EMQX V6 は認証と認可、モニタリング指標、保持メッセージ、データ統合に関する包括的な強化を提供します。また、ネームスペース、ログトレース、イベント履歴、BigQuery データ統合、Snowflake ストリーミングデータ統合などの機能が新たに導入または強化されています。詳細は 新機能 をご覧ください。
利用可能範囲
EMQX V6 は Dedicated および Dedicated Flex ブローカーのデプロイメントでのみ利用可能です。サーバレスデプロイメントでは EMQX バージョンの選択はサポートされていません。
アップグレード前の準備
- アップグレードのスケジュール調整のため、少なくとも3日前に お問い合わせ ください。アップグレードの注意点やメンテナンス時間についてご相談します。
- 本ガイドを全文お読みいただき、特に互換性のない変更点を理解してください。ご不明点があればサポートチケットを通じてお問い合わせください。
- 当社の SRE チームがデプロイメントの包括的な評価を行います。特別な設定や影響がある場合は特記事項として記載し、アップグレードの継続可否をご判断いただけます。
- ビジネスシステムが V4 の HTTP API を呼び出している場合や、外部認証・外部認可、複雑なデータ統合を利用している場合は、アップグレード前に V6 環境での互換性テストを必ず実施してください。
データ移行および保持される設定
アップグレード時に以下の設定およびデータは保持されます。
- MQTT エンドポイントおよびポート
- すべての認証および認可エントリ
- データ統合設定(リソース、ルール、アクションを含む。ただし互換性に関する注意事項あり)
- TLS 証明書情報
- 保持メッセージ
- ネットワーク管理設定(NAT ゲートウェイ、内部エンドポイント、PrivateLink、VPC ピアリングを含む)
互換性のない変更点
- 機能削除:デバイスシャドウサービスは V6 でサポートされません。
- 特別設定の変更:サポートチケット経由で以前に依頼された特別設定(追加ポートや ACL 許可リストなど)は影響を受ける可能性があります。SRE チームがアップグレード前に具体的な影響を説明します。
- HTTP API の変更:
API プレフィックスが
/apiから/api/v5に変更されます。V4 の API キーおよびシークレットキーは移行できません。アップグレード後に新しい認証情報を作成し、ビジネスシステムの API エンドポイントおよび認証情報を更新してください。
メッセージパブリッシュ、クライアント照会、ノード管理など複数の API パスが変更されました。
パス変更に加え、一部 API ではリクエストボディ、レスポンス構造、HTTP ステータスコード、エラーコード、フィールド名、フィールド型、時間フォーマットに互換性のない変更があります。
これらの変更は既存のビジネスシステムの API パースロジックに影響を与える可能性があるため、アップグレード前に互換性テストを完了してください。
詳細は以下のドキュメントを比較してください:
- 外部認証の変更:設定フィールドおよびクエリ・レスポンス要件が変更されました。外部認証と認可 のドキュメントに従って設定を更新してください。
- データ統合の互換性:
- ルールに紐づかないリソースは保持されません。アップグレード前にこれらのリソースが必要か確認してください。
- ルールに設定されたフォールバックアクションは保持されません。V6 のデータ統合アーキテクチャではフォールバックアクションはサポートされていません。
- リソースやアクションに紐づかない空のアクションはアップグレード時に自動削除されます。
WHEREを使用した一部のルール SQL 文は新バージョンと互換性がなく、手動で更新が必要な場合があります。例えば、フィールドの存在判定は V4 では<> "undefined"を使いますが、新バージョンではis_nullを使用します。
アップグレードの影響
- アップグレードには 15~25 分程度かかり、そのうち約 5~15 分 のサービス停止時間が発生します。
- アップグレードのために 2時間 のメンテナンスウィンドウが設けられます。この期間中のアップグレードや互換性問題によるサービス停止は SLA の可用性計算から除外されます。
- アップグレード中にクライアント接続は1~2回切断されます。クライアント側で自動再接続が有効になっていることを確認してください。アップグレードによる切断は MQTT のラストウィルメッセージをトリガーしません。
clean session = falseで作成されたセッションは保持されません。クライアントは再接続後に新しいセッションを作成します。
アップグレード後の手順
アップグレード後の検証
- アップグレード後、EMQX Cloud の SRE チームがデプロイメントのログとメトリクスを確認します。
- 以下を中心に包括的なビジネス検証を実施してください:
- HTTP API 呼び出しが新しいパスおよび新規作成された API キーとシークレットキーを使用しているか
- HTTP API のレスポンス構造がビジネスシステムのパースロジックと互換性があるか
- 組み込みおよび外部の認証・認可が正常に動作しているか
- データ統合のコネクター、ルール、ソース、シンクが正常に動作しているか
- クライアント接続、サブスクリプション、メッセージのパブリッシュおよび配信が正常に動作しているか
- TLS 接続およびカスタム証明書が正常に動作しているか
- 問題を発見した場合は、速やかに当社までご連絡ください。
ロールバック
- アップグレード確定前に 24 時間のロールバック期間があり、この期間中は V6 から V4 へロールバック可能です。
- ロールバックには 15~25 分程度かかり、そのうち約 3~5 分のサービス停止が発生します。
- ロールバック中もクライアント接続は1~2回切断されます。
clean session = falseで作成されたセッションは保持されません。
V6 コア機能の詳細な変更点
このセクションでは、V4 から V6 へのアップグレードで導入される機能強化、アーキテクチャ改善、および対応するコンソールの変更について説明します。
強化された証明書管理
V6 デプロイメントでは、デフォルトで一方向 TLS 証明書(ワイルドカード証明書)がデプロイメントエンドポイントドメインに対して付与されます。ポート 8883 および 8084 で TLS 接続が可能です。カスタム TLS 証明書を設定するとこれらのポートのデフォルト証明書が置き換わります。カスタム証明書を削除すると、デフォルトのデプロイメントエンドポイント証明書が復元されます。
HTTP API の変更
- API エンドポイントが
https://xxx/apiからhttps://xxx/api/v5に変更されます。 - V4 の API キーおよびシークレットキーは移行できず、アップグレード後に再作成が必要です。
- API パスの変更に加え、一部 API ではリクエストボディ、レスポンス構造、HTTP ステータスコード、エラーコード、フィールド名、フィールド型、時間フォーマットに互換性のない変更があります。
既存の V4 API レスポンス構造に依存するビジネスシステムがある場合は、アップグレード前に互換性テストを完了してください。詳細は 最新 API ドキュメント の認証セクションをご参照ください。
アクセス制御の改善
- Authentication & ACL 機能は Access Control に名称変更されました。
- 組み込みの認証・認可データと外部認証・認可設定は移行されます。
- 外部認証と外部認可はそれぞれ External Authentication と External Authorization に分離され、エントリポイントはそれぞれ Client Authentication の下の External Authentication、および Client Authorization の下の External Authorization に移動しました。
- 認証チェーン内の認証方式の優先順位を手動で調整可能です。
- クライアント認可ルールはクライアントID、ユーザー名、全ユーザーの3レベルで設定可能です。クライアントまたはユーザー名の認可情報は対応するタブで表示されます。
モニタリングの再設計
- 旧モニタリングページのリアルタイムメトリクスはメトリクスページに移動し、リアルタイムメトリクスまたは時系列データを閲覧可能です。
- クライアントおよびサブスクリプション管理はモニタリングの下の別ページである Clients と Subscriptions に分割されました。
- 新たに保持メッセージ管理ページが追加され、保持メッセージの照会および削除が可能です。
データ統合アーキテクチャのアップグレード
ルール、ソース、シンクのアーキテクチャ
互換性に関する注意
V6 へのアップグレード後、以下のルール互換性に関する変更にご注意ください:
- 空のアクションはアップグレード時に自動削除されます。
WHEREを使用した一部のルール SQL 文は V6 と互換性がなく、手動で更新が必要な場合があります。例として、フィールドの存在判定は V4 では<> "undefined"を使いますが、V6 ではis_nullを使用します。
- ルールとアクションは論理的に分離され、より柔軟な設定が可能です。
- シンクは外部サービスへのデータ送信を担当します。
- ソースは外部サービスから EMQX へのデータ取り込みを行い、V4 の MQTT Subscribe プラグインに類似しています。
- フォールバックアクションはサポートされなくなりました。
データ統合サポートの拡充
- 新たなデータ転送統合として Elasticsearch、Azure Event Hubs、Amazon Kinesis、SysKeeper Forwarder が追加されました。
- 新たなデータ永続化統合として Apache IoTDB、GreptimeDB、Amazon S3 が追加されました。
- Kafka Consumer や MQTT Source などの統合を通じて、メッセージキューや MQTT サービスからのデータ取り込みが可能です。
- V6 では BigQuery および Snowflake ストリーミングデータ統合も導入されています(以下の V6 固有機能参照)。
Smart Data Hub のアップグレード
Smart Data Hub はインテリジェントなデータ処理の統合ソリューションです。スキーマ管理、データ検証、リアルタイムデータ変換を行い、MQTT データストリーム処理を簡素化し、データ標準化とビジネス統合を促進します。
V4 デプロイメントでスキーマレジストリが設定されている場合、アップグレード後に Smart Data Hub が自動的に有効化されます。
V6 固有機能
注意
以下の機能は EMQX V6 をサポートする Dedicated および Dedicated Flex デプロイメントでのみ利用可能です。実際の利用可否は V6 のマイナーバージョン、リージョン、およびコンソールに表示されるオプションによります。
| V6 固有機能 | 実用的価値 |
|---|---|
| ネームスペース | マルチテナント環境におけるリソースと権限の分離を提供します。ルール、コネクター、アクションなどのリソースをテナント、チーム、事業部単位で整理でき、テナント間の影響を減らし共有クラスターの運用を簡素化します。 |
| ログトレース | 特定のクライアント、トピック、クライアント IP アドレス、ルール ID に対するデバッグログを収集できます。全デプロイメントの詳細ログを有効化することなく、対象を絞ったトラブルシューティングに有用です。 |
| イベント履歴 | 最近の接続、認証、サブスクリプションイベントを保持し、接続失敗、予期しない切断、認証失敗、サブスクリプションが反映されない問題の診断に役立ちます。 |
| BigQuery データ統合 | ルールエンジンと BigQuery シンクを通じて MQTT データを BigQuery に書き込み、SQL 分析やレポーティングに活用できます。 |
| Snowflake ストリーミングデータ統合 | ルールエンジンと Snowflake ストリーミングシンクを通じて低レイテンシで Snowflake テーブルにデータを書き込み、リアルタイム分析やビジネスインサイトに適しています。 |
ネームスペース
ネームスペースはマルチテナント管理とリソース分離を強化します。管理者はテナント、部門、事業部単位でリソース範囲を区切り、各ネームスペース内でルール、コネクター、アクションを独立して管理可能です。複数のチームや顧客が1つのデプロイメントを共有する場合、ネームスペースは誤操作やテナント間影響を軽減します。
ログトレース
ログトレースはコンソールから特定の MQTT クライアント、トピック、クライアント IP アドレス、ルール ID に対するデバッグレベルのログを収集できます。全デプロイメントで詳細ログを有効化するよりも影響範囲が限定され、特定のクライアントやトピック、ルール処理経路の問題再現や診断に適しています。
イベント履歴
イベント履歴は最近のクライアント接続、認証、サブスクリプションイベントを記録します。以下の調査に利用可能です:
- クライアント接続失敗や予期しない切断
- クライアント認証失敗
- サブスクリプションの作成失敗や反映されない問題
- 接続およびサブスクリプションのタイムライン
BigQuery データ統合
ルールエンジンが MQTT メッセージをフィルタリング・処理し、BigQuery シンクが Google BigQuery に書き込みます。大量の IoT データに対する SQL 分析、データウェアハウジング、レポーティングに適しています。
Snowflake ストリーミングデータ統合
Snowflake ストリーミングシンクは MQTT データを低レイテンシで Snowflake テーブルに書き込みます。リアルタイムに近いデータ取り込み、分析、ビジネスインサイトに適しています。
MQTT ソースの強化
V6 の MQTT ソースは重複メッセージを減らすために共有サブスクリプショントピックをサポートします。また、MQTT 5.0 のサブスクリプションオプションである No Local や Retain As Published に対応し、リモート MQTT サービスからのデータブリッジングに柔軟性を提供します。
アップグレードの確定
上記のアップグレード範囲と潜在的リスクを十分にご理解いただいた後、アップグレードスケジュールの確定のためにご連絡ください。アップグレード成功に向けて技術サポートを提供いたします。