EMQ X 規則引擎系列（一）：數據橋接到消息隊列（Kafka）

EMQ X 3.2 版本引入了 “規則引擎” 功能，支持在 EMQ X Broker 篩選終端上報的數據，處理后流至后端數據庫或其他的消息隊列。本篇以具體場景來說明 “如何使用規則引擎將消息轉發至 Kafka”

場景介紹

該場景需要將 EMQ X 指定主題下且滿足條件的消息橋接到 Kafka 。為了便於后續分析檢索，消息內容需要進行拆分。

該場景下設備端上報信息如下：

• 上報主題：cmd/state/:id，主題中 id 代表車輛客戶端識別碼

• 消息體：

  {
    "id": "NXP-058659730253-963945118132721-22", // 客戶端識別碼
    "speed": 32.12, // 車輛速度
    "direction": 198.33212, // 行駛方向
    "tachometer": 3211, // 發動機轉速，數值大於 8000 時才需存儲
    "dynamical": 8.93, // 瞬時油耗
    "location": { // GPS 經緯度數據
      "lng": 116.296011,
      "lat": 40.005091
    },
    "ts": 1563268202 // 上報時間
  }
  

當上報數據發動機轉速數值大於 8000 時，存儲當前信息以便后續分析用戶車輛使用情況。

准備工作

創建Kafka主題

./bin/kafka-topics.sh --create --bootstrap-server localhost:9092 --topic 'emqx_rule_engine_output' --partitions 1 --replication-factor 1

創建 Kafka Rule 之前必須先在 Kafka 中創建好主題，否則創建 Kafka Rule 失敗。

配置說明

創建資源

打開 EMQ X Dashboard，進入左側菜單的 資源 頁面，點擊 新建 按鈕，鍵入 Kafka 服務器信息進行資源創建。

EMQ X 集群中節點所在網絡環境可能互不相同，資源創建成功后點擊列表中 狀態按鈕，查看各個節點資源連接狀況，如果節點上資源不可用，請檢查配置是否正確、網絡連通性，並點擊 重連 按鈕手動重連。

創建規則

進入左側菜單的 規則 頁面，點擊 新建 按鈕，進行規則創建。這里選擇觸發事件 消息發布，在消息發布時觸發該規則進行數據處理。

選定觸發事件后，我們可在界面上看到可選字段及示例 SQL：

篩選所需字段

規則引擎使用 SQL 語句進行 處理/整型 終端消息或連接事件等。該業務中我們只需將 payload 中關鍵字段篩選出來進行使用。為此可使用 payload.<fieldname> 格式來選擇 payload 中的字段。此外，除 payload 中的內容外，還需要保存消息的 id 信息。則 SQL 可配置為如下格式：

SELECT
  payload.id as client_id, payload.speed as speed, 
  payload.tachometer as tachometer,
  payload.ts as ts, id
FROM
  "message.publish"
WHERE
  topic =~ 't/#'

確立篩選條件

使用 SQL 語句 WHERE 字句進行條件篩選，該業務中我們需要定義兩個條件：

• 僅處理 cmd/state/:id 主題，使用主題通配符 =~ 對 topic 進行篩選：topic =~ 'cmd/state/+'
• 僅處理 tachometer > 8000 的消息，使用比較符對 tachometer 進行篩選：payload.tachometer > 8000

組合上一步驟得到 SQL 如下：

SELECT
  payload.id as client_id, payload.speed as speed, 
  payload.tachometer as tachometer,
  payload.ts as ts,
  id
FROM
  "message.publish"
WHERE
  topic =~ 'cmd/state/+'
  AND payload.tachometer > 8000

使用 SQL 測試功能進行輸出測試

借助 SQL 測試功能，我們可以實時查看當前 SQL 處理后的數據輸出，該功能需要我們指定 payload 等模擬原始數據。

payload 數據如下，注意更改 tachometer 數值大小，以滿足 SQL 條件：

{
  "id": "NXP-058659730253-963945118132721-22",
  "speed": 32.12,
  "direction": 198.33212,
  "tachometer": 9001,
  "dynamical": 8.93,
  "location": {
    "lng": 116.296011,
    "lat": 40.005091
  },
  "ts": 1563268202
}

點擊 SQL 測試 切換按鈕，更改 topic 與 payload 為場景中的信息，點擊 測試 按鈕查看數據輸出：

測試輸出數據為：

{
  "client_id": "NXP-058659730253-963945118132721-22",
  "id": "589A429E9572FB44B0000057C0001",
  "speed": 32.12,
  "tachometer": 9001,
  "ts": 1563268202
}

測試輸出與預期相符，我們可以進行后續步驟。

添加響應動作，橋接消息到 Kafka

SQL 條件輸入輸出無誤后，我們繼續添加相應動作，配置寫入 SQL 語句，將篩選結果橋接到 Kafka。

點擊響應動作中的 添加 按鈕，選擇 橋接數據到Kafka 動作，選取剛剛選定的資源，Kafka 主題填寫上文創建的emqx_rule_engine_output

測試

預期結果

我們成功創建了一條規則，包含一個處理動作，動作期望效果如下：

1. 設備向 cmd/state/:id 主題上報消息是，當消息中的 tachometer 數值超過 8000 時將命中 SQL，規則列表中 已命中 數字增加 1；
2. Kafka 的 emqx_rule_engine_output 主題 將增加一條消息，數值與當前消息一致。

使用 Dashboard 中的 Websocket 工具測試

切換到 工具 --> Websocket 頁面，使用任意信息客戶端連接到 EMQ X，連接成功后在 消息 卡片發送如下信息：

• 主題：cmd/state/NXP-058659730253-963945118132721-22

• 消息體：

  {
    "id": "NXP-058659730253-963945118132721-22",
    "speed": 32.12,
    "direction": 198.33212,
    "tachometer": 8081,
    "dynamical": 8.93,
    "location": {
      "lng": 116.296011,
      "lat": 40.005091
    },
    "ts": 1563268202
  }
  

點擊 發送 按鈕，查看得到當前規則已命中統計值為 1。

然后通過 Kafka 命令去查看消息是否生產成功:

./bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 --topic emqx_rule_engine_output --from-beginning
{"client_id":"NXP-058659730253-963945118132721-22","id":"58DEE9D97711EF440000017B30002","speed":32.12,"tachometer":8081,"ts":1563268202}

至此，我們通過規則引擎實現了使用規則引擎橋接消息到 Kafka 的業務開發。

開源版規則引擎僅支持轉發到 Web Server, 轉發到 Kafka 的功能僅在企業版中發行