通过 CLI 创建简单规则

创建 Inspect 规则

创建一个测试规则，当有消息发送到 ‘t/a’ 主题时，打印消息内容以及动作参数细节。

  • 规则的筛选 SQL 语句为: SELECT * FROM “message.publish” WHERE topic = ‘t/a’;

  • 动作是: “打印动作参数细节”，需要使用内置动作 ‘inspect’。

    1. $ ./bin/emqx_ctl rules create \
    2.  "SELECT \* FROM \"message.publish\" WHERE topic = 't/a'" \
    3.  '[{"name":"inspect", "params": {"a": 1}}]' \
    4.  -d 'Rule for debug'
    6. Rule rule:803de6db created

上面的 CLI 命令创建了一个 ID 为 ‘Rule rule:803de6db’ 的规则。

参数中前两个为必参数:

  • SQL 语句: SELECT * FROM “message.publish” WHERE topic = ‘t/a’
  • 动作列表: [{“name”:”inspect”, “params”: {“a”: 1}}]。动作列表是用 JSON Array 格式表示的。name 字段是动作的名字，params 字段是动作的参数。注意 inspect 动作是不需要绑定资源的。

最后一个可选参数，是规则的描述: ‘Rule for debug’。

接下来当发送 “hello” 消息到主题 ‘t/a’ 时，上面创建的 “Rule rule:803de6db” 规则匹配成功，然后 “inspect” 动作被触发，将消息和参数内容打印到 emqx 控制台:

  1. $ tail -f log/erlang.log.1
  3. (emqx@127.0.0.1)1> [inspect]
  4.     Selected Data: #{client_id => <<"shawn">>,event => 'message.publish',
  5.                      flags => #{dup => false,retain => false},
  6.                      id => <<"5898704A55D6AF4430000083D0002">>,
  7.                      payload => <<"hello">>,
  8.                      peername => <<"127.0.0.1:61770">>,qos => 1,
  9.                      timestamp => 1558587875090,topic => <<"t/a">>,
  10.                      username => undefined}
  11.     Envs: #{event => 'message.publish',
  12.             flags => #{dup => false,retain => false},
  13.             from => <<"shawn">>,
  14.             headers =>
  15.                 #{allow_publish => true,
  16.                   peername => {{127,0,0,1},61770},
  17.                   username => undefined},
  18.             id => <<0,5,137,135,4,165,93,106,244,67,0,0,8,61,0,2>>,
  19.             payload => <<"hello">>,qos => 1,
  20.             timestamp => {1558,587875,89754},
  21.             topic => <<"t/a">>}
  22.     Action Init Params: #{<<"a">> => 1}
  • Selected Data 列出的是消息经过 SQL 筛选、提取后的字段，由于我们用的是 select * ，所以这里会列出所有可用的字段。
  • Envs 是动作内部可以使用的环境变量。
  • Action Init Params 是初始化动作的时候，我们传递给动作的参数。

创建 WebHook 规则

创建一个规则，将所有发送自 client_id=’Steven’ 的消息，转发到地址为 ‘ http://127.0.0.1:9910 通过 CLI 创建简单规则 - 图1 (opens new window) ‘ 的 Web 服务器:

  1. 首先我们创建一个简易 Web 服务，这可以使用 nc 命令实现:

    1. $ while true; do echo -e "HTTP/1.1 200 OK\n\n $(date)" | nc -l 127.0.0.1 9910; done;

  2. 使用 WebHook 类型创建一个资源，并配置资源参数 url:

    1). 列出当前所有可用的资源类型，确保 ‘web_hook’ 资源类型已存在:

    1. $ ./bin/emqx_ctl resource-types list
    2.  resource_type(name='web_hook', provider='emqx_web_hook', params=#{...}}, on_create={emqx_web_hook_actions,on_resource_create}, description='WebHook Resource')
    3.   ...

    2). 使用类型 ‘web_hook’ 创建一个新的资源，并配置 “url”=” http://127.0.0.1:9910 通过 CLI 创建简单规则 - 图4 (opens new window) “:

    1. $ ./bin/emqx_ctl resources create \
    2.  'web_hook' \
    3.  -c '{"url": "http://127.0.0.1:9910", "headers": {"token":"axfw34y235wrq234t4ersgw4t"}, "method": "POST"}'
    5.  Resource resource:691c29ba created

上面的 CLI 命令创建了一个 ID 为 ‘resource:691c29ba’ 的资源，第一个参数是必选参数 - 资源类型(web_hook)。参数表明此资源指向 URL = “ http://127.0.0.1:9910 通过 CLI 创建简单规则 - 图5 (opens new window) “ 的 Web 服务，方法为 POST，并且设置了一个 HTTP Header: “token”。

  1. 然后创建规则，并选择规则的动作为 ‘data_to_webserver’:

    1). 列出当前所有可用的动作，确保 ‘data_to_webserver’ 动作已存在:

    1. $ ./bin/emqx_ctl rule-actions list
    3.  action(name='data_to_webserver', app='emqx_web_hook', for='$any', types=[web_hook], params=#{'$resource' => ...}, title ='Data to Web Server', description='Forward Messages to Web Server')
    4.  ...

    2). 创建规则，选择 data_to_webserver 动作，并通过 “$resource” 参数将 resource:691c29ba 资源绑定到动作上:

    1. $ ./bin/emqx_ctl rules create \
    2.  "SELECT username as u, payload FROM \"message.publish\" where u='Steven'" \
    3.  '[{"name":"data_to_webserver", "params": {"$resource":  "resource:691c29ba"}}]' \
    4.  -d "Forward publish msgs from steven to webserver"
    6.  rule:26d84768

上面的 CLI 命令与第一个例子里创建 Inspect 规则时类似，区别在于这里需要把刚才创建的资源 ‘resource:691c29ba’ 绑定到 ‘data_to_webserver’ 动作上。这个绑定通过给动作设置一个特殊的参数 ‘$resource’ 完成。’data_to_webserver’ 动作的作用是将数据发送到指定的 Web 服务器。

  1. 现在我们使用 username “Steven” 发送 “hello” 到任意主题，上面创建的规则就会被触发，Web Server 收到消息并回复 200 OK:

    ``` $ while true; do echo -e “HTTP/1.1 200 OK\n\n $(date)” | nc -l 127.0.0.1 9910; done;

  1. POST / HTTP/1.1
  2. content-type: application/json
  3. content-length: 32
  4. te:
  5. host: 127.0.0.1:9910
  6. connection: keep-alive
  7. token: axfw34y235wrq234t4ersgw4t
  9. {"payload":"hello","u":"Steven"}
  10. ```