Dashboard

    The EMQX Dashboard function is implemented by the emqx-dashboard (opens new window) plugin, which is enabled by default, and it will be automatically loaded when the EMQX Broker starts. If you wish to disable the Dashboard function, you can modify in data/loaded_plugins to {emqx_dashboard, false}.

    EMQX Dashboard is a web application, and you can access it directly through the browser without installing any other software.

    When EMQX Broker runs successfully on your local computer and EMQX Dashboard is enabled by default, you can visit http://localhost:18083 to view your Dashboard. The default user name is admin and the password is public .

    You can view or modify the configuration of EMQX Dashboard in etc/plugins/emqx_dashboard.conf. Note that etc here does not refer to the system directory, see directory structure for details.

    EMQX Dashboard configuration items can be divided into two parts of default user and listener:

    Default User

    EMQX Dashboard can configure multiple users, but only the default user can be configured in the configuration file.

    It should be noted that once you change the password of the default user through Dashboard, the relevant information of the default user will be based on your latest changes on the Dashboard, and the default user configuration in the configuration file will be ignored.

    Listeners

    EMQX Dashboard supports both HTTP and HTTPS Listeners, but only HTTP Listeners with a listening port of 18083 are enabled by default. For the introduction of Listeners, please refer to .

    For the detailed configuration item description of Dashboard, please refer to Configuration Item.

    In order to enable users to quickly locate and switch the current position during operation and browsing, EMQX Dashboard adopts the mode of side navigation. By default, Dashboard includes the following first-level navigation items:

    EMQX Dashboard provides a very rich data monitoring project, that completely covers the server and client. All of this information will be reasonably displayed to users on the page under MONITORING.

    Overview

    As the default display page of Dashboard, Overview provides detailed information of EMQX Broker ’s current nodes and key information of other nodes in the cluster to help users quickly get the status of each node.

    image

    Clients

    The Clients page uses a snapshot to display the client list. Therefore, when the client status changes, the page does not automatically refresh, and you need to manually refresh the browser to get the latest client data.

    If you can not get the information you need in the client list, you can click Client ID to view the detailed information of the client.

    image

    We divided the various fields in the client details into connection, session and metrics. The following is the description of each field:

    Connection

    Session

    Metric

    In the Subscriptions tab of the client details, you can view the subscription information of the current client, and create or cancel subscriptions:

    Subscriptions

    The Subscriptions page provides all subscription information under the specified node, and supports users to query all subscriptions of the specified client through the Client ID.

    image

    The rule engine of EMQX Broker can flexibly process messages and events, such as converting the message into a specified format and storing it in a database table or resending it to the message queue. In order to facilitate users to better use the rules engine, EMQX Dashboard provides corresponding visual operation pages, and you can click the RULE ENGINE navigation item to access these pages.

    Due to the complexity of the related concepts of the rule engine, the operations involved may occupy a considerable amount of space. Considering your reading experience, we will introduce the rule engine through additional documents of .

    Currently, the EMQX Dashboard’s MANAGEMENT navigation item mainly includes an monitoring management page for extension plug-in and management page of AppID and AppSerect for HTTP API authentication.

    Plugins

    You can see that in addition to emqx-dashboardDashboard - 图8 (opens new window), EMQX Broker will also start other 4 plugins by default:

    Applications

    The page lists the currently created applications. You can perform operations such as creating applications, temporarily disabling or starting access permissions for an application on this page. EMQX Broker will create a default application with AppID of admin and AppSecret of publish for users to access for the first time:

    image

    You can click the New App button in the upper right corner of the Application page to create a new application, where AppID and AppSecret are required. After the creation is complete, you can click the View button to view the application details, and AppSecret will also be displayed in the details. The following is a description of the relevant fields:

    Currently, the TOOLS navigation item of EMQX Dashboard mainly includes WebSocket client tool page and HTTP API quick check page.

    Websocket

    The Websocket page provides you with a simple but effective WebSocket client tool, which includes connection, subscription and publishing functions. At the same time, you can view the message data you send and receive, we hope it can help you quickly complete test verification of certain scenarios or functions:

    HTTP API

    The HTTP API page lists all the HTTP APIs currently supported by EMQX Broker and their descriptions:

    image

    Users

    You can view and manage users who can access and operate Dashboard on the page:

    Settings

    Currently, EMQX Dashboard only supports the modification of the topic and language settings:

    image

    Help