GCP PubSub

Google Cloud PubSub 是一种异步消息传递服务，旨在实现极高的可靠性和可扩缩性。EMQX 支持与 Google Cloud Pub/Sub 的无缝集成，用于实时提取、处理和分析 MQTT 数据。此外，它还支持将数据推送并订阅各种Google Cloud 服务，如 Cloud Functions、App Engine、Cloud Run、Kubernetes Engine 和 Compute Engine。

借助 EMQX GCP PubSub 集成，您可以将 MQTT 消息和客户端事件发送到 GCP PubSub 中，这能够帮助您更快的基于 GCP 构建物联网应用，助力你从 GCP IoT Core 迁移到 EMQX 中。

TIP

EMQX 企业版功能。EMQX 企业版可以为您带来更全面的关键业务场景覆盖、更丰富的数据集成支持，更高的生产级可靠性保证以及 24/7 的全球技术支持，欢迎免费试用。

功能清单

• 连接池
• 异步请求模式
• 批量模式
• 缓存队列

快速开始

本节介绍如何配置 GCP PubSub 数据桥接，包括如何设置 GCP 的服务、创建数据桥接和转发数据到 GCP PubSub 的规则以及测试数据桥接和规则等主题。

在配置 GCP PubSub 之前，必须先在 GCP 上创建好对应的服务账户凭证以及 PubSub 主题。

创建服务账户凭证

服务账户凭证是用于身份验证和授权的 JSON 文件，EMQX 需要通过它访问 PubSub 资源。

1. 进入 GCP 控制台，在搜索框中输入 IAM 并进入 IAM & Admin 页面。
2. 在 IAM & Admin 页面中点击 Service Accounts -> Email 中对应的邮箱，选择 KEYS 标签页，点击 ADD KEY 添加以生成用于身份认证 JSON 格式的 key，请妥善保管该文件。

在 GCP PubSub 中创建主题

1. 打开 Pub/Sub 控制台，点击 **CREATE TOPIC，**输入自定义的 **Topic ID，**点击 CREATE 即可完成创建。

2. 点击列表页对应的 Topic ID 即可进入 Topic 详情页面，您需要创建一个 subscription 来保存消息，有关 subscription 详细介绍请参考 CCP Pub/Sub subscription，此处选择 Pull 类型，保留 7 天历史消息。

3. 点击 Subscription ID → MESSAGES → PULL 可以在线查看发送到主题中的消息。

创建 GCP PubSub 数据桥接

1. 转到 Dashboard 数据集成 -> 数据桥接页面。

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

3. 在数据桥接类型中选择 GCP PubSub，点击下一步。

4. 输入数据桥接名称，要求是大小写英文字母和数字的组合。

5. 在桥接角色字段中，根据业务需求从下拉列表中选择生产者 或消费者，并完成相应的配置。

   • 配置为生产者角色
   • 配置为消费者角色

   • GCP PubSub 主题：输入在 GCP 中创建和管理主题中创建的主题 ID my-iot-core 。
   • GCP 服务账户凭证：上传您在 在 GCP 中创建服务帐号密钥 中导出的 JSON 格式的服务帐号凭据。
   • HTTP 请求消息体模版：留空或定义一个模板。
     • 如果留空，它将使用 JSON 格式对 MQTT 消息中的所有可见输入进行编码，例如 clientid、topic、payload 等。
     • 如果使用定义的模板，占位符的形式为 ${variable_name}，将用 MQTT 上下文中的相应值填充。例如，如果 MQTT 消息主题是 my/topic，则 ${topic} 将被替换为 my/topic。
   • 属性模板和排序键模板（可选）：类似地，您可以定义用于格式化传出消息的属性和/或排序键的模板。
     • 对于属性，键和值都可以使用 ${variable_name} 形式的占位符。这样的值将从 MQTT 上下文中提取出来。如果键模板解析为空字符串，则该键将从传出到 GCP PubSub 的消息中省略。
     • 对于顺序键，可以使用 ${variable_name} 形式的占位符。如果解析后的值为空字符串，则不会为 GCP PubSub 传出消息设置 orderingKey 字段。
   • 高级配置（可选），根据情况配置同步/异步模式，队列等参数。

   • GCP 服务账户凭证：上传您在 在 GCP 中创建服务帐号密钥 中导出的 JSON 格式的服务帐号凭据。

   • 主题映射 字段必须包含至少一个 GCP PubSub 到 MQTT 主题映射。HTTP 请求消息体模版子字段指定应使用的 MQTT payload，并提供以下 GCP PubSub 消息字段供模板化：

     字段名称	描述
     attributes	（可选）一个包含字符串键值对的对象
     message_id	GCP PubSub 为此消息分配的消息 ID
     ordering_key	（可选）消息排序键
     publishing_time	GCP PubSub 定义的消息时间戳
     topic	原始 GCP PubSub 主题
     value	（可选）消息负载

     HTTP 请求消息体模版的默认值为 ${.}，它将所有可用数据编码为 JSON 对象。例如，选择 ${.} 作为模板将会为包含所有可选字段的 GCP PubSub 消息生成以下内容：

     jsonCopy code
     {
       "attributes": {"attribute_key": "attribute_value"},
       "message_id": "1679665968238",
       "ordering_key": "my-ordering-key",
       "topic": "my-pubsub-topic",
       "publishing_time": "2023-08-18T14:15:18.470Z",
       "value": "my payload"
     }

     可以使用点表示法访问 GCP PubSub 消息的子字段。例如，${.value} 将解析为 GCP PubSub 消息的值，${.attributes.h1} 将解析为 h1 消息属性键的值（如果存在）。不存在的值将被替换为空字符串。

     注意：每个 GCP PubSub 到 MQTT 主题映射必须包含唯一的 GCP PubSub 主题名称。即 GCP PubSub 主题不能在多个映射中存在。

   • 其他选项保持默认设置。

6. 设置完成后，您可点击测试连接按钮进行验证。

7. 点击创建按钮完成数据桥接创建。

至此您已经完成数据桥接创建流程，接下来将继续创建一条规则来指定需要写入的数据。

创建数据转发规则

1. 转到 Dashboard 数据集成 -> 规则页面。
2. 点击页面右上角的创建。
3. 输入规则 ID，例如： my_rule。
4. 在 SQL 编辑器中输入规则，请确保规则选择出来的字段（SELECT 部分）包含 HTTP 请求消息体模版中用到的变量。例如将 /devices/+/events 主题的 MQTT 消息集成到 GCP PubSub，此处规则 SQL 如下：

SELECT
  *
FROM
  "/devices/+/events"

5. 添加动作，在动作下拉框中选择 使用数据桥接转发 选项，选择先前创建好的 GCP PubSub 数据桥接。

6. 点击最下方创建按钮完成规则创建。

至此您已经完成整个创建过程，可以前往 数据集成 -> Flows 页面查看拓扑图，此时应当看到 /devices/+/events 主题的消息经过名为 my_rule 的规则处理，处理结果写入到 GCP PubSub 中。

测试数据桥接与规则

1. 使用 MQTTX 向 /devices/+/events 主题发布消息：

mqttx pub -i emqx_c -t /devices/+/events -m '{ "msg": "hello GCP PubSub" }'

2. 查看数据桥接运行统计，命中、发送成功次数均 +1。

3. 前往 GCP PubSub 控制台查看数据是否已经发送成功。