EMQ X Dashboard¶
EMQ X Dashboard 介绍¶
EMQ X Dashboard（EMQ X 管理控制台，以下简称 Dashboard) 是 EMQ X 提供的一个后端 Web 控制台，用户可通过 Web 控制台查看服务器节点和集群的运行状态、统计指标，客户端的在线情况和订阅关系等信息，并进行插件配置与停启，HTTP API 密钥管理，EMQ X 集群的热配置管理和 MQTT 连接测试等操作。
基本使用¶
如果 EMQ X 安装在本机，则使用浏览器打开地址 http://127.0.0.1:18083
，如需登录输入默认用户名 admin 与默认密码 public ，登录进入
Dashboard。如果忘记管理用户账号信息，点击登录页面忘记密码按钮按指引操作或使用管理命令重置或新建管理账号。
Dashboard 界面如下图所示，包含左侧导航栏、顶部控制栏和中间内容区，三个功能分别是：
- 告警信息：EMQ X 告警信息，由资源使用过高、EMQ X 内部错误触发显示告警数量，点击可查看告警列表；
- 用户信息：当前登录 Dashboard 用户名，可进行登出、修改密码等操作；
- 多语言切换：Dashboard 根据用户浏览器语言默认显示中/英文，点击可进行语言切换。
监控¶
监控页面可查看 EMQ X 当前集群的运行指标，界面从上到下功能区如下：
集群运行指标¶
页面顶部四个指标卡片，包含集群的消息发出、消息流入速率，订阅数和当前连接数。
节点数据¶
点击节点下拉列表可以切换查看节点的基本信息包括 EMQ X 版本信息、运行时间、资源占用、连接和订阅等数据。 部分信息释义如下：
- 内存： Erlang 虚拟机使用的当前内存/最大内存，其中最大内存由 EMQ X 视资源使用情况自动向系统申请，并非 EMQ X 所在节点服务器物理内存用户无需干预；
- 最大文件句柄：允许当前会话/进程打开文件句柄数，该值过小会限制 EMQ X 并发性能，在远小于 License 授权最大连接数时，请参照 测试调优 或联系 EMQ 技术人员进行修改；
- Erlang 进程、连接、主题、订阅、保留消息、共享订阅：该四个值通过
/分割为两组，分别是当前值与最大值。
节点详细信息¶
点击节点数据下方 查看详情 按钮可以跳转至节点详情，查看当前节点的基础信息、监听器及连接情况，度量指标等信息。
监听器¶
监听器为当前 EMQ X 监听网络端口列表，字段信息如下：
- 监听协议：监听的网络/应用协议，包含协议与功能信息：
- mqtt:ssl： MQTT TCP TLS 加密协议，默认最大连接数 102400
- mqtt:tcp： MQTT TCP 协议，默认最大连接数 1024000
- http:dashboard：Dashboard 使用的 HTTP 协议，默认最大连接数 512
- http:management：EMQ X REST API 使用的 HTTP 协议，默认最大连接数 512
- mqtt:ws：MQTT WebSocket 协议，默认最大连接数 102400
- mqtt:wss：MQTT WebSocket TLS 加密协议，默认最大连接数 102400
- 监听地址：监听绑定的网络地址与端口，默认监听全部 IP 地址；
- Acceptors：监听处理器线程池，可通过各自协议
*.acceptors字段配置； - 连接：包含一组当前值/最大值，当前值为实际建立连接数量，最大值为配置文件配置的最大连接数量，每个监听器超出最大值后将无法建立新连接。
License 信息¶
监控页面底部为 License 信息卡片，可以查看当前集群内 License 信息：
- 签发对象：同商务合同客户公司或部门名称；
- License 使用情况：License 规格与当前使用量；
- 签发邮箱：同商务合同客户联系邮箱；
- License 类型：右下角标识 License 信息，为试用版或正式版。
证书到期后您需要续签商务合同获取新的 License 证书并按照 License 更新方式或联系 EMQ 技术人员更新 License 证书，证书到期前 EMQ 将通过邮件通知签发邮箱，请留意信息接收以免错过续期时间对业务造成影响。
连接¶
连接列表¶
连接列表页面显示当前连接客户端列表，列表中几个重要信息如下：
- Client ID、Username：分别是 MQTT Client ID 与 MQTT Username，点击绿色Clientid ID可以查看客户端详情与订阅列表信息；
- IP 地址：连接 IP + 端口信息；
- 断开连接/清除会话：对于在线的客户端，将断开其连接并清除会话，如果客户端不在线，点击清除会话将清除客户端订阅关系等会话信息。
规则引擎¶
规则列表¶
规则引擎使用 SQL 设定规则，对消息数据进行筛选、编解码、变型，灵活地将处理后的数据无缝转发至数据库、流处理、API 网关等数据目的地。
规则引擎不仅提供了清晰、灵活的"配置式"的业务集成方案，简化了业务开发流程，提升用户易用性，降低业务系统与 EMQ X 的耦合度；也为用户私有功能定制提供了一个更优秀的基础架构。
规则引擎列表数据如下：
- ID：规则集群内唯一 ID，可用在管理命令和 REST API 操作中；
- 主题：规则对应的消息主题或事件主题；
- 监控：点击将弹出所选规则执行情况统计，包括规则命中次数与执行次数，动作触发成功/失败次数统计；
- 响应动作：一个或多个规则的响应动作。
创建规则¶
EMQ X 在消息发布、事件触发时将触发规则引擎，满足触发条件的规则将执行各自的 SQL 语句筛选并处理消息和事件的上下文信息。
规则引擎借助响应动作可将特定主题的消息处理结果存储到数据库，发送到 HTTP Server，转发到消息队列 Kafka 或 RabbitMQ，重新发布到新的主题甚至是另一个 Broker 集群中，每个规则可以配置多个响应动作。
- 从 message.publish 事件选择发布到 t/# 主题的消息，并筛选出全部字段：
SELECT * FROM "message.publish" WHERE topic =~ 't/#'
- 选择发布到 t/a 主题的消息，并从 JSON 格式的消息内容中筛选出 "x" 字段：
SELECT payload.x as x FROM "message.publish" WHERE topic =~ 't/a'
规则引擎使用事件处理 EMQ X 客户端行为，内置事件提供更精细的消息控制和客户端动作处理能力，可用在 QoS 1 QoS 2 的消息抵达记录、设备上下线记录等业务中。
- 选择客户端连接事件，筛选 Username 为 'emqx' 的设备并获取连接信息：
SELECT clientid, connected_at FROM "client.connected" WHERE username = 'emqx'
规则引擎数据和 SQL 语句格式及详细教程参见本文档规则引擎部分。
资源¶
资源保存了规则引擎动作所需的资源实例(如数据库连接实例，Web Server 的连接信息)，创建规则前需要创建相关动作所需资源并保证资源可用。
资源列表¶
资源列表数据如下：
- ID：资源集群内唯一 ID，可用在管理命令和 REST API 操作中；
- 状态：资源创建后，集群中的每个节点都将与资源建立连接，点击展开节点上资源状态；
- 删除：规则引擎正在使用中的资源无法删除，请先删除依赖所选资源的规则再进行删除操作。
编解码¶
编解码（Schema Registry） 用于管理编解码使用的 Schema、处理编码或解码请求并返回结果。编解码配合规则引擎，可进行 Protobuf、Avro 以及私有协议上/下行消息解析处理，实现如消息加密、消息压缩、任意二进制-JSON 消息互转等复杂操作。
插件¶
插件页面用于查看 EMQ X 内置插件列表、进行插件的启动、停止管理操作。
不同于命令行插件管理，Dashboard 上插件的启动、停止操作是集群同步的，如果插件启动失败，请检查集群内每个节点的配置是否正确，任意集群启动失败都无法成功启动插件。
工具¶
提供 WebSocket MQTT 客户端测试工具，可同时实现多个 MQTT 连接的发布、订阅测试。
