スキーマバリデーション

EMQXには、指定されたトピックからサブスクライバーにパブリッシュされるメッセージがあらかじめ定義されたデータフォーマットに準拠していることを保証するための組み込みスキーマバリデーション機能があります。スキーマバリデーションはJSON Schema、Protobuf、Avroなど複数のスキーマフォーマットおよび組み込みのSQL文バリデーションをサポートしています。本ページではスキーマバリデーション機能の概要と利用方法について説明します。

なぜデータをバリデートするのか

クライアントはブローカーに非標準のメッセージをパブリッシュする可能性があり、それがサブスクライバーやデータシステムの例外やセキュリティリスクを引き起こすことがあります。EMQXはデータフォーマットを早期にバリデートすることでこれらの非準拠メッセージを検出・ブロックし、システムの安定性と信頼性を確保します。スキーマバリデーションは以下のような利点をもたらします。

データ整合性：MQTTメッセージの構造とフォーマットを検証し、データの一貫性と正確性を保証します。
データ品質：欠落や無効なフィールド、データ型、フォーマットをチェックし、データの一貫性と品質を維持します。
統一データモデル：チームやプロジェクト全体で統一されたデータモデルを使用し、不整合やエラーを減らします。
再利用と共有：スキーマをチームメンバー間で再利用・共有でき、協力効率を高め、繰り返し作業やエラーを削減します。
セキュリティ：悪意あるまたは誤ったフォーマットのメッセージの処理を防ぎ、セキュリティ脆弱性のリスクを低減します。
相互運用性：メッセージが標準化されたフォーマットに準拠することで、異なるデバイスやシステム間の通信を円滑にします。
デバッグ：無効または誤ったフォーマットのメッセージを容易に特定し、デバッグできます。

ワークフロー

メッセージがパブリッシュされると、あらかじめ定義されたルールに基づいてバリデーションが行われます。バリデーションが成功すれば処理は継続され、失敗した場合はユーザー設定のアクションが実行されます（メッセージ破棄や切断など）。

メッセージがパブリッシュされると、まずEMQXの認可機構でパブリッシュ権限がチェックされます。権限チェックを通過した後、ユーザー設定のバリデータリストからパブリッシュされたトピックに基づいてバリデーションルールがマッチングされます。1つのバリデータは複数のトピックまたはトピックフィルターに設定可能です。
バリデーションルールがマッチすると、メッセージはあらかじめ設定されたスキーマまたはSQLに対してバリデートされます。
- JSON Schema、Protobuf、Avroなど複数のスキーマタイプをサポートします。
- EMQXルールエンジンの構文に準拠したSQL文もサポートします。
- 1つのポリシーに複数のスキーマやSQLを追加し、その関係性を指定できます：
  - All Pass：すべてのバリデーションが成功した場合のみ成功とみなします。
  - Any Pass：いずれかのバリデーションが成功した時点で成功とみなしてバリデーションを停止します。
バリデーションが成功すると、ルールエンジンのトリガーやサブスクライバーへの配信など次の処理に進みます。
バリデーションが失敗した場合、以下のユーザー設定のアクションが実行されます。
- メッセージ破棄：パブリッシュを終了しメッセージを破棄、QoS 1およびQoS 2メッセージにはPUBACKで特定の理由コード（131 - Implementation Specific Error）を返します。
- 切断してメッセージ破棄：メッセージを破棄し、パブリッシュクライアントを切断します。
- 無視：追加のアクションは行いません。
設定されたアクションにかかわらず、バリデーション失敗時にログを出力可能で、ログの出力レベルはユーザーが設定でき、デフォルトはwarningです。バリデーション失敗はルールエンジンイベント$events/schema_validation/failedをトリガーでき、ユーザーはこのイベントをキャッチして、誤ったメッセージを別トピックにパブリッシュしたりKafkaに送信して解析するなどのカスタム処理が可能です。

ユーザーガイド

このセクションではスキーマバリデーション機能の設定方法とテスト方法を説明します。

ダッシュボードでのスキーマバリデーション設定

ダッシュボードでスキーマバリデータを作成・設定する手順を示します。

ダッシュボードの左ナビゲーションで Smart Data Hub -> Schema Validation をクリックします。
Schema Validation ページ右上の Create をクリックします。
Create Schema Validationページで以下を設定します：
- Name：バリデータ名を入力します。
- Message Source Topic：バリデーション対象のメッセージトピックを設定します。複数トピックやトピックフィルターを設定可能です。
- Note（任意）：メモを入力します。
- Validation Method：
  - Validation Strategy：複数のバリデーション戦略間の関係を指定します。
    - All Pass（デフォルト）：すべてのバリデーションが成功した場合に成功とみなします。
    - Any Pass：いずれかのバリデーションが成功した時点で成功とみなしてバリデーションを停止します。
  - Validation List：Type ドロップダウンからスキーマを選択し、スキーマまたはSQLを追加します。スキーマの作成方法はCreate Validation Schemaを参照してください。
- Validation Failure Operation：
  - Action After Failure：バリデーション失敗時のアクションを選択します。
    - Drop Message：パブリッシュを終了しメッセージを破棄、QoS 1およびQoS 2メッセージにはPUBACKで特定の理由コードを返します。
    - Disconnect and Drop Message：メッセージを破棄し、パブリッシュクライアントを切断します。
    - Ignore：追加アクションは行いません。
- Output Logs：バリデーション失敗時にログを出力するか選択します。デフォルトは有効です。
- Logs Level：ログ出力レベルを設定します。デフォルトはwarningです。
Create をクリックして設定を完了します。

これで有効な新しいバリデータがSchema Validationページのリストに表示されます。必要に応じて無効化できます。Actions列のSettingsをクリックすると設定を更新でき、Moreからバリデータの削除や順序変更も可能です。

設定ファイルでのスキーマバリデーション設定

設定の詳細はConfiguration Manualを参照してください。

バリデーションスキーマの作成

ここではJSON Schemaを例にバリデーションスキーマの作成方法を示します。JSON Schemaは以下の条件を満たす必要があります。

EMQX 6.0.4以降、スキーマレジストリはdraft-03、draft-04、draft-06に加え、JSON Schema draft 2019-09およびdraft 2020-12をサポートしています。$schemaが省略された場合はdraft-06が使用されます。対応範囲や制限、完全な例についてはスキーマレジストリの例 - JSON Schemaを参照してください。

JSONオブジェクトにtempという名前のプロパティが含まれていること。
tempプロパティは整数型であること。
tempプロパティの値は101以上であること。

json

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "type": "object",
  "properties": {
    "temp": {
      "type": "integer",
      "minimum": 101
    }
  },
  "required": ["temp"]
}