Skip to content

Commit

Permalink
update(dashboard): Update screenshots and descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
Meggielqk committed Nov 6, 2024
1 parent bc08340 commit 00f34c6
Show file tree
Hide file tree
Showing 16 changed files with 45 additions and 59 deletions.
Binary file added en_US/dashboard/assets/connection_chart.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 added en_US/dashboard/assets/dashboard_preview.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 added en_US/dashboard/assets/message_rate.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 added en_US/dashboard/assets/messages_chart.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 added en_US/dashboard/assets/node_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/nodes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 21 additions & 15 deletions en_US/dashboard/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,61 +12,67 @@ This page provides an overview of the data for the entire EMQX cluster in operat

### Message Rate

Messages are the key data in EMQX. Messages are the data content being transmitted by all MQTT clients or real devices connected to EMQX. Clients or devices send or receive messages through topics as a way to complete data communication between them.
In EMQX, messages represent the key data transmitted by all connected MQTT clients or real devices. Clients or devices send and receive messages through topics, enabling data communication between them.

The card in the upper left corner of this overview page provides a clearer and easier way to monitor the rate changes in the current volume of messages incoming and outgoing in the system (message rate is measured in how many messages per second) by visualizing the rate spectrum with real-time rate values.

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

### Connections and Subscriptions

As an MQTT broker, the number of connections and topics subscribed to EMQX is one of the most important metrics to observe. The connections are the number of MQTT clients or real devices currently connected to EMQX, the number of subscriptions is the total number of topics currently subscribed to in each client, and topics are the unique subscriptions.

In the tab on the top right of the overview page, we can quickly see the number of connections, subscriptions, and topics in the cluster. The statistics in the card will be updated in real-time when a connection or a subscription topic is updated.
In the card on the top right of the overview page, you can quickly see the number of connections, subscriptions, and topics in the cluster. The statistics in the card will be updated in real-time when a connection or a subscription topic is updated.

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

::: tip

Subscriptions are differentiated by client, while topics are unique subscriptions and the same topic may be included in different clients.

:::

In addition to providing real-time statistics, the bottom of the page also provides a visual chart that allows you to view historical and current changes in the number of connections and subscriptions by time (the time format: YYYY/MM/DD HH:mm), which allows you to monitor the trend of the number of connections and subscriptions within the entire EMQX cluster more clearly and intuitively. Hovering over the chart and clicking the icon in the top right corner allows you to enlarge the chart.

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

### Messages

The number of messages is the statistics of the number of data transferred between clients or devices, and on the page includes the incomming, outgoing and dropped messages.

In the chart at the bottom of the page, you can see a visual chart of the number of messages, and view the historical and current number of messages by time change (the time format: YYYY/MM/DD HH:mm), which allows users to better monitor dynamically the real-time changes of all messages within the current EMQX cluster. Hovering over the chart and clicking the icon in the top right corner allows you to enlarge the chart.
In the lower part of the overview page, you can see a visual chart of the number of messages, and view the historical and current number of messages by time change (the time format: YYYY/MM/DD HH:mm), which allows users to better monitor dynamically the real-time changes of all messages within the current EMQX cluster. Hovering over the chart and clicking the icon in the top right corner allows you to enlarge the chart.

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

::: tip
In the above, all charts over time are available in the top left corner: statistics for the last 1 hour, last 6 hours, last 12 hours, last 1 day, last 3 days and last 7 days

All of the above time-varying charts can be viewed by selecting the time range in the upper left corner: statistics are available for data changes over the past 1 hour, past 6 hours, past 12 hours, past 1 day, past 3 days, and past 7 days.

:::

## Nodes

EMQX, the most scalable MQTT broker for IoT, cluster deployment is supported, and each EMQX in a cluster is a node.
EMQX, the most scalable MQTT broker for IoT, supports cluster deployment, where each EMQX instance within the cluster functions as a node.

### Node Data

You can monitor the whole EMQX cluster by the card in the middle of the overview page, including the topology diagram to visualize the association and distribution of all nodes in the cluster.
You can monitor the whole EMQX cluster by the card in the middle of the overview page, including a topology diagram to visualize the association and distribution of all nodes in the cluster.

Click on a single node in the topology diagram to view the basic information and operation status of the current node, including the node name and role, the number of connections, subscriptions and topics, the current EMQX version (click on the version number to view the change logs of the version, so as to quickly understand the content updates of the current version), and you can also view the CPU load and memory usage of the OS where the node is deployed (memory can only be showed in nodes deployed to Linux).
Hover over a node in the topology diagram to view its basic information and operation status. This includes the node name, node role, number of connections, subscriptions, and topics, as well as the current EMQX version. Clicking on the version number opens the changelog for a quick overview of updates in the current version. Additionally, you can view the CPU load and memory usage of the operating system on which the node is deployed (memory metrics are only available for nodes deployed on Linux).

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

::: tip
When the green node in the topology diagram turns gray, it means that the node is currently stopped

If a node in the topology diagram turns gray, it indicates that the node is currently stopped.

:::

### Node List

