This document describes the basic usage of the Chariot MQTT Server through the Chariot UI.

The UI can be accessed at the following URL:

http://<server-url>:8080

When installed on Linux, Windows or deployed via Azure Marketplace, the default login credentials are:

username: admin
password: password

When deployed via AWS Marketplace, the default login credentials are:

username: admin
password: EC instance ID for example: i-0049ac1e13e558b70

The Chariot MQTT Server Web UI provides the following status pages for monitoring server activity, logs, and data.

Dashboard

The Chariot dashboard provides a high level view of Chariot server and system status information.

Logging

The Logging page has two tabs when a user can either view live Chariot logs or modify log levels.  Additionally, a zip file containing the Chariot logs can be downloaded.

Live Logs

Live Chariot logs can be viewed on the Live logs tab.  The live logs can be filtered by matching message text or selecting a minimum log level.  A live toggle allows for enabling/disabling live log updates to the page.

Download Logs

The menu button at the top of the page contains an option for downloading a zip file containing the Chariot logs.

Log Levels

The second tabs allows for modifying log levels. The log levels can be filtered by name and each logger can have the level set to one of: TRACE, DEBUG, INFO, WARN, and ERROR.

Sparkplug

The Sparkplug page tracks data from Sparkplug MQTT clients that are connected to the Chariot MQTT server. The tracking can be disabled by clicking on the menu button at the top.

Overview

The Overview tab provides a dynamic representation of the Sparkplug Host Applications, Groups, Edge Nodes, and Devices that are being tracked by Chariot.

Selecting a specific Edge Node will display the Edge Node details and explode the Devices associated with the Edge Node

Selecting a specific Device will display the Device details

 Host Applications

The Host Applications tab will show all Sparkplug Host applications that Chariot is tracking.  Selecting a host application from the list will show additional details such as the last time it was online or offline.

Edge Nodes

The Edge Nodes tab will show all Sparkplug Edge Nodes and any Devices that Chariot is tracking.  Selecting an Edge Node from the list will show additional details and also populate the list of the Edge Node's Devices below.

Buttons on the far right of each Edge Node entry in the list provide tools for sampling compression and downloading the Sparkplug Edge Node birth (NBIRTH) and Device birth (DBIRTH) payloads in JSON format.

Tools

The Tools tab allows you to generate Access Control Lists (ACLs) needed for Hosts and Edge Nodes.

ACLs define the topics that a client can publish and subscribe on and generating an ACL through the Sparkplug Tools will automatically add the the credentials to the MQTT Credentials section of the Chariot configuration. 

Select Generate Edge Node ACL to generate the ACLs for a Sparkplug client. Enter the client username, password and Primary Host ID (if needed). Add the required Sparkplug Edge Node IDs and select create. 

A new entry for the username/password will be added to the MQTT Credentials section of the Chariot configuration.

Select Generate Host ACL to generate the ACLs for a Sparkplug Primary Host client. Enter the client username, password and Primary Host ID. Add the required Sparkplug Edge Node IDs and select create. 

A new entry for the username/password will be added to the MQTT Credentials section of the Chariot configuration.

For the examples above, the MQTT Credentials will have been updated as shown below:

MQTT

The MQTT page tracks the status of MQTT Clients.

Clients

The MQTT Clients pages show details of all clients connected to the Chariot MQTT server.  A searchable dropdown list is used to select an MQTT client and view network details, session information, LWT details, and a list of subscriptions.

Retained Messages

The Retained Messages page shows all retained messages recorded by the Chariot Server.

Alerts

The Alerts page provides a place to view and manage any alerts that are generated in the Chariot Server

Live Alerts

The Live Alerts tab shows a live view of alerts as they are generated. Individual alerts can be acknowledge and cleared. The alerts displayed can be filtered by matching text in the description, selecting an alert type, and/or hiding cleared or acknowledged alerts.

Types

The Types tab allows for the enabling/disabling of specific alert types as well as changing the priority (1, 2, or 3).

Some of the Alert Types supported in the Chariot Server include:

  • MQTT_DISCONNECT
    • An MQTT client has disconnected
  • MQTT_CONNECTION_LOST
    • An MQTT client has lost it's connection
  • MQTT_LWT_NOT_REGISTERED
    • An MQTT client has connected but not registered an LWT (last will and testament)
  • SPARKPLUG_SEQ_NUM_ERROR
    • Messages published from a Sparkplug MQTT client have been received out of sequence
  • SPARKPLUG_GROUP_EDGE_COLLISION
    • Multiple Sparkplug MQTT clients are using the same Group ID and Edge Node ID
  • SPARKPLUG_NONCOMPLIANT_LWT_TOPIC
    • A Sparkplug MQTT Client has registered an LWT that is not compliant with the Sparkplug specification
  • SPARKPLUG_TEMPLATE_DEF_COLLISION
    • A Sparkplug MQTT client is publishing template definitions that conflict with previously published definitions
  • SPARKPLUG_COMPRESSION_WARNING
    • A Sparkplug MQTT client is using data compression and the compressed data is actually larger in size then the uncompressed data


Diagnostics

The Diagnostics page provides a view to the threads running within the Chariot Server. This information may be requested by Cirrus Link support personnel to assist in diagnosing issues with the Chariot Server.


  • No labels

New to MQTT? Start Here!