EMQX 文档

简体中文

English

简体中文

English

Appearance

联系我们

将 MQTT 数据写入到 Redis ​

TIP

Redis 数据集成是 EMQX 企业版功能。

Redis 数据集成可以通过执行自定义 Redis 数据操作命令的方式，将 MQTT 消息和客户端事件存储到 Redis 中，借助 Redis 高性能与灵活数据结构，实现诸如消息暂存，发布订阅和消息丢弃行为的计数与统计等业务。

本页详细介绍了 EMQX 与 Redis 的数据集成并提供了实用的规则和 Sink 创建指导。

工作原理 ​

Redis 数据集成是 EMQX 中的一个开箱即用的功能，结合了 EMQX 的设备接入、消息传输能力与 Redis 丰富的数据结构以及强大的键值读写性能。通过内置的规则引擎组件，该集成简化了将数据从 EMQX 写入到 Redis 进行数据缓存和操作的过程，无需复杂编码。

下图展示了 EMQX 与 Redis 之间数据集成的典型架构:

EMQX-Redis 集成

将 MQTT 数据写入 Redis 的过程如下：

  1. 消息发布和接收：工业物联网设备通过 MQTT 协议成功连接到 EMQX，并根据其运行状态、读数或触发的事件，将实时 MQTT 数据从机器、传感器和生产线发布到 EMQX。EMQX 收到这些消息后，将启动其规则引擎中的匹配过程。
  2. 消息数据处理：当消息到达时，它会经过规则引擎，然后由 EMQX 中定义的规则处理。这些规则基于预定义的标准，确定哪些消息需要路由到 Redis。如果任何规则指定了有效载荷转换，那么将应用这些转换，例如转换数据格式、过滤特定信息或用额外的上下文丰富有效载荷。
  3. 数据写入到 Redis：一旦规则引擎处理了数据，它就会触发动作来执行预设的 Redis 命令，用于缓存、计数和对数据执行其他操作。
  4. 数据存储和利用：通过读取存储在 Redis 中的数据，企业可以利用其丰富的数据操作能力实现各种用例。例如物流领域，可以获取设备最新状态，也可以基于数据实现 GPS 地理位置分析，进行实时数据分析和排序等操作。以实现实时跟踪、路线推荐等功能。

特性与优势 ​

在 EMQX 中使用 Redis 数据集成能够为您的业务带来以下特性与优势：

  • 高性能和可扩展性：在 EMQX 的分布式架构和 Redis 的集群模式支持下，应用可随着数据量的增加实现无缝扩展。即使对于大型数据集，也可以确保一致的性能和响应能力。
  • 实时数据流：EMQX 专为处理实时数据流而构建，确保从设备到 Redis 的高效可靠的数据传输。Redis 能够快速执行数据操作，能够满足实时数据暂存，使其成为 EMQX 的理想数据存储组件。
  • 实时数据分析：Redis 可以用于实时数据分析，能够实时计算设备连接、消息发布以及具体的业务指标，而 EMQX 可以用于实时消息传输和处理，可以为数据分析提供实时数据输入。
  • 地理位置分析：Redis 提供了地理位置相关的数据结构和命令，可以用于存储和查询地理位置信息。结合 EMQX 强大的设备接入能力，能够广泛应用在如物流、车联网、智慧城市等各类物联网应用中。

准备工作 ​

本节介绍了在 EMQX 中创建 Redis 数据集成之前需要做的准备工作，包括安装 Redis。

前置准备 ​

安装 Redis ​

通过 Docker 安装并启动 Redis：

bash
# 启动一个 Redis 容器并设置密码为 public
docker run --name redis -p 6379:6379 -d redis --requirepass "public"

# 进入容器
docker exec -it redis bash

# 在容器中连接到 Redis 服务器，需要通过 AUTH 命令认证
redis-cli
127.0.0.1:6379> AUTH public
OK

# 验证安装结果
127.0.0.1:6379> set emqx "Hello World"
OK
127.0.0.1:6379> get emqx
"Hello World"

至此，您已经完成 Redis 的安装并使用 SET GET 命令验证了安装结果，更多 Redis 命令请参考 Redis Commands。

创建连接器 ​

本节演示如何创建一个连接器，将 Redis Sink 连接到 Redis 服务器。

以下步骤假设您在本地机器上同时运行 EMQX 和 Redis。如果您的 Redis 部署在其他地方，请相应调整设置。

  1. 进入 Dashboard，点击集成 -> 连接器。
  2. 点击页面右上角的创建。
  3. 在创建连接器页面中，选择 Redis，然后点击 下一步。
  4. 为连接器输入一个名称。名称应是大写/小写字母和数字的组合，例如 my_redis。
  5. 根据业务需求设置 部署模式，例如，选择 single。
  6. 输入连接信息。
    • 服务器地址：输入 127.0.0.1:6379。
    • 用户名：输入 admin。
    • 密码：输入 public。
    • 数据库名字：保持默认值 0。
    • 根据您的业务需求配置其他选项。
    • 如果您想建立加密连接，请点击 启用 TLS 切换开关。有关 TLS 连接的更多信息，请参见启用 TLS 访问外部资源。
  7. 在点击创建之前，您可以点击测试连接来测试连接器是否能连接到 Redis 服务器。
  8. 点击创建按钮完成连接器的创建。在弹出的对话框中，您可以点击返回连接器列表或点击创建规则继续创建规则以指定转发并暂存到 Redis 的数据或进行消息丢弃的统计。具体步骤请参见创建消息暂存 Sink 规则和创建消息丢弃统计 Sink 规则。

