baetyl-rule
更新时间：2022-08-02
简介
baetyl-rule 可以实现 baetyl 框架端侧的消息流转，在 baetyl-broker (端侧消息中心)、函数服务、Iot Hub (云端 mqtt broker) 进行消息交换。
支持以下的消息流转方式：
- 订阅 baetyl-broker 的消息主题，发送到自身的其他消息主题，支持函数处理
- 订阅 baetyl-broker 的消息主题，发送到其他消息节点（比如 Iot Hub）的消息主题，支持函数处理
- 订阅其他消息节点的消息主题，发送到 baetyl-broker 的消息主题，支持函数处理
其中 baetyl 支持 Python、Node、SQL 等多种运行时，可以配置相关的脚本函数对消息进行过滤、处理、转换以及丰富等，具体可以参考 baetyl-function 模块。
配置
baetyl-rule 的全量配置文件如下，并对配置字段做了相应解释：
clients: # 消息节点，可以从节点订阅消息，也可以发送消息节点
- name: iothub # 名称
kind: mqtt # mqtt 类型
address: 'ssl://u7isgiz.mqtt.iot.bj.baidubce.com:1884' # 地址
username: client.example.org # 用户名
ca: ../example/var/lib/baetyl/testcert/ca.pem # 连接节点的 CA
key: ../example/var/lib/baetyl/testcert/client.key # 连接节点的私钥
cert: ../example/var/lib/baetyl/testcert/client.pem # 连接节点的公钥
insecureSkipVerify: true # 是否跳过服务端证书校验
rules: # 消息规则
- name: rule1 # 规则名称，必须保持唯一
source: # 消息源
topic: broker/topic1 # 消息主题
qos: 1 # 消息质量
target: # 消息目的地
client: iothub # 消息节点，如果不设置，默认为 baetyl-broker
topic: iothub/topic2 # 消息主题
qos: 0 # 消息质量
- name: rule2 # 规则名称，必须保持唯一
source: # 消息源
topic: broker/topic5 # 消息主题
qos: 0 # 消息质量
target: # 消息目的地
topic: broker/topic6 # 消息主题
qos: 1 # 消息质量
function: # 处理函数
name: node85 # 函数名称说明：
- baetyl-rule 会自动在节点信息列表中添加 baetyl-broker 的节点信息。
- 当一条规则的的 client 字段未配置时，会默认设置为 baetyl-broker，从 baetyl-broker 订阅消息或者转发消息到 baetyl-broker。
demo示例
纯消息流转
下面示例定义了两条规则
- edge2iotcore：将边缘侧edgetopic1的消息，转发至云端iotcore，mqtt小的qos=1
- edge2edge：将边缘侧edgetopic1的消息，转发至边缘侧edgetopic2，mqtt消息的qos=1
clients:
- name: iotcore
kind: mqtt
address: 'tcp://aeccdhl.iot.gz.baidubce.com:1883'
username: xxxcdhl/device6
password: lfWjOxxxmvXPpM
rules:
- name: edge2iotcore
source:
topic: edgetopic1
qos: 1
target:
client: iotcore
topic: topic1
qos: 1
- name: edge2edge
source:
topic: edgetopic1
qos: 1
target:
topic: edgetopic2
qos: 1
logger:
level: debug
encoding: console消息流转+函数计算
下面示例定义了3条规则
- rule1：订阅
broker/topic1消息，将消息作为函数py-demo1/func1的输入，将函数计算结果输出至broker/topic2 - rule2：订阅
broker/topic3消息，将消息作为函数py-demo1/func2的输入，将函数计算结果输出至broker/topic4 - rule3：订阅
broker/topic5消息，将消息作为函数sql-demo1/func1的输入，将函数计算结果输出至broker/topic6
rules:
- name: rule1
source:
topic: broker/topic1
target:
topic: broker/topic2
function:
name: py-demo1/func1
- name: rule2
source:
topic: broker/topic3
target:
topic: broker/topic4
function:
name: py-demo1/func2
- name: rule3
source:
topic: broker/topic5
target:
topic: broker/topic6
function:
name: sql-demo1/func1
logger:
level: debug
encoding: console