Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

  • GENERALSparkplug
  • MQTT

    Anchor
    Dashboard
    Dashboard

    Dashboard

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

    Image Modified

    Anchor
    Logging
    Logging

    ...

    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.

    Image Modified

    Download Logs

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

    Image Modified

    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.

    Image Modified

    Image Modified

    Anchor
    Sparkplug
    Sparkplug

    ...

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

    Image Modified

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

    Image Modified

    Selecting a specific Device will display the Device details

    Image Modified

     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.

    Image Modified

    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.

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

    Image Modified

    Image Modified


    Image Modified

    Image Modified

    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 Account Credentials section of the Chariot configuration.  

    Image Modified

    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 Account Credentials section of the Chariot configuration.

    Image Modified

    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 Account Credentials section of the Chariot configuration.

    Image Modified

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

    Image Modified

    Anchor

    ...

    Client Status

    ...

    Client Status

    ...

    Client Status

    The MQTT Client Status page tracks the status of MQTT Clients.

    Clients

    The MQTT Clients pages show Client Status page shows details of all clients connected to the Chariot MQTT server. A filterable table lists the MQTT clients, selecting one will allow you to view network details, session information, LWT details , and a list of subscriptions.

    Image Modified

    Image Modified

    Retained Messages

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

    Image Modified

    Anchor
    Alerts
    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.

    Image Modified

    Types

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

    Image Modified

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

    ...

    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.

    Image Modified

    Image Modified