InfluxDB 消息存储

InfluxDB 配置

EMQ X 仅支持通过 UDP 协议连接 InfluxDB，需要修改 InfluxDB 配置文件：

  1. [[udp]]
  2.   enabled = true
  3.   bind-address = ":8089"
  4.   # 消息保存的数据库
  5.   database = "emqx"
  7.   # InfluxDB precision for timestamps on received points ("" or "n", "u", "ms", "s", "m", "h")
  8.   # EMQ X 默认时间戳是毫秒
  9.   precision = "ms"
  11.   # 其他配置根据需要自行修改
  12.   #   batch-size = 1000
  13.   #   batch-pending = 5
  14.   #   batch-timeout = "5s"
  15.   #   read-buffer = 1024

配置 InfluxDB 消息存储

配置文件: etc/plugins/emqx_backend_influxdb.conf:

  1. ## InfluxDB UDP 服务地址
  2. backend.influxdb.pool1.server = 127.0.0.1:8089
  4. ## InfluxDB 连接池大小
  5. backend.influxdb.pool1.pool_size = 5
  7. ## 是否自动添加 timestamp
  8. ## 如果设为 true，请将 InfluxDB UDP 配置中的 precision 设为 "ms"
  9. backend.influxdb.pool1.set_timestamp = true
  11. ## 存储 PUBLISH 消息
  12. backend.influxdb.hook.message.publish.1 = {"topic": "#", "action": {"function": "on_message_publish"}, "pool": "pool1"}

InfluxDB Backend 消息存储规则参数:

OptionDescription
topic配置哪些主题下的消息需要执行 hook
action配置 hook 具体动作, function 为 Backend 提供的内置函数, 实现通用功能
poolPool Name, 实现连接多个 InfluxDB Server 功能

Example:

  1. ## 存储主题为 "sensor/#" 的 PUBLISH 消息
  2. backend.influxdb.hook.message.publish.1 = {"topic": "sensor/#", "action": {"function": "on_message_publish"}, "pool": "pool1"}
  4. ## 存储主题为 "stat/#" 的 PUBLISH 消息
  5. backend.influxdb.hook.message.publish.2 = {"topic": "stat/#", "action": {"function": "on_message_publish"}, "pool": "pool1"}

InfluxDB Backend 支持 Hook 与 相应内置函数列表:

HookFunction list
message.publishon_message_publish

由于 MQTT Message 无法直接写入 InfluxDB, InfluxDB Backend 提供了 emqx_backend_influxdb.tmpl 模板文件将 MQTT Message 转换为可写入 InfluxDB 的 DataPoint。

模板文件采用 JSON 格式, 组成部分:

  • key - MQTT Topic, 字符串, 支持通配符
  • value - Template, Json 对象, 用于将 MQTT Message 转换成 measurement,tag_key=tag_value,... field_key=field_value,... timestamp 的形式以写入 InfluxDB。

你可以为不同 Topic 定义不同的 Template, 也可以为同一个 Topic 定义多个 Template, 类似:

  1. {
  2.   <Topic 1>: <Template 1>,
  3.   <Topic 2>: <Template 2>
  4. }

Template 格式如下:

  1. {
  2.   "measurement": <Measurement>,
  3.   "tags": {
  4.       <Tag Key>: <Tag Value>
  5.   },
  6.   "fields": {
  7.       <Field Key>: <Field Value>
  8.   },
  9.   "timestamp": <Timestamp>
  10. }

measurement 与 fields 为必选项, tags 与 timestamp 为可选项。

所有的值 (例如 <Measurement>) 你都可以直接在 Template 中配置为一个固定值, 它支持的数据类型依赖于你定义的数据表。当然更符合实际情况的是，你可以通过我们提供的占位符来获取 MQTT 消息中的数据。

目前我们支持的占位符如下:

