Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 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
Binary file modified en_US/access-control/assets/flapping-detect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 6 additions & 7 deletions en_US/access-control/flapping-detect.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@ This feature is disabled by default, and you can enable it via EMQX Dashboard or

## Enable Flapping Detect on Dashboard

Go to Dashboard, and click **Access Control** -> **Flapping Detect** from the left navigation menu to enter the **Flapping Detect** page. Enable the flapping detection feature by clicking the toggle switch.

- **Detection Time Window**: You can specify the duration for which the system monitors the client's flapping behavior. The default value is `1` minute.
- **Max Disconnection Count**: You can specify the maximum number of disconnections allowed for an MQTT client during the detection window time. It allows you to set precise criteria for identifying and responding to clients exhibiting flapping behavior. The default number is `15`.
- **Ban Duration**: You can specify for how long the client should be banned. The default value is `5` minutes.

Click **Save Changes** to finish the setting.
1. Go to Dashboard, and click **Access Control** -> **Flapping Detect** from the left navigation menu to enter the **Flapping Detect** page.
2. Enable the flapping detection feature by clicking the toggle switch.
- **Detection Time Window**: You can specify the duration for which the system monitors the client's flapping behavior. The default value is `1` minute.
- **Max Disconnection Count**: You can specify the maximum number of disconnections allowed for an MQTT client during the detection window time. It allows you to set precise criteria for identifying and responding to clients exhibiting flapping behavior. The default number is `15`.
- **Ban Duration**: You can specify for how long the client should be banned. The default value is `5` minutes.
3. Click **Save Changes** to finish the setting.

<img src="./assets/flapping-detect.png" alt="flapping-detect" style="zoom:67%;" />