Clicking **View Nodes** in the Node Information section allows access to the Nodes page, or you can click the **Nodes** tab at the top to access it. The Nodes page lists all nodes currently in the EMQX cluster, providing a quick overview of each node's name, operational status, uptime, version information, Erlang process count, memory usage, CPU load, and other details. Clicking the **Refresh** button in the top right corner enables real-time updates of the latest information in the current node list.
Clicking **View Nodes** at the upper right corner of the node card or selecting the **Nodes** tab at the top navigates to the Nodes page. This page lists all nodes currently in the EMQX cluster, offering a quick view of each node's name, status, uptime, version, connections, Erlang process count, memory usage, CPU load, and other key metrics. Clicking the **Refresh** button in the top right corner updates the list with the latest node information in real time.

![image](./assets/nodes.png)
![image](./assets/node_list.png)

### Node Details

Expand Down
40 changes: 7 additions & 33 deletions en_US/dashboard/introduction.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# EMQX Dashboard

EMQX provides a built-in Dashboard management console for users to monitor and manage EMQX clusters and configure the required features via web pages. The new Dashboard comes with a fresh new design and provides the most easy-to-use MQTT broker management UI.
EMQX provides a built-in Dashboard management console for users to monitor and manage EMQX clusters and configure the required features via web pages. The new Dashboard comes with a fresh new design and provides the easy-to-use MQTT broker management UI.

The new UI / UX design of EMQX Dashboard optimizes the display and content of key data and metrics, enhancing the visual experience while providing more comprehensive, powerful and easy-to-use built-in features, such as authentication and permission management for connection, subscription and publishing, support for data integration transformation using data bridging and with the rules engine, etc. Quick and easy access using the browser provides users with the convenience of using EMQX for more IoT business development.

![image](./assets/dashboard-preview.png)
![image](./assets/dashboard_preview.png)

## Key Features
## Main Features

This section introduces various features of EMQX that you can configure and manage through the Dashboard.

### [Monitoring](./monitoring.md)

View overall information of the running EMQX cluster, including connection count, subscribed topics, message delivery counts, inbound rates, and outbound rates. It also includes node lists, node information, and various system metric information. Additionally, you can view and manage client connections and subscription data.

### Access Control
### [Access Control](./acloverview.md)

Add and configure authentication and authorization mechanisms in EMQX visually.

### Integration
### [Integration](./bridgeoverview.md)

Utilize a powerful SQL-based rule engine and data integration, or the Flow editor's visual capabilities, for low-code data processing and integration. This helps in real-time extraction, filtering, enrichment, transformation, storage, and validation of MQTT data.

Expand All @@ -44,32 +44,6 @@ In addition to debugging through online MQTT over WebSocket client connections a

Manage and configure user accounts, audit logs, API keys, license settings, and single sign-on functionalities.

## Main Features

### Monitor and manage data in EMQX clusters

It supports viewing the number of connections, subscription topics, messages sent and received, and incoming and outgoing rates of the running EMQX cluster, including node list and information and some metrics data, as well as viewing and managing some client connection and subscription data.

### Access control (authentication and authorization) management

Supports visualization to add and configure authentication and authorization mechanisms in EMQX.

### Data integration

Low-code data processing and integration using a powerful SQL-based Rule Engine and Data Bridge or the visualization capabilities of the Flow Editor to help extract, filter, enrich, transform and store MQTT data in real-time.

### Online config update

Supports online modification and update of configuration including MQTT, logs, listeners, etc., with immediate effect after successful update.

### Gateway/Extension management

Support for custom plug-in integration, Extend EMQX connectivity protocols through built-in gateway management and configuration or use Hooks to modify or extend system functionality by intercepting function calls, message passing and event passing between modules.

### More powerful diagnosis tools

In addition to debugging through online MQTT over WebSocket client connections and publishing subscriptions, we also support diagnosing and finding issues using things like slow subscriptions and online logs tracing and alarms.

## Launch Dashboard

EMQX Dashboard is a web application that listens to port `18083` by default. After installing EMQX successfully, you can access and use the EMQX Dashboard by opening <http://localhost:18083/> (replace localhost with the actual IP address if deployed on a non-local machine) through your browser.
Expand All @@ -80,11 +54,11 @@ EMQX can still be used normally without Dashboard enabled, Dashboard just provid

### First Login

For users who have installed EMQX for the first time, you can use the default username `admin` and default password `public` to login web page after opening the Dashboard in your browser.
For users who have installed EMQX for the first time, you can use the default username `admin` and default password `public` to log in web page after opening the Dashboard in your browser.

After logging in for the first time, the system will automatically detect that you are logging in with the default username and password, and will force you to change the default password, which is good for the security of accessing Dashboard, note that the changed password cannot be the same as the original password, and it is not recommended to use `public` as the login password again.

### Reset password
### Reset Password