创建消息暂存 Sink 规则 ​

  1. 转到 Dashboard 集成 -> 规则页面。

  2. 点击页面右上角的创建。

  3. 输入规则 ID cache_to_redis，在 SQL 编辑器中输入规则，此处选择将 t/# 主题的 MQTT 消息暂存至 Redis，请确保规则选择出来的字段（SELECT 部分）包含所有 Redis Command 模板中用到的变量，此处规则 SQL 如下：

    sql
    SELECT
  *
FROM
  "t/#"

    TIP

    如果您初次使用 SQL，可以点击 SQL 示例和启用调试来学习和测试规则 SQL 的结果。

  4. 点击右侧的添加动作按钮，为规则在被触发的情况下指定一个动作。在动作类型下拉框中选择 Redis，保持动作下拉框为默认的创建动作选项，您也可以选择一个之前已经创建好的 Redis Sink。此处我们创建一个全新的 Sink 并添加到规则中。

  5. 输入 Sink 名称，名称应为大/小写字母和数字的组合。

  6. 从连接器下拉框中选择刚刚创建的 my_redis。您也可以通过点击下拉框旁边的按钮创建一个新的连接器。有关配置参数，请参见创建连接器。

  7. 配置 Redis 命令模板：使用 Redis HSET 命令与 hash 数据结构存储消息，数据格式以 clientid 为 key，存储 username、payload 和timestamp 等字段。为了便于与 Redis 中其他 key 区分，我们使用 emqx_messages 前缀作为 key 的命名空间并用 : 分割:

    bash
    # HSET key filed value [field value...]
HSET emqx_messages:${clientid} username ${username} payload ${payload} timestamp ${timestamp}

  8. 高级配置（可选），根据情况配置同步/异步模式，队列与批量等参数，详细请参考 Sink 的特性。

  9. 点击创建前，您可点击测试连接按钮确保 Sink 能连接到 Redis 服务器。

  10. 点击创建按钮完成 Sink 创建，新建的 Sink 将被添加到动作输出列表中。

  11. 回到创建规则页面，对配置的信息进行确认，点击创建。一条规则应该出现在规则列表中。

现在您已成功创建了通过 Redis Sink 将数据转发到 Redis 的规则，同时在规则页面的动作(Sink) 标签页看到新建的 Redis Sink。

您还可以点击 集成 -> Flow 设计器可以查看拓扑，通过拓扑可以直观的看到，主题 t/# 下的消息在经过规则 my_rule 解析后被发送到 Redis 中。

创建消息丢弃统计 Sink 规则 ​

本节我们将演示如何通过 Redis 统计 EMQX 消息丢弃情况。

注意：除 Redis Command 模板与规则外，其他操作步骤与创建消息暂存 Sink 规则章节完全相同。

Sink 的 Redis Command 模板

使用 HINCRBY 命令，对每个主题消息丢弃数量计数，模板如下：

bash
# HINCRBY key field increment
HINCRBY emqx_message_dropped_count ${topic} 1

该命令每次执行时，对应计数器将 +1。

规则 SQL

EMQX 规则提供了 2 个消息丢弃事件，可以通过其触发规则并记录到 Redis 中：

事件名称事件主题事件参数
消息在转发的过程中被丢弃$events/message_dropped点击查看
消息在投递的过程中被丢弃$events/delivery_dropped点击查看

对应规则 SQL 如下：

sql
SELECT
  *
FROM
  "$events/message_dropped", "$events/delivery_dropped"

测试规则和 Sink ​

使用 MQTTX 向 t/1 主题发布消息，此操作会触发消息暂存规则，如果 t/1 主题没有订阅者，消息将被丢弃并触发消息丢弃规则：

bash
mqttx pub -i emqx_c -u emqx_u -t t/1 -m '{ "msg": "hello Redis" }'

分别查看两个 Sink 运行统计，命中、发送成功次数均 +1。

查看消息是否已经暂存：

bash
127.0.0.1:6379> HGETALL emqx_messages:emqx_c
1) "username"
2) "emqx_u"
3) "payload"
4) "{ \"msg\": \"hello Redis\" }"
5) "timestamp"
6) "1675263885119"

再次执行消息发布测试并查看数据，timestamp 字段的值将更新。

查看消息丢失是否已经被计数：

bash
127.0.0.1:6379> HGETALL emqx_message_dropped_count
1) "t/1"
2) "1"

多次执行消息发布测试并查看数据，t/1 字段的计数器将增长。