Expand Down
Binary file modified en_US/dashboard/assets/rule-list.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 en_US/dashboard/assets/rule-overview.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 en_US/dashboard/assets/rule-settings.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 en_US/dashboard/assets/web-socket.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion en_US/dashboard/diagnose.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Information on currently supported alarms and more details can be found in [alar

## WebSocket Client

Click on **WebSocket Client** under the **Diagnose** menu on the left to go to the WebSocket Client page. The WebSocket Client page provides a simple but effective MQTT testing tool that includes connect, subscribe and publish functionality for quick debugging of the client's connect, publish and subscribe functionality, as well as the ability to view your own sent and received message data. Multiple WebSocket connections can be added by clicking the `+` button at the top of the page; the connection status and sent and received data for all connections will be cleared when the page is refreshed.
Click on **WebSocket Client** under the **Diagnose** menu on the left to go to the WebSocket Client page. The WebSocket Client page provides a simple but effective MQTT testing tool that includes connect, subscribe, and publish functionality for quick debugging of the client's connect, publish, and subscribe functionality, as well as the ability to view your own sent and received message data. Multiple WebSocket connections can be added by clicking the **+** button at the top of the page; the connection status and sent and received data for all connections will be cleared when the page is refreshed.

<img src="./assets/web-socket.png" alt="image" style="zoom:67%;" />

Expand Down
4 changes: 2 additions & 2 deletions en_US/dashboard/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,12 @@ The top of the list contains a search bar, we can use rule ID, topic, enabled st

## Rule Execution Statistics

On the rule list page, click the rule ID to quickly enter the rule overview page. The rule overview page contains the basic data statistics of the rule, including the execution statistics of the rule and the execution statistics of the action under the current rule. For example, the number of matched, passed, and failed, the execution rate of the rule, successful and failed executions of the action, etc. Click the `Refresh` button in the upper right corner to view the real-time running data statistics of the current rule.
On the rule list page, click the rule ID to quickly enter the rule overview page. The rule overview page contains the basic data statistics of the rule, including the execution statistics of the rule and the execution statistics of the action under the current rule. For example, the number of matched, passed, and failed, the execution rate of the rule, successful and failed executions of the action, etc. Click the **Refresh** button in the upper-right corner to view the real-time running data statistics of the current rule.

![image](./assets/rule-overview.png)

## Settings

By clicking the **Settings** tab or the **Settings** button in the **Action** colum in the rule list you can enter the Settings page. It contains the basic information of the rule, which displays the same as the rule creation page. On this page, you can modify and debug the rule. For example, you need to modify the execution action under the current rule, modify the rule notes, and re-edit the SQL statement.
By clicking the **Settings** tab or the **Settings** button in the **Action** column in the rule list, you can enter the Settings page. It contains the basic information of the rule, which is the same as the rule creation page. On this page, you can modify and debug the rule. For example, you need to modify the execution action under the current rule, modify the rule notes, and re-edit the SQL statement.

![image](./assets/rule-settings.png)
Binary file modified en_US/durability/assets/session-persistence-list.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 en_US/file-transfer/assets/file-transfer-enable.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 en_US/messaging/assets/config-auto-subscribe-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 en_US/messaging/assets/retained-messages.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 en_US/messaging/mqtt-delayed-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,15 @@ Example:

## Configure Delayed Publish via Dashboard

1. Open EMQX Dashboard. In the left navigation menu, click **Management**-> **Delayed Publish**.
1. Open EMQX Dashboard. In the left navigation menu, click **Management** -> **Delayed Publish**.

2. On the **Delayed Publish** page, you can configure as follows:

- **Enable**: Enable or disable delayed publish. By default, it is enabled.
- **Max Delayed Messages**: You can specify the max number of delayed messages.

<img src="./assets/configure-delayed-publish-dashboard.png" alt="configure-delayed-publish-dashboard" style="zoom:45%;" />

<img src="./assets/configure-delayed-publish-dashboard.png" alt="configure-delayed-publish-dashboard" style="zoom:45%;" />

## Try Delayed Publish with MQTTX Desktop

Expand Down
Binary file modified en_US/network/assets/edit-listener.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 en_US/observability/assets/topic-metrics-ee.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion en_US/observability/topic-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Topic Metrics feature is only available in the EMQX Enterprise edition.

:::

The Topic Metrics feature in EMQX provides detailed statistics for a given topic, including the number of messages sent and received, message rate, and other relevant metrics. To access this feature, navigate to **Diagnose** -> **Topic Metrics** on the EMQX Dashboard. Alternatively, you can retrieve topic metrics through the REST API.
The Topic Metrics feature in EMQX provides detailed statistics for a given topic, including the number of messages sent and received, message rate, and other relevant metrics. To access this feature, navigate to **Diagnostics Tools** -> **Topic Metrics** on the EMQX Dashboard. Alternatively, you can retrieve topic metrics through the REST API.

## View Topic Metrics on Dashboard

Expand Down
Binary file modified zh_CN/access-control/assets/flapping_detect_ee.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 6 additions & 7 deletions zh_CN/access-control/flapping-detect.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@

## 通过 Dashboard 开启

前往 Dashboard,从左侧导航菜单点击**访问控制** -> **连接抖动** 进入**连接抖动**页面。通过点击切换按钮启用抖动检测功能。

- **检测时间窗口**:您可以指定系统监视客户端抖动行为的持续时间。默认值为 `1` 分钟。
- **最大断连次数**:您可以指定在检测窗口时间内允许的 MQTT 客户端的最大断开连接次数。它允许您设定准确的标准来识别和响应表现出抖动行为的客户端。默认值为 `15`。
- **封禁时长**:您可以指定客户端被封禁的时间长度。默认值为 `5` 分钟。

点击**保存更改**以完成设置。
1. 前往 Dashboard,从左侧导航菜单点击**访问控制** -> **连接抖动**进入**连接抖动**页面。
2. 通过点击切换按钮启用抖动检测功能并配置以下参数:
- **检测时间窗口**:您可以指定系统监视客户端抖动行为的持续时间。默认值为 `1` 分钟。
- **最大断连次数**:您可以指定在检测窗口时间内允许的 MQTT 客户端的最大断开连接次数。它允许您设定准确的标准来识别和响应表现出抖动行为的客户端。默认值为 `15`。
- **封禁时长**:您可以指定客户端被封禁的时间长度。默认值为 `5` 分钟。
3. 点击**保存更改**以完成设置。

<img src="./assets/flapping_detect_ee.png" alt="flapping_detect_ee" style="zoom:67%;" />

Expand Down
Binary file modified zh_CN/dashboard/assets/rule-list.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/dashboard/assets/rule-overview.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/dashboard/assets/rule-settings.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/dashboard/connections/assets/connection-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions zh_CN/dashboard/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,12 @@ SQL 语句默认为 `SELECT * FROM "t/#"`,其含义为当客户端向 `t/#`

## 规则概览

在规则列表页面,点击规则 ID,可以快速进入规则的概览页面,规则概览页面包含了规则的基本数据统计包括:规则的运行时的统计,当前规则下动作的执行统计。例如规则的命中数,命中并通过的数量,规则的执行速率,失败数,执行动作成功和失败数等。点击右上角的 `刷新` 可以实时的查看当前规则的运行数据统计
在规则列表页面,点击规则 ID,可以快速进入规则的概览页面,规则概览页面包含了规则的基本数据统计包括:规则的运行时的统计,当前规则下动作的执行统计。例如规则的命中数,命中并通过的数量,规则的执行速率,失败数,执行动作成功和失败数等。点击右上角的**刷新**图标可以实时的查看当前规则的运行数据统计

![image](./assets/rule-overview.png)

## 规则设置

点击操作栏设置,可以进入到规则的设置页面,规则设置页面包含了规则的基本信息,设置页面可以进行规则的修改和调试,与创建页面相同。例如需要修改当前规则下的执行动作,修改规则的备注,重新编辑 SQL 语句等。
点击**设置**标签,可以进入到规则的设置页面,规则设置页面包含了规则的基本信息,设置页面可以进行规则的修改和调试,与创建页面相同。例如需要修改当前规则下的执行动作,修改规则的备注,重新编辑 SQL 语句等。

![image](./assets/rule-settings.png)
Binary file modified zh_CN/data-integration/assets/choose-connector-type.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/data-integration/assets/config-connector.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/data-integration/assets/rule-test-result.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/data-integration/assets/test-sql.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/data-integration/assets/webhook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 5 additions & 3 deletions zh_CN/data-integration/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@ EMQX 连接器是数据集成的关键概念,它作为 Sink/Source 的底层

3. 在连接器类型选择页面,选择所需的连接器,点击**下一步**填写连接参数。支持的连接器参考[此处](./data-bridges.md#支持的集成)。

:::tip
在 EMQX 开源版中,仅支持 HTTP 与 MQTT 连接器。
::: tip

在 EMQX 开源版中,仅支持 HTTP 与 MQTT 连接器。

:::

![EMQX 选择连接器](./assets/choose-connector-type.png)

4. 在连接器配置信息页面,填写连接器的基本信息,包括连接器名称、描述,以及连接器的连接参数,此处内容请参考各个 Sink/Source 使用文档中的连接器参数部分,不在此处赘述。
Expand Down
Binary file modified zh_CN/durability/assets/session-persistence-list.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/file-transfer/assets/file-transfer-enable.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/messaging/assets/auto-sub-dashboard.png
Binary file modified zh_CN/messaging/assets/auto-sub-emqx_c.png
Binary file modified zh_CN/messaging/assets/delay-publish-dashboard.png
Binary file modified zh_CN/messaging/assets/retained-messages-dashboard.png
3 changes: 2 additions & 1 deletion zh_CN/messaging/mqtt-delayed-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ $delayed/{DelayInterval}/{TopicName}
- **启用**: 启用或禁用延迟发布。默认情况下,已启用。
- **最大延迟消息数**:可以指定延迟消息的最大数量。

<img src="./assets/delay-publish-dashboard.png" alt="delay-publish-dashboard" style="zoom:50%;" />

<img src="./assets/delay-publish-dashboard.png" alt="delay-publish-dashboard" style="zoom:45%;" />

## 使用 MQTTX Desktop 尝试延迟发布

Expand Down
Binary file modified zh_CN/network/assets/edit-listener.png
Binary file modified zh_CN/observability/assets/topic-metrics.png