You can reset your Dashboard login password via the `admins` command. For details, see [CLI - admins](../admin/cli.md#admins).

Expand Down
Binary file added zh_CN/dashboard/assets/connection_statistic.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 added zh_CN/dashboard/assets/message_rate.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 added zh_CN/dashboard/assets/messages.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 added zh_CN/dashboard/assets/node_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/nodes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 17 additions & 11 deletions zh_CN/dashboard/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,38 +12,42 @@

### 消息速率

了解完集群内的连接数和订阅主题数后,消息数据也是 EMQX 的一大关键指标数据。消息是指当前所有的 MQTT 客户端或真实设备连接到 EMQX 后所传输的数据内容,客户端或设备通过主题来发送或接收消息,以此来完成它们之间的数据通信。
消息数据是 EMQX 的一大关键指标数据。消息是指当前所有的 MQTT 客户端或真实设备连接到 EMQX 后所传输的数据内容,客户端或设备通过主题来发送或接收消息,以此来完成它们之间的数据通信。

在该概览页面左上角的卡片内,通过可视化的速率频谱图与实时的速率值展示,可以更加清晰和方便的监控当前系统内发送和接收消息量的速率变化(消息速率的统计单位为每秒多少条消息)。
在概览页面左上角的卡片内,通过可视化的速率频谱图与实时的速率值展示,可以更加清晰和方便的监控当前系统内发送和接收消息量的速率变化(消息速率的统计单位为每秒多少条消息)。

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

### 连接数和订阅主题数

EMQX 作为一款 MQTT 服务器,其连接数和订阅主题数是整个系统中最为重要的观测数据指标之一。连接数是指当前 MQTT 客户端或真实设备连接到 EMQX 的数量,订阅是当前每个客户端中订阅主题的总数,而主题数是当前存在于 EMQX 集群内,所有客户端订阅过的主题总数。

在概览页面的右上方的卡片里,我们可以快速的查看到整个集群内的所有的连接数,订阅数和主题数。当有连接或订阅主题更新时,卡片内的统计数据将会实时的更新。

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

::: tip

订阅是按客户端区分的,而主题是唯一的订阅,同一主题可能包含在不同的客户端中。

:::

除提供直观的实时数字统计的显示外,在该页面的底部还提供了可视化图表的展示,可以通过时间变化来查看历史和当前的连接、订阅主题数的变化(时间单位精确到年月日时分),从而可以更好的帮助用户能够更加清晰直观的监控到整个 EMQX 集群内连接和订阅主题数的变化趋势。将鼠标移动到图表右上角可以通过点击图标来放大图表。

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

### 消息数

而消息数是指客户端或设备之间传输数据的条数统计,页面中所展示的消息数包含:消息流入、消息发出和消息丢弃的数量统计
消息数是指客户端或设备之间传输数据的条数统计,页面中所展示的消息数包含:消息流入、消息流出和消息丢弃的数量统计

在页面底部图表中,可以看到消息数量的可视化图表,通过时间变化来查看历史和当前的消息数(时间单位精确到年月日时分),用户通过图表能更好的动态监测到当前 EMQX 集群内,所有消息数量的实时变化。将鼠标移动到图表右上角可以通过点击图标来放大图表。

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

::: tip

上述所有随时间变化的图表都可以在左上角选择查看:过去 1 小时、过去 6 小时、过去 12 时、过去 1 天、过去 3 天和过去 7 天的数据变化统计。

:::

## 节点
Expand All @@ -54,17 +58,19 @@ EMQX 作为一款大规模分布式物联网 MQTT 消息服务器,支持集群

在概览页面中部可以查看到整个 EMQX 集群节点的概况,包括可视化展示集群内所有节点的关联与分布的拓扑图。点击拓扑图中的单个节点,可以查看到当前节点的基础信息、运行状况,包括了节点名称、角色,当前单个节点上连接数、订阅数和主题数,当前节点上的 EMQX 版本(点击版本号可以查看当前版本的发布信息,以此来快速了解当前版本的内容更新),同时还可以查看到部署了该节点的操作系统的 CPU 负载与内存使用量等基础信息(内存仅支持在部署到 Linux 系统上的节点中查看)。

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

::: tip
当拓扑图中的绿色节点变为灰色的时候,表示该节点目前处于停止的状态。

当拓扑图中的节点变为灰色的时候,表示该节点目前处于停止的状态。

:::

### 节点列表

在节点信息区域点击最右侧的**查看节点列表**可以访问节点列表页面,您也可以点击顶部的**节点**页签访问。节点列表页面列出了当前 EMQX 集群内所有的节点,可以简单查看到每一个节点的节点名称,运行状态、时长,版本信息,Erlang 进程占用数,内存使用量和 CPU 负载等信息,点击右上角的**刷新**按钮,可以实时的查看当前节点列表的最新信息。
在节点信息区域点击最右侧的**查看节点列表**可以访问节点列表页面,您也可以点击顶部的**节点**页签访问。节点列表页面列出了当前 EMQX 集群内所有的节点,可以简单查看到每一个节点的节点名称,运行状态、时长,版本信息,客户端连接数,Erlang 进程占用数,内存使用量和 CPU 负载等信息,点击右上角的**刷新**按钮,可以实时的查看当前节点列表的最新信息。

![image](./assets/nodes.png)
![image](./assets/node_list.png)

### 节点详情

Expand Down

0 comments on commit 00f34c6

Please sign in to comment.