EMQ X 規則引擎系列（五）存儲消息到 Cassandra 數據庫

Cassandra 介紹與安裝

Cassandra 是來自 Apache 的開源分佈式數據庫系統，它能在支持線性擴展 、 高可用的特性下，不損失原有的讀寫性能。目前普遍運用於各個大企業的後端服務中，例如 Netflix、Apple 等已部署上千個節點。

Cassandra 的安裝參考：http://cassandra.apache.org/doc/latest/getting_started/installing.html

原理概覽

經過配置規則引擎，EMQ X 可將指定主題下知足某條件的消息存儲到 Cassandra 數據庫。其消息流向簡圖以下：

其中：

• PUB/SUB：爲 EMQ X 中的發佈訂閱處理邏輯。
• Rule：IoT 消息規則，提取、篩選、轉換消息報文中的數據。
• Action: 爲具體執行的動做。例如存數據庫、寫 Kafka 等。

場景介紹

爲說明規則引擎在 Cassandra 數據庫下的使用方式，咱們以 將發動機轉速超過 8000 的車輛狀態存入 Cassandra 中 爲例。

假設車輛上報狀態信息以下：

• 上報主題：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 // 上報時間
  }

準備工做

建立數據庫

建立 emqx_rule_engine_output 表空間以存儲消息數據：

CREATE KEYSPACE emqx_rule_engine_output WITH replication = {'class': 'SimpleStrategy', 'replication_factor': '1'}  AND durable_writes = true;

建立數據表

根據場景需求，建立數據表 use_statistics 結構及字段註釋以下：

USE emqx_rule_engine_output;

CREATE TABLE use_statistics (
  msgid text,
  client_id text,
  speed double,
  tachometer int,
  ts int,
  PRIMARY KEY (msgid)
);

建立成功後確認數據表是否存在：

root@cqlsh:emqx_rule_engine_output> use emqx_rule_engine_output ;
root@cqlsh:emqx_rule_engine_output> desc use_statistics ;

CREATE TABLE emqx_rule_engine_output.use_statistics (
    msgid text PRIMARY KEY,
    client_id text,
    speed double,
    tachometer int,
    ts int
) WITH bloom_filter_fp_chance = 0.01
    AND caching = {'keys': 'ALL', 'rows_per_partition': 'NONE'}
    AND comment = ''
    AND compaction = {'class': 'org.apache.cassandra.db.compaction.SizeTieredCompactionStrategy', 'max_threshold': '32', 'min_threshold': '4'}
    AND compression = {'chunk_length_in_kb': '64', 'class': 'org.apache.cassandra.io.compress.LZ4Compressor'}
    AND crc_check_chance = 1.0
    AND dclocal_read_repair_chance = 0.1
    AND default_time_to_live = 0
    AND gc_grace_seconds = 864000
    AND max_index_interval = 2048
    AND memtable_flush_period_in_ms = 0
    AND min_index_interval = 128
    AND read_repair_chance = 0.0
    AND speculative_retry = '99PERCENTILE';

配置規則引擎

建立資源

打開 EMQ X Dashboard，進入左側菜單的 資源 頁面，點擊 新建 按鈕，選擇 Cassandra 資源類型進行建立：

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

建立規則

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

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

篩選所需字段

規則引擎使用 SQL 語句處理規則條件，該業務中咱們須要將 payload 中全部字段單獨選擇出來，使用 payload.<fieldName> 格式進行選擇，還須要消息上下文的 topic、qos、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
}

測試輸出與預期相符，咱們能夠進行後續步驟。

添加響應動做，存儲消息到 Cassandra

SQL 條件輸入輸出無誤後，咱們繼續添加相應動做，配置寫入 SQL 語句，將篩選結果存儲到 Cassandra。

點擊響應動做中的 添加 按鈕，選擇 保存數據到 Cassandra 動做，選取剛剛選定的資源，咱們使用 ${fieldName} 語法填充 SQL 語句，將數據插入到數據庫，最後點擊 新建 按鈕完成規則建立。

動做的 SQL 配置以下：

INSERT INTO use_statistics (msgid, client_id, speed, tachometer, ts) VALUES (${id}, ${client_id}, ${speed}, ${tachometer}, ${ts});

測試

預期結果

咱們成功建立了一條規則，包含一個處理動做，動做指望效果以下：

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

使用 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
  }

點擊 發送 按鈕，此時消息體中的 tachometer 數值，知足上面設置的 tachometer > 8000 的條件，當前規則已命中統計值爲加 1。

Cassandra 命令行中查看數據表記錄獲得數據以下：

至此，咱們經過規則引擎實現了使用規則引擎存儲消息到 Cassandra 數據庫的業務開發。

---

更多信息請訪問咱們的官網 emqx.io，或關注咱們的開源項目 github.com/emqx/emqx ，詳細文檔請訪問 官方文檔。