Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update zh docs for v5.2.0 updates in v5 #615

Merged
merged 1 commit into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en_US/data_integration/republish.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Configuring the message republishing feature through data integration does not r
3. Configure the **MQTT 5.0 Message Properties** options (optional) by clicking the toggle switch. For more information on these options, see [Add Republish Action](https://docs.emqx.com/en/emqx/latest/data-integration/rule-get-started.html#add-republish-action).
4. If you need to enable the **Direct Dispatch**, click the toggle switch. Once enabled, the message is dispatched directly to subscribers. It helps prevent the triggering of additional rules or the recursive activation of the same rule.
5. Click **Confirm** to complete the action and rule creation.
6. In the **Successful new rule** pop-up, click **Back to Rules**, thus completing the entire data integration configuration chain.
6. In the **Successful new rule** pop-up, click **Back to Rules**, and test the rule according to the instructions in [Test Message Republish](#test-message-republish). Alternatively, you can click **Test Rules** and input simulated data on the page to test the rule. For details, see [Test Rules](#test-rules).

## Test Message Republish

Expand Down
3 changes: 2 additions & 1 deletion zh_CN/data_integration/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,11 +209,12 @@ Apache Kafka 数据集成是 EMQX Platform 的开箱即用功能,能够在基
- 选择 Kafka 消费者连接器
- **Kafka 主题名称**:输入需要从 Kafka 消费的主题,如 `temp_hum/emqx`
- **Key 编码模式** 和 **Value 编码模式**:选择 Kafka 消息键和消息值的编码模式。
- **消费组 ID**:指定此 Source 的消费组标识符。如果未提供,系统将基于 Source 名称自动生成一个组 ID。该字段只能包含字母、数字、下划线、点和连字符。
- **偏移重置策略**:选择当没有消费者偏移量或偏移量变得无效时,Kafka 消费者开始从 Kafka 主题分区读取的偏移量重置策略。
- 如果您希望消费者从最新偏移量开始读取消息,跳过消费者启动前产生的消息,请选择 `latest`。
- 如果您希望消费者从分区的开始读取消息,包括消费者启动前产生的消息,即读取主题中的所有历史数据,请选择 `earliest`。
- 点击**确认**按钮完成配置。

3. SQL 编辑器中将更新数据源字段,同时可以在 `SELECT` 中选取字段用于数据转发。

```sql
Expand Down
9 changes: 6 additions & 3 deletions zh_CN/data_integration/republish.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,13 @@
2. 在**创建动作**步骤页中,配置以下信息:
- **使用连接器**:使用默认选项`消息重新发布`。
- **主题**:设置目标主题为 `greet`。
- **QoS** 和 **Retain**: 使用默认值。
- **Payload**:在消息内容模板里填写 `${msg} -- forward from EMQX Cloud`。
- 关于 **MQTT 5.0 消息属性**的选项,详见[添加重新发布动作](#添加重新发布动作)。
3. 点击**确定**完成配置。
- **QoS** 和 **Retain**: 使用默认值。

3. 关于 **MQTT 5.0 消息属性**的选项,详见[添加重新发布动作](https://docs.emqx.com/zh/emqx/latest/data-integration/rule-get-started.html#%E6%B7%BB%E5%8A%A0%E6%B6%88%E6%81%AF%E9%87%8D%E5%8F%91%E5%B8%83%E5%8A%A8%E4%BD%9C)。
4. 如果您需要启用**直接派发**,请点击切换开关。启用后,消息将直接派发给订阅者。这有助于防止触发额外的规则或重复激活相同的规则。
5. 点击**确定**完成配置。
6. 在**成功创建规则**对话框中点击**返回规则列表**,然后参考[测试消息重发布](#测试消息重发布)中的步骤测试规则。或者,您也可以点击**测试规则**,在页面中数据测试数据进行规则测试,详见[测试规则](#测试规则)。


## 测试消息重发布
Expand Down
Binary file modified zh_CN/deployments/_assets/auth_management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zh_CN/deployments/_assets/metric_serverless_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zh_CN/deployments/_assets/retain_msg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zh_CN/deployments/_assets/retain_payload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions zh_CN/deployments/custom_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
## 扩展认证数据源

[HTTP 认证](./http_auth.md)

[MySQL 认证](./mysql_auth.md)

[PostgreSQL 认证](./pgsql_auth.md)

[Redis 认证](./redis_auth.md)
Expand All @@ -26,5 +26,6 @@
- 认证失败,终止认证链并禁止客户端接入
- 当前数据源未能匹配,将进入下一个认证源进行认证
自定义认证链:可拖动认证数据源的图标,左右排列进行认证顺序的编排。

![auth_management](./_assets/auth_management.png)

3 changes: 2 additions & 1 deletion zh_CN/deployments/http_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,11 @@ Body:
- **请求超时**(可选):填入连接超时等待时长,单位:秒。

- **请求体**:请求模板,对于 `POST` 请求,它以 JSON 形式在请求体中发送。对于 `GET` 请求,它被编码为 URL 中的查询参数(Query String)。映射键和值可以使用占位符。请求体支持以下占位符:

- `${clientid}`: 将在运行时被替换为客户端 ID。客户端 ID 一般由客户端在 `CONNECT` 报文中显式指定。
- `${username}`: 将在运行时被替换为用户名。用户名来自 `CONNECT` 报文中的 `Username` 字段。
- `${password}`: 将在运行时被替换为密码。密码来自 `CONNECT` 报文中的 `Password` 字段。
- `${client_attrs.<attribute>}`: 客户端属性。`<attribute>` 会在运行时根据预定义的配置被替换为具体的属性名称。



5 changes: 3 additions & 2 deletions zh_CN/deployments/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ Serverless 部署的时间轴指标页面提供了连接数、流入流出消息

#### 消息流入流出
消息流入流出图表展示在选择的时间段内,部署接收到的消息数、发送出去的消息数和未被订阅的消息数。
- 部署接收到的消息为从设备或应用端发送到部署的消息数。
- 部署发送的消息为从部署发送到设备或应用端的消息。
- 部署接收到的消息数:从设备或应用端发送到部署的消息数。
- 部署发送的消息数:从部署发送到设备或应用端的消息数。
- 未订阅消息数:由于主题未被订阅而导致被丢弃的消息数。

<img src="./_assets/metric_serverless_3.png" alt="metrics_detail" style="zoom: 33%;" />

Expand Down
1 change: 1 addition & 0 deletions zh_CN/deployments/redis_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,4 @@ pbkdf2, sha256, 1000, 20
- `${clientid}`: 将在运行时被替换为客户端 ID。客户端 ID 一般由客户端在 `CONNECT` 报文中显式指定。
- `${username}`: 将在运行时被替换为用户名。用户名来自 `CONNECT` 报文中的 `Username` 字段。
- `${password}`: 将在运行时被替换为密码。密码来自 `CONNECT` 报文中的 `Password` 字段。
- `${client_attrs.<attribute>}`:客户端属性。`<attribute>` 会在运行时根据预定义的配置被替换为具体的属性名称。
42 changes: 32 additions & 10 deletions zh_CN/deployments/retain_message.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,52 @@
# 保留消息

点击左侧导航菜单中的**监控** -> **保留消息**,可以进入保留消息页面。在该页面可以查看当前系统中所有的保留消息。

当用户发布了一条保留消息时,部署会将这条消息保存在系统中,用户可以在当前保留消息列表页面查看到这条消息。当用户订阅了这条保留消息的主题时,部署会将这条消息发送给用户。保留消息的有效期默认为永不过期,除非用户手动删除这条消息。

点击左侧导航菜单中的**监控** -> **保留消息**,可以进入保留消息页面。在该页面可以查看当前系统中所有的保留消息。


## 保留消息列表
保留消息列表呈现当前系统中所有的保留消息。列表内包含了保留消息的主题、保留消息的质量等级 QoS、发布保留消息的时间、还有发布该保留消息的客户端 ID。在列表中,您还可以点击查看 Payload 和删除按钮来查看保留消息的 payload 和删除一条保留消息。点击列表右上角的刷新按钮可以刷新当前保留消息列表。
保留消息列表呈现当前系统中所有的保留消息。列表内包含了保留消息的主题、保留消息的质量等级 QoS、发布保留消息的时间、还有发布该保留消息的客户端 ID。

点击列表右上角的刷新按钮可以刷新当前保留消息列表。

![retain](./_assets/retain_msg.png)

## 搜索保留消息

当列表中有大量保留消息时,您可以通过主题筛选保留消息,以显示您想要查看的保留消息。您可以在搜索框中输入特定的主题名称,或使用通配符进行搜索。

::: tip 提示

Serverless 部署不支持搜索功能。

:::

### 查看 Payload
可查看保留消息的 Payload,可以在保留消息的列表页中点击操作列中的查看按钮来查看保留消息的 Payload。

在 Payload 弹窗中可以查看保留消息的具体的 Payload 内容。可以点击复制按钮来快速复制保留消息的 Payload。在左下角的下拉框中还可以对 Payload 进行格式化输出,这对于一些特殊的 Payload 格式,如 JSON 或 Hex 格式的,可以更加直观地查看。
您可以查看保留消息的 payload。在列表中,点击保留消息条目**操作**列中的查看 payload 图标,即可查看消息 payload。

在**查看 Payload** 弹出窗口中,您可以查看保留消息 payload 的具体内容。您可以点击复制按钮快速复制 payload。在下拉框中,您还可以选择 payload 的格式化输出,这样可以更直观地查看一些特殊的 payload 格式,例如 JSON 或 Hex 格式。

<img src="./_assets/retain_payload.png" alt="retain" style="zoom:67%;" />

### 删除保留消息

通常有以下几种方式删除保留消息:
1. 保留消息的主题发布一条空消息。
2. 点击保留消息操作选项中的删除按钮。
3. 点击右上角清除按钮,可清除部署中全部保留消息。
您可以通过以下方式删除保留消息:

1. 在保留消息的主题上发布一条空消息。

2. 点击**操作**列中的删除图标,删除单条保留消息条目。

3. 点击右上角的删除图标,删除列表中的所有保留消息。

::: tip 提示

Serverless 部署不支持删除所有保留消息的功能。

:::

::: tip
保留消息的大小及存储条目限制请查看[配额和限制](../create/restriction.md)。
关于保留消息的大小及存储条目限制,请查看[配额和限制](../create/restriction.md)。
:::