PlaceholderDescription
$idMQTT 消息 UUID, 由 EMQ X 分配
$clientid客户端使用的 Client ID
$username客户端使用的 Username
$peerhost客户端 IP
$qosMQTT 消息的 QoS
$topicMQTT 消息主题
$payloadMQTT 消息载荷, 必须为合法的 Json
$<Number>必须配合 $paylaod 使用, 用于从 Json Array 中获取数据
$timestampEMQ X 准备转发消息时设置的时间戳, 精度: 纳秒

$payload 与 $<Number>:

你可以直接使用 $payload 取得完整的消息载荷, 也可以通过 ["$payload", <Key>, ...] 取得消息载荷内部的数据。

例如 payload 为 {"data": {"temperature": 23.9}}, 你可以通过占位符 ["$payload", "data", "temperature"] 来获取其中的 23.9。

考虑到 Json 还有数组这一数据类型的情况, 我们引入了 $0 与 $<pos_integer>, $0 表示获取数组内所有元素, $<pos_integer> 表示获取数组内第 <pos_integer> 个元素。

一个简单例子, ["$payload", "$0", "temp"] 将从 [{"temp": 20}, {"temp": 21}] 中取得 [20, 21], 而 ["$payload", "$1", "temp"] 将只取得 20。

值得注意的是, 当你使用 $0 时，我们希望你取得的数据个数都是相等的。因为我们需要将这些数组转换为多条记录写入 InfluxDB, 而当你一个字段取得了 3 份数据, 另一个字段却取得了 2 份数据, 我们将无从判断应当怎样为你组合这些数据。

Example

data/templates 目录下提供了一个示例模板 (emqx_backend_influxdb_example.tmpl, 正式使用时请去掉文件名中的 “_example” 后缀) 供用户参考:

  1. {
  2.   "sample": {
  3.       "measurement": "$topic",
  4.       "tags": {
  5.           "host": ["$payload", "data", "$0", "host"],
  6.           "region": ["$payload", "data", "$0", "region"],
  7.           "qos": "$qos",
  8.           "clientid": "$clientid"
  9.       },
  10.       "fields": {
  11.           "temperature": ["$payload", "data", "$0", "temp"]
  12.       },
  13.       "timestamp": "$timestamp"
  14.   }
  15. }

TIP

当 Template 中设置 timestamp 或插件配置 backend.influxdb.pool1.set_timestamp = true 时，请将 InfluxDB UDP 配置中的 precision 设为 “ms”。

当 Topic 为 “sample” 的 MQTT Message 拥有以下 Payload 时:

  1. {
  2.   "data": [
  3.       {
  4.           "temp": 1,
  5.           "host": "serverA",
  6.           "region": "hangzhou"
  7.       },
  8.       {
  9.           "temp": 2,
  10.           "host": "serverB",
  11.           "region": "ningbo"
  12.       }
  13.   ]
  14. }

Backend 会将 MQTT Message 转换为:

  1. [
  2.   {
  3.       "measurement": "sample",
  4.       "tags": {
  5.           "clientid": "mqttjs_ebcc36079a",
  6.           "host": "serverA",
  7.           "qos": "0",
  8.           "region": "hangzhou",
  9.       },
  10.       "fields": {
  11.           "temperature": "1"
  12.       },
  13.       "timestamp": "1560743513626681000"
  14.   },
  15.   {
  16.       "measurement": "sample",
  17.       "tags": {
  18.           "clientid": "mqttjs_ebcc36079a",
  19.           "host": "serverB",
  20.           "qos": "0",
  21.           "region": "ningbo",
  22.       },
  23.       "fields": {
  24.           "temperature": "2"
  25.       },
  26.       "timestamp": "1560743513626681000"
  27.   }
  28. ]

最终编码为以下数据写入 InfluxDB:

  1. "sample,clientid=mqttjs_6990f0e886,host=serverA,qos=0,region=hangzhou temperature=\"1\" 1560745505429670000\nsample,clientid=mqttjs_6990f0e886,host=serverB,qos=0,region=ningbo temperature=\"2\" 1560745505429670000\n"

启用 InfluxDB 消息存储:

  1. ./bin/emqx_ctl plugins load emqx_backend_influxdb